XTREE(1)                    X Version 11(Release 5)                    XTREE(1)


NAME
      xtree - tree graphing filter

SYNOPSIS
      xtree [-option ...]

DESCRIPTION
      The xtree program is a filter that generates tree graphs from outline-
      style representations of data provided on the standard input.  Pressing
      on nodes in the tree causes their name to be printed on the standard
      output in one of several formats.

OPTIONS
      This program accepts all of the standard X Toolkit command line options
      as well as the following:

      -separator string
              This option specifies the character or string prefix for each
              line.  The number of separators at the beginning of the line
              determines the level in the tree.  This is the same as setting
              the separator resource.  The default value is a tab.

      -vertical
              This option indicates that the tree should be displayed
              vertically instead of horizontally.  This is a shorthand for
              setting the gravity resource of the Tree widget to north.

      -iformat format-name
              This option specifies the format in which tree data on the
              standard input is encoded.  The format-name may be either number
              or separator.  This is the same as setting the inputFormat
              resource.  The default value is separator.

      -oformat format-name
              This option specifies the format in which the names of nodes that
              have been pressed should be printed on the standard output.  The
              format-name may be: number, separator, name, or resource.  This
              is the same as setting the outputFormat resource.  The default
              value is name.

      -nbase number
              This option specifies the level of the highest nodes in the tree
              for number output when number was not used for input . It is the
              same as setting the numberBase resource.  The default is 1, and
              this value is overridden by any number input.

RESOURCES
      The following application resources may be set in addition to the
      individual widget resources described in the Athena Widget Set
      documentation:




10/89                                                                    Page 1

XTREE(1)                    X Version 11(Release 5)                    XTREE(1)


      separator (class Separator)
              This resource specifies a string that is used as a prefix on each
              input line to indicate the depth of that line in the tree.  The
              default is a tab.

      numberBase (class NumberBase)
              This resource specifies the number index of top-most nodes on
              output.  If the input data is in number format, the first entry
              of the input will override this value.  The default is 1.

      inputFormat (class Format)
              This resource specifies the format in which tree data on the
              standard input is encoded.  The format-name may be either number
              or separator (which is the default).

      outputFormat (class Format)
              This resource specifies the format in which the names of nodes
              that have been pressed should be printed on the standard output.
              The format-name may be either number, separator, name (the
              default), or resource.

FORMATS
      Input and output data may have the following formats:

      separator
              In this format, lines are indented using the separator resource
              to indicate their depth in the tree.  A child is indicated by
              indenting with one separator more than the preceeding line; a
              sibling is indicated by indenting with the same number of
              separators as the preceeding line.  This format may be used for
              both input and output.

      number  In this format, lines are prefixed with their depth in the tree
              followed by a colon and optional whitespace.  If this format is
              only used for output, then the numberBase resource is used for
              the level of the first entry.  This format may be used for both
              input and output.

      name    In this output-only format, only the text of the node is printed
              when the command button for the node is pressed.

      resource
              In this output-only format, the text of all node from the root
              down to the pressed node are printed, separated by a period.
              This is most useful when looking at trees of resources.

WIDGET HIERARCHY
      Resources may be specified for the following Athena widgets (class name):

      xtree (XTree)
           pane (Paned)
                buttonbox (Box)


Page 2                                                                    10/89

XTREE(1)                    X Version 11(Release 5)                    XTREE(1)


                     quit (Command)
           form (Form)
                porthole (Porthole)
                     tree (Tree)
                          entry-name (Command)
                panner (Panner)

      where entry-name is the contents of the label with all non-alphanumeric
      characters removed.

SEE ALSO
      X(1), Athena Widget Set documentation

COPYRIGHT
      Copyright 1990, Massachusetts Institute of Technology.
      See X(1) for a full statement of rights and permissions.

AUTHOR
      Jim Fulton, MIT X Consortium



































10/89                                                                    Page 3