[bug-enscript] [PATCH] enscript.man: some remarks and fixes for the manual

[Bjarni Ingi Gislason]

Output from "mandoc  -T lint enscript.man"

mandoc: enscript.man:22:16: STYLE: normalizing date format to: TH March 12, 1999
mandoc: enscript.man:967:1: WARNING: skipping paragraph macro: sp after PP
mandoc: enscript.man:1094:2: WARNING: skipping paragraph macro: PP empty
mandoc: enscript.man:1104:1: WARNING: skipping paragraph macro: sp after PP
mandoc: enscript.man:1356:1: WARNING: skipping paragraph macro: sp after PP

#######

Increase type size of ~ (tilde) to make it more visible
in the output of "troff".

1415:Markku Rossi <mtr@iki.fi> <http://www.iki.fi/~mtr/>
1417:GNU Enscript WWW home page: <http://www.iki.fi/~mtr/genscript/>

#####

Add a (non-breaking, "\ " or "\~") space between a number and a unit, as these
are not one entity.

193:12pt.
211:"\f3Times\-Roman10.2\f1" selects a 10.2pt "Times\-Roman" font.
1351:font to be Times\-Roman 7pt, set the following value to the

#####

Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).

553:octal notation: `\\000', `\\001', `\\002', ... (default)

#####

Add a hair space (\^) around "|" to increase readability

126:\f3enscript \-\-header='$n|%W|Page $% of $=' *.c\f1

#####

Wrong distance between sentences.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("semantic newline") and "info groff".

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

196:have a corresponding AFM file. See section \f3USING NEW FONTS\f1 for
475:cookie from the beginning of the file. \f3Note!\f1 \f3Enscript\f1

#####

Add a zero (0) in front of a decimal fraction that begins with a period
(.)

628:default gray value is .8.

#####

point size: the typographical term is 'type size'.  There exist
several point sizes, like 'Didot point', 'big point' (PostScript point), 'pica
point' (printer's point, English, USA).

204:The font point size can also be given in the format

#####

Spelling errors:

scandinavian
valuee

  From "codespell":

enscript.man:1362: build-in ==> built-in

Signed-off-by: Bjarni Ingi Gislason <bjarniig@simnet.is>
---
 docs/enscript.man | 53 +++++++++++++++++++++++++----------------------
 1 file changed, 28 insertions(+), 25 deletions(-)

diff --git a/docs/enscript.man b/docs/enscript.man
index 705530f..7d513c9 100644
--- a/docs/enscript.man
+++ b/docs/enscript.man
@@ -123,7 +123,7 @@ file name, current date and page numbers:
 The header string can also contain left, center and right justified
 fields.  The fields are separated by the \f3'|'\f1 character:
 
-\f3enscript \-\-header='$n|%W|Page $% of $=' *.c\f1
+\f3enscript \-\-header='$n\^|\^%W\^|\^Page $% of $=' *.c\f1
 
 now the file name is printed left justified, the date is centered to
 the header and the page numbers are printed right justified.
@@ -190,25 +190,26 @@ selected, in which case the default font is 
\f3Courier7\f1.
 The font specification \f2name\f1 contains two parts: the name of the
 font and its size in PostScript points.  For example,
 "\f3Times\-Roman12\f1" selects the "Times\-Roman" font with size
-12pt.
+12\~pt.
 
 The name of the font must appear in @DATADIR@/enscript/font.map and
-have a corresponding AFM file. See section \f3USING NEW FONTS\f1 for
+have a corresponding AFM file.
+See section \f3USING NEW FONTS\f1 for
 information on adding a font beyond the defaults.
 
 The font specification \f2name\f1 can also be given in format
-`\f2name\f1@\f2ptsize\f1', where the name of the font and its point
+`\f2name\f1@\f2ptsize\f1', where the name of the font and its type
 size are separated by a `@' character.  This allows \f3enscript\f1 to use
 fonts which contain digit characters in their names.
 
-The font point size can also be given in the format
+The font type size can also be given in the format
 \f2width\f1/\f2height\f1 where the \f2width\f1 and the \f2height\f1
 specify the size of the font in x- and y-directions.  For example,
 "\f3Times\-Roman@10/12\f1" selects a 10 points wide and 12 points high
 "Times\-Roman" font.
 
 You can also give the font sizes as decimal numbers.  For example,
-"\f3Times\-Roman10.2\f1" selects a 10.2pt "Times\-Roman" font.
+"\f3Times\-Roman10.2\f1" selects a 10.2\~pt "Times\-Roman" font.
 .TP 8
 .B \-F \f2name\f3, \-\-header\-font=\f2name\f3
 Select a font for the header texts.
@@ -333,7 +334,7 @@ Print in the portrait mode (default).
 .B \-s \f2num\f3, \-\-baselineskip=\f2num\f3
 Specify the baseline skip in PostScript points.  The number \f2num\f1
 can be given as a decimal number.  When \f3enscript\f1 moves from line
-to line, the current point \f2y\f1 coordinate is moved (\f2font point
+to line, the current point \f2y\f1 coordinate is moved (\f2font type
 size + baselineskip\f1) points down.  The default baseline skip is 1.
 .TP 8
 .B \-S \f2key\f1[\f3:\f2value\f1]\f3, 
\-\-statusdict=\f2key\f1[\f3:\f2value\f1]\f3
@@ -437,10 +438,10 @@ ISO\-8859\-15 (ISO Latin9)
 7\-bit ascii
 .TP 8
 .B asciifise, asciifi, asciise
-7\-bit ascii with some scandinavian (Finland, Sweden) extensions
+7\-bit ascii with some Scandinavian (Finland, Sweden) extensions
 .TP 8
 .B asciidkno, asciidk, asciino
-7\-bit ascii with some scandinavian (Denmark, Norway) extensions
+7\-bit ascii with some Scandinavian (Denmark, Norway) extensions
 .TP 8
 .B ibmpc, pc, dos
 IBM PC charset
@@ -472,7 +473,8 @@ Pass through all PostScript and PCL files without any 
modifications.
 This allows that \f3enscript\f1 can be used as a lp filter.
 
 The PostScript files are recognized by looking up the `%!' magic
-cookie from the beginning of the file. \f3Note!\f1 \f3Enscript\f1
+cookie from the beginning of the file.
+\f3Note!\f1 \f3Enscript\f1
 recognized also the Windoze damaged `^D%!' cookie.
 
 The PCL files are recognized by looking up the `^[E' or `^[%' magic
@@ -550,7 +552,7 @@ values for the \f2format\f1 are:
 caret notation: `^@', `^A', `^B', ...
 .TP 8
 .B octal
-octal notation: `\\000', `\\001', `\\002', ... (default)
+octal notation: `\e000', `\e001', `\e002', ... (default)
 .TP 8
 .B questionmark
 replace non-printable characters with a question mark `?'
@@ -624,8 +626,8 @@ Select a font for the underlay text.  The default underlay 
font is
 \f3Times-Roman200\f1.
 .TP 8
 .B \-\-ul\-gray=\f2num\f3
-Print the underlay text with the gray value \f2num\f1 (0 ... 1), the
-default gray value is .8.
+Print the underlay text with the gray value \f2num\f1 (0 ... 1),
+the default gray value is 0.8.
 .TP 8
 .B \-\-ul\-position=\f2position_spec\f3
 Set the underlay text's starting position according to the
@@ -680,7 +682,7 @@ Specify if the Control-D (^D) character should be appended 
to the end
 of the output.  The default value is false (0).
 .TP 8
 .B Clean7Bit: \f2bool\f3
-Specify how characters greater than 127 are printed.  The valuee true
+Specify how characters greater than 127 are printed.  The value true
 (1) generates 7-bit clean code by escaping all characters greater than
 127 to the backslash-octal notation (default).  The value false (0)
 generates 8-bit PostScript code leaving all characters untouched.
@@ -794,10 +796,11 @@ same which can be given for the \f3\-\-ps\-level\f1 
option.
 Names the printer to which the output is spooled.
 .TP 8
 .B QueueParam: \f2name\f3
-The spooler command switch to select the printer queue, e.g. \f3\-P\f1
-in \f3lpr \-Pps\f1.  This option can also be used to pass other flags
-to the spooler command.  These options must be given before the queue
-switch.
+The spooler command switch to select the printer queue,
+e.g. \f3\-P\f1 in \f3lpr \-Pps\f1.
+This option can also be used to pass other flags
+to the spooler command.
+These options must be given before the queue switch.
 .TP 8
 .B SetPageDevice: \f2key\f1[\f3:\f2value\f1]\f3
 Pass a page device definition to the generated PostScript output.
@@ -964,7 +967,7 @@ file name without the directory part (bar.c)
 .B gs_languagelevel
 PostScript interpreter's language level (currently 1 or 2)
 .P
-
+.
 You can also use the following special comments to customize your
 headers and to specify some extra options.  Special comments are like
 DSC comments but they start with a single `%' character; special
@@ -1091,7 +1094,7 @@ which expands to:
 
 .B /eurdatestr (96/01/08) def
 .RE
-.P
+.
 .TP 8
 .B %HeaderHeight: \f2height\f1
 Allocate \f2height\f1 points space for the page header.  The default
@@ -1101,7 +1104,7 @@ header height is 36 points.
 Allocate \f2height\f1 points space for the page footer.  The default
 footer height is 0 points.
 .P
-
+.
 According to Adobe's Document Structuring Conventions (DSC), all
 resources needed by a document must be listed in document's prolog.
 Since user's can create their own headers, \f3enscript\f1 don't know
@@ -1348,12 +1351,12 @@ A nice HTML report of your project's C source files.
 
 The environment variable \f3ENSCRIPT\f1 can be used to pass default
 options for \f3enscript\f1.  For example, to select the default body
-font to be Times\-Roman 7pt, set the following value to the
+font to be Times\-Roman 7\~pt, set the following value to the
 \f3ENSCRIPT\f1 environment variable:
 .TP 8
 .B \-fTimes\-Roman7
 .P
-
+.
 The value of the \f3ENSCRIPT\f1 variable is processed before the
 command line options, so command line options can be used to overwrite
 these defaults.
@@ -1412,6 +1415,6 @@ To generate a new font map automatically, use 
\f3mkafmmap\f1.
 diffpp(1), ghostview(1), gs(1), lpq(1), lpr(1), lprm(1), states(1)
 
 .SH AUTHOR
-Markku Rossi <mtr@iki.fi> <http://www.iki.fi/~mtr/>
+Markku Rossi <mtr@iki.fi> <http://www.iki.fi/\s+3~\s-3mtr/>
 
-GNU Enscript WWW home page: <http://www.iki.fi/~mtr/genscript/>
+GNU Enscript WWW home page: <http://www.iki.fi/\s+3~\s-3mtr/genscript/>
-- 
2.39.2