BSD 4_1c_2 development
authorCSRG <csrg@ucbvax.Berkeley.EDU>
Wed, 9 Mar 1983 09:23:07 +0000 (01:23 -0800)
committerCSRG <csrg@ucbvax.Berkeley.EDU>
Wed, 9 Mar 1983 09:23:07 +0000 (01:23 -0800)
Work on file usr/man/man1/vlp.1

Synthesized-from: CSRG/cd1/4.1c.2

usr/man/man1/vlp.1 [new file with mode: 0644]

diff --git a/usr/man/man1/vlp.1 b/usr/man/man1/vlp.1
new file mode 100644 (file)
index 0000000..a8e1da2
--- /dev/null
@@ -0,0 +1,64 @@
+.TH VLP 1
+.SH NAME
+vlp \- Format Lisp programs to be printed with nroff, vtroff, or troff
+.SH SYNOPSIS
+\fBvlp\fR [\-p pointsize] [\-d] [\-f] [\-l] [\-v] [\-T title1] file1 [\-T title2] file2 ...
+.SH DESCRIPTION
+\fIvlp\fR
+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.
+.PP
+Normally,
+\fIvlp\fR works as a filter and sends its output to the standard output.
+However,
+the \fI\-v\fR switch pipes the output directly to vtroff.
+If no files are specified,
+then \fIvlp\fR reads from the standard input.
+.SH SWITCHES
+.IP \-p
+The \fI\-p\fR
+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 \fI\-f\fR below).
+.IP -d
+The \fI\-d\fR switch puts \fIvlp\fR into debugging mode.
+.IP \-f
+\fIvlp\fR has a filtered mode,
+in which all lines are passed unmodified,
+except those lines between the directives \fB.Ls\fR and \fB.Le\fR.
+This mode can be used to format Lisp code that is embedded in a document.
+The directive \fB.Ls\fR 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.
+.IP \-l
+The \fI\-l\fR switch prevents \fIvlp\fR from placing labels next to functions.
+This switch is useful for embedded Lisp code,
+where the labels would be distracting.
+.IP \-v
+This switch cause \fIvlp\fR to send its output to vtroff rather than the
+standard output.
+.IP \-T
+A title to be printed on each page may be specified by using the 
+\fI\-T\fR switch.
+The \fI\-T\fR switch applies only to the next file name given.
+Titles are not printed for embedded text (see \fI\-f\fR, above).
+This switch may not be used if \fIvlp\fR is reading from the standard input.
+.SH FILES
+/usr/local/lib/vlpmacs         troff/nroff macros
+.SH AUTHOR
+Originally written by John K. Foderaro, with additional changes by
+Kevin Layer and James Larus.
+.SH SEE ALSO
+vgrind(1), lisp(1)
+.SH BUGS
+\fIvlp\fR transforms \\ into \\\\ so that it will be printed out.
+Hence, troff commands cannot be embedded in Lisp code.