1*48594Scael.\" Copyright (c) 1983, 1991 The Regents of the University of California. 237658Sbostic.\" All rights reserved. 319762Smckusick.\" 4*48594Scael.\" %sccs.include.redist.roff% 519762Smckusick.\" 6*48594Scael.\" @(#)vlp.1 6.3 (Berkeley) 04/23/91 737658Sbostic.\" 8*48594Scael.Dd 9*48594Scael.Dt VLP 1 10*48594Scael.Os BSD 4.2 11*48594Scael.Sh NAME 12*48594Scael.Nm vlp 13*48594Scael.Nd Format Lisp programs to 14*48594Scaelbe printed with nroff, vtroff, or troff 15*48594Scael.Sh SYNOPSIS 16*48594Scael.Nm vlp 17*48594Scael.Op Fl d 18*48594Scael.Op Fl f 19*48594Scael.Op Fl l 20*48594Scael.Op Fl p Ar pointsize 21*48594Scael.Op Fl v 22*48594Scael.Op Fl T Ar title1 23*48594Scael.Ar file1 24*48594Scael.Bk -words 25*48594Scael.Op Fl T Ar title2 26*48594Scael.Ek 27*48594Scael.Ar file2 Ar ... 28*48594Scael.Sh DESCRIPTION 29*48594Scael.Nm Vlp 30*48594Scaelformats the named files so that they can be run through 31*48594Scael.Xr nroff 1 , 32*48594Scael.Xr vtroff 1 , 33*48594Scaelor 34*48594Scael.Xr troff 1 35*48594Scaelto produce listings that line-up and are attractive. 3619762SmckusickThe first non-blank character of each line is lined-up vertically, 3719762Smckusickas in the source file. 3819762SmckusickComments (text beginning with a semicolon) 3919762Smckusickare printed in italics. 4019762SmckusickEach function's name is printed in bold face next to the function. 4119762SmckusickThis format makes Lisp code look attractive when it is printed with a 4219762Smckusickvariable width font. 43*48594Scael.Pp 4419762SmckusickNormally, 45*48594Scael.Nm vlp 46*48594Scaelworks as a filter and sends its output to the standard output. 4719762SmckusickHowever, 4819762Smckusickthe 49*48594Scael.Fl v 5019762Smckusickswitch pipes the output directly to vtroff. 5119762SmckusickIf no files are specified, 52*48594Scaelthen 53*48594Scael.Nm vlp 54*48594Scaelreads from the standard input. 55*48594Scael.Pp 5619762SmckusickThe following options are available: 57*48594Scael.Bl -tag -width Ds 58*48594Scael.It Fl d 5919762SmckusickThe 60*48594Scael.Fl d 61*48594Scaelswitch puts 62*48594Scael.Nm vlp 63*48594Scaelinto debugging mode. 64*48594Scael.It Fl f 65*48594Scael.Nm Vlp 6619762Smckusickhas a filtered mode 6719762Smckusickin which all lines are passed unmodified, 68*48594Scaelexcept those lines between the directives 69*48594Scael.Sy .Ls 70*48594Scaeland 71*48594Scael.Sy .Le . 7219762SmckusickThis mode can be used to format Lisp code that is embedded in a document. 73*48594ScaelThe directive 74*48594Scael.Sy .Ls 75*48594Scaeltakes an optional argument that gives the point 7619762Smckusicksize for the embedded code. 7719762SmckusickIf not size is specified, 7819762Smckusickthe size of the surrounding text is used. 79*48594Scael.It Fl l 8019762SmckusickThe 81*48594Scael.Fl l 82*48594Scaelswitch prevents 83*48594Scael.Nm vlp 84*48594Scaelfrom placing labels next to functions. 8519762SmckusickThis switch is useful for embedded Lisp code, 8619762Smckusickwhere the labels would be distracting. 87*48594Scael.It Fl p Ar pointsize 88*48594ScaelThe 89*48594Scael.Fl p 90*48594Scaelswitch changes the size of the text from its default value of 8 points 91*48594Scaelto one of 6, 8, 10, or 12 points. 92*48594ScaelOnce set, the point size is used for all subsequent files. 93*48594ScaelThis point size does not apply to embedded text (see 94*48594Scael.Fl f 95*48594Scaelabove). 96*48594Scael.It Fl v 97*48594ScaelThis switch cause 98*48594Scael.Nm vlp 99*48594Scaelto send its output to vtroff rather than the 10019762Smckusickstandard output. 101*48594Scael.It Fl T Ar title 10219762SmckusickA title to be printed on each page may be specified by using the 103*48594Scael.Fl T 10419762Smckusickswitch. 10519762SmckusickThe 106*48594Scael.Fl T 107*48594Scaelswitch applies only to the next 108*48594Scael.Ar file 109*48594Scaelname given. 11019762SmckusickTitles are not printed for embedded text (see 111*48594Scael.Fl f , 11219762Smckusickabove). 113*48594ScaelThis switch may not be used if 114*48594Scael.Nm vlp 115*48594Scaelis reading from the standard input. 116*48594Scael.El 117*48594Scael.Sh FILES 118*48594Scael.Bl -tag -width Pa 119*48594Scael.It Pa /usr/lib/vlpmacs 120*48594Scael.Xr troff/nroff 121*48594Scaelmacros 122*48594Scael.El 123*48594Scael.Sh SEE ALSO 124*48594Scael.Xr vgrind 1 , 125*48594Scael.Xr lisp 1 126*48594Scael.Sh BUGS 127*48594Scael.Nm vlp 128*48594Scaeltransforms 129*48594Scael.Ql \e 130*48594Scaelinto 131*48594Scael.Ql \e\e 132*48594Scaelso that it will be printed out. 133*48594ScaelHence, 134*48594Scael.Xr troff 135*48594Scaelcommands cannot be embedded in Lisp code. 136*48594Scael.Sh HISTORY 137*48594ScaelThe 138*48594Scael.Nm 139*48594Scaelcommand appeared in 140*48594Scael.Bx 4.2 . 141