Package: bin86
Version: 0.16.17-3.6
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
[test-]groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
<stdin>:2: Content of macro 'BY' is Shyamal Prasad <shya...@member.fsf.org>
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: 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.10.9-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 bin86 depends on:
ii libc6 2.40-2
bin86 recommends no packages.
bin86 suggests no packages.
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <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 outputs 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 objdump86.1": (possibly shortened list)
mandoc: objdump86.1:2:2: ERROR: skipping unknown macro: .BY Shyamal Prasad
<shya...@member.fsf.org>
mandoc: objdump86.1:7:15: STYLE: whitespace at end of input line
mandoc: objdump86.1:10:11: STYLE: whitespace at end of input line
mandoc: objdump86.1:13:10: STYLE: whitespace at end of input line
mandoc: objdump86.1:22:9: STYLE: whitespace at end of input line
mandoc: objdump86.1:38:4: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
7:.BI objdump86
10:.B size86
13:.BI nm86
22:.B nm86
38:and
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
7:.BI objdump86
13:.BI nm86
41:.BR objdump86
-.-.
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.
48:.B -s
52:.B -n
-.-.
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.
17:These commands are used to examine the contents of object files. They
18:may also be used to examine archive or executable files. When archive
29:decodes and displays the contents of the object files specified. This
42:in the source distribution). The result of running this executable is
70:Prasad <shya...@member.fsf.org>. It is distributed under the terms of
-.-.
Output from "test-groff -b -mandoc -rF0 -rHY=0 -K utf8 -t -ww -z ":
<stdin>:2: Content of macro 'BY' is Shyamal Prasad <shya...@member.fsf.org>
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: warning: trailing space in the line
--- objdump86.1 2024-09-18 10:02:57.445397034 +0000
+++ objdump86.1.new 2024-09-18 21:21:03.455519797 +0000
@@ -1,55 +1,59 @@
+.de BY
+Written by \\$*
+..
.TH objdump86 1 "May, 2006"
-.BY Shyamal Prasad <shya...@member.fsf.org>
+.BY Shyamal Prasad <shya...@member.fsf.org>.
.nh
.SH NAME
objdump86, size86, nm86 \- Examine object, archive or executable files
.SH SYNOPSIS
-.BI objdump86
+.B objdump86
.RI [ file ...]
.PP
-.B size86
+.B size86
.RI [ file ...]
.PP
-.BI nm86
+.BI nm86
.RI [ file ...]
.SH DESCRIPTION
-These commands are used to examine the contents of object files. They
-may also be used to examine archive or executable files. When archive
-files are examined each module in the archive will be processed in
-sequence.
+These commands are used to examine the contents of object files.
+They may also be used to examine archive or executable files.
+When archive files are examined each module in the archive will be processed
+in sequence.
.PP
-.B nm86
+.B nm86
prints the symbol table in each of the specified files.
.PP
.B size86
displays a summary of the sizes of the segments in each of the files.
.PP
.B objdump86
-decodes and displays the contents of the object files specified. This
-includes the section headers, symbols tables, segment sizes, and
-segment contents.
+decodes and displays the contents of the object files specified.
+This includes the section headers,
+symbols tables, segment sizes, and segment contents.
.SH OPTIONS
The programs are not designed to accept any options.
.PP
It should be noted that all three of
.BR objdump86 ,
.BR size86 ,
-and
+and
.B nm86
are implemented as links to the same executable file (called
-.BR objdump86
-in the source distribution). The result of running this executable is
-determined by the file name actually used to execute it.
+.B objdump86
+in the source distribution).
+The result of running this executable is determined by the file name
+actually used to execute it.
.PP
It is possible to force a specific behavior irrespective of the
invocation file name using one of the options below
.TP
-.B -s
+.B \-s
Behave like
.BR size86 .
.TP
-.B -n
+.B \-n
Behave like
.BR nm86 .
.SH RESTRICTIONS
@@ -67,10 +71,6 @@ and
\(co 1999 Greg Haerr <g...@censoft.com>.
.SH COPYRIGHT
The manual page was written for Debian GNU/Linux, \(co 2006 Shyamal
-Prasad <shya...@member.fsf.org>. It is distributed under the terms of
-the GNU General Public License version 2 (or any later version
-released by the Free Software Foundation).
-.tm objdump86.1: next trap is \n(.t
-.de BY
-Written by \\$*
-..
+Prasad <shya...@member.fsf.org>.
+It is distributed under the terms of the GNU General Public License version 2
+(or any later version released by the Free Software Foundation).
