ogonkify.1: Some remarks about this man page

--+NU85/8BVocG0IeM
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Package: a2ps
Version: ?
Severity: minor
Tags: upstream

   * What led up to the situation?

     Checking for defects with a new version

test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man page"

  [Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.]

  ["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).

  [The fate of "test-nroff" was decided in groff bug #55941.]

   * What was the outcome of this action?

troff:<stdin>:88: warning: trailing space in the line
troff:<stdin>:119: warning: trailing space in the line
an.tmac:<stdin>:142: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
troff:<stdin>:186: warning: trailing space in the line
troff:<stdin>:192: warning: trailing space in the line
troff:<stdin>:198: warning: trailing space in the line
troff:<stdin>:208: warning: trailing space in the line
troff:<stdin>:214: warning: trailing space in the line
troff:<stdin>:304: warning: trailing space in the line
troff:<stdin>:307: warning: trailing space in the line


   * What outcome did you expect instead?

     No output (no warnings).

-.-

  General remarks and further material, if a diff-file exist, are in the
attachments.


--+NU85/8BVocG0IeM
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="chk_man.err.ogonkify.1"

Input file is ogonkify.1

Output from "mandoc -T lint  ogonkify.1": (shortened list)

      1 input text line longer than 80 bytes: Much of the composit...
      1 skipping paragraph macro: PP empty
      1 skipping paragraph macro: sp after PP
     15 whitespace at end of input line


Remove trailing space with: sed -e 's/  *$//'

-.-.

Output from "test-nroff -mandoc -t -ww -z ogonkify.1": (shortened list)

      1 	Use macro '.B' for one argument or split argument.
      1 .BR is for at least 2 arguments, got 1
      9 trailing space in the line


Remove trailing space with: sed -e 's/  *$//'

-.-.

Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

Number of lines affected is

15

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

201:.B -A
203:.B -C

-.-.

Wrong distance (not two spaces) between sentences in the input file.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  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.

Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.

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

Mark a final abbreviation point as such by suffixing it with "\&".

Some sentences (etc.) do not begin on a new line.

Split (sometimes) lines after a punctuation mark; before a conjunction.

  Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.

Use

#!/usr/bin/sh

sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\.  */\1.\n/g' $1

to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"

82:Set the encoding of the output. Defaults to
84:(ISO 8859\-2, a.k.a. ISO Latin\-2). Other possible values are
86:(ISO 8859\-1, a.k.a. ISO Latin\-1),
88:(ISO 8859\-3, a.k.a. ISO Latin\-3), 
90:(ISO 8859\-4, a.k.a. ISO Latin\-4),
92:(ISO 8859\-9, a.k.a. ISO Latin\-5),
94:(ISO 8859\-10, a.k.a. ISO Latin\-6),
96:(ISO 8859\-13, a.k.a. ISO Latin\-7),
98:(ISO 8859\-15, a.k.a. ISO Latin\-9),
100:(Microsoft Code Page 1250, a.k.a. CeP),
239:ISO Latin\-2. Netscape stubbornly insists on printing it as
240:ISO Latin\-1. By using the File->Print command, have Netscape send the
246:generated by Netscape will correct the encoding of the fonts. It is
302:Much of the composite character data have been provided by Primoz Peterlin, H. Turgut Uyar, Ricardas Cepas, Kristof Petrovay and Jan Prikryl.

-.-.

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.  

Line 302, length 141

Much of the composite character data have been provided by Primoz Peterlin, H. Turgut Uyar, Ricardas Cepas, Kristof Petrovay and Jan Prikryl.

Longest line is number 302 with 141 characters

-.-.

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

37:.I file ...

-.-.

Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".

ogonkify.1:44:that don't use the standard Western-European encoding (ISO 8859-1).

-.-.

Use a character "\(->" instead of plain "->" or "\->".

240:ISO Latin\-1. By using the File->Print command, have Netscape send the

-.-.

Only one space character after a possible end of sentence
(after a punctuation, that can end a sentence).

ogonkify.1:82:Set the encoding of the output. Defaults to
ogonkify.1:84:(ISO 8859\-2, a.k.a. ISO Latin\-2). Other possible values are
ogonkify.1:86:(ISO 8859\-1, a.k.a. ISO Latin\-1),
ogonkify.1:88:(ISO 8859\-3, a.k.a. ISO Latin\-3), 
ogonkify.1:90:(ISO 8859\-4, a.k.a. ISO Latin\-4),
ogonkify.1:92:(ISO 8859\-9, a.k.a. ISO Latin\-5),
ogonkify.1:94:(ISO 8859\-10, a.k.a. ISO Latin\-6),
ogonkify.1:96:(ISO 8859\-13, a.k.a. ISO Latin\-7),
ogonkify.1:98:(ISO 8859\-15, a.k.a. ISO Latin\-9),
ogonkify.1:100:(Microsoft Code Page 1250, a.k.a. CeP),
ogonkify.1:239:ISO Latin\-2. Netscape stubbornly insists on printing it as
ogonkify.1:240:ISO Latin\-1. By using the File->Print command, have Netscape send the
ogonkify.1:246:generated by Netscape will correct the encoding of the fonts. It is
ogonkify.1:302:Much of the composite character data have been provided by Primoz Peterlin, H. Turgut Uyar, Ricardas Cepas, Kristof Petrovay and Jan Prikryl.

-.-.

Put a subordinate sentence (after a comma) on a new line.

[List of affected lines removed.]

-.-

Space character after a macro call.

173:.B \-T 
187:.B Netscape 
193:.B Mosaic 
199:.B mp 
295:.B \-arguments 
305:.BR StarOffice .  

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

troff:<stdin>:88: warning: trailing space in the line
troff:<stdin>:119: warning: trailing space in the line
an.tmac:<stdin>:142: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
troff:<stdin>:186: warning: trailing space in the line
troff:<stdin>:192: warning: trailing space in the line
troff:<stdin>:198: warning: trailing space in the line
troff:<stdin>:208: warning: trailing space in the line
troff:<stdin>:214: warning: trailing space in the line
troff:<stdin>:304: warning: trailing space in the line
troff:<stdin>:307: warning: trailing space in the line

-.-.

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.

--+NU85/8BVocG0IeM
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="general.bugs"

  Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)

[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>

  The same goes for man pages that are used as an input.

  For a style guide use

  mandoc -T lint

-.-

  Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.

  It should also check its input files for too long (> 80) lines.

  This is just a simple quality control measure.

  The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.

  Common defects:

  Not removing trailing spaces (in in- and output).
  The reason for these trailing spaces should be found and eliminated.

  "git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")

  Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.

  The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.

  See man-pages(7), item "semantic newline".

-.-

The difference between the formatted output of the original and patched file
can be seen with:

  nroff -mandoc <file1> > <out1>
  nroff -mandoc <file2> > <out2>
  diff -d -u <out1> <out2>

and for groff, using

\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"

instead of 'nroff -mandoc'

  Add the option '-t', if the file contains a table.

  Read the output from 'diff -d -u ...' with 'less -R' or similar.

-.-.

  If 'man' (man-db) is used to check the manual for warnings,
the following must be set:

  The option \"-warnings=w\"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT=\"-ww -b -z\"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-

--+NU85/8BVocG0IeM--