Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

graphics(1G)

gps(4)



toc(1G)                                                   toc(1G)



NAME
     dtoc ttoc vtoc - graphical table of contents routines

SYNOPSIS
     dtoc [directory]
     ttoc mm-file
     vtoc [-cdhnimsvn] [TTOC file]

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

     dtoc      Dtoc makes a textual table of contents, TTOC, of
               all subdirectories beginning at directory (direc-
               tory 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.  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 /:
                    dtoc / | vtoc | td

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

     vtoc      Vtoc 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 posi-
                           tion 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;



Page 1                              CX/UX User's Reference Manual





toc(1G)                                                   toc(1G)



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

               Options:

               c    Use text as entered (default is all upper
                    case).

               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.



SEE ALSO
     graphics(1G).
     gps(4) in the CX/UX Programmer's Reference Manual.








Page 2                              CX/UX User's Reference Manual



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