BSD 4_3_Tahoe development
[unix-history] / usr / man / cat1 / vlp.0
VLP(1) UNIX Programmer's Manual VLP(1)
N\bNA\bAM\bME\bE
vlp - Format Lisp programs to be printed with nroff, vtroff,
or troff
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
v\bvl\blp\bp [ -\b-p\bp _\bp_\bo_\bi_\bn_\bt_\bs_\bi_\bz_\be ] [ -\b-d\bd ] [ -\b-f\bf ] [ -\b-l\bl ] [ -\b-v\bv ] [ -\b-T\bT _\bt_\bi_\bt_\bl_\be_\b1
] file1 [ -\b-T\bT _\bt_\bi_\bt_\bl_\be_\b2 ] file2 ...
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
_\bV_\bl_\bp formats the named files so that they can be run through
nroff, vtroff, or troff to produce listings that line-up and
are attractive. The first non-blank character of each line
is lined-up vertically, as in the source file. Comments
(text beginning with a semicolon) are printed in italics.
Each function's name is printed in bold face next to the
function. This format makes Lisp code look attractive when
it is printed with a variable width font.
Normally, _\bv_\bl_\bp works as a filter and sends its output to the
standard output. However, the -\b-v\bv switch pipes the output
directly to vtroff. If no files are specified, then _\bv_\bl_\bp
reads from the standard input.
The following options are available:
-\b-p\bp The -\b-p\bp switch changes the size of the text from its
default value of 8 points to one of 6, 8, 10, or 12
points. Once set, the point size is used for all sub-
sequent files. This point size does not apply to
embedded text (see -_\bf below).
-\b-d\bd The -\b-d\bd switch puts _\bv_\bl_\bp into debugging mode.
-\b-f\bf _\bV_\bl_\bp has a filtered mode in which all lines are passed
unmodified, except those lines between the directives
.\b.L\bLs\bs and .\b.L\bLe\be. This mode can be used to format Lisp code
that is embedded in a document. The directive .\b.L\bLs\bs
takes an optional argument that gives the point size
for the embedded code. If not size is specified, the
size of the surrounding text is used.
-\b-l\bl The -\b-l\bl switch prevents _\bv_\bl_\bp from placing labels next to
functions. This switch is useful for embedded Lisp
code, where the labels would be distracting.
-\b-v\bv This switch cause _\bv_\bl_\bp to send its output to vtroff
rather than the standard output.
-\b-T\bT A title to be printed on each page may be specified by
using the -\b-T\bT switch. The -\b-T\bT switch applies only to the
next file name given. Titles are not printed for
embedded text (see -\b-f\bf, above). This switch may not be
Printed 7/9/88 April 29, 1985 1
VLP(1) UNIX Programmer's Manual VLP(1)
used if _\bv_\bl_\bp is reading from the standard input.
F\bFI\bIL\bLE\bES\bS
/usr/lib/vlpmacs troff/nroff macros
A\bAU\bUT\bTH\bHO\bOR\bR
Originally written by John K. Foderaro, with additional
changes by Kevin Layer and James Larus.
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
vgrind(1), lisp(1)
B\bBU\bUG\bGS\bS
_\bv_\bl_\bp transforms \ into \\ so that it will be printed out.
Hence, troff commands cannot be embedded in Lisp code.
Printed 7/9/88 April 29, 1985 2