man: Document the cli inteface a little.

This just documents the cli interface syntax. Mostly a lift from
http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/CLI
with some minor editing and bringing up to date.

Also document a few undocumented commands.

Shuffle around the order in 'pacmd help' output to match the order
in the new docs for consistency.

https://bugs.freedesktop.org/show_bug.cgi?id=45029
This commit is contained in:
Colin Guthrie 2012-04-05 11:41:18 +01:00
parent 87edc1ccb0
commit aa19646d34
7 changed files with 379 additions and 31 deletions

View file

@ -34,7 +34,11 @@ USA.
the commands also understood in the <file>default.pa</file>
configuration scripts.</p>
<p>This program takes no command line options.</p>
<p>To exit the live shell, use ctrl+d. Note that the 'exit' command
inside the shell will tell the PulseAudio daemon itself to shutdown!</p>
<p>If any arguments are passed on the command line, they will be
passed into the live shell which will process the command and exit.</p>
</description>
<section name="Authors">
@ -43,7 +47,10 @@ USA.
<section name="See also">
<p>
<manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>, <manref name="default.pa" section="5"/>
<manref name="pulse-cli-syntax" section="5"/>,
<manref name="pulseaudio" section="1"/>,
<manref name="pactl" section="1"/>,
<manref name="default.pa" section="5"/>
</p>
</section>