From aa19646d34e57719ee87bb8c619ccc7d4ea4e9aa Mon Sep 17 00:00:00 2001 From: Colin Guthrie Date: Thu, 5 Apr 2012 11:41:18 +0100 Subject: [PATCH] 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 --- configure.ac | 1 + man/Makefile.am | 3 + man/default.pa.5.xml.in | 9 +- man/pacmd.1.xml.in | 11 +- man/pactl.1.xml.in | 7 +- man/pulse-cli-syntax.5.xml.in | 335 ++++++++++++++++++++++++++++++++++ src/pulsecore/cli-command.c | 44 ++--- 7 files changed, 379 insertions(+), 31 deletions(-) create mode 100644 man/pulse-cli-syntax.5.xml.in diff --git a/configure.ac b/configure.ac index 7bdd4010..efcb753b 100644 --- a/configure.ac +++ b/configure.ac @@ -1330,6 +1330,7 @@ man/padsp.1.xml man/pulse-daemon.conf.5.xml man/pulse-client.conf.5.xml man/default.pa.5.xml +man/pulse-cli-syntax.5.xml man/start-pulseaudio-kde.1.xml man/start-pulseaudio-x11.1.xml ]) diff --git a/man/Makefile.am b/man/Makefile.am index b27a9f2b..d0cc8e71 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -31,6 +31,7 @@ noinst_DATA = \ pulse-daemon.conf.5.xml \ pulse-client.conf.5.xml \ default.pa.5.xml \ + pulse-cli-syntax.5.xml \ start-pulseaudio-kde.1.xml \ start-pulseaudio-x11.1.xml @@ -54,6 +55,7 @@ dist_man_MANS = \ pulse-daemon.conf.5 \ pulse-client.conf.5 \ default.pa.5 \ + pulse-cli-syntax.5 \ start-pulseaudio-kde.1 \ start-pulseaudio-x11.1 @@ -78,6 +80,7 @@ EXTRA_DIST = \ pulse-daemon.conf.5.xml.in \ pulse-client.conf.5.xml.in \ default.pa.5.xml.in \ + pulse-cli-syntax.5.xml.in \ start-pulseaudio-kde.1.xml.in \ start-pulseaudio-x11.1.xml.in \ xmltoman \ diff --git a/man/default.pa.5.xml.in b/man/default.pa.5.xml.in index 1ec618d5..fb5b2d2d 100644 --- a/man/default.pa.5.xml.in +++ b/man/default.pa.5.xml.in @@ -34,7 +34,7 @@ USA. ~/.pulse/default.pa on startup, and when that file doesn't exist @PA_DEFAULT_CONFIG_DIR@/default.pa. It should contain directives in the PulseAudio CLI languages, as - documented on .

+ documented in .

The same commands can also be entered during runtime in the tool, allowing flexible runtime reconfiguration.

@@ -47,9 +47,10 @@ USA.

- , , + , + , + , +

diff --git a/man/pacmd.1.xml.in b/man/pacmd.1.xml.in index c20c016e..079eb61e 100644 --- a/man/pacmd.1.xml.in +++ b/man/pacmd.1.xml.in @@ -34,7 +34,11 @@ USA. the commands also understood in the default.pa configuration scripts.

-

This program takes no command line options.

+

To exit the live shell, use ctrl+d. Note that the 'exit' command + inside the shell will tell the PulseAudio daemon itself to shutdown!

+ +

If any arguments are passed on the command line, they will be + passed into the live shell which will process the command and exit.

@@ -43,7 +47,10 @@ USA.

- , , + , + , + , +

diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in index 688ac38b..86e76099 100644 --- a/man/pactl.1.xml.in +++ b/man/pactl.1.xml.in @@ -66,7 +66,7 @@ USA.