From 2d87bd2d2f088220ccf98af93073cfd807dc2d1b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 20 Sep 2004 20:52:35 +0000 Subject: documentation update git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@225 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/cli.html.in | 75 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 34 deletions(-) (limited to 'doc/cli.html.in') diff --git a/doc/cli.html.in b/doc/cli.html.in index 6f84a07d..49e568f8 100644 --- a/doc/cli.html.in +++ b/doc/cli.html.in @@ -28,19 +28,19 @@ commands are supported:

Status Commands

-

modules

+

list-modules

Show all currently loaded modules with their arguments.

-

sinks/sources

+

list-sinks/list-sources

Show all currently registered sinks (resp. sources).

-

clients

+

list-clients

Show all currently active clients.

-

sink_inputs/sink_outputs

+

list-sink-inputs/list-sink-outputs

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

@@ -56,19 +56,19 @@ and list are synonyms for info.

Module Management

-

load

+

load-module

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

-

unload

+

unload-module

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

Configuration Commands

-

sink_volume

+

set-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 @@ -76,12 +76,12 @@ 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-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

+

set-default-sink/set-default-source

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 @@ -89,39 +89,46 @@ name.

Sample Cache

-

scache_list

+

list-samples

Lists the contents of the sample cache.

-

scache_play

+

play-sample

Play a sample cache entry to a sink. Expects the sample name and the sink name as arguments.

-

sache_remove

+

remove-sample

Remove an entry from the sample cache. Expects the sample name as argument.

-

sache_load

+

load-sample

Load an audio file to the sample cache. Expects the file name to load and the desired sample name as arguments.

+

load-sample-lazy

+ +

Create a new entry in the sample cache, but don't load the sample +immediately. The sample is loaded only when it is first used. After a +certain idle time it is freed again. Expects the the desired sample +name and file name to load as arguments.

+

Module Autoloading

-

autoload_list

+

list-autoload

Lists all currently defined autoloading entries.

-

autoload_sink_add/autoload_source_add

+

add-autoload-sink/add-autoload-source

Adds an autoloading entry for a sink (resp. source). Expects the sink name (resp. source name), the module name and the module arguments as arguments.

-

autoload_sink_remove/autoload_source_remove

+

remove-autoload-sink/remove-autoload-source

Remove an autoloading entry. Expects the sink name (resp. source name) as argument.

Miscellaneous Commands

-

play_file

+

play-file

Play an audio file to a sink. Expects the file name and the sink name as argumens.

@@ -131,12 +138,12 @@ name.

Killing Clients/Streams

-

kill_client

+

kill-client

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

-

kill_sink_input/kill_source_output

+

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 @@ -165,34 +172,34 @@ on the interactive command line.

Mark the following script as executable (chmod +x) and run it for a sensible polypaudio configuration.

-#!/usr/bin/polaudio -F
+#!/usr/bin/polaudio -nF
 
 # Create autoload entries for the device drivers
-autoload_sink_add output module-alsa-sink device=plughw:0,0 rate=48000 sink_name=output
-autoload_source_add input load module-alsa-source device=hw:1,0 source_name=input
+add-autoload-sink output module-alsa-sink device=plughw:0,0 rate=48000 sink_name=output
+add-autoload-sink output2 module-oss device=/dev/dsp1 record=0 sink_name=output2
+add-autoload-sink combined module-combine master=output slaves=output2 sink_name=combined
 
-# Load several protocols
-load module-esound-protocol-tcp
-load module-simple-protocol-tcp
-load module-native-protocol-unix
-load module-cli-protocol-unix
+add-autoload-source input module-alsa-source device=hw:1,0 source_name=input
 
-# Load the CLI module (This is similar to passing "-C" on the command line of polypaudio)
-load module-cli
+# Load several protocols
+load-module module-esound-protocol-unix
+load-module module-simple-protocol-tcp
+load-module module-native-protocol-unix
+load-module module-cli-protocol-unix
 
 # Make some devices default
-sink_default output
-source_default input
+set-default-sink combined
+set-default-source input
 
 # Don't fail if the audio files referred to below don't exist
 .nofail
 
 # Load an audio to the sample cache for usage with module-x11-bell
-scache_load /usr/share/sounds/KDE_Notify.wav x11-bell
-load module-x11-bell
+load-sample-lazy  /usr/share/sounds/KDE_Notify.wav x11-bell
+load-module module-x11-bell sample=x11-bell
 
 # Play a welcome sound
-play_file /usr/share/sounds/startup3.wav output
+play-file /usr/share/sounds/startup3.wav combined
-- cgit