|
|
1.1 root 1: .\" Copyright (c) 1983 Regents of the University of California.
2: .\" All rights reserved. The Berkeley software License Agreement
3: .\" specifies the terms and conditions for redistribution.
4: .\"
5: .\" @(#)vlp.1 6.1 (Berkeley) 4/29/85
6: .\"
7: .TH VLP 1 "April 29, 1985"
8: .UC 5
9: .SH NAME
10: vlp \- Format Lisp programs to be printed with nroff, vtroff, or troff
11: .SH SYNOPSIS
12: .B vlp
13: [
14: .B \-p
15: .I pointsize
16: ] [
17: .B \-d
18: ] [
19: .B \-f
20: ] [
21: .B \-l
22: ] [
23: .B \-v
24: ] [
25: .B \-T
26: .I title1
27: ] file1 [
28: .B \-T
29: .I title2
30: ] file2 ...
31: .SH DESCRIPTION
32: \fIVlp\fR
33: formats the named files so that they can be run through nroff, vtroff, or
34: troff to produce listings that line-up and are attractive.
35: The first non-blank character of each line is lined-up vertically,
36: as in the source file.
37: Comments (text beginning with a semicolon)
38: are printed in italics.
39: Each function's name is printed in bold face next to the function.
40: This format makes Lisp code look attractive when it is printed with a
41: variable width font.
42: .PP
43: Normally,
44: \fIvlp\fR works as a filter and sends its output to the standard output.
45: However,
46: the
47: .B \-v
48: switch pipes the output directly to vtroff.
49: If no files are specified,
50: then \fIvlp\fR reads from the standard input.
51: .PP
52: The following options are available:
53: .TP
54: .B \-p
55: The
56: .B \-p
57: switch changes the size of the text from its default value of 8 points
58: to one of 6, 8, 10, or 12 points.
59: Once set, the point size is used for all subsequent files.
60: This point size does not apply to embedded text (see \fI\-f\fR below).
61: .TP
62: .B \-d
63: The
64: .B \-d
65: switch puts \fIvlp\fR into debugging mode.
66: .TP
67: .B \-f
68: .I Vlp
69: has a filtered mode
70: in which all lines are passed unmodified,
71: except those lines between the directives \fB.Ls\fR and \fB.Le\fR.
72: This mode can be used to format Lisp code that is embedded in a document.
73: The directive \fB.Ls\fR takes an optional argument that gives the point
74: size for the embedded code.
75: If not size is specified,
76: the size of the surrounding text is used.
77: .TP
78: .B \-l
79: The
80: .B \-l
81: switch prevents \fIvlp\fR from placing labels next to functions.
82: This switch is useful for embedded Lisp code,
83: where the labels would be distracting.
84: .TP
85: .B \-v
86: This switch cause \fIvlp\fR to send its output to vtroff rather than the
87: standard output.
88: .TP
89: .B \-T
90: A title to be printed on each page may be specified by using the
91: .B \-T
92: switch.
93: The
94: .B \-T
95: switch applies only to the next file name given.
96: Titles are not printed for embedded text (see
97: .BR \-f ,
98: above).
99: This switch may not be used if \fIvlp\fR is reading from the standard input.
100: .SH FILES
101: /usr/lib/vlpmacs troff/nroff macros
102: .SH AUTHOR
103: Originally written by John K. Foderaro, with additional changes by
104: Kevin Layer and James Larus.
105: .SH SEE ALSO
106: vgrind(1), lisp(1)
107: .SH BUGS
108: \fIvlp\fR transforms \\ into \\\\ so that it will be printed out.
109: Hence, troff commands cannot be embedded in Lisp code.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.