xref: /original-bsd/old/lisp/vlp/vlp.1 (revision da818fbb)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)vlp.1 6.2 (Berkeley) 05/05/89

VLP 1 ""
C 5
NAME
vlp - Format Lisp programs to be printed with nroff, vtroff, or troff
SYNOPSIS
vlp [ -p pointsize ] [ -d ] [ -f ] [ -l ] [ -v ] [ -T title1 ] file1 [ -T title2 ] file2 ...
DESCRIPTION
Vlp 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, vlp works as a filter and sends its output to the standard output. However, the -v switch pipes the output directly to vtroff. If no files are specified, then vlp reads from the standard input.

The following options are available:

-p The -p 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 subsequent files. This point size does not apply to embedded text (see -f below).

-d The -d switch puts vlp into debugging mode.

-f Vlp has a filtered mode in which all lines are passed unmodified, except those lines between the directives .Ls and .Le. This mode can be used to format Lisp code that is embedded in a document. The directive .Ls 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.

-l The -l switch prevents vlp from placing labels next to functions. This switch is useful for embedded Lisp code, where the labels would be distracting.

-v This switch cause vlp to send its output to vtroff rather than the standard output.

-T A title to be printed on each page may be specified by using the -T switch. The -T switch applies only to the next file name given. Titles are not printed for embedded text (see -f , above). This switch may not be used if vlp is reading from the standard input.

FILES
/usr/lib/vlpmacs troff/nroff macros
AUTHOR
Originally written by John K. Foderaro, with additional changes by Kevin Layer and James Larus.
SEE ALSO
vgrind(1), lisp(1)
BUGS
vlp transforms \ into \\\ so that it will be printed out. Hence, troff commands cannot be embedded in Lisp code.