diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/c2lout.1 | 133 | ||||
| -rw-r--r-- | man/c2lout.txt | 95 | ||||
| -rw-r--r-- | man/lout.1 | 270 | ||||
| -rw-r--r-- | man/lout.txt | 187 |
4 files changed, 685 insertions, 0 deletions
diff --git a/man/c2lout.1 b/man/c2lout.1 new file mode 100644 index 0000000..472e530 --- /dev/null +++ b/man/c2lout.1 @@ -0,0 +1,133 @@ +.TH C2LOUT 1 +.SH NAME +c2lout - convert C and C++ source code into Lout +.SH SYNOPSIS +\fBc2lout\fR [ \fIoptions\fR ] \fIC\(en\&files\fR... +.SH DESCRIPTION +Reformat C and C++ source code for input to the Lout document formatting +system, taking care of comments, character strings, tab characters, etc. +.LP +.B c2lout +reads the named C and C++ files and produces output +suitable for input to +.BR "lout -s" . +Thus, +.LP +.RS +.B "c2lout foo.c | lout -s | lpr" +.RE +.LP +will print +.B foo.c +on a PostScript printer. Each file will start on a new page, preceded +by its name in bold. +.SH OPTIONS +.TP +.B \-pfixed +Use a fixed width font (the default). +.TP +.B \-pvarying +Use a varying-width italic font with non-italic bold keywords. +.TP +.B \-psymbol +Use a varying-width italic font with mathematical symbols and +non-italic bold keywords. +.TP +.B \-n +Do not print the file name before each C or C++ file. +.TP +.BI \-f " font" +Select a font family. +The default is +.B \-fCourier +for +.BR \-pfixed , +and +.B \-fTimes +for +.B \-pvarying +and +.BR \-psymbol . +.TP +.BI \-s " size" +Select a Lout font size. The default is +.B -s9p +(meaning 9 points) for +.BR \-pfixed , +and +.B \-s10p +for +.B \-pvarying +and +.BR \-psymbol . +These work well with 80-character-wide programs. +.TP +.BI \-v " vsize" +Select a Lout vertical inter-line gap. The default is +.B -v1.1fx +meaning 1.1 times the font size measured from baseline to baseline. +.TP +.BI \-t " num" +Set the tab interval to +.I num +characters (default is +.BR \-t8 ). +.TP +.BI \-T " width" +Without this option, +.B c2lout +simulates tabs with spaces. With this option, +.B c2lout +simulates tabs with Lout tabulation operators; +.I width +is the width of one tab interval in the final print, measured in Lout +units. This guarantees alignment of characters following tabs even +with varying-width fonts, provided +.I width +is sufficiently large. For example, +.B -T0.5i +produces half-inch tab intervals. +.TP +.B \-u +Print usage information on stderr and exit. +.TP +.B \-V +Print version information on stderr and exit. +.SS Raw Mode +There is a \(lq\&raw mode\(rq usage of +.B c2lout +invoked by a +.B -r +flag (must be the first argument). This converts one C file into +Lout-readable source without any heading or trailing information. +Synopsis: +.LP +.RS +.B c2lout +.B \-r +.BI \-i \ infile +.BI \-o \ outfile +.BI \-e \ errfile +.BI \-t \ num +.BI \-T \ width +.RE +.LP +Users should never need this mode; it is invoked automatically +from within Lout by the +.B @CP +symbol from the +.B cprint +package (see reference). +.SH SEE ALSO +.BR lout (1), +.BR lpr (1), +.BR ghostview (1). +.SH REFERENCES +.LP +Jeffrey H. Kingston, +.I +\(lq\&A User's Guide to the Lout Document Formatting System\(rq\c +\&, Chapter 11. +.SH AUTHOR +.LP +Jeffrey H. Kingston diff --git a/man/c2lout.txt b/man/c2lout.txt new file mode 100644 index 0000000..47349d6 --- /dev/null +++ b/man/c2lout.txt @@ -0,0 +1,95 @@ + + + +User Commands C2LOUT(1) + + + +NAME + c2lout - convert C and C++ source code into Lout + +SYNOPSIS + c2lout [ options ] Cfiles... + +DESCRIPTION + Reformat C and C++ source code for input to the Lout docu- + ment formatting system, taking care of comments, character + strings, tab characters, etc. + + c2lout reads the named C and C++ files and produces output + suitable for input to lout -s. Thus, + + c2lout foo.c | lout -s | lpr + + will print foo.c on a PostScript printer. Each file will + start on a new page, preceded by its name in bold. + +OPTIONS + -pfixed + Use a fixed width font (the default). + + -pvarying + Use a varying-width italic font with non-italic bold + keywords. + + -psymbol + Use a varying-width italic font with mathematical sym- + bols and non-italic bold keywords. + + -n Do not print the file name before each C or C++ file. + + -f font + Select a font family. The default is -fCourier for + -pfixed, and -fTimes for -pvarying and -psymbol. + + -s size + Select a Lout font size. The default is -s9p (meaning + 9 points) for -pfixed, and -s10p for -pvarying and + -psymbol. These work well with 80-character-wide pro- + grams. + + -v vsize + Select a Lout vertical inter-line gap. The default is + -v1.1fx meaning 1.1 times the font size measured from + baseline to baseline. + + -t num + Set the tab interval to num characters (default is + -t8). + + -T width + Without this option, c2lout simulates tabs with spaces. + With this option, c2lout simulates tabs with Lout tabu- + lation operators; width is the width of one tab inter- + val in the final print, measured in Lout units. This + guarantees alignment of characters following tabs even + with varying-width fonts, provided width is suffi- + ciently large. For example, -T0.5i produces half-inch + tab intervals. + + -u Print usage information on stderr and exit. + + -V Print version information on stderr and exit. + + Raw Mode + There is a raw mode usage of c2lout invoked by a -r flag + (must be the first argument). This converts one C file into + Lout-readable source without any heading or trailing infor- + mation. Synopsis: + + c2lout -r -i infile -o outfile -e errfile -t num + -T width + + Users should never need this mode; it is invoked automati- + cally from within Lout by the @CP symbol from the cprint + package (see reference). + +SEE ALSO + lout(1), lpr(1), ghostview(1). + +REFERENCES + Jeffrey H. Kingston, A User's Guide to the Lout Document + Formatting System, Chapter 11. + +AUTHOR + Jeffrey H. Kingston diff --git a/man/lout.1 b/man/lout.1 new file mode 100644 index 0000000..5b9b6bc --- /dev/null +++ b/man/lout.1 @@ -0,0 +1,270 @@ +.\" Use default p.i., so commented out here and in .TP +.\" .nr oi 16 \" Prevailing indentation for options' .TP request +.\" .de Sp +.\" .if n .sp +.\" .if t .sp 0.4 +.\" .. +.TH LOUT 1 +.SH NAME +lout - prepare Lout document for printing +.SH SYNOPSIS +\fBlout\fR [ \fIoption\fR ] \fIfile\fR... +.SH DESCRIPTION +Invoke the Basser Lout interpreter on the concatenation of the named +files, producing a PostScript file on standard output suitable for +printing on PostScript printers using +.IR lpr (1). +If no files are named, stdin is used instead. The special file name +.RB ` \|\-\| ' +may be used to denote standard input. There white space between flags +and their associated option values is optional. +.LP +An optional +.B .lt +suffix may be used for Lout source and include files. When invoking +files ending in this suffix the suffix may be omitted. +.SH OPTIONS +.SS Output +.TP \" \n(oi +.BI \-o " filename" +Direct output to +.I filename +instead of to stdout. +.TP +.BI \-e " filename" +Direct error messages to +.I filename +instead of to stderr. +.TP +.B \-a +Use "\c +.IR filename :\c +.IR linenum :\c +.IR colnum :\c +.I message\c +\&" alternative error message format useful with Emacs compilation +mode and other tools. +.SS Output format +.TP \" \n(oi +.B \-EPS +Produce output in the form of an EPS (Encapsulated PostScript) file, +suitable for inclusion in another document. Useful with stand-alone +illustrations. +.TP +.B \-p +Produce plain text output instead of PostScript. +.TP +.B \-P +Like +.BR \-p , +but with a form-feed character between pages. +.TP +.B \-Z +Produce Adobe Portable Document Format (PDF) output. This includes +links, but the more advanced graphics packages of Lout are not supported. +.TP +.B \-PDF +Synonym for +.BR \-Z . +.SS Cross-reference database +.TP \" \n(oi +.B \-s +Suppress all reading and writing of the cross reference database; +other databases are not affected. Useful when many simple documents +that don't do any cross referencing are stored in one directory. +.TP +.B \-l +Use ASCII order when sorting index entries etc.; the default depends on +the COLLATE compilation option (use +.B \-V +option to find out your default value). +.TP +.B \-L +Use your locale's order when sorting index entries etc.; the default +depends on the COLLATE compilation option (use +.B \-V +option to find out your default value). +.SS Execution of filters +.TP \" \n(oi +.B \-S +Safe execution: disable all calls to +.IR system (3), +instead echoing the commands that would have been executed. Although +this makes the Lout run certainly safe, the PostScript output file may +not be. +.TP +.B \-U +Unsafe execution: allow calls to +.IR system (3). +This is usually the default behavior, but it is possible to make safe +execution the default during installation (use +.B \-V +option to find out whether this was done or not), hence the need for +this flag. +.SS Changing document setup options +.TP \" \n(oi +.BI \-\- option { value } +Set setup file +.I option +to +.IR value , +overriding any value assigned to +.I option +in the setup file. For example, +.B \-\-@PageType{Letter} +will set the +.B @PageType +setup file option to +.BR Letter . +The value may be a sequence of words but not an arbitrary Lout object. +If there are spaces you must ensure that it is passed to Lout as a +single option; the usual way to do this is to enclose it in quotes. +.SS Searching for files +.TP \" \n(oi +.BI \-i " filename" +Search the directories of the include file path (see below) for +.I filename +or +.IR filename .lt +and include it. There may be multiple +.B \-i +options. +.TP +.BI \-I " dirname" +Add +.I dirname +to the list of directories searched for +.B @Include +files and +.B \-i +option files. +There may be multiple +.B \-I +options. +.B @Include +first searches the current directory, then searches the +.B \-I +directories in the order given, and finally searches the default +include file directory (see below). +.B @SysInclude +and the +.B \-i +option omit the search of the current directory. +.TP +.BI \-C " dirname" +Add +.I dirname +to the list of directories searched for Lout character mapping (\c +.BR .LCM ) +files. +There may be multiple +.B \-C +options; the directories are searched in the order given, and finally +the default character mappings directory is searched (see below). +.TP +.BI -F " dirname" +Add +.I dirname +to the list of directories searched for font metrics (formerly +.BR .AFM ) +files. There may be multiple +.B \-F +options; the directories are searched in the order given, and finally +the default font metrics directory is searched (see below). +.TP +.BI \-H " dirname" +Add +.I dirname +to the list of directories searched for hyphenation patterns files, +both unpacked +.RB ( .lh ) +and packed +.RB ( .lp ). +There may be multiple +.B \-H +options; the directories are searched in the order given, and finally +the default hyphenation directory is searched (see below). +.TP +.BI -D " dirname" +Add +.I dirname +to the list of directories searched for Lout database files. There +may be multiple +.B \-D +options. +.B @Database +searches the current directory, then the +.B \-D +directories in the order given, and finally searches the default +databases directory (see below). +.B @SysDatabase +omits the search of the current directory. +.SS Miscellaneous options +.TP \" \n(oi +.B \-x +Initializing run, not for ordinary use: read and check all font files +mentioned in font definitions, read and check all hyphenation files +mentioned in language definitions and build compressed versions, read +and check all database files mentioned in database clauses and build +index files. +.TP +.B \-u +Print usage information on stderr and exit. +.TP +.B \-V +Print version information on stderr and exit. +.TP +.B \-M +Use less memory and run more slowly (the cross reference database index +will be kept in a file rather than in memory). +.TP +.B \-w +Show the total number of non-empty words printed in the output file. +This includes words and numbers in page headers and footers; section +numbers and other numbers; every punctuation character in a font +different from its adjacent word; and every little fragment of every +equation; so it will always somewhat overestimate the true number. +.SH FILES AND ENVIRONMENT VARIABLE +.LP +.\" NB: be careful with tabs in the table below +.nf +.ta \w'Default character mappings dir.: 'u +\&Default include file directory: \fILOUTLIB\fP/include +\&Default databases directory: \fILOUTLIB\fP/data +\&Default font metrics directory: \fILOUTLIB\fP/font +\&Default hyphenation directory: \fILOUTLIB\fP/hyph +\&Default character mappings dir.: \fILOUTLIB\fP/maps +\&Default locales directory: \fILOUTLIB\fP/locale +.fi +.LP +The default library directory, usually +.BR /usr/local/lib/lout , +can be changed by setting environment variable +.SB LOUTLIB +to an alternative directory name. +.SH SEE ALSO +.LP +.BR c2lout (1), +.BR lpr (1), +.BR ghostview (1) +.SH MAILING LIST +.LP +A public mailing list for discussion of Lout exists. To subscribe, +mail +.B lout\-request@ptc.spbu.ru +with the word +.B subscribe +in the Subject line. To post an item, mail it to +.BR lout@ptc.spbu.ru . +.SH REFERENCES +.LP +Jeffrey H. Kingston, +.I +\(lq\&A User's Guide to the Lout Document Formatting System\(rq\c +\&, and +.I +\(lq\&An Expert's Guide to the Lout Document Formatting System\(rq\c +\&. +.SH AUTHOR +.LP +Jeffrey H. Kingston diff --git a/man/lout.txt b/man/lout.txt new file mode 100644 index 0000000..9638390 --- /dev/null +++ b/man/lout.txt @@ -0,0 +1,187 @@ + + + +User Commands LOUT(1) + + + +NAME + lout - prepare Lout document for printing + +SYNOPSIS + lout [ option ] file... + +DESCRIPTION + Invoke the Basser Lout interpreter on the concatenation of + the named files, producing a PostScript file on standard + output suitable for printing on PostScript printers using + lpr(1). If no files are named, stdin is used instead. The + special file name `-' may be used to denote standard input. + There white space between flags and their associated option + values is optional. + + An optional .lt suffix may be used for Lout source and + include files. When invoking files ending in this suffix + the suffix may be omitted. + +OPTIONS + Output + -o filename + Direct output to filename instead of to stdout. + + -e filename + Direct error messages to filename instead of to stderr. + + -a Use "filename:linenum:colnum:message" alternative error + message format useful with Emacs compilation mode and + other tools. + + Output format + -EPS Produce output in the form of an EPS (Encapsulated + PostScript) file, suitable for inclusion in another + document. Useful with stand-alone illustrations. + + -p Produce plain text output instead of PostScript. + + -P Like -p, but with a form-feed character between pages. + + -Z Produce Adobe Portable Document Format (PDF) output. + This includes links, but the more advanced graphics + packages of Lout are not supported. + + -PDF Synonym for -Z. + + Cross-reference database + -s Suppress all reading and writing of the cross reference + database; other databases are not affected. Useful + when many simple documents that don't do any cross + referencing are stored in one directory. + + -l Use ASCII order when sorting index entries etc.; the + default depends on the COLLATE compilation option (use + -V option to find out your default value). + + -L Use your locale's order when sorting index entries + etc.; the default depends on the COLLATE compilation + option (use -V option to find out your default value). + + Execution of filters + -S Safe execution: disable all calls to system(3), instead + echoing the commands that would have been executed. + Although this makes the Lout run certainly safe, the + PostScript output file may not be. + + -U Unsafe execution: allow calls to system(3). This is + usually the default behavior, but it is possible to + make safe execution the default during installation + (use -V option to find out whether this was done or + not), hence the need for this flag. + + Changing document setup options + --option{value} + Set setup file option to value, overriding any value + assigned to option in the setup file. For example, + --@PageType{Letter} will set the @PageType setup file + option to Letter. The value may be a sequence of words + but not an arbitrary Lout object. If there are spaces + you must ensure that it is passed to Lout as a single + option; the usual way to do this is to enclose it in + quotes. + + Searching for files + -i filename + Search the directories of the include file path (see + below) for filename or filename.lt and include it. + There may be multiple -i options. + + -I dirname + Add dirname to the list of directories searched for + @Include files and -i option files. There may be mul- + tiple -I options. @Include first searches the current + directory, then searches the -I directories in the + order given, and finally searches the default include + file directory (see below). @SysInclude and the -i + option omit the search of the current directory. + + -C dirname + Add dirname to the list of directories searched for + Lout character mapping (.LCM) files. There may be mul- + tiple -C options; the directories are searched in the + order given, and finally the default character mappings + directory is searched (see below). + + -F dirname + Add dirname to the list of directories searched for + font metrics (formerly .AFM) files. There may be mul- + tiple -F options; the directories are searched in the + order given, and finally the default font metrics + directory is searched (see below). + + -H dirname + Add dirname to the list of directories searched for + hyphenation patterns files, both unpacked (.lh) and + packed (.lp). There may be multiple -H options; the + directories are searched in the order given, and + finally the default hyphenation directory is searched + (see below). + + -D dirname + Add dirname to the list of directories searched for + Lout database files. There may be multiple -D options. + @Database searches the current directory, then the -D + directories in the order given, and finally searches + the default databases directory (see below). @SysData- + base omits the search of the current directory. + + Miscellaneous options + -x Initializing run, not for ordinary use: read and check + all font files mentioned in font definitions, read and + check all hyphenation files mentioned in language + definitions and build compressed versions, read and + check all database files mentioned in database clauses + and build index files. + + -u Print usage information on stderr and exit. + + -V Print version information on stderr and exit. + + -M Use less memory and run more slowly (the cross refer- + ence database index will be kept in a file rather than + in memory). + + -w Show the total number of non-empty words printed in the + output file. This includes words and numbers in page + headers and footers; section numbers and other numbers; + every punctuation character in a font different from + its adjacent word; and every little fragment of every + equation; so it will always somewhat overestimate the + true number. + +FILES AND ENVIRONMENT VARIABLE + Default include file directory: LOUTLIB/include + Default databases directory: LOUTLIB/data + Default font metrics directory: LOUTLIB/font + Default hyphenation directory: LOUTLIB/hyph + Default character mappings dir.: LOUTLIB/maps + Default locales directory: LOUTLIB/locale + + The default library directory, usually /usr/local/lib/lout, + can be changed by setting environment variable LOUTLIB to an + alternative directory name. + +SEE ALSO + c2lout(1), lpr(1), ghostview(1) + +MAILING LIST + A public mailing list for discussion of Lout exists. To + subscribe, mail lout-request@ptc.spbu.ru with the word sub- + scribe in the Subject line. To post an item, mail it to + lout@ptc.spbu.ru. + +REFERENCES + Jeffrey H. Kingston, A User's Guide to the Lout Document + Formatting System, and An Expert's Guide to the Lout Docu- + ment Formatting System. + +AUTHOR + Jeffrey H. Kingston |