Bug#739099: vorbis-tools: ogg123 manpage inadequately documents -d option

[Martin Steghöfer]

tags 739099 moreinfo
thanks


On Sat, 15 Feb 2014 19:57:36 +0000 Paul LeoNerd Evans 
<leonerd at leonerd.org.uk> wrote:
> The manpage briefly mentions  the -d option, and says it takes such
> choices as 'alsa'. It further mentions that the 'alsa' option has
> some sub-parameters.
>
> However, the manpage doesn't include a sufficiently-clear example or
> explanation on how to build the actual value for the -d option to
> contain these options. Are they comma-separated? Colons? Use
> name=value or name:value, or what..?


Excerpts from the manpage of ogg123 in vorbis-tools 1.4.0-1:


[ -d driver [ -o option:value ] [ -f filename ] ]

(Synopsis)


-o option[:value], --device-option option[:value]
   Sets  the  option  option to value for the preceding
   device.  See DEVICES for a list of valid options for
   each device.

(Options)


alsa   Advanced Linux Sound Architecture live output driver. Options:
   buffer_time:value
     Override the default hardware buffer size (in milliseconds).

(One of many examples for options:value pairs in the "Devices" section)


I'm not sure what else you'd expect here. Especially your doubt about 
the format of the name-value pairs seems to be explained in the very 
first paragraph of the man page ("-o option:value"). Is the information 
not structured enough? Not visible enough? Ambiguous?

Cheers,
Martin