toc

PURPOSE

     Provides graphical table of contents routines.

SYNOPSIS
     dtoc [ directory ]

     ttoc mmfile

     vtoc [ flags ] [ ttocfile ]

                              OL777076

                                                      OL777076

DESCRIPTION

     All of the commands  listed below reside in /usr/bin/graf
     (see "graphics").

       dtoc

     The dtoc command makes a textual table of contents, TTOC,
     of all subdirectories beginning  at directory (by default
     the  current directory.).   The  list has  one entry  per
     directory.  The entry fields from left to right are level
     number, directory name, and  the number of ordinary read-
     able files in the directory.   dtoc is useful in making a
     visual display  of all  or parts of  a file  system.  The
     following will make a visual  display of all the readable
     directories under the root directory (/):

       dtoc / | vtoc | td

       ttoc

     Output  is the  table of  contents generated  by the  .TC
     macro of the  mm command translated to  TTOC format.  The
     input is assumed to be a  mm file that uses the .H family
     of macros for section headers.   If no file is given, the
     standard input is assumed.

       vtoc

     The vtoc  command produces  a GPS describing  a hierarchy
     chart from a TTOC.  The  output drawing consists of boxes
     containing  text connected  in a  tree structure.   If no
     file is given, the standard  input is assumed.  Each TTOC
     entry describes one box and has the form:

     id[line-weight,line-style]"text"[mark]

     where:

     id            is an  alternating sequence of  numbers and
                   dots.  The id specifies the position of the
                   entry in  the hierarchy.  The id  0. is the
                   root of the tree.
     line-weight   is either:
                       n, normal-weight; or
                       m, medium-weight; or
                       b, bold-weight.
     line-style    is either:
                       so, solid-line;
                       do, dotted-line;
                       dd, dot-dash line;
                       da, dashed-line; or
                       ld, long-dashed
     text          is a character string surrounded by quotes.
                   The  characters between  the quotes  become
                   the  contents of  the  box.   To include  a
                   quote within a box it must be escaped (\").
     mark          is a character string (surrounded by quotes
                   if it contains  spaces), with included dots
                   being escaped.  The string is put above the
                   top right  corner of  the box.   To include
                   either a  quote or a  dot within a  mark it
                   must be escaped.

     Entry example:

       1.1b,da"ABD" DEF

     Entries may span more than  one line by escaping the new-
     line (\new-line).

     Comments  are surrounded  by  the /*,*/  pair.  They  may
     appear anywhere in a TTOC.

     FLAGS

     c     Uses text as entered, (default is all upper case).
     d     Connects the boxes with diagonal lines.
     hnum  Sets  horizontal  interbox  space to  num%  of  box
           width.
     i     Suppresses the box id.
     m     Suppresses the box mark.
     s     Do not compact boxes horizontally.
     vnum  Vertical interbox space is num% of box height.

RELATED INFORMATION

     The following command:  "graphics."

     The gps file in AIX Operating System Technical Reference.