From 169e6b9564cf7f0ab4cfbc37da06077329dd9b27 Mon Sep 17 00:00:00 2001 From: Larry Kollar Date: Wed, 28 Jan 2015 10:00:20 +0330 Subject: [PATCH] man: manual pages for neat* --- man/neateqn.1 | 34 +++++++++++++++++++ man/neatmkfn.1 | 77 ++++++++++++++++++++++++++++++++++++++++++ man/neatpost.1 | 62 ++++++++++++++++++++++++++++++++++ man/neatrefer.1 | 54 ++++++++++++++++++++++++++++++ man/neatroff.1 | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 328 insertions(+) create mode 100644 man/neateqn.1 create mode 100644 man/neatmkfn.1 create mode 100644 man/neatpost.1 create mode 100644 man/neatrefer.1 create mode 100644 man/neatroff.1 diff --git a/man/neateqn.1 b/man/neateqn.1 new file mode 100644 index 0000000..905f56f --- /dev/null +++ b/man/neateqn.1 @@ -0,0 +1,34 @@ +.\" first draft by Larry Kollar +.TH neateqn 1 +.SH NAME +neateqn \- the neatroff equation preprocessor +.SH SYNOPSIS +.I neateqn +.RI [< input ] +.RI [> output ] +.SH DESCRIPTION +.I Neateqn +is a preprocessor for +.IR neatroff . +It processes blocks of equation markup between +.B \&.EQ +and +.B \&.EN +commands, replacing the equation commands +with low-level typesetting markup +that is typically piped to +.I neatroff +or another preprocessor. +.LP +The primary difference between +.I neateqn +and standard +.I eqn +is that +.I neateqn +recognizes UTF-8 encoding. +.SH "SEE ALSO" +.IR neatroff (1) +.IP http://litcave.rudi.ir/neateqn.pdf +Explains how to define custom brackets and specify character types in +.IR neateqn . diff --git a/man/neatmkfn.1 b/man/neatmkfn.1 new file mode 100644 index 0000000..e6f7a20 --- /dev/null +++ b/man/neatmkfn.1 @@ -0,0 +1,77 @@ +.\" first draft by Larry Kollar +.TH neatmkfn 1 +.SH NAME +neatmkfn \- the neatroff typesetting processor +.SH SYNOPSIS +.I neatmkfn +.RB [ \-a ] +.RB [ \-o ] +.RB [ \-s ] +.RB [ \-p \~\c +.IR name ] +.RB [ \-t \~\c +.IR name ] +.RB [ \-r \~\c +.IR res ] +.RB [ \-k \~\c +.IR kmin ] +.RB [ \-b ] +.RB [ \-S \~\c +.IR scrs ] +.RB [ \-L \~\c +.IR langs ] +.RB [ \-w ] +.RI < file +.RI > output +.SH DESCRIPTION +.I Neatmkfn +extracts information +from TrueType/OpenType fonts +or AFM files +and outputs font descriptions +suitable for use with +.IR neatroff . +.SH OPTIONS +The following options are available: +.IP \-a 10 +Reads an AFM file (default). +.IP "\-o" +Reads a TrueType or OpenType file. +.IP "\-s" +Designates this as a special font. +.IP "\-p \fIname\fP" +Use +.I name +in place of the PostScript font name. +.IP "\-t \fIname\fP" +Sets the +.I troff +font name. +.IP "\-r \fIres\fP" +Sets the device resolution. +The default is 720 (i.e. 1/720 inch). +.IP "\-k \fIkmin\fP" +Sets the minimum amount of kerning. +The default is 0. +.IP "\-b" +Include glyph bounding boxes in the output. +.IP "\-S \fIscrs\fP" +A comma-separated list of scripts to include. +Use +.RB \[dq] "-S\~help" \[dq] +to list the available scripts in the font. +.IP "\-L \fIlangs\fP" +A comma-separated list of languages to include. +Use +.RB \[dq] "-L\~help" \[dq] +to list the available languages in the font. +.IP "\-w" +Warn about unsupported font features. +.SH FILES +.IP "/usr/share/neatroff/font/devutf/*" 4 +Font description files for +.I utf +output device. +.SH "SEE ALSO" +.IR neatroff (1), +.IR neatpost (1) diff --git a/man/neatpost.1 b/man/neatpost.1 new file mode 100644 index 0000000..cba12d1 --- /dev/null +++ b/man/neatpost.1 @@ -0,0 +1,62 @@ +.\" first draft by Larry Kollar +.TH neatpost 1 +.SH NAME +neatpost \- the neatroff PostScript post-processor +.SH SYNOPSIS +.I neatpost +.RB [ \-F \~\c +.IR dir ] +.RB [ \-p \~\c +.IR size ] +.RB [ \-w \~\c +.IR wid ] +.RI [< input ] +.RI [> output ] +.SH DESCRIPTION +.I Neatpost +translates the device-independent output from +.IR neatroff , +usually read on the standard input from a pipe, +into PostScript. +.SH OPTIONS +The following options are available: +.IP "\-F \fIdir\fP" 9 +Sets the font directory. +The default is typically +/usr/share/neatroff/font. +.IP "\-p \fIsize\fP" +Sets the paper size. +The +.I size +can be one of the following: +.RS +.IP \[bu] 3 +Any standard metric paper size like +.BR a4 . +.IP \[bu] +One of the standard US paper sizes: +.BR letter , +.BR legal , +.BR ledger , +or +.BR tabloid . +.IP \[bu] +A custom paper size, specified as +.IR width x height , +in units of 0.1mm (1/254 inch). +For example, +.B 2100x2970 +is equivalent to\~\c +.BR a4 . +.RE +.IP "\-w \fIwid\fP" +Sets the line thickness for drawing primitives, +in thousands of an em. +The default is 40. +.SH FILES +.IP "/usr/share/neatroff/font/*" +.I Neatroff +output device directories. +.SH "SEE ALSO" +.IR neatroff (1), +.IR neatmkfn (1) diff --git a/man/neatrefer.1 b/man/neatrefer.1 new file mode 100644 index 0000000..2144cd3 --- /dev/null +++ b/man/neatrefer.1 @@ -0,0 +1,54 @@ +.\" first draft by Larry Kollar +.TH neatrefer 1 +.SH NAME +neatrefer \- the neatroff reference pre-processor +.SH SYNOPSIS +.I neatrefer +.RB [ \-p \~\c +.IR bib ] +.RB [ \-e ] +.RB [ \-m ] +.RI [< input ] +.RI [> output ] +.SH DESCRIPTION +.I Neatrefer +is a preprocessor for +.IR neatroff . +It processes reference markup between +.B \&.[ +and +.B \&.] +commands, replacing the commands +with reference information from a database of references. +The output is formatted as footnotes or endnotes. +.SS "Extensions and Limitations" +.I Neatrefer +assumes that each database entry +has an +.B L +key, which specifies the label of a record. +.LP +.I Neatrefer +supports multiple references in a single +.BR \&.[ / \&.] +command when using the +.B -m +option. +Separate multiple labels by whitespace. +.SH OPTIONS +The following options are available: +.IP "\-p \fIbib\fP" 8 +The file name of the reference database. +.IP "\-e" +Accumulate references. +.IP "\-m" +Allow multiple references in a single +.BR \&.[ / \&.] +command. +Separate labels with whitespace. +.SH "SEE ALSO" +.IR neatroff (1) +.IP http://man.cat-v.org/unix_8th/1/refer 4 +The original +.I refer +manpage. diff --git a/man/neatroff.1 b/man/neatroff.1 new file mode 100644 index 0000000..508cba2 --- /dev/null +++ b/man/neatroff.1 @@ -0,0 +1,101 @@ +.\" first draft by Larry Kollar +.TH neatroff 1 +.SH NAME +neatroff \- the neatroff typesetting processor +.SH SYNOPSIS +.I neatroff +.RB [ \-m\c +.IR x ] +.RB [ \-C ] +.RB [ \-T\c +.IR dev ] +.RB [ \-F\c +.IR dir ] +.RB [ \-M\c +.IR dir ] +.RI [ files \&...] +.SH DESCRIPTION +.I Neatroff +is an extended version of AT&T +.IR ditroff , +supporting TrueType/OpenType fonts +and whole-paragraph formatting. +.I Neatroff +requires the user to construct the pipeline +to format a document. +For example: +.EX +.sp +cat mydoc.t | neateqn | neatroff -ms -Tutf | neatpost | ps2pdf - mydoc.pdf +.EE +.SS Extensions +The following are the most important +.I neatroff +extensions: +.IP \[bu] 3 +Like GNU +.IR troff , +.I neatroff +supports names of arbitrary length for +requests, macro names, number registers, and string variables. +.IP \[bu] +.I Neatroff +supports UTF-8 input +without the need for a preprocessor. +.IP \[bu] +The ``dir'' branch of +.I neatroff +supports right-to-left typesetting +for languages requiring it. +.IP \[bu] +To enable whole-paragraph formatting, add +.B p +in front of the adjustment specification; for example, +.B "ad pb" +fully justifies paragraphs with advanced filling. +Finally, in the ``dir'' branch, +.B "ad k" +supports Kashideh justification. +.SH OPTIONS +The following options are available: +.IP "\-m \fIx\fP" 8 +Loads the +.I x +macro package. +.IP "\-C" +Enables compatibility mode +with AT&T +.IR troff . +.IP "\-T \fIdev\fP" +Sets the output device. +The default is +.B utf +for PostScript. +.IP "\-F \fIdir\fP" +Sets the font directory. +The default is typically +/usr/share/neatroff/font. +.IP "\-M \fIdir\fP" +Sets the macro directory. +The default is typically +/usr/share/neatroff/tmac. +.SH FILES +.IP "/usr/share/neatroff/tmac/tmac.x" 4 +The +.I x +macro package. +.IP "/usr/share/neatroff/font/*" +Output device directories. +.SH "SEE ALSO" +.IR neatpost (1), +.IR neateqn (1), +.IR neatrefer (1), +.IR neatmkfn (1) +.IP http://litcave.rudi.ir/neatstart.pdf 4 +Explains how to compile and install +.IR neatroff , +and add new fonts. +.IP http://litcave.rudi.ir/neatroff.pdf +Describes the primary differences between +.I neatroff +and other troff-like typesetting systems. -- 2.11.4.GIT