Package: pngtools
Version: 1.2-1
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>:35: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
troff:<stdin>:37: warning: trailing space in the line
troff:<stdin>:49: warning: trailing space in the line
troff:<stdin>:50: warning: trailing space in the line
troff:<stdin>:51: warning: trailing space in the line
troff:<stdin>:63: warning: trailing space in the line
troff:<stdin>:64: warning: trailing space in the line
troff:<stdin>:65: 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.12+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 pngtools depends on:
ii libc6 2.42-13
ii libpng16-16t64 1.6.55-1
pngtools recommends no packages.
Versions of packages pngtools suggests:
pn optipng | pngcrush <none>
-- no debconf information
Input file is pnginfo.1
Output from "mandoc -T lint pnginfo.1": (shortened list)
3 STYLE: input text line longer than 80 bytes:
3 STYLE: whitespace at end of input line
6 WARNING: skipping paragraph macro: PP after SH
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -Kutf8 -ww -z pnginfo.1: (shortened list)
9 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Input file is pnginfo.1
Show if docman-to-man created this.
1:.\" This manpage has been automatically generated by docbook2man
2:.\" from a DocBook document. This tool can be found at:
3:.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
-.-.
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
12
-.-.
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 "\-\-".
pnginfo.1:21:The format for the output bitmaps is hexadecimal, with each pixel
presented as a triple -- for instance [red green blue]. This means that
paletted images et cetera will have their bitmaps expanded before display.
-.-.
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.
13: pnginfo [-t] [-d] [-D] <filenames>
19:The \fB-t\fR command line option forces pnginfo to use \fBlibtiff\fR
\fBtiffinfo\fR style labels, instead of the more relevant png names. The
\fB-d\fR command line option dumps the bitmap contained by the image to
standard out, whilst the \fB-D\fR command merely checks that the image bitmap
could be extracted from the file. If nothing is reported by \fB-D\fR, then
there was no error.
21:The format for the output bitmaps is hexadecimal, with each pixel presented
as a triple -- for instance [red green blue]. This means that paletted images
et cetera will have their bitmaps expanded before display.
30:pnginfo -t toucan.png basn3p02.png basn6a16.png toucan.png...
-.-.
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"
17:This command dumps information about the PNG files named on the command
line. This command's output is based on the output of the \fBtiffinfo\fR
command, which is part of the \fBlibtiff\fR distribution. Each line output by
the command represents a value that has been set within the PNG file.
19:The \fB-t\fR command line option forces pnginfo to use \fBlibtiff\fR
\fBtiffinfo\fR style labels, instead of the more relevant png names. The
\fB-d\fR command line option dumps the bitmap contained by the image to
standard out, whilst the \fB-D\fR command merely checks that the image bitmap
could be extracted from the file. If nothing is reported by \fB-D\fR, then
there was no error.
21:The format for the output bitmaps is hexadecimal, with each pixel presented
as a triple -- for instance [red green blue]. This means that paletted images
et cetera will have their bitmaps expanded before display.
80:\fBpngtools\fR was written by Michael Still and is released under the GNU
GPL. The project is hosted at https://github.com/mikalstill/pngtools.
-.-.
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 17, length 292
This command dumps information about the PNG files named on the command line.
This command's output is based on the output of the \fBtiffinfo\fR command,
which is part of the \fBlibtiff\fR distribution. Each line output by the
command represents a value that has been set within the PNG file.
Line 19, length 386
The \fB-t\fR command line option forces pnginfo to use \fBlibtiff\fR
\fBtiffinfo\fR style labels, instead of the more relevant png names. The
\fB-d\fR command line option dumps the bitmap contained by the image to
standard out, whilst the \fB-D\fR command merely checks that the image bitmap
could be extracted from the file. If nothing is reported by \fB-D\fR, then
there was no error.
Line 21, length 212
The format for the output bitmaps is hexadecimal, with each pixel presented as
a triple -- for instance [red green blue]. This means that paletted images et
cetera will have their bitmaps expanded before display.
Line 35, length 101
Colour Type (Photometric Interpretation): PALETTED COLOUR with alpha (256
colours, 256 transparent)
Line 49, length 86
Colour Type (Photometric Interpretation): PALETTED COLOUR (4 colours, 0
transparent)
Line 80, length 143
\fBpngtools\fR was written by Michael Still and is released under the GNU GPL.
The project is hosted at https://github.com/mikalstill/pngtools.
Longest line is number 19 with 386 characters
-.-.
The name of a man page is typeset in bold (or italic) and the section in
roman (see man-pages(7)).
74:tiffinfo(1) pngchunkdesc(1) pngcp(1)
-.-.
Name of a manual is set in bold (or italic), the section in roman.
See man-pages(7).
74:tiffinfo(1) pngchunkdesc(1) pngcp(1)
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
pnginfo.1:17:This command dumps information about the PNG files named on the
command line. This command's output is based on the output of the
\fBtiffinfo\fR command, which is part of the \fBlibtiff\fR distribution. Each
line output by the command represents a value that has been set within the PNG
file.
pnginfo.1:19:The \fB-t\fR command line option forces pnginfo to use
\fBlibtiff\fR \fBtiffinfo\fR style labels, instead of the more relevant png
names. The \fB-d\fR command line option dumps the bitmap contained by the image
to standard out, whilst the \fB-D\fR command merely checks that the image
bitmap could be extracted from the file. If nothing is reported by \fB-D\fR,
then there was no error.
pnginfo.1:21:The format for the output bitmaps is hexadecimal, with each pixel
presented as a triple -- for instance [red green blue]. This means that
paletted images et cetera will have their bitmaps expanded before display.
pnginfo.1:80:\fBpngtools\fR was written by Michael Still and is released under
the GNU GPL. The project is hosted at https://github.com/mikalstill/pngtools.
-.-.
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.
pnginfo.1:6:.TH "PNGINFO" "1" "25 February 2026" "User Commands" ""
pnginfo.1:15:.SH "DESCRIPTION"
pnginfo.1:22:.SH "RETURNS"
pnginfo.1:27:.SH "EXAMPLE"
pnginfo.1:75:.SH "VERSION"
pnginfo.1:78:.SH "AUTHOR"
pnginfo.1:81:.SH "BUGS"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:35: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
troff:<stdin>:37: warning: trailing space in the line
troff:<stdin>:49: warning: trailing space in the line
troff:<stdin>:50: warning: trailing space in the line
troff:<stdin>:51: warning: trailing space in the line
troff:<stdin>:63: warning: trailing space in the line
troff:<stdin>:64: warning: trailing space in the line
troff:<stdin>:65: 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.
--- pnginfo.1 2026-03-03 09:40:49.414164464 +0000
+++ pnginfo.1.new 2026-03-03 10:18:01.116177726 +0000
@@ -1,40 +1,38 @@
-.\" This manpage has been automatically generated by docbook2man
+.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
-.\" Please send any bug reports, improvements, comments, patches,
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <[email protected]>.
-.TH "PNGINFO" "1" "25 February 2026" "User Commands" ""
+.TH PNGINFO 1 "25 February 2026" "User Commands" ""
.SH NAME
pnginfo \- display information on the PNG files named
.SH SYNOPSIS
.nf
- pnginfo [-t] [-d] [-D] <filenames>
+ pnginfo [\-t] [\-d] [\-D] <filenames>
.fi
-.SH "DESCRIPTION"
-.PP
+.SH DESCRIPTION
This command dumps information about the PNG files named on the command line.
This command's output is based on the output of the \fBtiffinfo\fR command,
which is part of the \fBlibtiff\fR distribution. Each line output by the
command represents a value that has been set within the PNG file.
.PP
-The \fB-t\fR command line option forces pnginfo to use \fBlibtiff\fR
\fBtiffinfo\fR style labels, instead of the more relevant png names. The
\fB-d\fR command line option dumps the bitmap contained by the image to
standard out, whilst the \fB-D\fR command merely checks that the image bitmap
could be extracted from the file. If nothing is reported by \fB-D\fR, then
there was no error.
+The \fB\-t\fR command line option forces pnginfo to use \fBlibtiff\fR
\fBtiffinfo\fR style labels, instead of the more relevant png names. The
\fB\-d\fR command line option dumps the bitmap contained by the image to
standard out, whilst the \fB\-D\fR command merely checks that the image bitmap
could be extracted from the file. If nothing is reported by \fB\-D\fR, then
there was no error.
.PP
The format for the output bitmaps is hexadecimal, with each pixel presented as
a triple -- for instance [red green blue]. This means that paletted images et
cetera will have their bitmaps expanded before display.
-.SH "RETURNS"
-.PP
+.SH RETURNS
0 success
.PP
1 error
-.SH "EXAMPLE"
+.SH EXAMPLE
.nf
-pnginfo -t toucan.png basn3p02.png basn6a16.png toucan.png...
+pnginfo \-t toucan.png basn3p02.png basn6a16.png toucan.png...
Image Width: 162 Image Length: 150
Bits/Sample: 8
Samples/Pixel: 1
Pixel Depth: 8
- Colour Type (Photometric Interpretation): PALETTED COLOUR with alpha (256
colours, 256 transparent)
- Image filter: Single row per byte filter
- Interlacing: Adam7 interlacing
+ Colour Type (Photometric Interpretation): PALETTED COLOUR with alpha (256
colours, 256 transparent)
+ Image filter: Single row per byte filter
+ Interlacing: Adam7 interlacing
Compression Scheme: Deflate method 8, 32k window
Resolution: (not specified)
FillOrder: msb-to-lsb
@@ -46,9 +44,9 @@ basn3p02.png...
Bits/Sample: 2
Samples/Pixel: 1
Pixel Depth: 2
- Colour Type (Photometric Interpretation): PALETTED COLOUR (4 colours, 0
transparent)
- Image filter: Single row per byte filter
- Interlacing: No interlacing
+ Colour Type (Photometric Interpretation): PALETTED COLOUR (4 colours, 0
transparent)
+ Image filter: Single row per byte filter
+ Interlacing: No interlacing
Compression Scheme: Deflate method 8, 32k window
Resolution: (not specified)
FillOrder: msb-to-lsb
@@ -60,9 +58,9 @@ basn6a16.png...
Bits/Sample: 16
Samples/Pixel: 4
Pixel Depth: 64
- Colour Type (Photometric Interpretation): RGB with alpha channel
- Image filter: Single row per byte filter
- Interlacing: No interlacing
+ Colour Type (Photometric Interpretation): RGB with alpha channel
+ Image filter: Single row per byte filter
+ Interlacing: No interlacing
Compression Scheme: Deflate method 8, 32k window
Resolution: (not specified)
FillOrder: msb-to-lsb
@@ -70,14 +68,12 @@ basn6a16.png...
Number of text strings: 0 of 0
.fi
.SH "SEE ALSO"
-.PP
-tiffinfo(1) pngchunkdesc(1) pngcp(1)
-.SH "VERSION"
-.PP
+.BR tiffinfo (1),
+.BR pngchunkdesc (1),
+.BR pngcp (1)
+.SH VERSION
This documentation is for \fBpngtools\fR 1.0.
-.SH "AUTHOR"
-.PP
+.SH AUTHOR
\fBpngtools\fR was written by Michael Still and is released under the GNU GPL.
The project is hosted at https://github.com/mikalstill/pngtools.
-.SH "BUGS"
-.PP
+.SH BUGS
Please report bugs at https://github.com/mikalstill/pngtools/issues.
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)
-.-
