From 7b8c329578d642d31618d487b97864306c43073c Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sat, 17 Jul 2004 14:06:13 +0000 Subject: add documentation git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@86 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/cli.html.in | 152 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 doc/cli.html.in (limited to 'doc/cli.html.in') diff --git a/doc/cli.html.in b/doc/cli.html.in new file mode 100644 index 00000000..c67d78db --- /dev/null +++ b/doc/cli.html.in @@ -0,0 +1,152 @@ + + + + +polypaudio: Simple Command Line Language + + + + +

Simple Command Line Language

+ +

polypaudio provides a simple command line language used by +configuration scripts as well as the modules module-cli +and module-cli-protocol-{unix,tcp}. Empty lines and lines +beginning with a hashmark (#) are silently ignored. Several +commands are supported:

+ +

Miscellaneous Commands

+ +

help

+ +

Show a quick help on the commands available.

+ +

exit

+ +

Terminate the daemon. If you want to terminate a CLI connection +("log out") you might want to use C-d.

+ +

Status Commands

+ +

modules

+ +

Show all currently loaded modules with their arguments.

+ +

sinks/sources

+ +

Show all currently registered sinks (resp. sources).

+ +

clients

+ +

Show all currently active clients.

+ +

sink_inputs/sink_outputs

+ +

Show all currently active inputs to sinks (resp. outputs of sources).

+ +

stat

+ +

Show some simple statistics about the allocated memory blocks and +the space used by them.

+ +

info

+ +

A combination of all status commands described above. ls +and list are synonyms for info.

+ +

Module Management

+ +

load

+ +

Load a module specified by its name and arguments. For most modules +it is OK to be loaded more than once.

+ +

unload

+ +

Unload a module specified by its index in the module list as +returned by modules.

+ +

Configuration Commands

+ +

sink_volume

+ +

Set the volume of the specified sink. You may specify the sink either +by its index in the sink list or by its name. The volume should be an +integer value greater or equal than 0 (= muted). Volume 256 +(0x100) is normal volume, values greater than this amplify +the audio signal with clipping.

+ +

sink_input_volume

+ +

Set the volume of a sink input specified by its index the the sink +input list. The same volume rules apply as with sink_volume.

+ +

sink_default/source_default

+ +

Make a sink (resp. source) the default. You may specify the sink +(resp. ssource) by its index in the sink (resp. source) list or by its +name.

+ +

Killing clients/streams

+ +

kill_client

+ +

Remove a client forcibly from the server. There is no protection that +the client reconnects immediately.

+ +

kill_sink_input/kill_source_output

+ +

Remove a sink input (resp. source output) forcibly from the +server. This will not remove the owning client or any other streams +opened by the client from the server.

+ +

Meta Commands

+ +

In addition the the commands described above there a few meta +directives supported by the command line interpreter:

+ +

.include

+ +

Executes the commands from the specified script file.

+ +

.fail/.nofail

+ +

Enable (resp. disable) that following failing commands will cancel +the execution of the current script file. This is a ignored when used +on the interactive command line.

+ +

.verbose/.noverbose

+

Enable (resp. disable) extra verbosity.

+ +

Example Configuration Script

+ +
+#!/usr/bin/polaudio -F
+
+# Load audio drivers
+load module-alsa-sink device=plughw:0,0 rate=48000
+load module-alsa-source device=hw:1,0
+
+# Load several protocols
+load module-esound-protocol-tcp
+load module-simple-protocol-tcp
+load module-native-protocol-unix
+load module-cli-protocol-unix
+
+# Load the CLI module (This is similar to passing "-C" on the command line of polypaudio)
+load module-cli
+
+.nofail
+
+# Make some devices default
+sink_default alsa_output
+source_default alsa_input
+
+# Use digital amplification
+sink_volume alsa_output 0x200
+
+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004
+
$Id$
+ -- cgit