Package: texlive-latex-recommended
Version: 2025.20250927-4
Severity: minor
Tags: patch

>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-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

troff:<stdin>:86: warning: special character 'uFFFD' not defined

   * 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.16.12+deb14+1-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-latex-recommended depends on:
ii  tex-common          6.19
ii  texlive-base        2025.20250927-4
ii  texlive-binaries    2025.20250727.75242+ds-4
ii  texlive-latex-base  2025.20250927-4

texlive-latex-recommended recommends no packages.

Versions of packages texlive-latex-recommended suggests:
pn  texlive-latex-recommended-doc  <none>
ii  texlive-luatex                 2025.20250927-4
pn  texlive-pstricks               <none>

Versions of packages tex-common depends on:
ii  ucf  3.0052

Versions of packages tex-common suggests:
pn  debhelper  <none>

Versions of packages texlive-latex-recommended is related to:
ii  tex-common        6.19
ii  texlive-binaries  2025.20250727.75242+ds-4

-- no debconf information
Input file is thumbpdf.1

Output from "mandoc -T lint  thumbpdf.1": (shortened list)

      1 ERROR: skipping bad character: 0xc2
     47 STYLE: whitespace at end of input line
      7 WARNING: skipping paragraph macro: PP after SH
     12 WARNING: skipping paragraph macro: PP empty

Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>

-.-.

Output from
test-nroff -mandoc -t -ww -z thumbpdf.1: (shortened list)

      1 special character 'uFFFD' not defined

Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>

-.-.

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

47

-.-.

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.

thumbpdf.1:52:(0-9; default: 9)

-.-.

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 "\-\-".

thumbpdf.1:30:.IP "\fB--help\fP" 
thumbpdf.1:32:.IP "\fB--(no)makepng\fP" 
thumbpdf.1:34:.IP "\fB--(no)makepdf\fP" 
thumbpdf.1:37:.IP "\fB--(no)makedef\fP" 
thumbpdf.1:40:.IP "\fB--(no)quiet\fP" 
thumbpdf.1:42:.IP "\fB--(no)verbose\fP" 
thumbpdf.1:44:.IP "\fB--(no)debug\fP" 
thumbpdf.1:47:.IP "\fB--resolution\fP \fIres\fP" 
thumbpdf.1:50:.IP "\fB--compress\fP \fIn\fP" 
thumbpdf.1:53:.IP "\fB--device\fP | \fBpng\fP\fIdev\fP" 

-.-.

Reduce space between words.

thumbpdf.1:9:\fBthumbpdf\fP [ \fIOPTION\fP\&.\&.\&. ]  \fIPDF_FILE\fP

-.-.

Wrong distance (not two spaces) 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"

9:\fBthumbpdf\fP [ \fIOPTION\fP\&.\&.\&. ]  \fIPDF_FILE\fP
94:This manual page was written by C\&.M\&. Connelly for the Debian
95:GNU/Linux system\&. It is now maintained as part of TeX Live.

-.-.

Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".

thumbpdf.1:14:within a PDF (Portable Document Format) document\&.
thumbpdf.1:33:make PNG thumbnail images (default: true)
thumbpdf.1:36:thumbnails (default: true)
thumbpdf.1:39:read in (default: true)
thumbpdf.1:41:suppress messages (default: false)
thumbpdf.1:43:verbose messages (default: false)
thumbpdf.1:87:version 1, or (at your option) a later version of the LaTeX 
Project

-.-.

No need for '\&' to be in front of a period (.),
if there is a character in front of it.

Remove with "sed -e 's/\(.\)\\&\./\1./g'".

9:\fBthumbpdf\fP [ \fIOPTION\fP\&.\&.\&. ]  \fIPDF_FILE\fP
14:within a PDF (Portable Document Format) document\&.
18:First run \fBpdftex\fP(1) on your document to create a PDF file\&.
21:in the PDF file\&.  Finally, run \fBpdftex\fP(1) on your file again to
22:create the final PDF file\&.
26:containing the thumbnail images\&.
51:\epdfcompresslevel for \fBthumbpdf\&.pdf\fP
61:.IP "\fIthumb\fPnn\fI\&.png\fP" 
63:.IP "\fIthumbpdf\&.pdf\fP" 
65:.IP "\fIthumbpdf\&.tex\fP" 
68:.IP "\fIthumbpdf\&.log\fP" 
70:.IP "\fIthumbpdf\&.sty\fP" 
76:\fBgs\fP(1), \fBpdftex\fP(1)\&.
86:Copyright Â\[co] 1999\&.  \fBthumbpdf\fP is distributed under
88:Public License\&.
94:This manual page was written by C\&.M\&. Connelly for the Debian
95:GNU/Linux system\&. It is now maintained as part of TeX Live.

-.-.

Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).

[List of affected lines removed.]


thumbpdf.1:9:\fBthumbpdf\fP [ \fIOPTION\fP\&.\&.\&. ]  \fIPDF_FILE\fP
thumbpdf.1:94:This manual page was written by C\&.M\&. Connelly for the Debian
thumbpdf.1:95:GNU/Linux system\&. It is now maintained as part of TeX Live.

-.-.

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.

thumbpdf.1:1:.TH "thumbpdf" "1" "8 March 2022" "TeX Live"
thumbpdf.1:3:.SH "NAME" 
thumbpdf.1:7:.SH "SYNOPSIS" 
thumbpdf.1:11:.SH "DESCRIPTION" 
thumbpdf.1:16:.SH "USAGE" 
thumbpdf.1:28:.SH "OPTIONS" 
thumbpdf.1:30:.IP "\fB--help\fP" 
thumbpdf.1:32:.IP "\fB--(no)makepng\fP" 
thumbpdf.1:34:.IP "\fB--(no)makepdf\fP" 
thumbpdf.1:37:.IP "\fB--(no)makedef\fP" 
thumbpdf.1:40:.IP "\fB--(no)quiet\fP" 
thumbpdf.1:42:.IP "\fB--(no)verbose\fP" 
thumbpdf.1:44:.IP "\fB--(no)debug\fP" 
thumbpdf.1:59:.SH "FILES" 
thumbpdf.1:61:.IP "\fIthumb\fPnn\fI\&.png\fP" 
thumbpdf.1:63:.IP "\fIthumbpdf\&.pdf\fP" 
thumbpdf.1:65:.IP "\fIthumbpdf\&.tex\fP" 
thumbpdf.1:68:.IP "\fIthumbpdf\&.log\fP" 
thumbpdf.1:70:.IP "\fIthumbpdf\&.sty\fP" 
thumbpdf.1:80:.SH "BUGS" 
thumbpdf.1:84:.SH "COPYRIGHT" 
thumbpdf.1:90:.SH "AUTHOR" 

-.-.

Space character after a macro call.

2:.PP 
3:.SH "NAME" 
6:.PP 
7:.SH "SYNOPSIS" 
8:.PP 
10:.PP 
11:.SH "DESCRIPTION" 
12:.PP 
15:.PP 
16:.SH "USAGE" 
17:.PP 
23:.PP 
27:.PP 
28:.SH "OPTIONS" 
29:.PP 
30:.IP "\fB--help\fP" 
32:.IP "\fB--(no)makepng\fP" 
34:.IP "\fB--(no)makepdf\fP" 
37:.IP "\fB--(no)makedef\fP" 
40:.IP "\fB--(no)quiet\fP" 
42:.IP "\fB--(no)verbose\fP" 
44:.IP "\fB--(no)debug\fP" 
47:.IP "\fB--resolution\fP \fIres\fP" 
50:.IP "\fB--compress\fP \fIn\fP" 
53:.IP "\fB--device\fP | \fBpng\fP\fIdev\fP" 
58:.PP 
59:.SH "FILES" 
60:.PP 
61:.IP "\fIthumb\fPnn\fI\&.png\fP" 
63:.IP "\fIthumbpdf\&.pdf\fP" 
65:.IP "\fIthumbpdf\&.tex\fP" 
68:.IP "\fIthumbpdf\&.log\fP" 
70:.IP "\fIthumbpdf\&.sty\fP" 
73:.PP 
74:.SH "SEE ALSO" 
75:.PP 
77:.PP 
79:.PP 
80:.SH "BUGS" 
81:.PP 
83:.PP 
84:.SH "COPYRIGHT" 
85:.PP 
89:.PP 
90:.SH "AUTHOR" 
91:.PP 
93:.PP 

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

troff:<stdin>:86: warning: special character 'uFFFD' not defined

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.

-.-
--- thumbpdf.1  2025-11-04 18:27:29.730831767 +0000
+++ thumbpdf.1.new      2025-11-04 18:56:26.916663510 +0000
@@ -1,95 +1,76 @@
 .TH "thumbpdf" "1" "8 March 2022" "TeX Live"
-.PP 
-.SH "NAME" 
+.SH "NAME"
 thumbpdf \- generate thumbnail images for a PDF file
 created with \fBpdftex\fP
-.PP 
-.SH "SYNOPSIS" 
-.PP 
-\fBthumbpdf\fP [ \fIOPTION\fP\&.\&.\&. ]  \fIPDF_FILE\fP
-.PP 
-.SH "DESCRIPTION" 
-.PP 
+.SH "SYNOPSIS"
+\fBthumbpdf\fP [ \fIOPTION\fP...\& ] \fIPDF_FILE\fP
+.SH "DESCRIPTION"
 \fBthumbpdf\fP is used to create thumbnail images of individual pages
 within a PDF (Portable Document Format) document\&.
-.PP 
-.SH "USAGE" 
-.PP 
+.SH "USAGE"
 First run \fBpdftex\fP(1) on your document to create a PDF file\&.
 Then run \fBthumbpdf\fP to generate the thumbnails, a PDF file
 containing the thumbnails, and a pdfTeX file to include the thumbnails
 in the PDF file\&.  Finally, run \fBpdftex\fP(1) on your file again to
 create the final PDF file\&.
-.PP 
+.PP
 \fBthumbpdf\fP calls \fBgs\fP(1) to generate PNG images of the pages
 within \fIPDF_FILE\fP, and \fBpdftex\fP(1) to create a PDF file
 containing the thumbnail images\&.
-.PP 
-.SH "OPTIONS" 
-.PP 
-.IP "\fB--help\fP" 
+.SH "OPTIONS"
+.IP "\fB\-\-help\fP"
 print usage
-.IP "\fB--(no)makepng\fP" 
+.IP "\fB\-\-(no)makepng\fP"
 make PNG thumbnail images (default: true)
-.IP "\fB--(no)makepdf\fP" 
+.IP "\fB\-\-(no)makepdf\fP"
 generate new PDF file containing the
 thumbnails (default: true)
-.IP "\fB--(no)makedef\fP" 
+.IP "\fB\-\-(no)makedef\fP"
 create a TeX file for \fBpdftex\fP(1) to
 read in (default: true)
-.IP "\fB--(no)quiet\fP" 
+.IP "\fB\-\-(no)quiet\fP"
 suppress messages (default: false)
-.IP "\fB--(no)verbose\fP" 
+.IP "\fB\-\-(no)verbose\fP"
 verbose messages (default: false)
-.IP "\fB--(no)debug\fP" 
+.IP "\fB\-\-(no)debug\fP"
 print debugging information while parsing
 (default: false)
-.IP "\fB--resolution\fP \fIres\fP" 
+.IP "\fB\-\-resolution\fP \fIres\fP"
 resolution for GhostScript step
 (default: 9)
-.IP "\fB--compress\fP \fIn\fP" 
+.IP "\fB\-\-compress\fP \fIn\fP"
 \epdfcompresslevel for \fBthumbpdf\&.pdf\fP
-(0-9; default: 9)
-.IP "\fB--device\fP | \fBpng\fP\fIdev\fP" 
+(0\(en9; default: 9)
+.IP "\fB\-\-device\fP | \fBpng\fP\fIdev\fP"
 GhostScript PNG device;
 \fIdev\fP = `mono\', `gray\',
 `16\', `256\', `16m\' (default:
 `png16m\')
-.PP 
-.SH "FILES" 
-.PP 
-.IP "\fIthumb\fPnn\fI\&.png\fP" 
+.SH "FILES"
+.IP "\fIthumb\fPnn\fI\&.png\fP"
 PNG thumbnail images
-.IP "\fIthumbpdf\&.pdf\fP" 
+.IP "\fIthumbpdf\&.pdf\fP"
 PDF file containing thumbnail images
-.IP "\fIthumbpdf\&.tex\fP" 
+.IP "\fIthumbpdf\&.tex\fP"
 A pdfTeX program to include the thumbnails
 file
-.IP "\fIthumbpdf\&.log\fP" 
+.IP "\fIthumbpdf\&.log\fP"
 pdfTeX log file
-.IP "\fIthumbpdf\&.sty\fP" 
+.IP "\fIthumbpdf\&.sty\fP"
 a LaTeX package to be included in files
 for which a user wants to generate thumbnails
-.PP 
-.SH "SEE ALSO" 
-.PP 
+.SH "SEE ALSO"
 \fBgs\fP(1), \fBpdftex\fP(1)\&.
-.PP 
+.PP
 Web page: <https://ctan.org/pkg/thumbpdf/>
-.PP 
-.SH "BUGS" 
-.PP 
+.SH "BUGS"
 Submit reports via the bug url on the CTAN package page.
-.PP 
-.SH "COPYRIGHT" 
-.PP 
-Copyright Â\[co] 1999\&.  \fBthumbpdf\fP is distributed under
+.SH "COPYRIGHT"
+Copyright \[co] 1999\&.  \fBthumbpdf\fP is distributed under
 version 1, or (at your option) a later version of the LaTeX Project
 Public License\&.
-.PP 
-.SH "AUTHOR" 
-.PP 
+.SH "AUTHOR"
 \fBthumbpdf\fP was written by Heiko Oberdiek.
-.PP 
-This manual page was written by C\&.M\&. Connelly for the Debian
-GNU/Linux system\&. It is now maintained as part of TeX Live.
+.PP
+This manual page was written by C.M.\& Connelly for the Debian
+GNU/Linux system.  It is now maintained as part of TeX Live.
  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.

  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)

-.-

Reply via email to