Package: bzip2
Version: 1.0.8-6
Severity: minor
Tags: patch
* 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?
an.tmac:<stdin>:3: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:3: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:22: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:50: style: 4 leading space(s) on input line
an.tmac:<stdin>:51: style: 4 leading space(s) on input 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.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.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 bzip2 depends on:
ii libbz2-1.0 1.0.8-6
ii libc6 2.40-7
bzip2 recommends no packages.
Versions of packages bzip2 suggests:
pn bzip2-doc <none>
-- no debconf information
Input file is bzgrep.1
Output from "mandoc -T lint bzgrep.1": (shortened list)
1 input text line longer than 80 bytes: bzgrep, bzfgrep, bze...
1 missing date, using "": TH
-.-.
Output from "test-groff -mandoc -t -ww -z bzgrep.1": (shortened list)
1 Use macro '.I' for one argument or split argument.
1 .IR is for at least 2 arguments, got 1
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
bzgrep.1:50: for sh: GREP=fgrep bzgrep string files
bzgrep.1:51: for csh: (setenv GREP fgrep; bzgrep string files)
-.-.
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.
9:.BI [\ -e\ ] " pattern"
14:.BI [\ -e\ ] " pattern"
19:.BI [\ -e\ ] " pattern"
-.-.
Wrong distance 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"
25:on bzip2-compressed files. All options specified are passed directly to
48:program to be invoked. For example:
53:Charles Levert (char...@comm.polymtl.ca). Adapted to bzip2 by Philippe
-.-.
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 5, length 91
bzgrep, bzfgrep, bzegrep \- search possibly bzip2 compressed files for a
regular expression
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
56:grep(1), egrep(1), fgrep(1), bzdiff(1), bzmore(1), bzless(1), bzip2(1)
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
26:.I grep.
30:.I grep.
43:.I grep.
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
55:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:3: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:3: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:22: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:50: style: 4 leading space(s) on input line
an.tmac:<stdin>:51: style: 4 leading space(s) on input line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- bzgrep.1 2025-03-03 15:22:23.982469048 +0000
+++ bzgrep.1.new 2025-03-03 15:24:04.771095265 +0000
@@ -2,32 +2,34 @@
\"for Debian GNU/Linux
.TH BZGREP 1
.SH NAME
-bzgrep, bzfgrep, bzegrep \- search possibly bzip2 compressed files for a
regular expression
+bzgrep, bzfgrep, bzegrep \- search possibly bzip2 compressed files for a
+regular expression
.SH SYNOPSIS
.B bzgrep
[ grep_options ]
-.BI [\ -e\ ] " pattern"
+.BI [\ \-e\ ] " pattern"
.IR filename ".\|.\|."
.br
.B bzegrep
[ egrep_options ]
-.BI [\ -e\ ] " pattern"
+.BI [\ \-e\ ] " pattern"
.IR filename ".\|.\|."
.br
.B bzfgrep
[ fgrep_options ]
-.BI [\ -e\ ] " pattern"
+.BI [\ \-e\ ] " pattern"
.IR filename ".\|.\|."
.SH DESCRIPTION
-.IR Bzgrep
+.I Bzgrep
is used to invoke the
.I grep
-on bzip2-compressed files. All options specified are passed directly to
-.I grep.
+on bzip2-compressed files.
+All options specified are passed directly to
+.IR grep .
If no file is specified, then the standard input is decompressed
if necessary and fed to grep.
Otherwise the given files are uncompressed if necessary and fed to
-.I grep.
+.IR grep .
.PP
If
.I bzgrep
@@ -40,17 +42,22 @@ then
or
.I fgrep
is used instead of
-.I grep.
+.IR grep .
If the GREP environment variable is set,
.I bzgrep
uses it as the
.I grep
-program to be invoked. For example:
+program to be invoked.
+For example:
+.nf
for sh: GREP=fgrep bzgrep string files
for csh: (setenv GREP fgrep; bzgrep string files)
+.fi
.SH AUTHOR
-Charles Levert (char...@comm.polymtl.ca). Adapted to bzip2 by Philippe
+Charles Levert (char...@comm.polymtl.ca).
+Adapted to bzip2 by Philippe
Troin <p...@fifi.org> for Debian GNU/Linux.
-.SH "SEE ALSO"
-grep(1), egrep(1), fgrep(1), bzdiff(1), bzmore(1), bzless(1), bzip2(1)
+.SH SEE ALSO
+.BR grep "(1), " egrep "(1), " fgrep "(1), " bzdiff "(1), " bzmore "(1), " \
+bzless "(1), " bzip2 (1)
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)
-.-
