Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

graphics(1)

mm(1)

gps(4)



  toc(1)                              CLIX                              toc(1)



  NAME

    toc:  dtoc, ttoc, vtoc - Run graphical table of contents routines

  SYNOPSIS

    dtoc [directory]

    ttoc mm-file

    vtoc [-cdims] [-hn] [-vn] [TTOC file]

  FLAGS

    -c    Use text as entered (default is all uppercase).

    -d    Connect the boxes with diagonal lines.

    -hn   Horizontal interbox space is n% of box width.

    -i    Suppress the box id.

    -m    Suppress the box mark.

    -s    Do not compact boxes horizontally.

    -vn   Vertical interbox space is n% of box height.

  DESCRIPTION

    The toc commands run graphical table of contents routines.  All of the
    following commands reside in /usr/bin/graf (see graphics).

    dtoc   The dtoc command makes a textual table of contents, TTOC, of all
           subdirectories beginning at directory (directory defaults to .).
           The list has one entry per directory.  The entry fields from left
           to right are level number, directory name, and the number of
           ordinary readable files in the directory.  The dtoc command 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 /:

           dtoc / | vtoc | td


    ttoc   Output is the table of contents generated by the .TC macro of mm
           translated to TTOC format.  The input is assumed to be an mm file
           that uses the .H family of macros for section headers (see the
           Documenter's Workbench Software).  If no file is given, stdin is
           assumed.




  2/94 - Intergraph Corporation                                              1






  toc(1)                              CLIX                              toc(1)



    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, stdin 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   can be one of the following:

                         n   normal-weight

                         m   medium-weight

                         b   bold-weight

           line-style    can be one of the following:

                         so   solid-line

                         do   dotted-line

                         dd   dot-dash line

                         da   dashed-line

                         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.1 b,da "ABC" DEF

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

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



  2                                              Intergraph Corporation - 2/94






  toc(1)                              CLIX                              toc(1)



    TTOC.

  DIAGNOSTICS

    Too much text/too many nodes
           vtoc is unable to get enough memory to handle the data.

           There are no diagnostic messages for dtoc and ttoc.

  EXIT VALUES

    Exit values for dtoc, ttoc, and vtoc are not valid.

  RELATED INFORMATION

    Commands: graphics(1), mm(1)

    Files: gps(4)




































  2/94 - Intergraph Corporation                                              3




Typewritten Software • bear@typewritten.org • Edmonds, WA 98026