Package: mupdf
Version: 1.25.1+ds1-5+b2
Severity: minor
Tags: upstream
* 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=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious 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?
troff:<stdin>:31: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:31: warning: TH: second argument is not a numeric expression:
an.tmac:<stdin>:31: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:31: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:31: warning: name 'an-extra3' not defined
an.tmac:<stdin>:31: style: .TH missing fifth argument and second argument ''
not a recognized manual section; specify its title
troff:<stdin>:33: warning: trailing space in the line
troff:<stdin>:1: warning: special character 'u2B05' not defined
troff:<stdin>:1: warning: special character 'uFE0F' not defined
troff:<stdin>:1: warning: special character 'u2B06' not defined
troff:<stdin>:1: warning: special character 'u2B07' 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.17-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.41-4
ii libgl1 1.7.0-1+b2
ii libglut3.12 3.4.0-4
ii libjbig2dec0 0.20-1+b3
ii libjs-sphinxdoc 8.1.3-5
ii libmujs3 1.3.6-1
ii libmupdf25.1 1.25.1+ds1-5+b2
ii libssl3t64 3.4.1-1
ii libx11-6 2:1.8.10-2
ii libxext6 2:1.3.4-1+b3
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)
1 input text line longer than 80 bytes: Several commands can...
1 input text line longer than 80 bytes: The \fIOpenGL\fP bas...
1 input text line longer than 80 bytes: The right mouse butt...
1 input text line longer than 80 bytes: This will open the v...
1 missing date, using "": TH
2 skipping paragraph macro: sp after SH
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
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 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if generated from reStructuredText or rd2
Who is actually generating this man page? Debian or upstream?
Is the generating software out of date?
2:.\" Man page generated from reStructuredText.
416:.\" Generated by docutils manpage writer.
Latest version: docutils (Docutils 0.21.2, Python 3.13.2, 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"
35:The \fIOpenGL\fP based viewer can read \fIPDF\fP, \fIXPS\fP, \fICBZ\fP,
\fIEPUB\fP, & \fIFB2\fP documents as well as typical image formats including
\fISVG\fP\&. It compiles on any platform that has a GLUTlibrary. The latest
release builds on \fILinux\fP, \fIWindows\fP, and \fIMacOS\fP\&.
58:Set the initial zoom level, specified as DPI. The default value is
\fI72\fP\&.
145:Several commands can take a number argument entered before the key, to
modify the command. For example, to zoom to 150 dpi, type \(dq150z\(dq.
-.-.
Split lines longer than 80 characters 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 35, length 289
The \fIOpenGL\fP based viewer can read \fIPDF\fP, \fIXPS\fP, \fICBZ\fP,
\fIEPUB\fP, & \fIFB2\fP documents as well as typical image formats including
\fISVG\fP\&. It compiles on any platform that has a GLUTlibrary. The latest
release builds on \fILinux\fP, \fIWindows\fP, and \fIMacOS\fP\&.
Line 117, length 91
This will open the viewer with a file browser which allows you to choose the
file you need.
Line 142, length 84
The right mouse button selects a region and copies the marked text to the
clipboard.
Line 145, length 142
Several commands can take a number argument entered before the key, to modify
the command. For example, to zoom to 150 dpi, type \(dq150z\(dq.
Longest line is number 35 with 289 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:55:Load an ICC profile to use for display (default is sRGB).
mupdf-gl.1:99:Set black tint color (default \fI303030\fP).
mupdf-gl.1:102:Set white tint color (default \fIFFFFF0\fP).
mupdf-gl.1:105:Set UI scaling factor (default calculated from screen DPI).
mupdf-gl.1:140:The middle mouse button (scroll wheel button) pans the document
view.
mupdf-gl.1:194:Save document (only for \fIPDF\fP).
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\\&\././g'".
35:The \fIOpenGL\fP based viewer can read \fIPDF\fP, \fIXPS\fP, \fICBZ\fP,
\fIEPUB\fP, & \fIFB2\fP documents as well as typical image formats including
\fISVG\fP\&. It compiles on any platform that has a GLUTlibrary. The latest
release builds on \fILinux\fP, \fIWindows\fP, and \fIMacOS\fP\&.
58:Set the initial zoom level, specified as DPI. The default value is
\fI72\fP\&.
-.-.
Only one space character after a possible end of sentence
(after a punctuation, that can end a sentence).
mupdf-gl.1:35:The \fIOpenGL\fP based viewer can read \fIPDF\fP, \fIXPS\fP,
\fICBZ\fP, \fIEPUB\fP, & \fIFB2\fP documents as well as typical image formats
including \fISVG\fP\&. It compiles on any platform that has a GLUTlibrary. The
latest release builds on \fILinux\fP, \fIWindows\fP, and \fIMacOS\fP\&.
mupdf-gl.1:58:Set the initial zoom level, specified as DPI. The default value
is \fI72\fP\&.
mupdf-gl.1:145:Several commands can take a number argument entered before the
key, to modify the command. For example, to zoom to 150 dpi, type \(dq150z\(dq.
-.-.
Put a subordinate sentence (after a comma) on a new line.
mupdf-gl.1:35:The \fIOpenGL\fP based viewer can read \fIPDF\fP, \fIXPS\fP,
\fICBZ\fP, \fIEPUB\fP, & \fIFB2\fP documents as well as typical image formats
including \fISVG\fP\&. It compiles on any platform that has a GLUTlibrary. The
latest release builds on \fILinux\fP, \fIWindows\fP, and \fIMacOS\fP\&.
mupdf-gl.1:58:Set the initial zoom level, specified as DPI. The default value
is \fI72\fP\&.
mupdf-gl.1:129:This will open a specific file, in inverted color mode, on page
10.
mupdf-gl.1:145:Several commands can take a number argument entered before the
key, to modify the command. For example, to zoom to 150 dpi, type \(dq150z\(dq.
mupdf-gl.1:312:\fBâ¬
ï¸â¡ï¸â¬ï¸â¬ï¸\fP or \fBh\fP, \fBj\fP, \fBk\fP,
\fBl\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:31:.TH "MUPDF-GL" "" "" ""
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:31: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:31: warning: TH: second argument is not a numeric expression:
an.tmac:<stdin>:31: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:31: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:31: warning: name 'an-extra3' not defined
an.tmac:<stdin>:31: style: .TH missing fifth argument and second argument ''
not a recognized manual section; specify its title
troff:<stdin>:33: warning: trailing space in the line
troff:<stdin>:1: warning: special character 'u2B05' not defined
troff:<stdin>:1: warning: special character 'uFE0F' not defined
troff:<stdin>:1: warning: special character 'u2B06' not defined
troff:<stdin>:1: warning: special character 'u2B07' not defined
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Put data, that are wider than the header in a centered last column,
in a "T{\n...\nT}" block.
Table headers, that are wider than any data in the corresponding column,
do not need to be centered, so left adjustment (l, L) is sufficient.
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
-.-
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)
-.-
