[Pkg-gmagick-im-team] Bug#1129978: animate-im7.q16.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Fri Mar 6 23:10:35 GMT 2026
Package: imagemagick-7.q16
Version: 8:7.1.2.15+dfsg1-1
Severity: minor
Tags: patch, upstream
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>:91: warning: trailing space in the line
troff:<stdin>:95: 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.18.15+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 imagemagick-7.q16 depends on:
ii hicolor-icon-theme 0.18-2
ii libc6 2.42-13
ii libmagickcore-7.q16-10 8:7.1.2.15+dfsg1-1
ii libmagickwand-7.q16-10 8:7.1.2.15+dfsg1-1
Versions of packages imagemagick-7.q16 recommends:
ii ghostscript 10.06.0~dfsg-3
pn libmagickcore-7.q16-10-extra <none>
ii netpbm 2:11.13.03-1
Versions of packages imagemagick-7.q16 suggests:
pn autotrace <none>
pn cups-bsd | lpr | lprng <none>
ii curl 8.18.0-2
pn enscript <none>
pn ffmpeg <none>
pn gimp <none>
pn gnuplot <none>
pn grads <none>
pn graphviz <none>
ii groff-base 1.23.0-10
pn hp2xx <none>
pn html2ps <none>
ii imagemagick-7-doc 8:7.1.2.15+dfsg1-1
pn libraw-bin <none>
pn libwmf-bin <none>
pn mplayer <none>
pn povray <none>
pn radiance <none>
pn sane-utils <none>
ii texlive-binaries [texlive-base-bin] 2025.20250727.75242+ds-5+b2
pn transfig <none>
ii xdg-utils 1.2.1-2
-- no debconf information
-------------- next part --------------
Input file is animate-im7.q16.1
Output from "mandoc -T lint animate-im7.q16.1": (shortened list)
4 STYLE: input text line longer than 80 bytes:
2 STYLE: whitespace at end of input line
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -Kutf8 -ww -z animate-im7.q16.1: (shortened list)
2 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Input file is animate-im7.q16.1, case 1
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
2
-.-.
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.
93:By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
93:By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
-.-.
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"
93:By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
102:\fBCopyright (C) 1999 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html or https://imagemagick.org/license/\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 8, length 155
The \fBanimate-im7.q16\fP program is a member of the ImageMagick-ims7.q16(1) suite of tools. Use it to animate an image or image sequence on any X server.
Line 10, length 181
For more information about the animate command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/animate.html or https://imagemagick.org/script/animate.php.
Line 91, length 248
In addition to those listed above, you can specify these standard X resources as command line options: \-background, \-bordercolor, \-borderwidth, \-font, \-foreground, \-iconGeometry, \-iconic, \-name, \-mattecolor, \-shared-memory, or \-title.
Line 93, length 306
By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
Line 102, length 212
\fBCopyright (C) 1999 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html or https://imagemagick.org/license/\fP
Longest line is number 93 with 306 characters
-.-.
Name of a manual is set in bold (or italic), the section in roman.
See man-pages(7).
98:ImageMagick-im7.q16(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
animate-im7.q16.1:93:By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
animate-im7.q16.1:93:By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
animate-im7.q16.1:102:\fBCopyright (C) 1999 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html or https://imagemagick.org/license/\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.
animate-im7.q16.1:1:.TH animate-im7.q16 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
-.-.
Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
10:For more information about the animate command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/animate.html or https://imagemagick.org/script/animate.php.
102:\fBCopyright (C) 1999 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html or https://imagemagick.org/license/\fP
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:91: warning: trailing space in the line
troff:<stdin>:95: warning: trailing space in the line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:91: warning: trailing space in the line
troff:<stdin>:95: warning: trailing space in the line
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block(, when the table gets wider than the output line).
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.
-------------- next part --------------
--- animate-im7.q16.1 2026-03-06 22:56:27.276234438 +0000
+++ animate-im7.q16.1.new 2026-03-06 23:04:52.283655959 +0000
@@ -1,4 +1,4 @@
-.TH animate-im7.q16 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
+.TH animate-im7.q16 1 "Date: 2009/01/10 01:00:00" ImageMagick
.SH NAME
animate \- animates an image or image sequence on any X server.
.SH SYNOPSIS
@@ -88,14 +88,14 @@ Miscellaneous Options:
\-list type print a list of supported option arguments
\-version print version information
-In addition to those listed above, you can specify these standard X resources as command line options: \-background, \-bordercolor, \-borderwidth, \-font, \-foreground, \-iconGeometry, \-iconic, \-name, \-mattecolor, \-shared-memory, or \-title.
+In addition to those listed above, you can specify these standard X resources as command line options: \-background, \-bordercolor, \-borderwidth, \-font, \-foreground, \-iconGeometry, \-iconic, \-name, \-mattecolor, \-shared-memory, or \-title.
-By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
+By default, the image format of `file' is determined by its magic number. To specify a particular image format, precede the filename with an image format name and a colon (i.e.\& ps:image) or specify the image type as the filename suffix (i.e.\& image.ps). Specify 'file' as '\-' for standard input or output.
-Buttons:
+Buttons:
1 press to map or unmap the Command widget
.SH SEE ALSO
-ImageMagick-im7.q16(1)
+.BR ImageMagick-im7.q16 (1)
.SH COPYRIGHT
-------------- next part --------------
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)
-.-
More information about the Pkg-gmagick-im-team
mailing list