1.\" Copyright (c) 1983, 1991 The Regents of the University of California. 2.\" All rights reserved. 3.\" 4.\" %sccs.include.redist.roff% 5.\" 6.\" @(#)vlp.1 6.3 (Berkeley) 04/23/91 7.\" 8.Dd 9.Dt VLP 1 10.Os BSD 4.2 11.Sh NAME 12.Nm vlp 13.Nd Format Lisp programs to 14be printed with nroff, vtroff, or troff 15.Sh SYNOPSIS 16.Nm vlp 17.Op Fl d 18.Op Fl f 19.Op Fl l 20.Op Fl p Ar pointsize 21.Op Fl v 22.Op Fl T Ar title1 23.Ar file1 24.Bk -words 25.Op Fl T Ar title2 26.Ek 27.Ar file2 Ar ... 28.Sh DESCRIPTION 29.Nm Vlp 30formats the named files so that they can be run through 31.Xr nroff 1 , 32.Xr vtroff 1 , 33or 34.Xr troff 1 35to produce listings that line-up and are attractive. 36The first non-blank character of each line is lined-up vertically, 37as in the source file. 38Comments (text beginning with a semicolon) 39are printed in italics. 40Each function's name is printed in bold face next to the function. 41This format makes Lisp code look attractive when it is printed with a 42variable width font. 43.Pp 44Normally, 45.Nm vlp 46works as a filter and sends its output to the standard output. 47However, 48the 49.Fl v 50switch pipes the output directly to vtroff. 51If no files are specified, 52then 53.Nm vlp 54reads from the standard input. 55.Pp 56The following options are available: 57.Bl -tag -width Ds 58.It Fl d 59The 60.Fl d 61switch puts 62.Nm vlp 63into debugging mode. 64.It Fl f 65.Nm Vlp 66has a filtered mode 67in which all lines are passed unmodified, 68except those lines between the directives 69.Sy .Ls 70and 71.Sy .Le . 72This mode can be used to format Lisp code that is embedded in a document. 73The directive 74.Sy .Ls 75takes an optional argument that gives the point 76size for the embedded code. 77If not size is specified, 78the size of the surrounding text is used. 79.It Fl l 80The 81.Fl l 82switch prevents 83.Nm vlp 84from placing labels next to functions. 85This switch is useful for embedded Lisp code, 86where the labels would be distracting. 87.It Fl p Ar pointsize 88The 89.Fl p 90switch changes the size of the text from its default value of 8 points 91to one of 6, 8, 10, or 12 points. 92Once set, the point size is used for all subsequent files. 93This point size does not apply to embedded text (see 94.Fl f 95above). 96.It Fl v 97This switch cause 98.Nm vlp 99to send its output to vtroff rather than the 100standard output. 101.It Fl T Ar title 102A title to be printed on each page may be specified by using the 103.Fl T 104switch. 105The 106.Fl T 107switch applies only to the next 108.Ar file 109name given. 110Titles are not printed for embedded text (see 111.Fl f , 112above). 113This switch may not be used if 114.Nm vlp 115is reading from the standard input. 116.El 117.Sh FILES 118.Bl -tag -width Pa 119.It Pa /usr/lib/vlpmacs 120.Xr troff/nroff 121macros 122.El 123.Sh SEE ALSO 124.Xr vgrind 1 , 125.Xr lisp 1 126.Sh BUGS 127.Nm vlp 128transforms 129.Ql \e 130into 131.Ql \e\e 132so that it will be printed out. 133Hence, 134.Xr troff 135commands cannot be embedded in Lisp code. 136.Sh HISTORY 137The 138.Nm 139command appeared in 140.Bx 4.2 . 141