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 and 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', 'on' or any
  42       word starting with the letters 't' or 'y'. Likewise, negative values can be
  43       given as '0', 'off' or any word starting with the letters 'f' or 'n'.
  44       Case is ignored.
  45     </p>
  46   </description>
  47
  48   <section name="General Commands">
  49
  50     <option>
  51       <p><opt>help</opt></p>
  52       <optdesc><p>Show a quick help on the commands available.</p></optdesc>
  53     </option>
  54   </section>
  55
  56   <section name="Status_Commands">
  57     <option>
  58       <p><opt>list-modules</opt></p>
  59       <optdesc><p>Show all currently loaded modules with their arguments.</p></optdesc>
  60     </option>
  61
  62     <option>
  63       <p><opt>list-cards</opt></p>
  64       <optdesc><p>Show all currently registered cards</p></optdesc>
  65     </option>
  66
  67     <option>
  68       <p><opt>list-sinks</opt> or <opt>list-sources</opt></p>
  69       <optdesc><p>Show all currently registered sinks (resp. sources).</p></optdesc>
  70     </option>
  71
  72     <option>
  73       <p><opt>list-clients</opt></p>
  74       <optdesc><p>Show all currently active clients.</p></optdesc>
  75     </option>
  76
  77     <option>
  78       <p><opt>list-sink-inputs</opt> or <opt>list-source-outputs</opt></p>
  79       <optdesc><p>Show all currently active inputs to sinks a.k.a. playback
  80       streams (resp. outputs of sources a.k.a. recording streams).</p></optdesc>
  81     </option>
  82
  83     <option>
  84       <p><opt>stat</opt></p>
  85       <optdesc><p>Show some simple statistics about the allocated memory blocks and the space used by them.</p></optdesc>
  86     </option>
  87
  88     <option>
  89       <p><opt>info</opt> or <opt>ls</opt> or <opt>list</opt></p>
  90       <optdesc><p>A combination of all status commands described above (all
  91       three commands are synonyms).</p></optdesc>
  92     </option>
  93   </section>
  94
  95   <section name="Module Management">
  96     <option>
  97       <p><opt>load-module</opt> <arg>name</arg> [<arg>arguments...</arg>]</p>
  98       <optdesc><p>Load a module specified by its name and arguments. For most
  99       modules it is OK to be loaded more than once.</p></optdesc>
 100     </option>
 101
 102     <option>
 103       <p><opt>unload-module</opt> <arg>index</arg></p>
 104       <optdesc><p>Unload a module specified by its index in the module list as
 105       returned by list-modules.</p></optdesc>
 106     </option>
 107
 108     <option>
 109       <p><opt>describe-module</opt> <arg>name</arg></p>
 110       <optdesc><p>Give information about a module specified by its name.</p></optdesc>
 111     </option>
 112   </section>
 113
 114   <section name="Volume Commands">
 115     <option>
 116       <p><opt>set-sink-volume|set-source-volume</opt> <arg>index|name</arg> <arg>volume</arg></p>
 117       <optdesc><p>Set the volume of the specified sink (resp. source). You may
 118       specify the sink (resp. source) either by its index in the sink/source list
 119       or by its name. The volume should be an integer value greater or equal than
 120       0 (muted). Volume 65536 (0x10000) is 'normal' volume a.k.a. 100%. Values
 121       greater than this amplify the audio signal (with clipping).</p></optdesc>
 122     </option>
 123
 124     <option>
 125       <p><opt>set-sink-mute|set-source-mute</opt> <arg>index|name</arg> <arg>boolean</arg></p>
 126       <optdesc><p>Mute or unmute the specified sink (resp. source). You may
 127       specify the sink (resp. source) either by its index or by its name.
 128       The mute value is either 0 (not muted) or 1 (muted).</p></optdesc>
 129     </option>
 130
 131     <option>
 132       <p><opt>set-sink-input-volume|set-source-output-volume</opt> <arg>index</arg> <arg>volume</arg></p>
 133       <optdesc><p>Set the volume of a sink input (resp. source output) specified
 134       by its index. The same volume rules apply as with set-sink-volume.</p></optdesc>
 135     </option>
 136
 137     <option>
 138       <p><opt>set-sink-input-mute|set-source-output-mute</opt> <arg>index</arg> <arg>boolean</arg></p>
 139       <optdesc><p>Mute or unmute a sink input (resp. source output) specified
 140       by its index. The same mute rules apply as with set-sink-mute.</p></optdesc>
 141     </option>
 142   </section>
 143
 144   <section name="Configuration Commands">
 145     <option>
 146       <p><opt>set-default-sink|set-default-source</opt> <arg>index|name</arg></p>
 147       <optdesc><p>Make a sink (resp. source) the default. You may specify the
 148       sink (resp. source) by its index in the sink (resp. source) list or by its
 149       name.</p><p>Note that defaults may be overridden by various policy modules
 150       or by specific stream configurations.</p></optdesc>
 151     </option>
 152
 153     <option>
 154       <p><opt>set-card-profile</opt> <arg>index|name</arg> <arg>profile-name</arg></p>
 155       <optdesc><p>Change the profile of a card.</p></optdesc>
 156     </option>
 157
 158     <option>
 159       <p><opt>set-sink-port|set-source-port</opt> <arg>index|name</arg> <arg>port-name</arg></p>
 160       <optdesc><p>Change the profile of a sink (resp. source).</p></optdesc>
 161     </option>
 162
 163     <option>
 164       <p><opt>suspend-sink|suspend-source</opt> <arg>index|name</arg> <arg>boolean</arg></p>
 165       <optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink
 166       (resp. source).</p></optdesc>
 167     </option>
 168
 169     <option>
 170       <p><opt>suspend</opt> <arg>boolean</arg></p>
 171       <optdesc><p>Suspend all sinks and sources.</p></optdesc>
 172     </option>
 173   </section>
 174
 175   <section name="Moving streams">
 176     <option>
 177       <p><opt>move-sink-input|move-source-output</opt> <arg>index</arg> <arg>sink-index|sink-name</arg></p>
 178       <optdesc><p>Move sink input (resp. source output) to another sink
 179       (resp. source).</p></optdesc>
 180     </option>
 181   </section>
 182
 183   <section name="Property lists">
 184     <option>
 185       <p><opt>update-sink-proplist|update-source-proplist</opt> <arg>index|name</arg> <arg>properties</arg></p>
 186       <optdesc><p>Update the properties of a sink (resp. source) specified by
 187       name or index. The property is specified as e.g. device.description="My
 188       Preferred Name"</p></optdesc>
 189     </option>
 190
 191     <option>
 192       <p><opt>update-sink-input-proplist|update-source-output-proplist</opt> <arg>index</arg> <arg>properties</arg></p>
 193       <optdesc><p>Update the properties of a sink input (resp. source output)
 194       specified by index. The properties are specified as above.</p></optdesc>
 195     </option>
 196   </section>
 197
 198   <section name="Sample Cache">
 199     <option>
 200       <p><opt>list-samples</opt></p>
 201       <optdesc><p>Lists the contents of the sample cache.</p></optdesc>
 202     </option>
 203
 204     <option>
 205       <p><opt>play-sample</opt> <arg>name</arg> <arg>sink-index|sink-name</arg></p>
 206       <optdesc><p>Play a sample cache entry to a sink.</p></optdesc>
 207     </option>
 208
 209     <option>
 210       <p><opt>remove-sample</opt> <arg>name</arg></p>
 211       <optdesc><p>Remove an entry from the sample cache.</p></optdesc>
 212     </option>
 213
 214     <option>
 215       <p><opt>load-sample</opt> <arg>name</arg> <arg>filename</arg></p>
 216       <optdesc><p>Load an audio file to the sample cache.</p></optdesc>
 217     </option>
 218
 219     <option>
 220       <p><opt>load-sample-lazy</opt> <arg>name</arg> <arg>filename</arg></p>
 221       <optdesc><p>Create a new entry in the sample cache, but don't load the
 222       sample immediately. The sample is loaded only when it is first used.
 223       After a certain idle time it is freed again.</p></optdesc>
 224     </option>
 225
 226     <option>
 227       <p><opt>load-sample-dir-lazy</opt> <arg>path</arg></p>
 228       <optdesc><p>Load all entries in the specified directory into the sample
 229       cache as lazy entries. A shell globbing expression (e.g. *.wav) may be
 230       appended to the path of the directory to add.</p></optdesc>
 231     </option>
 232   </section>
 233
 234   <section name="Killing Clients/Streams">
 235     <option>
 236       <p><opt>kill-client</opt> <arg>index</arg></p>
 237       <optdesc><p>Remove a client forcibly from the server. There is no protection
 238       against the client reconnecting immediately.</p></optdesc>
 239     </option>
 240
 241     <option>
 242       <p><opt>kill-sink-input|kill-source-output</opt> <arg>index</arg></p>
 243       <optdesc><p>Remove a sink input (resp. source output) forcibly from the
 244       server. This will not remove the owning client or any other streams opened
 245       by the same client from the server.</p></optdesc>
 246     </option>
 247   </section>
 248
 249   <section name="Log Commands">
 250     <option>
 251       <p><opt>set-log-level</opt> <arg>numeric-level</arg></p>
 252       <optdesc><p>Change the log level.</p></optdesc>
 253     </option>
 254
 255     <option>
 256       <p><opt>set-log-meta</opt> <arg>boolean</arg></p>
 257       <optdesc><p>Show source code location in log messages.</p></optdesc>
 258     </option>
 259
 260     <option>
 261       <p><opt>set-log-time</opt> <arg>boolean</arg></p>
 262       <optdesc><p>Show timestamps in log messages.</p></optdesc>
 263     </option>
 264
 265     <option>
 266       <p><opt>set-log-backtrace</opt> <arg>num-frames</arg></p>
 267       <optdesc><p>Show backtrace in log messages.</p></optdesc>
 268     </option>
 269   </section>
 270
 271   <section name="Miscellaneous Commands">
 272     <option>
 273       <p><opt>play-file</opt> <arg>filename</arg> <arg>sink-index|sink-name</arg></p>
 274       <optdesc><p>Play an audio file to a sink.</p></optdesc>
 275     </option>
 276
 277     <option>
 278       <p><opt>dump</opt></p>
 279       <optdesc><p>Dump the daemon's current configuration in CLI commands.</p></optdesc>
 280     </option>
 281
 282     <option>
 283       <p><opt>dump-volumes</opt></p>
 284       <optdesc><p>Debug: Shows the current state of all volumes.</p></optdesc>
 285     </option>
 286
 287     <option>
 288       <p><opt>shared</opt></p>
 289       <optdesc><p>Debug: Show shared properties.</p></optdesc>
 290     </option>
 291
 292     <option>
 293       <p><opt>exit</opt></p>
 294       <optdesc><p>Terminate the daemon. If you want to terminate a CLI
 295       connection ("log out") you might want to use ctrl+d</p></optdesc>
 296     </option>
 297   </section>
 298
 299   <section name="Meta Commands">
 300     <p>
 301       In addition the the commands described above there a few meta directives
 302       supported by the command line interpreter.
 303     </p>
 304     <option>
 305       <p><opt>.include</opt> <arg>filename|folder</arg></p>
 306       <optdesc><p>Executes the commands from the specified script file or in all
 307       of the *.pa file within the folder.</p></optdesc>
 308     </option>
 309     <option>
 310       <p><opt>.fail</opt> and <opt>.nofail</opt></p>
 311       <optdesc><p>Enable (resp. disable) that following failing commands will
 312       cancel the execution of the current script file. This is a ignored when
 313       used on the interactive command line.</p></optdesc>
 314     </option>
 315
 316     <option>
 317       <p><opt>.verbose</opt> and <opt>.noverbose</opt></p>
 318       <optdesc><p>Enable (resp. disable) extra verbosity.</p></optdesc>
 319     </option>
 320   </section>
 321
 322   <section name="Authors">
 323     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
 324     PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 325   </section>
 326
 327   <section name="See also">
 328     <p>
 329       <manref name="default.pa" section="5"/>,
 330       <manref name="pacmd" section="1"/>,
 331       <manref name="pulseaudio" section="1"/>
 332     </p>
 333   </section>
 334
 335 </manpage>