Subject: bug#64118: [PATCH] gzip.1: some remarks and formatting fixes for the man page

From: Bjarni Ingi Gislason <[email-masked]>
Date: Fri, 16 Jun 2023 20:08:34 +0000

Output from "mandoc  -T lint gzip.1:"

mandoc: gzip.1:347:173: STYLE: input text line longer than 80 bytes: When you synchronize...
mandoc: gzip.1:348:277: STYLE: input text line longer than 80 bytes: Normally, after a ch...
mandoc: gzip.1:349:176: STYLE: input text line longer than 80 bytes: With this option, rs...

#######

Change '-' (\-) to '\(en' (en-dash) for a numeric range.

gzip.1:175:is reduced by 60\-70%.

#####

Change two HYPHEN-MINUSES (code 0x055, 2D) to an em-dash (\[em]), if one
is intended.  An en-dash is usually surrounded by a space, while an em-dash
is used without spaces. "man" (1 byte characters) transforms an en-dash
(\[en] to one HYPHEN-MINUS, and an em-dash to two HYPHEN-MINUSES without
considering the space around it.

gzip.1:469:\fIfile\fP\^: already has .gz suffix -- unchanged

#####

Start a sentence in parenthesis on a new line (semantic newline,
see man-pages(7)).

273:default. (The original name is always saved if the name had to be

#####

Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-

196:.B \-a --ascii
201:.B \-c --stdout --to-stdout
207:.B \-d --decompress --uncompress
210:.B \-f --force
216:and if the option --stdout is also given, copy the input data without change
228:.B \-h --help
231:.B \-k --keep
234:.B \-l --list
248:In combination with the --verbose option, the following fields are also
259:With --name, the uncompressed name,  date and time  are
262:With --verbose, the size totals and compression ratio for all files
263:is also displayed, unless some sizes are unknown. With --quiet,
266:.B \-L --license
271:.B \-n --no-name
281:.B \-N --name
292:.B \-q --quiet
295:.B \-r --recursive
304:.B \-S .suf   --suffix .suf
313:.B --synchronous
319:.B \-t --test
322:.B \-v --verbose
326:.B \-V --version
329:.B \-# --fast --best
381:size and CRC reported by the --list option applies to the last member
505:and emits a warning by default.  You can use the --quiet option to
508:In some rare cases, the --best option gives worse compression than

#####

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

gzip.1:242:The uncompressed size is given as -1 for files not in gzip format,
gzip.1:509:the default compression level (-6). On some highly redundant files,

#####

Use the word (in)valid instead of (il)legal if not related to legal
matters.
See "www.gnu.org/prep/standards".
Think about translations into other languages!

gzip.1:75:legal.

#####

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

38:If no files are specified, or if a file name is "-", the standard input is
68:.B "gzip -d"
79:file whose name ends with .gz, -gz, .z, -z, or _z (ignoring case)
105:.B "compress -H"
126:The SCO compress -H format (lzh compression method) does not include a CRC
138:.RB ' "gunzip -S .zip foo.zip" '.
246:    zcat file.Z | wc -c
256:(SCO compress -H) and pack.  The crc is given as ffffffff for a file
355:      gzip -c file1  > foo.gz
356:      gzip -c file2 >> foo.gz
360:      gunzip -c foo
374:      gzip -c file1 file2 > foo.gz
378:      gzip -cd old.gz | gzip > new.gz
384:      gzip -cd file.gz | wc -c
388:such as tar or zip. GNU tar supports the -z option to invoke gzip

#####

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("semantic newline") and "info groff".

  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.

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

!!!
!!!  These are too many lines to reorganize,
!!!  so not in the patch,
!!!  except the long line number 348.
!!!

53:(A part is delimited by dots.) If the name consists of small parts only,
54:the longest parts are truncated. For example, if file names are limited
61:keeps the original file name and timestamp in the compressed file. These
64:option. This is useful when the compressed file name was truncated or
111:checks a 32 bit CRC. For
115:checks the uncompressed length. The standard
117:format was not designed to allow consistency checks. However
119:is sometimes able to detect a bad .Z file. If you get an error
123:does not complain. This generally means that the standard
132:with the 'deflation' method. This feature is only intended to help
185:slightly larger than the original. The worst case expansion is
187:or an expansion ratio of 0.015% for large files. The actual
192:of a file when compressing or decompressing. If you have appropriate
197:Ascii text mode: convert end-of-lines using local conventions. This option
198:is supported only on some non-Unix systems. For MSDOS, CR LF is converted
204:independently compressed members. To obtain better compression,
213:is read from or written to a terminal. If the input data is not in
243:such as compressed .Z files. To get the uncompressed size for such a file,
263:is also displayed, unless some sizes are unknown. With --quiet,
273:default. (The original name is always saved if the name had to be
274:truncated.) When decompressing, do not restore the original file name
278:timestamp if present (copy it from the compressed file). This option
287:is the default. When decompressing, restore from the saved file name and
288:timestamp if present. This option is useful on systems which have
296:Travel the directory structure recursively. If any of the file names
320:Test. Check the compressed file integrity then quit.
323:Verbose. Display the name and percentage reduction for each file compressed
327:Version. Display the version number and compilation options then quit.
348:Normally, after a change is made to any file in the archive, the compression algorithm can generate a new version of the archive that does not match the previous version of the archive. In this case, rsync transfers the entire new version of the archive to the remote computer.
351:Multiple compressed files can be concatenated. In this case,
353:will extract all members at once. For example:
367:still be recovered (if the damaged member is removed). However,
382:only. If you need the uncompressed size for all members, you can use:
388:such as tar or zip. GNU tar supports the -z option to invoke gzip
389:transparently. gzip is designed as a complement to tar, not as a
417:      #! /bin/sh
432:file format is specified in P. Deutsch, \s-1GZIP\s0 file format
438:deflation format is specified in P. Deutsch, \s-1DEFLATE\s0 Compressed
444:if an error occurs, exit status is 1. If a warning occurs, exit status is 2.
454:\fIfile\fP\^: Corrupt input. Use zcat to recover some data.
455:The compressed file has been damaged. The data up to the point of failure
488:(e.g. a symbolic link, socket, FIFO, device file), it is
494:for more information. Use the
499:pad the output with zeroes up to a block boundary. When the data is
509:the default compression level (-6). On some highly redundant files,

#####

Split lines longer than 100 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

gzip.1: line 347	length 173
When you synchronize a compressed file between two computers, this option allows rsync to transfer only files that were changed in the archive instead of the entire archive.

gzip.1: line 348	length 277
Normally, after a change is made to any file in the archive, the compression algorithm can generate a new version of the archive that does not match the previous version of the archive. In this case, rsync transfers the entire new version of the archive to the remote computer.

gzip.1: line 349	length 176
With this option, rsync can transfer only the changed files as well as a small amount of metadata that is required to update the archive structure in the area that was changed.

#####

Change '-' to '\' if part of an option.

446:Usage: gzip [-cdfhklLnNrtvV19] [-S suffix] [file ...]
Signed-off-by: Bjarni Ingi Gislason <[email-masked]>

#####
---
 gzip.1 | 127 ++++++++++++++++++++++++++++++++-------------------------
 1 file changed, 72 insertions(+), 55 deletions(-)

diff --git a/gzip.1 b/gzip.1
index 22ab88d..6663481 100644
--- a/gzip.1
+++ b/gzip.1
@@ -35,7 +35,7 @@ while keeping the same ownership modes, access and modification times.
 (The default extension is
 .B "z"
 for MSDOS, OS/2 FAT, Windows NT FAT and Atari.)
-If no files are specified, or if a file name is "-", the standard input is
+If no files are specified, or if a file name is "\-", the standard input is
 compressed to the standard output.
 The
 .B gzip
@@ -65,18 +65,18 @@ option. This is useful when the compressed file name was truncated or
 when the timestamp was not preserved after a file transfer.
 .PP
 Compressed files can be restored to their original form using
-.B "gzip -d"
+.B "gzip \-d"
 or
 .B gunzip
 or
 .BR zcat .
 If the original name saved in the compressed file is not suitable for its
 file system, a new name is constructed from the original one to make it
-legal.
+valid.
 .PP
 .B gunzip
 takes a list of files on its command line and replaces each
-file whose name ends with .gz, -gz, .z, -z, or _z (ignoring case)
+file whose name ends with .gz, \-gz, .z, \-z, or _z (ignoring case)
 and which begins with the correct magic number with an uncompressed
 file without the original extension.
 .B gunzip
@@ -102,7 +102,7 @@ can currently decompress files created by
 .BR gzip ,
 .BR zip ,
 .BR compress ,
-.B "compress -H"
+.B "compress \-H"
 or
 .BR pack .
 The detection of the input format is automatic.  When using
@@ -123,7 +123,7 @@ correct simply because the standard
 does not complain. This generally means that the standard
 .B uncompress
 does not check its input, and happily generates garbage output.
-The SCO compress -H format (lzh compression method) does not include a CRC
+The SCO compress \-H format (lzh compression method) does not include a CRC
 but also allows some consistency checks.
 .PP
 Files created by
@@ -135,7 +135,7 @@ conversion of tar.zip files to the tar.gz format.  To extract a
 file with a single member, use a command like
 .RB ' "gunzip <foo.zip" '
 or
-.RB ' "gunzip -S .zip foo.zip" '.
+.RB ' "gunzip \-S .zip foo.zip" '.
 To extract zip files
 with several members, use
 .B unzip
@@ -172,7 +172,7 @@ and PKZIP.
 The amount of compression obtained depends on the size of the
 input and the distribution of common substrings.
 Typically, text such as source code or English
-is reduced by 60\-70%.
+is reduced by 60\(en70%.
 Compression is generally much better than that achieved by
 LZW (as used in
 .BR compress ),
@@ -193,27 +193,27 @@ of a file when compressing or decompressing. If you have appropriate
 privileges, it also preserves the file's owner and group.
 .SH OPTIONS
 .TP
-.B \-a --ascii
+.B \-a \-\-ascii
 Ascii text mode: convert end-of-lines using local conventions. This option
 is supported only on some non-Unix systems. For MSDOS, CR LF is converted
 to LF when compressing, and LF is converted to CR LF when decompressing.
 .TP
-.B \-c --stdout --to-stdout
+.B \-c \-\-stdout \-\-to-stdout
 Write output on standard output; keep original files unchanged.
 If there are several input files, the output consists of a sequence of
 independently compressed members. To obtain better compression,
 concatenate all input files before compressing them.
 .TP
-.B \-d --decompress --uncompress
+.B \-d \-\-decompress \-\-uncompress
 Decompress.
 .TP
-.B \-f --force
+.B \-f \-\-force
 Force compression or decompression even if the file has multiple links
 or the corresponding file already exists, or if the compressed data
 is read from or written to a terminal. If the input data is not in
 a format recognized by
 .BR gzip ,
-and if the option --stdout is also given, copy the input data without change
+and if the option \-\-stdout is also given, copy the input data without change
 to the standard output: let
 .B zcat
 behave as
@@ -225,13 +225,13 @@ and when not running in the background,
 .B gzip
 prompts to verify whether an existing file should be overwritten.
 .TP
-.B \-h --help
+.B \-h \-\-help
 Display a help screen and quit.
 .TP
-.B \-k --keep
+.B \-k \-\-keep
 Keep (don't delete) input files during compression or decompression.
 .TP
-.B \-l --list
+.B \-l \-\-list
 For each compressed file, list the following fields:
 
     compressed size: size of the compressed file
@@ -239,13 +239,13 @@ For each compressed file, list the following fields:
     ratio: compression ratio (0.0% if unknown)
     uncompressed_name: name of the uncompressed file
 
-The uncompressed size is given as -1 for files not in gzip format,
+The uncompressed size is given as \-1 for files not in gzip format,
 such as compressed .Z files. To get the uncompressed size for such a file,
 you can use:
 
-    zcat file.Z | wc -c
+    zcat file.Z | wc \-c
 
-In combination with the --verbose option, the following fields are also
+In combination with the \-\-verbose option, the following fields are also
 displayed:
 
     method: compression method
@@ -253,32 +253,39 @@ displayed:
     date & time: timestamp for the uncompressed file
 
 The compression methods currently supported are deflate, compress, lzh
-(SCO compress -H) and pack.  The crc is given as ffffffff for a file
+(SCO compress \-H) and pack.  The crc is given as ffffffff for a file
 not in gzip format.
 
-With --name, the uncompressed name,  date and time  are
+With \-\-name, the uncompressed name,  date and time  are
 those stored within the compress file if present.
 
-With --verbose, the size totals and compression ratio for all files
-is also displayed, unless some sizes are unknown. With --quiet,
+With \-\-verbose, the size totals and compression ratio for all files
+is also displayed, unless some sizes are unknown. With \-\-quiet,
 the title and totals lines are not displayed.
 .TP
-.B \-L --license
+.B \-L \-\-license
 Display the
 .B gzip
 license and quit.
 .TP
-.B \-n --no-name
+.B \-n \-\-no-name
 When compressing, do not save the original file name and timestamp by
-default. (The original name is always saved if the name had to be
-truncated.) When decompressing, do not restore the original file name
-if present (remove only the
+default.
+(The original name is always saved if the name had to be
+truncated.)
+When decompressing,
+do not restore the original file name
+if present
+(remove only the
 .B gzip
-suffix from the compressed file name) and do not restore the original
-timestamp if present (copy it from the compressed file). This option
+suffix from the compressed file name)
+and do not restore the original
+timestamp if present
+(copy it from the compressed file).
+This option
 is the default when decompressing.
 .TP
-.B \-N --name
+.B \-N \-\-name
 When compressing, always save the original file name, and save
 the seconds part of the original modification timestamp if the
 original is a regular file and its timestamp is at least 1 (1970-01-01
@@ -289,10 +296,10 @@ timestamp if present. This option is useful on systems which have
 a limit on file name length or when the timestamp has been lost after
 a file transfer.
 .TP
-.B \-q --quiet
+.B \-q \-\-quiet
 Suppress all warnings.
 .TP
-.B \-r --recursive
+.B \-r \-\-recursive
 Travel the directory structure recursively. If any of the file names
 specified on the command line are directories,
 .B gzip
@@ -301,7 +308,7 @@ will descend into the directory and compress all the files it finds there
 .B gunzip
 ).
 .TP
-.B \-S .suf   --suffix .suf
+.B \-S .suf   \-\-suffix .suf
 When compressing, use suffix .suf instead of .gz.
 Any non-empty suffix can be given, but suffixes
 other than .z and .gz should be avoided to avoid confusion when files
@@ -310,23 +317,23 @@ are transferred to other systems.
 When decompressing, add .suf to the beginning of the list of
 suffixes to try, when deriving an output file name from an input file name.
 .TP
-.B --synchronous
+.B \-\-synchronous
 Use synchronous output.  With this option,
 .B gzip
 is less likely to lose data during a system crash, but it can be
 considerably slower.
 .TP
-.B \-t --test
+.B \-t \-\-test
 Test. Check the compressed file integrity then quit.
 .TP
-.B \-v --verbose
+.B \-v \-\-verbose
 Verbose. Display the name and percentage reduction for each file compressed
 or decompressed.
 .TP
-.B \-V --version
+.B \-V \-\-version
 Version. Display the version number and compilation options then quit.
 .TP
-.B \-# --fast --best
+.B \-# \-\-fast \-\-best
 Regulate the speed of compression using the specified digit
 .BR # ,
 where
@@ -344,20 +351,30 @@ The default compression level is
 (that is, biased towards high compression at expense of speed).
 .TP
 .B \-\-rsyncable
-When you synchronize a compressed file between two computers, this option allows rsync to transfer only files that were changed in the archive instead of the entire archive.
-Normally, after a change is made to any file in the archive, the compression algorithm can generate a new version of the archive that does not match the previous version of the archive. In this case, rsync transfers the entire new version of the archive to the remote computer.
-With this option, rsync can transfer only the changed files as well as a small amount of metadata that is required to update the archive structure in the area that was changed.
+When you synchronize a compressed file between two computers,
+this option allows rsync to transfer only files
+that were changed in the archive instead of the entire archive.
+Normally,
+after a change is made to any file in the archive,
+the compression algorithm can generate a new version of the archive
+that does not match the previous version of the archive.
+In this case,
+rsync transfers the entire new version of the archive to the remote computer.
+With this option,
+rsync can transfer only the changed files
+as well as a small amount of metadata
+that is required to update the archive structure in the area that was changed.
 .SH "ADVANCED USAGE"
 Multiple compressed files can be concatenated. In this case,
 .B gunzip
 will extract all members at once. For example:
 
-      gzip -c file1  > foo.gz
-      gzip -c file2 >> foo.gz
+      gzip \-c file1  > foo.gz
+      gzip \-c file2 >> foo.gz
 
 Then
 
-      gunzip -c foo
+      gunzip \-c foo
 
 is equivalent to
 
@@ -371,21 +388,21 @@ you can get better compression by compressing all members at once:
 
 compresses better than
 
-      gzip -c file1 file2 > foo.gz
+      gzip \-c file1 file2 > foo.gz
 
 If you want to recompress concatenated files to get better compression, do:
 
-      gzip -cd old.gz | gzip > new.gz
+      gzip \-cd old.gz | gzip > new.gz
 
 If a compressed file consists of several members, the uncompressed
-size and CRC reported by the --list option applies to the last member
+size and CRC reported by the \-\-list option applies to the last member
 only. If you need the uncompressed size for all members, you can use:
 
-      gzip -cd file.gz | wc -c
+      gzip \-cd file.gz | wc -c
 
 If you wish to create a single archive file with multiple members so
 that members can later be extracted independently, use an archiver
-such as tar or zip. GNU tar supports the -z option to invoke gzip
+such as tar or zip. GNU tar supports the \-z option to invoke gzip
 transparently. gzip is designed as a complement to tar, not as a
 replacement.
 .SH "ENVIRONMENT"
@@ -443,7 +460,7 @@ Internet RFC 1951 (May 1996).
 Exit status is normally 0;
 if an error occurs, exit status is 1. If a warning occurs, exit status is 2.
 .TP
-Usage: gzip [-cdfhklLnNrtvV19] [-S suffix] [file ...]
+Usage: gzip [\-cdfhklLnNrtvV19] [\-S suffix] [file ...]
 Invalid options were specified on the command line.
 .TP
 \fIfile\fP\^: not in gzip format
@@ -466,7 +483,7 @@ than the decompress code on this machine.
 Recompress the file with gzip, which compresses better and uses
 less memory.
 .TP
-\fIfile\fP\^: already has .gz suffix -- unchanged
+\fIfile\fP\^: already has .gz suffix \(en unchanged
 The file is assumed to be already compressed.
 Rename the file and try again.
 .TP
@@ -502,11 +519,11 @@ read and the whole block is passed to
 for decompression,
 .B gunzip
 detects that there is extra trailing garbage after the compressed data
-and emits a warning by default.  You can use the --quiet option to
+and emits a warning by default.  You can use the \-\-quiet option to
 suppress the warning.
 .SH BUGS
-In some rare cases, the --best option gives worse compression than
-the default compression level (-6). On some highly redundant files,
+In some rare cases, the \-\-best option gives worse compression than
+the default compression level (\-6). On some highly redundant files,
 .B compress
 compresses better than
 .BR gzip .
-- 
2.39.2