Package: psutils
Version: 1.17.dfsg-5
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 -ww -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?
an.tmac:<stdin>:47: style: use of deprecated macro: .PD
an.tmac:<stdin>:64: style: use of deprecated macro: .PD
troff:<stdin>:97: 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 psutils depends on:
ii libc6 2.40-4
Versions of packages psutils recommends:
ii ghostscript 10.04.0~dfsg-2
psutils suggests no packages.
-- no debconf information
Input file is extractbb.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 extractbb.1": (shortened list)
11 skipping paragraph macro
12 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z extractbb.1": (shortened list)
1 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
7
-.-.
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.
49:.B -v
52:.B -q
55:.B -O
58:.B -m
61:.B -x
-.-.
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 abbreviation point as such by suffixing them with "\\&".
26:together with some header information. These files can then be used by
28:or other programs. For
83:files. It will always be the first one from the following
84:list: ArtBox, TrimBox, BleedBox, MediaBox. (Often only MediaBox
85:is defined.) Moreover, the reported bounding box always refers
93:<dvipd...@ktug.or.kr>, based on the program \fBebb\fP by Mark A. Wicks.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
extractbb.1:70:The original ebb (from dvipdfm) ignored density information in
bitmap
extractbb.1:75:So, extractbb (from dvipdfmx) uses density information if
present.
-.-.
No need for "\&" to be in front of a period (.) if not at the beginning of
a line.
12:.IR file \&.\&.\&.
96:based on a manual page Frank K\[:u]ster <frank@kuesterei\&.ch>
97:wrote for the Debian GNU/Linux system\&.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:47: style: use of deprecated macro: .PD
an.tmac:<stdin>:64: style: use of deprecated macro: .PD
troff:<stdin>:97: warning: trailing space in the line
-.-.
Additionally (general):
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!
--- extractbb.1 2024-12-18 08:42:17.614461677 +0000
+++ extractbb.1.new 2024-12-18 08:57:39.807613501 +0000
@@ -1,18 +1,13 @@
.TH "EXTRACTBB" "1" "20 April 2012" "20120420" "DVIPDFMx"
-.PP
-.SH "NAME"
+.SH "NAME"
extractbb, ebb \- extract bounding box information from graphics files
-.PP
-.SH "SYNOPSIS"
-.PP
+.SH "SYNOPSIS"
.B extractbb
.RB [ \-v | \-q ]
.RB [ \-O ]
.RB [ \-m | \-x ]
-.IR file \&.\&.\&.
-.PP
-.SH "DESCRIPTION"
-.PP
+.IR file .\|.\|.
+.SH "DESCRIPTION"
For each
.SM JPEG\c
,
@@ -42,29 +37,26 @@ as used by
may be defined as a synomym for
.B extractbb
on your system.
-.PP
-.SH "OPTIONS"
+.SH "OPTIONS"
.PD 0
.TP 10
-.B -v
+.B \-v
Be verbose.
.TP
-.B -q
+.B \-q
Be quiet.
.TP
-.B -O
+.B \-O
Write output to standard output.
.TP
-.B -m
+.B \-m
Write output in dvipdfm's ``bb'' format.
.TP
-.B -x
+.B \-x
Write output in dvipdfmx's ``xbb'' format (default), which is the same
as that used by pdfTeX.
.PD
-.PP
.SH "OUTPUT FORMATS"
-.PP
Here are more details about the bb and xbb formats:
.PP
The original ebb (from dvipdfm) ignored density information in bitmap
@@ -76,7 +68,6 @@ So, extractbb (from dvipdfmx) uses densi
Otherwise, it generates bounding box with 100px = 100bp. This is what
pdfTeX does.
.SH "BUGS"
-.PP
There is currently no way to specify which bounding box is taken
for
.SM PDF
@@ -86,14 +77,12 @@ is defined.) Moreover, the reported boun
to the first page in a
.SM PDF
file.
-.PP
-.SH "AUTHOR"
-.PP
+.SH "AUTHOR"
\fBextractbb\fP was written by the DVIPDFMx project team
<dvipd...@ktug.or.kr>, based on the program \fBebb\fP by Mark A. Wicks.
-.PP
+.PP
This manual page was also written by the DVIPDFMx project team,
-based on a manual page Frank K\[:u]ster <frank@kuesterei\&.ch>
-wrote for the Debian GNU/Linux system\&.
+based on a manual page Frank K\[:u]ster <fr...@kuesterei.ch>
+wrote for the Debian GNU/Linux system.
It may be used, modified, and/or redistributed by others without
-contacting the authors\&.
+contacting the authors.
