code.delx.au - pulseaudio/blob - man/pulse-cli-syntax.5.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!--
   6 This file is part of PulseAudio.
   7
   8 PulseAudio is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU Lesser General Public License as
  10 published by the Free Software Foundation; either version 2.1 of the
  11 License, or (at your option) any later version.
  12
  13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16 Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with PulseAudio; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 USA.
  22 -->
  23
  24 <manpage name="pulse-cli-syntax" section="5" desc="PulseAudio Command Line Interface Syntax">
  25
  26   <synopsis>
  27     <p><file>~/.config/pulse/default.pa</file></p>
  28     <p><file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file></p>
  29     <p><file>@PA_DEFAULT_CONFIG_DIR@/system.pa</file></p>
  30   </synopsis>
  31
  32   <description>
  33     <p>
  34       PulseAudio provides a simple command line language used by configuration
  35       scripts, the pacmd interactive shell, and the modules module-cli and
  36       module-cli-protocol-{unix,tcp}. Empty lines and lines beginning with a
  37       hashmark (#) are silently ignored. Several commands are supported.
  38     </p>
  39
  40     <p>
  41       Note that any boolean arguments can be given positively as '1', 't', 'y',
  42       'true', 'yes' or 'on'. Likewise, negative values can be given as '0',
  43       'f', 'n', 'false', 'no' or 'off'. Case is ignored.
  44     </p>
  45   </description>
  46
  47   <section name="General Commands">
  48
  49     <option>
  50       <p><opt>help</opt></p>
  51       <optdesc><p>Show a quick help on the commands available.</p></optdesc>
  52     </option>
  53   </section>
  54
  55   <section name="Status_Commands">
  56     <option>
  57       <p><opt>list-modules</opt></p>
  58       <optdesc><p>Show all currently loaded modules with their arguments.</p></optdesc>
  59     </option>
  60
  61     <option>
  62       <p><opt>list-cards</opt></p>
  63       <optdesc><p>Show all currently registered cards</p></optdesc>
  64     </option>
  65
  66     <option>
  67       <p><opt>list-sinks</opt> or <opt>list-sources</opt></p>
  68       <optdesc><p>Show all currently registered sinks (resp. sources).</p></optdesc>
  69     </option>
  70
  71     <option>
  72       <p><opt>list-clients</opt></p>
  73       <optdesc><p>Show all currently active clients.</p></optdesc>
  74     </option>
  75
  76     <option>
  77       <p><opt>list-sink-inputs</opt> or <opt>list-source-outputs</opt></p>
  78       <optdesc><p>Show all currently active inputs to sinks a.k.a. playback
  79       streams (resp. outputs of sources a.k.a. recording streams).</p></optdesc>
  80     </option>
  81
  82     <option>
  83       <p><opt>stat</opt></p>
  84       <optdesc><p>Show some simple statistics about the allocated memory blocks and the space used by them.</p></optdesc>
  85     </option>
  86
  87     <option>
  88       <p><opt>info</opt> or <opt>ls</opt> or <opt>list</opt></p>
  89       <optdesc><p>A combination of all status commands described above (all
  90       three commands are synonyms).</p></optdesc>
  91     </option>
  92   </section>
  93
  94   <section name="Module Management">
  95     <option>
  96       <p><opt>load-module</opt> <arg>name</arg> [<arg>arguments...</arg>]</p>
  97       <optdesc><p>Load a module specified by its name and arguments. For most
  98       modules it is OK to be loaded more than once.</p></optdesc>
  99     </option>
 100
 101     <option>
 102       <p><opt>unload-module</opt> <arg>index|name</arg></p>
 103       <optdesc><p>Unload a module, specified either by its index in the module
 104       list or its name.</p></optdesc>
 105     </option>
 106
 107     <option>
 108       <p><opt>describe-module</opt> <arg>name</arg></p>
 109       <optdesc><p>Give information about a module specified by its name.</p></optdesc>
 110     </option>
 111   </section>
 112
 113   <section name="Volume Commands">
 114     <option>
 115       <p><opt>set-sink-volume|set-source-volume</opt> <arg>index|name</arg> <arg>volume</arg></p>
 116       <optdesc><p>Set the volume of the specified sink (resp. source). You may
 117       specify the sink (resp. source) either by its index in the sink/source list
 118       or by its name. The volume should be an integer value greater or equal than
 119       0 (muted). Volume 65536 (0x10000) is 'normal' volume a.k.a. 100%. Values
 120       greater than this amplify the audio signal (with clipping).</p></optdesc>
 121     </option>
 122
 123     <option>
 124       <p><opt>set-sink-mute|set-source-mute</opt> <arg>index|name</arg> <arg>boolean</arg></p>
 125       <optdesc><p>Mute or unmute the specified sink (resp. source). You may
 126       specify the sink (resp. source) either by its index or by its name.
 127       The mute value is either 0 (not muted) or 1 (muted).</p></optdesc>
 128     </option>
 129
 130     <option>
 131       <p><opt>set-sink-input-volume|set-source-output-volume</opt> <arg>index</arg> <arg>volume</arg></p>
 132       <optdesc><p>Set the volume of a sink input (resp. source output) specified
 133       by its index. The same volume rules apply as with set-sink-volume.</p></optdesc>
 134     </option>
 135
 136     <option>
 137       <p><opt>set-sink-input-mute|set-source-output-mute</opt> <arg>index</arg> <arg>boolean</arg></p>
 138       <optdesc><p>Mute or unmute a sink input (resp. source output) specified
 139       by its index. The same mute rules apply as with set-sink-mute.</p></optdesc>
 140     </option>
 141   </section>
 142
 143   <section name="Configuration Commands">
 144     <option>
 145       <p><opt>set-default-sink|set-default-source</opt> <arg>index|name</arg></p>
 146       <optdesc><p>Make a sink (resp. source) the default. You may specify the
 147       sink (resp. source) by its index in the sink (resp. source) list or by its
 148       name.</p><p>Note that defaults may be overridden by various policy modules
 149       or by specific stream configurations.</p></optdesc>
 150     </option>
 151
 152     <option>
 153       <p><opt>set-card-profile</opt> <arg>index|name</arg> <arg>profile-name</arg></p>
 154       <optdesc><p>Change the profile of a card.</p></optdesc>
 155     </option>
 156
 157     <option>
 158       <p><opt>set-sink-port|set-source-port</opt> <arg>index|name</arg> <arg>port-name</arg></p>
 159       <optdesc><p>Change the profile of a sink (resp. source).</p></optdesc>
 160     </option>
 161
 162     <option>
 163       <p><opt>set-port-latency-offset</opt> <arg>card-index|card-name</arg> <arg>port-name</arg> <arg>offset</arg> </p>
 164       <optdesc><p>Change the latency offset of a port belonging to the specified card</p></optdesc>
 165     </option>
 166
 167     <option>
 168       <p><opt>suspend-sink|suspend-source</opt> <arg>index|name</arg> <arg>boolean</arg></p>
 169       <optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink
 170       (resp. source).</p></optdesc>
 171     </option>
 172
 173     <option>
 174       <p><opt>suspend</opt> <arg>boolean</arg></p>
 175       <optdesc><p>Suspend all sinks and sources.</p></optdesc>
 176     </option>
 177   </section>
 178
 179   <section name="Moving streams">
 180     <option>
 181       <p><opt>move-sink-input|move-source-output</opt> <arg>index</arg> <arg>sink-index|sink-name</arg></p>
 182       <optdesc><p>Move sink input (resp. source output) to another sink
 183       (resp. source).</p></optdesc>
 184     </option>
 185   </section>
 186
 187   <section name="Property lists">
 188     <option>
 189       <p><opt>update-sink-proplist|update-source-proplist</opt> <arg>index|name</arg> <arg>properties</arg></p>
 190       <optdesc><p>Update the properties of a sink (resp. source) specified by
 191       name or index. The property is specified as e.g. device.description="My
 192       Preferred Name"</p></optdesc>
 193     </option>
 194
 195     <option>
 196       <p><opt>update-sink-input-proplist|update-source-output-proplist</opt> <arg>index</arg> <arg>properties</arg></p>
 197       <optdesc><p>Update the properties of a sink input (resp. source output)
 198       specified by index. The properties are specified as above.</p></optdesc>
 199     </option>
 200   </section>
 201
 202   <section name="Sample Cache">
 203     <option>
 204       <p><opt>list-samples</opt></p>
 205       <optdesc><p>Lists the contents of the sample cache.</p></optdesc>
 206     </option>
 207
 208     <option>
 209       <p><opt>play-sample</opt> <arg>name</arg> <arg>sink-index|sink-name</arg></p>
 210       <optdesc><p>Play a sample cache entry to a sink.</p></optdesc>
 211     </option>
 212
 213     <option>
 214       <p><opt>remove-sample</opt> <arg>name</arg></p>
 215       <optdesc><p>Remove an entry from the sample cache.</p></optdesc>
 216     </option>
 217
 218     <option>
 219       <p><opt>load-sample</opt> <arg>name</arg> <arg>filename</arg></p>
 220       <optdesc><p>Load an audio file to the sample cache.</p></optdesc>
 221     </option>
 222
 223     <option>
 224       <p><opt>load-sample-lazy</opt> <arg>name</arg> <arg>filename</arg></p>
 225       <optdesc><p>Create a new entry in the sample cache, but don't load the
 226       sample immediately. The sample is loaded only when it is first used.
 227       After a certain idle time it is freed again.</p></optdesc>
 228     </option>
 229
 230     <option>
 231       <p><opt>load-sample-dir-lazy</opt> <arg>path</arg></p>
 232       <optdesc><p>Load all entries in the specified directory into the sample
 233       cache as lazy entries. A shell globbing expression (e.g. *.wav) may be
 234       appended to the path of the directory to add.</p></optdesc>
 235     </option>
 236   </section>
 237
 238   <section name="Killing Clients/Streams">
 239     <option>
 240       <p><opt>kill-client</opt> <arg>index</arg></p>
 241       <optdesc><p>Remove a client forcibly from the server. There is no protection
 242       against the client reconnecting immediately.</p></optdesc>
 243     </option>
 244
 245     <option>
 246       <p><opt>kill-sink-input|kill-source-output</opt> <arg>index</arg></p>
 247       <optdesc><p>Remove a sink input (resp. source output) forcibly from the
 248       server. This will not remove the owning client or any other streams opened
 249       by the same client from the server.</p></optdesc>
 250     </option>
 251   </section>
 252
 253   <section name="Log Commands">
 254     <option>
 255       <p><opt>set-log-level</opt> <arg>numeric-level</arg></p>
 256       <optdesc><p>Change the log level.</p></optdesc>
 257     </option>
 258
 259     <option>
 260       <p><opt>set-log-meta</opt> <arg>boolean</arg></p>
 261       <optdesc><p>Show source code location in log messages.</p></optdesc>
 262     </option>
 263
 264     <option>
 265       <p><opt>set-log-target</opt> <arg>target</arg></p>
 266       <optdesc><p>Change the log target (null, auto, journal, syslog, stderr,
 267       file:PATH, newfile:PATH).</p></optdesc>
 268     </option>
 269
 270     <option>
 271       <p><opt>set-log-time</opt> <arg>boolean</arg></p>
 272       <optdesc><p>Show timestamps in log messages.</p></optdesc>
 273     </option>
 274
 275     <option>
 276       <p><opt>set-log-backtrace</opt> <arg>num-frames</arg></p>
 277       <optdesc><p>Show backtrace in log messages.</p></optdesc>
 278     </option>
 279   </section>
 280
 281   <section name="Miscellaneous Commands">
 282     <option>
 283       <p><opt>play-file</opt> <arg>filename</arg> <arg>sink-index|sink-name</arg></p>
 284       <optdesc><p>Play an audio file to a sink.</p></optdesc>
 285     </option>
 286
 287     <option>
 288       <p><opt>dump</opt></p>
 289       <optdesc><p>Dump the daemon's current configuration in CLI commands.</p></optdesc>
 290     </option>
 291
 292     <option>
 293       <p><opt>dump-volumes</opt></p>
 294       <optdesc><p>Debug: Shows the current state of all volumes.</p></optdesc>
 295     </option>
 296
 297     <option>
 298       <p><opt>shared</opt></p>
 299       <optdesc><p>Debug: Show shared properties.</p></optdesc>
 300     </option>
 301
 302     <option>
 303       <p><opt>exit</opt></p>
 304       <optdesc><p>Terminate the daemon. If you want to terminate a CLI
 305       connection ("log out") you might want to use ctrl+d</p></optdesc>
 306     </option>
 307   </section>
 308
 309   <section name="Meta Commands">
 310     <p>
 311       In addition to the commands described above there are a few meta directives
 312       supported by the command line interpreter.
 313     </p>
 314     <option>
 315       <p><opt>.include</opt> <arg>filename|folder</arg></p>
 316       <optdesc><p>Executes the commands from the specified script file or in all
 317       of the *.pa file within the folder.</p></optdesc>
 318     </option>
 319     <option>
 320       <p><opt>.fail</opt> and <opt>.nofail</opt></p>
 321       <optdesc><p>Enable (resp. disable) that following failing commands will
 322       cancel the execution of the current script file. This is a ignored when
 323       used on the interactive command line.</p></optdesc>
 324     </option>
 325   </section>
 326
 327   <section name="Authors">
 328     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
 329     PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 330   </section>
 331
 332   <section name="See also">
 333     <p>
 334       <manref name="default.pa" section="5"/>,
 335       <manref name="pacmd" section="1"/>,
 336       <manref name="pulseaudio" section="1"/>
 337     </p>
 338   </section>
 339
 340 </manpage>