Package: mupdf
Version: 1.27.0+ds1-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-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:32: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:32: warning: TH: second argument is not a numeric expression:
troff:<stdin>:32: warning: name 'an-extra3' not defined
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:300: warning: special character 'u2B05' not defined
troff:<stdin>:300: warning: special character 'uFE0F' not defined
troff:<stdin>:300: warning: special character 'u2B06' not defined
troff:<stdin>:300: warning: special character 'u2B07' not defined
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:32: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:32: warning: TH: second argument is not a numeric expression:
troff:<stdin>:32: warning: name 'an-extra3' not defined
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:300: warning: special character 'u2B05' not defined
troff:<stdin>:300: warning: special character 'uFE0F' not defined
troff:<stdin>:300: warning: special character 'u27A1' not defined
troff:<stdin>:300: warning: special character 'u2B06' not defined
troff:<stdin>:300: warning: special character 'u2B07' not defined
lexgrog: mupdf-gl.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 mupdf depends on:
ii libc6 2.42-10+b1
ii libgl1 1.7.0-3
ii libglut3.12 3.4.0-6+b1
ii libjbig2dec0 0.20-1+b4
ii libjs-sphinxdoc 8.2.3-12
ii libmupdf27.0 1.27.0+ds1-2
ii libssl3t64 3.5.4-1+b1
ii libx11-6 2:1.8.12-1+b1
ii libxext6 2:1.3.4-1+b4
mupdf recommends no packages.
Versions of packages mupdf suggests:
pn mupdf-tools <none>
-- no debconf information
Input file is mupdf-gl.1
Output from "mandoc -T lint mupdf-gl.1": (shortened list)
3 STYLE: input text line longer than 80 bytes:
1 STYLE: whitespace at end of input line
1 WARNING: missing date, using "": TH
3 WARNING: skipping paragraph macro: sp after SH
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z mupdf-gl.1: (shortened list)
1
1 name 'an-extra3' not defined
1 special character 'u27A1' not defined
1 special character 'u2B05' not defined
1 special character 'u2B06' not defined
1 special character 'u2B07' not defined
1 special character 'uFE0F' not defined
1 start (0) and end (0) index of substring out of range
1 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Input file is mupdf-gl.1
Show if generated from reStructuredText or rd2
2:.\" Man page generated from reStructuredText
Latest version: docutils (Docutils 0.22.4, Python 3.13.11, on linux)
-.-.
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
1
-.-.
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"
59:Set the initial zoom level, specified as DPI. The default value is
\fB72\fP\&.
-.-.
Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 36, length 114
The mupdf\-gl viewer can show PDF, XPS, CBZ, EPUB, & FB2 documents as well as
typical image formats including SVG.
Line 129, length 84
The right mouse button selects a region and copies the marked text to the
clipboard.
Line 132, length 94
Several key bindings can take a number argument entered before the key, to
modify the command.
Longest line is number 36 with 114 characters
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
mupdf-gl.1:56:Load an ICC profile to use for display (default is sRGB).
mupdf-gl.1:92:Set black tint color (default \fB303030\fP).
mupdf-gl.1:95:Set white tint color (default \fBFFFFF0\fP).
mupdf-gl.1:98:Set UI scaling factor (default calculated from screen DPI).
mupdf-gl.1:127:The middle mouse button (scroll wheel button) pans the document
view.
mupdf-gl.1:182:Save document (only for PDF).
-.-.
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'".
59:Set the initial zoom level, specified as DPI. The default value is
\fB72\fP\&.
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
mupdf-gl.1:59:Set the initial zoom level, specified as DPI. The default value
is \fB72\fP\&.
-.-.
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.
mupdf-gl.1:32:.TH "mupdf-gl" "" "" ""
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:32: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:32: warning: TH: second argument is not a numeric expression:
troff:<stdin>:32: warning: name 'an-extra3' not defined
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:300: warning: special character 'u2B05' not defined
troff:<stdin>:300: warning: special character 'uFE0F' not defined
troff:<stdin>:300: warning: special character 'u2B06' not defined
troff:<stdin>:300: warning: special character 'u2B07' not defined
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:32: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:32: warning: TH: second argument is not a numeric expression:
troff:<stdin>:32: warning: name 'an-extra3' not defined
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:300: warning: special character 'u2B05' not defined
troff:<stdin>:300: warning: special character 'uFE0F' not defined
troff:<stdin>:300: warning: special character 'u27A1' not defined
troff:<stdin>:300: warning: special character 'u2B06' not defined
troff:<stdin>:300: warning: special character 'u2B07' not defined
lexgrog: mupdf-gl.1: parse failed
-.-
Additionally:
Remove '.sp' after a macro '.SH'.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- mupdf-gl.1 2026-01-23 19:50:51.783598580 +0000
+++ mupdf-gl.1.new 2026-01-24 00:58:22.489826357 +0000
@@ -29,10 +29,9 @@ level margin: \\n[rst2man-indent\\n[rst2
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "mupdf-gl" "" "" ""
+.TH mupdf-gl 1 "" ""
.SH Name
-mupdf-gl \-
-.sp
+mupdf-gl \-
The mupdf\-gl viewer can show PDF, XPS, CBZ, EPUB, & FB2 documents as well as
typical image formats including SVG.
.SH Command Line Options
.INDENT 0.0
@@ -56,7 +55,7 @@ The password needed to open a password p
Load an ICC profile to use for display (default is sRGB).
.TP
.B \fB\-r\fP resolution
-Set the initial zoom level, specified as DPI. The default value is \fB72\fP\&.
+Set the initial zoom level, specified as DPI. The default value is \fB72\fP.
.TP
.B \fB\-W\fP width
Set the page width in points for EPUB layout.
@@ -102,7 +101,6 @@ Set UI scaling factor (default calculate
The initial page number to show.
.UNINDENT
.SH Examples
-.sp
To open the viewer with a file browser, just start it:
.INDENT 0.0
.INDENT 3.5
@@ -123,12 +121,10 @@ mupdf\-gl \-I mupdf_explored.pdf 10
.UNINDENT
.UNINDENT
.SH Mouse Bindings
-.sp
The middle mouse button (scroll wheel button) pans the document view.
.sp
The right mouse button selects a region and copies the marked text to the
clipboard.
.SH Key Bindings
-.sp
Several key bindings can take a number argument entered before the key, to
modify the command.
For example, to zoom to 150 dpi, type \(dq150z\(dq.
.TS
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)
-.-
