aboutsummaryrefslogtreecommitdiffstats
path: root/man/c2lout.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/c2lout.1')
-rw-r--r--man/c2lout.1133
1 files changed, 133 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