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

[Bjarni Ingi Gislason]

Output from "mandoc  -T lint states.man":

mandoc: states.man:21:14: STYLE: normalizing date format to: TH October 23, 1998

mandoc: states.man:321:2: ERROR: skipping end of block that is not open: RE
mandoc: states.man:321:2: WARNING: skipping paragraph macro: br before sp
mandoc: states.man:352:2: ERROR: skipping end of block that is not open: RE
mandoc: states.man:352:2: WARNING: skipping paragraph macro: br before sp

#######

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

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

#####

Change - to \- if it shall be printed as a minus sign.

states.man:301:.B -1

#####

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

144:  /\\.(c|h)$/    c;
145:  /\\.[fF]$/     fortran;
150:  /-\\*- [cC] -\\*-/      c;
151:  /-\\*- fortran -\\*-/   fortran;

#####

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

144:  /\\.(c|h)$/    c;

#####

Test nr. 37:

Use \(en for a dash (en-dash) between space characters, not a minus
(\-) or a hyphen (-), except in the NAME section.

states.man:135:regular expression - symbol pairs, when the regular expression is

#####

Split a punctuation from a single argument, if a two-font macro is meant

325:.B $.

#####

Test nr. 59:

Name of a manual is set in bold, the section in roman.
See man-pages(7).

361:awk(1), enscript(1)

#####

  Spelling mistakes:

Concanate
comparision
intput
rexpression

Signed-off-by: Bjarni Ingi Gislason <bjarniig@simnet.is>
---
 docs/states.man | 39 +++++++++++++++++++--------------------
 1 file changed, 19 insertions(+), 20 deletions(-)

diff --git a/docs/states.man b/docs/states.man
index f01079c..b425a8a 100644
--- a/docs/states.man
+++ b/docs/states.man
@@ -132,7 +132,7 @@ from the initial state.
 
 The initial state is resolved by the information found from the
 \f2startrules\f1 and \f2namerules\f1 blocks.  Both blocks contain
-regular expression - symbol pairs, when the regular expression is
+regular expression \(en symbol pairs, when the regular expression is
 matched from the name of from the beginning of the input file, the
 initial state is named by the corresponding symbol.  For example, the
 following start and name rules can distinguish C and Fortran files:
@@ -141,14 +141,14 @@ following start and name rules can distinguish C and 
Fortran files:
 .nf
 namerules
 {
-  /\\.(c|h)$/    c;
-  /\\.[fF]$/     fortran;
+  /\e.(c\^|\^h)$/    c;
+  /\e.[fF]$/     fortran;
 }
 
 startrules
 {
-  /-\\*- [cC] -\\*-/      c;
-  /-\\*- fortran -\\*-/   fortran;
+  /-\e*- [cC] -\e*-/      c;
+  /-\e*- fortran -\e*-/   fortran;
 }
 .fi
 .RE
@@ -178,7 +178,7 @@ symbol and \f2statements\f1 is a list of statements.  When 
the
 expression \f2expr\f1 is matched from the input, the statement block
 is executed.  The statement block can call \f3states\f1' primitives,
 user-defined subroutines, call other states, etc.  Once the block is
-executed, the input processing is continued from the current intput
+executed, the input processing is continued from the current input
 position (which might have been changed if the statement block called
 other states).
 
@@ -218,7 +218,7 @@ Try to resolve start state from \f3startrules\f1 rules.  
Function
 returns \f31\f1 if start state was resolved or \f30\f1 otherwise.
 .TP 8
 .B concat (\f2str\f3, ...)
-Concanate argument strings and return result as a new string.
+Concatenate argument strings and return result as a new string.
 .TP 8
 .B float (\f2any\f3)
 Convert argument to a floating point number.
@@ -287,18 +287,18 @@ fails, the program will terminate with an error message.
 .TP 8
 .B split (\f2regexp\f3, \f2string\f3)
 Split string \f2string\f1 to list considering matches of regular
-rexpression \f2regexp\f1 as item separator.
+expression \f2regexp\f1 as item separator.
 .TP 8
 .B sprintf (\f2fmt\f1, ...)
 Format arguments according to \f2fmt\f1 and return result as a
 string.
 .TP 8
 .B strcmp (\f2str1\f3, \f2str2\f3)
-Perform a case\-sensitive comparision for strings \f2str1\f1 and
+Perform a case\-sensitive comparison for strings \f2str1\f1 and
 \f2str2\f1.  Function returns a value that is:
 .RS 8
 .TP 8
-.B -1
+.B \-1
 string \f2str1\f1 is less than \f2str2\f1
 .TP 8
 .B 0
@@ -312,17 +312,16 @@ string \f2str1\f1 is greater than \f2str2\f1
 Convert argument to string.
 .TP 8
 .B strncmp (\f2str1\f3, \f2str2\f3, \f2num\f3)
-Perform a case\-sensitive comparision for strings \f2str1\f1 and
+Perform a case\-sensitive comparison for strings \f2str1\f1 and
 \f2str2\f1 comparing at maximum \f2num\f3 characters.
 .TP 8
 .B substring (\f2str\f3, \f2start\f3, \f2end\f3)
 Return a substring of string \f2str\f1 starting from position
 \f2start\f1 (inclusively) to \f2end\f1 (exclusively).
-.RE
-
+.
 .SH BUILTIN VARIABLES
 .TP 8
-.B $.
+.BR $ .
 current input line number
 .TP 8
 .B $\f2n\f3
@@ -330,7 +329,7 @@ the \f2n\f1:th parenthesized regular expression 
sub-expression from the
 latest state regular expression or from the \f3regmatch\f1 primitive
 .TP 8
 .B $`
-everything before the matched regular rexpression.  This is usable
+everything before the matched regular expression.  This is usable
 when used with the \f3regmatch\f1 primitive; the contents of this
 variable is undefined when used in action blocks to refer the data
 before the block's regular expression.
@@ -349,8 +348,7 @@ name of the program (usually \f3states\f1)
 .TP 8
 .B version
 program version string
-.RE
-
+.
 .SH FILES
 .nf
 .ta 4i
@@ -358,9 +356,10 @@ program version string
 .fi
 
 .SH SEE ALSO
-awk(1), enscript(1)
+.BR awk (1),
+.BR enscript (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