Return to vlp.1 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / pgrm / lisp / vlp

Annotation of 43BSDReno/pgrm/lisp/vlp/vlp.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted
                      5: .\" provided that the above copyright notice and this paragraph are
                      6: .\" duplicated in all such forms and that any documentation,
                      7: .\" advertising materials, and other materials related to such
                      8: .\" distribution and use acknowledge that the software was developed
                      9: .\" by the University of California, Berkeley.  The name of the
                     10: .\" University may not be used to endorse or promote products derived
                     11: .\" from this software without specific prior written permission.
                     12: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
                     13: .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
                     14: .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     15: .\"
                     16: .\"    @(#)vlp.1       6.2 (Berkeley) 5/5/89
                     17: .\"
                     18: .TH VLP 1 "May 5, 1989"
                     19: .UC 5
                     20: .SH NAME
                     21: vlp \- Format Lisp programs to be printed with nroff, vtroff, or troff
                     22: .SH SYNOPSIS
                     23: .B vlp
                     24: [
                     25: .B \-p
                     26: .I pointsize
                     27: ] [
                     28: .B \-d
                     29: ] [
                     30: .B \-f
                     31: ] [
                     32: .B \-l
                     33: ] [
                     34: .B \-v
                     35: ] [
                     36: .B \-T
                     37: .I title1
                     38: ] file1 [
                     39: .B \-T
                     40: .I title2
                     41: ] file2 ...
                     42: .SH DESCRIPTION
                     43: \fIVlp\fR
                     44: formats the named files so that they can be run through nroff, vtroff, or
                     45: troff to produce listings that line-up and are attractive.
                     46: The first non-blank character of each line is lined-up vertically,
                     47: as in the source file.
                     48: Comments (text beginning with a semicolon)
                     49: are printed in italics.
                     50: Each function's name is printed in bold face next to the function.
                     51: This format makes Lisp code look attractive when it is printed with a 
                     52: variable width font.
                     53: .PP
                     54: Normally,
                     55: \fIvlp\fR works as a filter and sends its output to the standard output.
                     56: However,
                     57: the 
                     58: .B \-v
                     59: switch pipes the output directly to vtroff.
                     60: If no files are specified,
                     61: then \fIvlp\fR reads from the standard input.
                     62: .PP
                     63: The following options are available:
                     64: .TP
                     65: .B \-p
                     66: The
                     67: .B \-p
                     68: switch changes the size of the text from its default value of 8 points
                     69: to one of 6, 8, 10, or 12 points.
                     70: Once set, the point size is used for all subsequent files.
                     71: This point size does not apply to embedded text (see \fI\-f\fR below).
                     72: .TP
                     73: .B \-d
                     74: The 
                     75: .B \-d
                     76: switch puts \fIvlp\fR into debugging mode.
                     77: .TP
                     78: .B \-f
                     79: .I Vlp
                     80: has a filtered mode
                     81: in which all lines are passed unmodified,
                     82: except those lines between the directives \fB.Ls\fR and \fB.Le\fR.
                     83: This mode can be used to format Lisp code that is embedded in a document.
                     84: The directive \fB.Ls\fR takes an optional argument that gives the point
                     85: size for the embedded code.
                     86: If not size is specified,
                     87: the size of the surrounding text is used.
                     88: .TP
                     89: .B \-l
                     90: The
                     91: .B \-l
                     92: switch prevents \fIvlp\fR from placing labels next to functions.
                     93: This switch is useful for embedded Lisp code,
                     94: where the labels would be distracting.
                     95: .TP
                     96: .B \-v
                     97: This switch cause \fIvlp\fR to send its output to vtroff rather than the
                     98: standard output.
                     99: .TP
                    100: .B \-T
                    101: A title to be printed on each page may be specified by using the 
                    102: .B \-T
                    103: switch.
                    104: The 
                    105: .B \-T
                    106: switch applies only to the next file name given.
                    107: Titles are not printed for embedded text (see 
                    108: .BR \-f ,
                    109: above).
                    110: This switch may not be used if \fIvlp\fR is reading from the standard input.
                    111: .SH FILES
                    112: /usr/lib/vlpmacs               troff/nroff macros
                    113: .SH AUTHOR
                    114: Originally written by John K. Foderaro, with additional changes by
                    115: Kevin Layer and James Larus.
                    116: .SH SEE ALSO
                    117: vgrind(1), lisp(1)
                    118: .SH BUGS
                    119: \fIvlp\fR transforms \\ into \\\\ so that it will be printed out.
                    120: 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.