Bug#716677: zita-alsa-pcmi-utils: missing documentation

IOhannes m zmoelnig zmoelnig at iem.at
Thu Jul 11 10:58:32 UTC 2013


Package: zita-alsa-pcmi-utils
Version: 0.2.0-1
Severity: minor

the two programs that come with zita-alsa-pcmi-utils 
(alsa_loopback and alsa_delay) currently have a total lack of
documentation on how to use these programs.
- /usr/share/doc/zita-alsa-pcmi/utils only holds the minimal required files
- there are no manpages
- there are no help-flags
- running the commands without any arguments gives:
    CMDNAME <playdev><captdev><fsamp><frsize><nfrags>
  "CMDNAME" is replaced by the actual commandname, though 
  - for `alsa_loopback` it reads `alsa-loopback`
  - for `alsa_delay` this actually reads 'alsa-latency' [sic!]

  this "help" indicates that all options should be given in a single string,
  though the source code reveals, that they actually need to be given as
  separate arguments.


i suggest the following:
- fixing the online-help, so it reads 
     "$0 <playdev> <captdev> <fsamp> <frsize> <nfrags>"
- adding minimal manpages that explain these parameters and give a working
  example (and hopefully a short summary what these programs really do)

-- System Information:
Debian Release: jessie/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'testing'), (1, 'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 3.9-1-amd64 (SMP w/2 CPU cores)
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968)
Shell: /bin/sh linked to /bin/dash

Versions of packages zita-alsa-pcmi-utils depends on:
ii  libasound2          1.0.27.2-1
ii  libc6               2.17-7
ii  libgcc1             1:4.8.1-6
ii  libstdc++6          4.8.1-6
ii  libzita-alsa-pcmi0  0.2.0-1

zita-alsa-pcmi-utils recommends no packages.

zita-alsa-pcmi-utils suggests no packages.

-- no debconf information



More information about the pkg-multimedia-maintainers mailing list