VLP
Section: User Commands (1)
Index
Return to Main Contents
BSD mandoc
BSD 4.2
NAME
vlp
- Format Lisp programs to
be printed with nroff, vtroff, or troff
SYNOPSIS
vlp
[-d
]
[-f
]
[-l
]
[-p pointsize
]
[-v
]
[-T title1
]
file1
-words
[-T title2
]
file2 ...
DESCRIPTION
Vlp
formats the named files so that they can be run through
nroff(1),
vtroff(1),
or
troff(1)
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:
- -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.
- -p pointsize
-
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
above).
- -v
-
This switch cause
vlp
to send its output to vtroff rather than the
standard output.
- -T title
-
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
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.
HISTORY
The
vlp
command appeared in
BSD 4.2
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- FILES
-
- SEE ALSO
-
- BUGS
-
- HISTORY
-
This document was created by
man2html,
using the manual pages.
Time: 06:28:44 GMT, May 19, 2025