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 <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 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:<stdin>:273: warning: ignoring escape character before '1'
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages ncompress depends on:
ii libc6 2.38-11
ncompress recommends no packages.
ncompress suggests no packages.
-- no debconf information
--- compress.1 2024-05-20 01:07:33.034835052 +0000
+++ compress.1.new 2024-05-20 01:29:40.658348531 +0000
@@ -43,11 +43,10 @@ compress, uncompress.real \- compress an
.I "name \&..."
]
.SH DESCRIPTION
-.PP
Note that the program that would normally be installed as
.I uncompress
is installed for Debian as
-.I uncompress.real.
+.IR uncompress.real .
This has been done to avoid conflicting with the more-commonly-used
program with the same name that is part of the gzip package.
.PP
@@ -61,8 +60,8 @@ If no files are specified, the standard
standard output.
.I Compress
will only attempt to compress regular files.
-In particular, it will ignore symbolic links. If a file has multiple
-hard links,
+In particular, it will ignore symbolic links.
+If a file has multiple hard links,
.I compress
will refuse to compress it unless the
.B \-f
@@ -76,14 +75,14 @@ is run in the foreground,
the user is prompted as to whether an existing file should be overwritten.
.PP
Compressed files can be restored to their original form using
-.I uncompress.real.
+.IR uncompress.real .
.PP
.I uncompress.real
takes a list of files on its command line and replaces each
file whose name ends with
.B "\&.Z"
and which begins with the correct magic number with an uncompressed
-file without the
+file without the
.B "\&.Z."
The uncompressed file will have the mode, ownership and
timestamps of the compressed file.
@@ -102,10 +101,10 @@ write to the standard output; no files a
.PP
If the
.B \-r
-flag is specified,
+flag is specified,
.I compress
-will operate recursively. If any of the file names specified on the command
-line are directories,
+will operate recursively.
+If any of the file names specified on the command line are directories,
.I compress
will descend into the directory and compress all the files it finds there.
When compressing, any files already compressed will be ignored, and when
@@ -120,9 +119,9 @@ stderr before doing any compression or u
.I Compress
uses the modified Lempel\-Ziv algorithm popularized in
"A Technique for High Performance Data Compression",
-Terry A. Welch,
+Terry A.\& Welch,
.I "IEEE Computer,"
-vol. 17, no. 6 (June 1984), pp. 8\-19.
+vol.\& 17, no.\& 6 (June 1984), pp.\& 8\(en19.
Common substrings in the file are first replaced by 9\-bit codes 257 and up.
When code 512 is reached, the algorithm switches to 10\-bit codes and
continues to use more bits until the
@@ -149,13 +148,13 @@ the algorithm to adapt to the next "bloc
Note that the
.B \-b
flag is omitted for
-.I uncompress.real,
-since the
+.IR uncompress.real ,
+since the
.I bits
parameter specified during compression
is encoded within the output, along with
a magic number to ensure that neither decompression of random data nor
-recompression of compressed data is attempted.
+recompression of compressed data is attempted.
.PP
.ne 8
The amount of compression obtained depends on the size of the
@@ -163,7 +162,7 @@ input, the number of
.I bits
per code, and the distribution of common substrings.
Typically, text such as source code or English
-is reduced by 50\-60%.
+is reduced by 50\(en60%.
Compression is generally much better than that achieved by
Huffman coding (as used in
.IR pack ),
@@ -192,7 +191,7 @@ Invalid options were specified on the co
Missing maxbits
.in +8
Maxbits must follow
-.BR \-b \.
+.BR \-b .
.in -8
.IR file :
not in compressed format
@@ -202,19 +201,19 @@ The file specified to
has not been compressed.
.in -8
.IR file :
-compressed with
+compressed with
.I xx
-bits, can only handle
+bits, can only handle
.I yy
bits
.in +8
.I File
was compressed by a program that could deal with
-more
+more
.I bits
than the compress code on this machine.
Recompress the file with smaller
-.IR bits \.
+.IR bits .
.in -8
.IR file :
already has .Z suffix \-\- no change
@@ -240,26 +239,27 @@ uncompress.real: corrupt input
A SIGSEGV violation was detected which usually means that the input file has
been corrupted.
.in -8
-Compression:
+Compression:
.I "xx.xx%"
.in +8
Percentage of the input saved by compression.
(Relevant only for
-.BR \-v \.)
+.BR \-v .)
.in -8
\-\- not a regular file or directory: ignored
.in +8
When the input file is not a regular file or directory,
-(e.g. a symbolic link, socket, FIFO, device file), it is
+(e.g.\& a symbolic link, socket, FIFO, device file), it is
left unaltered.
.in -8
\-\- has
-.I xx
+.I xx
other links: unchanged
.in +8
The input file has links; it is left unchanged. See
.IR ln "(1)"
-for more information. Use the
+for more information.
+Use the
.B \-f
flag to force compression of multiply\-linked files.
.in -8
@@ -270,9 +270,9 @@ compression. The input remains virgin.
.in -8
.SH "BUGS"
Although compressed files are compatible between machines with large memory,
-.BR \-b \12
-should be used for file transfer to architectures with
-a small process data space (64KB or less, as exhibited by the DEC PDP
+.BR \-b 12
+should be used for file transfer to architectures with
+a small process data space (64\~KiB or less, as exhibited by the DEC PDP
series, the Intel 80286, etc.)
.SH "SEE ALSO"
.BR pack (1),
