Package: ncompress
Version: 5.0-1
Severity: minor
Tags: patch
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 >
nroff -man >
diff -u
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 compress.1": (possibly shortened list)
mandoc: compress.1:46:2: WARNING: skipping paragraph macro: PP after SH
mandoc: compress.1:86:17: STYLE: whitespace at end of input line
mandoc: compress.1:105:19: STYLE: whitespace at end of input line
mandoc: compress.1:108:22: STYLE: whitespace at end of input line
mandoc: compress.1:153:10: STYLE: whitespace at end of input line
mandoc: compress.1:158:47: STYLE: whitespace at end of input line
mandoc: compress.1:205:16: STYLE: whitespace at end of input line
mandoc: compress.1:207:22: STYLE: whitespace at end of input line
mandoc: compress.1:213:5: STYLE: whitespace at end of input line
mandoc: compress.1:243:13: STYLE: whitespace at end of input line
mandoc: compress.1:257:7: STYLE: whitespace at end of input line
mandoc: compress.1:273:9: WARNING: undefined escape, printing literally: \1
mandoc: compress.1:274:55: STYLE: whitespace at end of input line
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
compress.1:125:vol. 17, no. 6 (June 1984), pp. 8\-19.
compress.1:166:is reduced by 50\-60%.
-.-.
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
275:a small process data space (64KB or less, as exhibited by the DEC PDP
-.-.
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.
125:vol. 17, no. 6 (June 1984), pp. 8\-19.
253:(e.g. a symbolic link, socket, FIFO, device file), it is
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
253:(e.g. a symbolic link, socket, FIFO, device file), it is
-.-.
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.
64:In particular, it will ignore symbolic links. If a file has multiple
107:will operate recursively. If any of the file names specified on the command
262:for more information. Use the
-.-.
Remove reverse slash (\) in front of a period (.) that is to be printed
as such, and can not come a control character in the first column of a line.
This is a sign, that the man page was transformed from another source
file with a program, whose name is NOT mentioned in a comment.
195:.BR \-b \.
217:.IR bits \.
248:.BR \-v \.)
-.-.
Use the name of units in text; use symbols in tables and
calculations.
The rule is to have a (no-break, \~) space between a number and
its units (see "www.bipm.org/en/publications/si-brochure")
275:a small process data space (64KB or less, as exhibited by the DEC PDP
-.-.
Split a punctuation from a single argument, if a two-font macro is meant
50:.I uncompress.real.
79:.I uncompress.real.
152:.I uncompress.real,
-.-.
troff::273: warning: ignoring escape character before '1'
-- System Information:
Debian Release:
