Dear Maintainer,
here are some notes and editorial fixes for the manual.
The patch is in the attachment.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint cpio.1": (possibly shortened list)
mandoc: cpio.1:97:11: STYLE: whitespace at end of input line
mandoc: cpio.1:226:26: STYLE: whitespace at end of input line
mandoc: cpio.1:297:31: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
97:\fB\-i\fR.
226:Equivalent to \fB\-sS\fR.
297:.TP
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
53:[\fIpattern\fR...] [\fB<\fR \fIarchive\fR]
150:The old (POSIX.1) portable format. (8589934591 bytes)
154:having more than 65536 i-nodes. (4294967295 bytes)
160:The old tar format. (8589934591 bytes)
164:which are similar but not identical. (8589934591 bytes)
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
204:.BR all
-.-.
Strings longer than 3/4 of a standard line length (80)
25 [\fB\-\-file=\fR[[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE\fR]
40 [\fB\-\-file=\fR[[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE\fR]
214 \fB\-F\fR, \fB\-\-file=\fR[[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE-FILE\fR
-.-.
Wrong distance between sentences.
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.
150:The old (POSIX.1) portable format. (8589934591 bytes)
154:having more than 65536 i-nodes. (4294967295 bytes)
160:The old tar format. (8589934591 bytes)
164:which are similar but not identical. (8589934591 bytes)
268:Use \fIARCHIVE-NAME\fR instead of standard output. Optional \fIUSER\fR and
299:Use \fIARCHIVE-NAME\fR instead of standard input. Optional \fIUSER\fR and
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
77:cpio(5)
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rCHECKSTYLE=0":
troff: backtrace: file '<stdin>':97
troff:<stdin>:97: warning: trailing space in the line
troff: backtrace: file '<stdin>':201
troff:<stdin>:201: warning: special character 'u0438' not defined
troff: backtrace: file '<stdin>':226
troff:<stdin>:226: warning: trailing space in the line