]> code.delx.au - pulseaudio/blobdiff - doc/cli.html.in
delx.au / code / pulseaudio / blobdiff
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
fix mailman URL
[pulseaudio] / doc / cli.html.in
diff --git a/doc/cli.html.in b/doc/cli.html.in
index 61d29e5af0704a7d79d4b5764e45f22dddf99832..3a256732d5b502d0ea692e9d285c076a71322f73 100644 (file)
--- a/doc/cli.html.in
+++ b/doc/cli.html.in
@@ -2,14 +2,14 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
-<title>polypaudio: Simple Command Line Language</title>
+<title>PulseAudio: Simple Command Line Language</title>
 <link rel="stylesheet" type="text/css" href="style.css" />
 </head>
 
 <body>
 <h1>Simple Command Line Language</h1>
 
-<p><tt>polypaudio</tt> provides a simple command line language used by
+<p>PulseAudio provides a simple command line language used by
 configuration scripts as well as the modules <tt>module-cli</tt>
 and <tt>module-cli-protocol-{unix,tcp}</tt>. Empty lines and lines
 beginning with a hashmark (<tt>#</tt>) are silently ignored. Several
@@ -68,13 +68,19 @@ returned by <tt>modules</tt>.</p>
 
 <h2>Configuration Commands</h2>
 
-<h3><tt>set-sink-volume</tt></h3>
+<h3><tt>set-sink-volume</tt>/<tt>set-source-volume</tt></h3>
 
-<p>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
-(<tt>0x100</tt>) is normal volume, values greater than this amplify
-the audio signal with clipping.</p>
+<p>Set the volume of the specified sink or source. You may specify the sink/source either
+by its index in the sink/source list or by its name. The volume should be an
+integer value greater or equal than 0 (= muted). Volume 65536
+(<tt>0x10000</tt>) is normal volume, values greater than this amplify
+the audio signal (with clipping).</p>
+
+<h3><tt>set-sink-mute</tt>/<tt>set-source-mute</tt></h3>
+
+<p>Mute or unmute the specified sink our source. You may specify the
+sink/source either by its index or by its name. The mute value is
+either 0 or 1.</p>
 
 <h3><tt>set-sink-input-volume</tt></h3>
 
@@ -175,7 +181,7 @@ on the interactive command line.</p>
 
 <h2>Example Configuration Script</h2>
 
-<p>Mark the following script as executable (<tt>chmod +x</tt>) and run it for a sensible polypaudio configuration.</p>
+<p>Mark the following script as executable (<tt>chmod +x</tt>) and run it for a sensible PulseAudio configuration.</p>
 
 <pre>
 #!/usr/bin/polaudio -nF
@@ -209,6 +215,6 @@ play-file /usr/share/sounds/startup3.wav combined
 </pre>
 
 <hr/>
-<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, November 2004</address>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, June 2006</address>
 <div class="grey"><i>$Id$</i></div>
 </body> </html>