Package: bzip2
Version: 1.0.8-6
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[Use "groff -e ' $' <file>" to find 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?
troff: backtrace: file '<stdin>':81
troff:<stdin>:81: warning: trailing space in the line
troff: backtrace: file '<stdin>':86
troff:<stdin>:86: warning: trailing space in the line
troff: backtrace: file '<stdin>':108
troff:<stdin>:108: warning: trailing space in the line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':81
troff:<stdin>:81: warning: trailing space in the line
troff: backtrace: file '<stdin>':86
troff:<stdin>:86: warning: trailing space in the line
troff: backtrace: file '<stdin>':108
troff:<stdin>:108: warning: trailing space in the 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.11.10-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-3
bzip2 recommends no packages.
Versions of packages bzip2 suggests:
pn bzip2-doc <none>
-- no debconf information
Input file is bzmore.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
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
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 -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 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 -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint bzmore.1 ": (shortened list)
1 missing date, using ""
15 skipping paragraph macro
4 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -b -z bzmore.1 ": (shortened list)
3 trailing space in the line
-.-.
Output from "mandoc -T lint bzmore.1 ":
mandoc: bzmore.1:3:2: WARNING: missing date, using "": TH
mandoc: bzmore.1:51:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:56:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:62:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:65:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:70:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:73:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:76:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:79:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:81:36: STYLE: whitespace at end of input line
mandoc: bzmore.1:84:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:86:36: STYLE: whitespace at end of input line
mandoc: bzmore.1:89:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:89:4: STYLE: whitespace at end of input line
mandoc: bzmore.1:92:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:103:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:106:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:108:37: STYLE: whitespace at end of input line
mandoc: bzmore.1:111:2: WARNING: skipping paragraph macro: PP empty
mandoc: bzmore.1:115:2: WARNING: skipping paragraph macro: PP empty
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
81:When the prompt --More--(Next file:
86:When the prompt --More--(Next file:
89:.PP
108:invoke a shell with \fIcommand\|\fP.
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
bzmore.1:34:normally pauses after each screenful, printing --More--
bzmore.1:81:When the prompt --More--(Next file:
bzmore.1:86:When the prompt --More--(Next file:
bzmore.1:125:--More-- message.
bzmore.1:130:will stop sending output, and will display the usual --More--
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
110:previous shell command. The sequence "\\!" is replaced by "!".
128:hit the quit key (normally control\-\\).
-.-.
Split a punctuation from a single argument, if a two-font macro is meant
20:.I more.
146:.I bzcat,
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
152:more(1), less(1), bzip2(1), bzdiff(1), bzgrep(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
bzmore.1:55:more lines, (or another screenful if no argument is given)
bzmore.1:58:display 11 more lines (a ``scroll'').
bzmore.1:128:hit the quit key (normally control\-\\).
-.-.
Two or more space charaters between printable characters.
When the distance is between sentences,
start the beginning of the second one on a separate line
("semantic newline", see man-pages(7)).
8:[ name ... ]
11:[ name ... ]
22:.I Bzmore
38:another screenful is displayed. Other possibilities are enumerated later.
68:window size. Note that the window size reverts back to the default at the
110:previous shell command. The sequence "\\!" is replaced by "!".
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':81
troff:<stdin>:81: warning: trailing space in the line
troff: backtrace: file '<stdin>':86
troff:<stdin>:86: warning: trailing space in the line
troff: backtrace: file '<stdin>':108
troff:<stdin>:108: warning: trailing space in the line
-.-.
Additionally (general):
FSF office address update. See
https://lists.gnu.org/archive/html/bug-gnulib/2024-09/msg00004.html
-.-
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
Table headers, that are wider than any data in the corresponding column,
do not need to be centered, so left adjustment is sufficient.
The default value for kerning (.kern) and ligature (.lg) is one (1),
so for n-mode (nroff) it should be set to zero (0) to avoid the processing
of unnecessary code.
--- bzmore.1 2024-12-04 18:04:33.710514227 +0000
+++ bzmore.1.new 2024-12-04 18:21:24.730415328 +0000
@@ -1,14 +1,14 @@
.\"Shamelessly copied from zmore.1 by Philippe Troin <p...@fifi.org>
.\"for Debian GNU/Linux
-.TH BZMORE 1
+.TH BZMORE 1 ""\" Date is missing
.SH NAME
bzmore, bzless \- file perusal filter for crt viewing of bzip2 compressed text
.SH SYNOPSIS
.B bzmore
-[ name ... ]
+.RI "[ " name " ... ]"
.br
.B bzless
-[ name ... ]
+.RI "[ " name " ... ]"
.SH NOTE
In the following description,
.I bzless
@@ -17,9 +17,9 @@ and
can be used interchangeably with
.I bzmore
and
-.I more.
+.IR more .
.SH DESCRIPTION
-.I Bzmore
+.B Bzmore
is a filter which allows examination of compressed or plain text files
one screenful at a time on a soft-copy terminal.
.I bzmore
@@ -35,7 +35,8 @@ normally pauses after each screenful, pr
at the bottom of the screen.
If the user then types a carriage return, one more line is displayed.
If the user hits a space,
-another screenful is displayed. Other possibilities are enumerated later.
+another screenful is displayed.
+Other possibilities are enumerated later.
.PP
.I Bzmore
looks in the file
@@ -48,48 +49,39 @@ Other sequences which may be typed when
.I bzmore
pauses, and their effects, are as follows (\fIi\fP is an optional integer
argument, defaulting to 1) :
-.PP
.IP \fIi\|\fP<space>
display
.I i
-more lines, (or another screenful if no argument is given)
-.PP
+more lines,
+(or another screenful if no argument is given)
.IP ^D
-display 11 more lines (a ``scroll'').
+display 11 more lines
+(a ``scroll'').
If
.I i
is given, then the scroll size is set to \fIi\|\fP.
-.PP
.IP d
same as ^D (control-D)
-.PP
.IP \fIi\|\fPz
same as typing a space except that \fIi\|\fP, if present, becomes the new
window size. Note that the window size reverts back to the default at the
end of the current file.
-.PP
.IP \fIi\|\fPs
skip \fIi\|\fP lines and print a screenful of lines
-.PP
.IP \fIi\|\fPf
skip \fIi\fP screenfuls and print a screenful of lines
-.PP
.IP "q or Q"
quit reading the current file; go on to the next (if any)
-.PP
.IP "e or q"
-When the prompt --More--(Next file:
+When the prompt --More--(Next file:
.IR file )
is printed, this command causes bzmore to exit.
-.PP
.IP s
-When the prompt --More--(Next file:
+When the prompt --More--(Next file:
.IR file )
is printed, this command causes bzmore to skip the next file and continue.
-.PP
.IP =
Display the current line number.
-.PP
.IP \fIi\|\fP/expr
search for the \fIi\|\fP-th occurrence of the regular expression \fIexpr.\fP
If the pattern is not found,
@@ -100,19 +92,16 @@ where the expression was found.
The user's erase and kill characters may be used to edit the regular
expression.
Erasing back past the first column cancels the search command.
-.PP
.IP \fIi\|\fPn
search for the \fIi\|\fP-th occurrence of the last regular expression entered.
-.PP
.IP !command
-invoke a shell with \fIcommand\|\fP.
+invoke a shell with \fIcommand\|\fP.
The character `!' in "command" are replaced with the
-previous shell command. The sequence "\\!" is replaced by "!".
-.PP
+previous shell command.
+The sequence "\e!" is replaced by "!".
.IP ":q or :Q"
quit reading the current file; go on to the next (if any)
(same as q or Q).
-.PP
.IP .
(dot) repeat the previous command.
.PP
@@ -125,7 +114,8 @@ In addition, the user may hit the erase
--More-- message.
.PP
At any time when output is being sent to the terminal, the user can
-hit the quit key (normally control\-\\).
+hit the quit key
+(normally control\-\e).
.I Bzmore
will stop sending output, and will display the usual --More--
prompt.
@@ -143,10 +133,10 @@ commands.
If the standard output is not a teletype, then
.I bzmore
acts just like
-.I bzcat,
+.IR bzcat ,
except that a header is printed before each file.
.SH FILES
.DT
/etc/termcap Terminal data base
.SH "SEE ALSO"
-more(1), less(1), bzip2(1), bzdiff(1), bzgrep(1)
+.BR more "(1), " less "(1), " bzip2 "(1), " bzdiff "(1), " bzgrep (1)
