Package: texlive-extra-utils
Version: 2025.20251127-2
Severity: minor
Tags: patch
Dear Maintainer,
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* 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=0 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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?
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
an.tmac:<stdin>:8: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:9: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split the argument.
troff:<stdin>:30: warning: name 'NF' not defined
troff:<stdin>:46: warning: name 'FI' not defined
lexgrog: show-pdf-tags.1: parse failed
* 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.17.13+deb14-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 texlive-extra-utils depends on:
ii libfile-homedir-perl 1.006-2
ii libunicode-linebreak-perl 0.0.20190101-1+b9
ii libyaml-tiny-perl 1.76-1
ii python3 3.13.7-1+b1
ii tex-common 6.20
ii texlive-base 2025.20251127-1
ii texlive-binaries 2025.20250727.75242+ds-5
ii texlive-latex-base 2025.20251127-1
ii texlive-luatex 2025.20251127-1
ii texlive-plain-generic 2025.20251127-2
Versions of packages texlive-extra-utils recommends:
ii ghostscript 10.06.0~dfsg-3
pn liblog-log4perl-perl <none>
ii ruby 1:3.3+b1
ii texlive-latex-recommended 2025.20251127-1
Versions of packages texlive-extra-utils suggests:
pn chktex <none>
pn default-jre-headless <none>
pn dvidvi <none>
pn dvipng <none>
pn fragmaster <none>
pn lacheck <none>
pn latexdiff <none>
pn latexmk <none>
pn purifyeps <none>
pn xindy <none>
Versions of packages tex-common depends on:
ii bzip2 1.0.8-6
ii ucf 3.0052
Versions of packages tex-common suggests:
pn debhelper <none>
Versions of packages texlive-extra-utils is related to:
ii tex-common 6.20
ii texlive-binaries 2025.20250727.75242+ds-5
-- no debconf information
Input file is show-pdf-tags.1
Output from "mandoc -T lint show-pdf-tags.1": (shortened list)
1 ERROR: skipping unknown macro: .FI
1 ERROR: skipping unknown macro: .NF
1 WARNING: skipping paragraph macro: PP empty
1 WARNING: skipping paragraph macro: sp after PP
-.-.
Output from
test-nroff -mandoc -t -ww -z show-pdf-tags.1: (shortened list)
2 Use macro '.I' for one argument or split the argument.
2 .RI is for at least 2 arguments, got 1
1 name 'FI' not defined
1 name 'NF' not defined
-.-.
Input file is show-pdf-tags.1
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
show-pdf-tags.1:56:Copyright (C) 2024-2025 The LaTeX Project
-.-.
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 "\-\-".
show-pdf-tags.1:21:structure elements unless the \fB--map\fR option is used, in
which case the
show-pdf-tags.1:32: \fB--help|-h\fR Prints this message and exits
show-pdf-tags.1:34: \fB--ignore-case\fR Ignore case when sorting directory
listing
show-pdf-tags.1:36: \fB--tree\fR (default) Show as tree
show-pdf-tags.1:38: \fB--xml\fR Show as XML
show-pdf-tags.1:40: \fB--table\fR Show Lua table structure
show-pdf-tags.1:42: \fB--map\fR Follow role mapping (xml printer)
show-pdf-tags.1:44: \fB--w3c-\fR Add - to w3c namespaces to force
browser display
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
show-pdf-tags.1:17:using Unicode line characters, or as XML, or (primarily for
debugging)
show-pdf-tags.1:42: \fB--map\fR Follow role mapping (xml printer)
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
show-pdf-tags.1:1:.TH SHOW-PDF-TAGS 1 "2025-01-28" "LaTeX"
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
an.tmac:<stdin>:8: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:9: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split the argument.
troff:<stdin>:30: warning: name 'NF' not defined
troff:<stdin>:46: warning: name 'FI' not defined
lexgrog: show-pdf-tags.1: parse failed
-.-.
Additionally:
Macro 'NF' is request 'nf' (no filling)
Macro 'FI' is request 'fi' (filling, default behaviour)
-.-.
Spelling (codespell):
mmatching -> matching
maping -> mapping
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- show-pdf-tags.1 2025-12-30 21:56:31.054610423 +0000
+++ show-pdf-tags.1.new 2025-12-30 22:20:31.748680244 +0000
@@ -1,50 +1,48 @@
-.TH SHOW-PDF-TAGS 1 "2025-01-28" "LaTeX"
+.TH SHOW-PDF-TAGS 1 2025-01-28 LaTeX
.SH NAME
-show-pdf-tags
+show-pdf-tags \- show the internal Structure Tree of a tagged PDF file
.SH SYNOPSIS
-.B show-pdf-tags
-.RI [<options>]
-.RI <PDF-File>
+.B show-pdf-tags
+.RI [ <options> ]
+.I <PDF-File>
.SH DESCRIPTION
-The \fBshow-pdf-tags\fR script shows the internal Structure Tree
+The \fBshow-pdf-tags\fR script shows the internal Structure Tree
of a tagged PDF File.
The structure may be shown using an indented tree display
using Unicode line characters, or as XML, or (primarily for debugging)
as a linearisation of the Lua table structure obtained from the PDF file.
-The XML display will use element names mmatching the names of the
-structure elements unless the \fB--map\fR option is used, in which case the
+The XML display will use element names matching the names of the
+structure elements unless the \fB\-\-map\fR option is used, in which case the
standard PDF Structure element names will be used, as specified in the
-role maping in the file.
+role mapping in the file.
It accepts a single PDF File and outputs to the standard
output stream.
Valid <options> are:
-.NF
+.nf
.TP
- \fB--help|-h\fR Prints this message and exits
+ \fB\-\-help|-h\fR Prints this message and exits
.TP
- \fB--ignore-case\fR Ignore case when sorting directory listing
+ \fB\-\-ignore-case\fR Ignore case when sorting directory listing
.TP
- \fB--tree\fR (default) Show as tree
+ \fB\-\-tree\fR (default) Show as tree
.TP
- \fB--xml\fR Show as XML
+ \fB\-\-xml\fR Show as XML
.TP
- \fB--table\fR Show Lua table structure
+ \fB\-\-table\fR Show Lua table structure
.TP
- \fB--map\fR Follow role mapping (xml printer)
+ \fB\-\-map\fR Follow role mapping (xml printer)
.TP
- \fB--w3c-\fR Add - to w3c namespaces to force browser display
-.PP
-.FI
-
+ \fB\-\-w3c-\fR Add - to w3c namespaces to force browser display
+.fi
.SH "SEE ALSO"
Full manual available via 'texdoc show-pdf-tags'.
@@ -53,4 +51,4 @@ Repository : https://github.com/latex3/p
Bug tracker: https://github.com/latex3/pdf_structure/issues
.SH AUTHORS
-Copyright (C) 2024-2025 The LaTeX Project
+Copyright (C) 2024\(en2025 The LaTeX Project
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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
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 when that has been fixed.
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)
-.-
