Package: pngcrush
Version: 1.5.10-2
Severity: normal
File: /usr/share/man/man1/pngcrush.1.gz

I chose normal instead of minor severity because this doesn't look like a
spelling error or cosmetic issue to the user.  It didn't to me -- I had to
go look up documentation on the web to find out which was which.  That
sucks.

Spot the problem:

  Textual information pertaining to an image can be conveyed with the tEXt,
  iTXt and zTXt chunks.
[...]
  An iTXt  chunk  stores  text  in  the  ISO/IEC 8859‐1 (Latin‐1) character
  set.  zTXt chunks also use the Latin‐1 character set, but the text is
  compressed.  This can be useful for large text chunks.  iTXt chunks consist
  of text in the UTF‐8 of the Unicode character set.

So, *which* one uses UTF-8, again?

This manpage should probably just cross-reference png(5) for PNG format
information, except for the fact that *that* manpage is impressively
useless.

So until png(5) actually documents the file format, I'd fix the manpage
using the information here:

http://www.libpng.org/pub/png/spec/1.2/PNG-Chunks.html

...and maybe include a URL to the above in the manpage.

[[

I don't know why png(5) *doesn't* have this information -- the PNG
specification appears to be under a MIT/X11-style license:

http://www.libpng.org/pub/png/spec/1.2/PNG-Credits.html

]]

Yes, you can put URLs in manpages.  See man(7) for a recipe, or my WTFM
presentation:

http://people.debian.org/~branden/talks/wtfm/wtfm.pdf

pp. 33-35 in the current revision.

Thanks in advance for your attention to this bug.

-- System Information:
Debian Release: testing/unstable
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'stable')
Architecture: powerpc (ppc)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.9-powerpc-smp
Locale: LANG=C, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)

Versions of packages pngcrush depends on:
ii  libc6                     2.3.5-6        GNU C Library: Shared libraries an
ii  libpng12-0                1.2.8rel-1.0.1 PNG library - runtime
ii  zlib1g                    1:1.2.3-4      compression library - runtime

pngcrush recommends no packages.

-- no debconf information

Reply via email to