VTOC(1G) COMMAND REFERENCE VTOC(1G)
NAME
vtoc - visual table of contents
SYNOPSIS
vtoc [ -c ] [ -d ] [ -hn ] [ -i ] [ -m ] [ -s ] [ -vn ] [
file ... ]
DESCRIPTION
Vtoc produces a GPS describing a hierarchy chart from a
textual table of contents (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]
Brackets denote optional fields. Each field describes an
attribute of the box, as follows:
id is an alternating sequence of numbers and
periods. The id specifies the position of
the entry in the tree: the number of
periods in the id corresponds to the level
of the entry in the heirarchy. The id is
displayed above the upper left corner of
the box. The entry with 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). The mark string is
put above the top right corner of the box.
Printed 10/17/86 1
VTOC(1G) COMMAND REFERENCE VTOC(1G)
To include either a quote or a period
within a mark, it must be escaped (\" or
\.).
Entry example: 1.1 b,da "ABC" DEF
Entries may span more than one line by escaping the newline.
For example:
2.1.3 n,do \
"text label for box" boxmark
Comments are surrounded by the /*,*/ pair. They may appear
anywhere in a TTOC.
The command dtoc produces a TTOC describing a UTek directory
structure. See dtoc(1g).
OPTIONS
-c Take the 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 horizontially.
-vn Vertical interbox space is n% of box height.
EXAMPLES
The following example outputs a VTOC derived from the TTOC
in the file A.t. The VTOC boxes are without id fields, and
the ratio of vertical box spacing to box height is 1/2.
vtoc -i,v50 A.t
SEE ALSO
abs(1g), af(1g), bar(1g), bel(1g), bucket(1g), ceil(1g),
cor(1g), cusum(1g), cvrtopt(1g), dtoc(1g), erase(1g),
exp(1g), floor(1g), gamma(1g), gas(1g), gd(1g), ged(1g),
graphics(1g), gtop(1g), hardcopy(1g), hilo(1g), hist(1g),
hpd(1g), intro(1g), label(1g), list(1g), log(1g), lreg(1g),
mean(1g), mod(1g), pair(1g), pd(1g), pie(1g), plot(1g),
point(1g), power(1g), prime(1g), prod(1g), ptog(1g),
qsort(1g), quit(1g), rand(1g), rank(1g), remcom(1g),
root(1g), round(1g), siline(1g), sin(1g), subset(1g),
td(1g), tekset(1g), title(1g), total(1g), ttoc(1g), var(1g),
Printed 10/17/86 2
VTOC(1G) COMMAND REFERENCE VTOC(1G)
whatis(1g), yoo(1g), and gps(5g).
Printed 10/17/86 3
%%index%%
na:72,67;
sy:139,257;
de:396,2160;2700,626;
op:3326,488;
ex:3814,280;
se:4094,1350;5588,126;
%%index%%000000000126