aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/prg2lout.1135
-rw-r--r--man/prg2lout.txt96
2 files changed, 231 insertions, 0 deletions
diff --git a/man/prg2lout.1 b/man/prg2lout.1
new file mode 100644
index 0000000..7014e46
--- /dev/null
+++ b/man/prg2lout.1
@@ -0,0 +1,135 @@
+.TH PRG2LOUT 1
+.SH NAME
+prg2lout - convert computer program text into Lout
+.SH SYNOPSIS
+\fBprg2lout\fR -l \fIlanguage\fR [ \fIoptions\fR ] \fIfiles\fR...
+.SH DESCRIPTION
+Reformat computer program text for input to the Lout document formatting
+system, taking care of comments, character strings, tab characters, etc.
+.LP
+.B prg2lout
+reads the named program source files and produces output
+suitable for input to
+.BR "lout -s" .
+Thus,
+.LP
+.RS
+.B "prg2lout -l C foo.c | lout -s | lpr"
+.RE
+.LP
+will print the C program
+.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 \-llanguage
+(Compulsory.) Files are written in this programmming language. Run
+\fIprg2lout -u\fR to see the list of languages available.
+.TP
+.B \-pfixed
+Use a fixed width font (the default for C).
+.TP
+.B \-pvarying
+Use a varying-width italic font with non-italic bold keywords (the
+default for Eiffel).
+.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 source 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 prg2lout
+simulates tabs with spaces. With this option,
+.B prg2lout
+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, including available languages, 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 prg2lout
+invoked by a
+.B -r
+flag (must be the first argument). This converts one program file into
+Lout-readable source without any heading or trailing information.
+Synopsis:
+.LP
+.RS
+.B prg2lout
+.B \-r
+.BI \-i \ infile
+.BI \-o \ out
+.BI \-e \ err
+.BI \-t \ num
+.BI \-T \ width
+.RE
+.LP
+Users should never need this mode; it is invoked automatically
+from within Lout by symbols supplied with the standard configuration
+(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/prg2lout.txt b/man/prg2lout.txt
new file mode 100644
index 0000000..991315d
--- /dev/null
+++ b/man/prg2lout.txt
@@ -0,0 +1,96 @@
+
+
+NAME
+ prg2lout - convert computer program text into Lout
+
+SYNOPSIS
+ prg2lout -l language [ options ] files...
+
+DESCRIPTION
+ Reformat computer program text for input to the Lout docu-
+ ment formatting system, taking care of comments, character
+ strings, tab characters, etc.
+
+ prg2lout reads the named program source files and produces
+ output suitable for input to lout -s. Thus,
+
+ prg2lout -l C foo.c | lout -s | lpr
+
+ will print the C program foo.c on a PostScript printer.
+ Each file will start on a new page, preceded by its name in
+ bold.
+
+OPTIONS
+ -llanguage
+ (Compulsory.) Files are written in this programmming
+ language. Run prg2lout -u to see the list of languages
+ available.
+
+ -pfixed
+ Use a fixed width font (the default for C).
+
+ -pvarying
+ Use a varying-width italic font with non-italic bold
+ keywords (the default for Eiffel).
+
+ -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 source 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, prg2lout simulates tabs with
+ spaces. With this option, prg2lout simulates tabs with
+ Lout tabulation operators; width is the width of one
+ tab interval in the final print, measured in Lout
+ units. This guarantees alignment of characters follow-
+ ing tabs even with varying-width fonts, provided width
+ is sufficiently large. For example, -T0.5i produces
+ half-inch tab intervals.
+
+ -u Print usage information on stderr, including available
+ languages, and exit.
+
+ -V Print version information on stderr and exit.
+
+ Raw Mode
+ There is a raw mode usage of prg2lout invoked by a -r flag
+ (must be the first argument). This converts one program
+ file into Lout-readable source without any heading or trail-
+ ing information. Synopsis:
+
+ prg2lout -r -i infile -o out -e err -t num -T width
+
+ Users should never need this mode; it is invoked automati-
+ cally from within Lout by symbols supplied with the standard
+ configuration (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