Bug#976159: xfonts-utils: bdftopcf(1) documentation of some flags is misleading

[Reuben Thomas <rrt@sc3d.org>]

Package: xfonts-utils
Version: 1:7.7+6
Severity: normal

The -t and -i flags for bdftopcf are documented thus:

       -t      When this option is specified, bdftopcf will convert fonts into "terminal" fonts when possible.  A terminal
               font has each glyph image padded to the same size; the X server can usually render these types of fonts
               more quickly.

       -i      This option inhibits the normal computation of ink metrics.  When a font has glyph images which do not fill
               the bitmap image (i.e., the "on" pixels don't extend to the edges of the metrics) bdftopcf computes the
               actual ink metrics and places them in the .pcf file; the -t option inhibits this behaviour.

However, looking at the source code bdftopcf.c, they are both parsed, but
ignored. I suggest changing the man page to read:

       -t, -i  Ignored.

Further, it may be worth patching the code, as currently it reads:

            case 't':          /* attempt to make terminal fonts if possible */
                if (argv[0][2] != '\0')
                    goto usage;
                break;

            case 'i':          /* inhibit ink metric computation */
                if (argv[0][2] != '\0')
                    goto usage;
                break;

It might make sense to add a “TODO:” at the start of each comment.

Further investigation might reveal that the flags used to do something, but
the above changes would at least help reduce confusion without prejudice to
(unlikely?) future improvements.

-- System Information:
Debian Release: bullseye/sid
  APT prefers focal-updates
  APT policy: (500, 'focal-updates'), (500, 'focal-security'), (500, 'focal'), (100, 'focal-backports')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 5.4.0-54-generic (SMP w/16 CPU cores)
Kernel taint flags: TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8), LANGUAGE=en_GB (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages xfonts-utils depends on:
ii  libc6             2.31-0ubuntu9.1
ii  libfontenc1       1:1.1.4-0ubuntu1
ii  libfreetype6      2.10.1-2ubuntu0.1
ii  x11-common        1:7.7+19ubuntu14
ii  xfonts-encodings  1:1.0.5-0ubuntu1
ii  zlib1g            1:1.2.11.dfsg-2ubuntu1.2

xfonts-utils recommends no packages.

xfonts-utils suggests no packages.

-- no debconf information