man/pactl.1.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, see <http://www.gnu.org/licenses/>.
  20 -->
  21
  22 <manpage name="pactl" section="1" desc="Control a running PulseAudio sound server">
  23
  24   <synopsis>
  25     <cmd>pactl [<arg>options</arg>] <arg>COMMAND</arg> [<arg>ARGS ...</arg>]</cmd>
  26     <cmd>pactl <opt>--help</opt></cmd>
  27     <cmd>pactl <opt>--version</opt></cmd>
  28   </synopsis>
  29
  30   <description>
  31     <p><file>pactl</file> can be used to issue control commands to the PulseAudio sound server.</p>
  32
  33     <p><file>pactl</file> only exposes a subset of the available operations. For the full set use the <manref name="pacmd" section="1"/>.</p>
  34   </description>
  35
  36   <options>
  37
  38     <option>
  39       <p><opt>-h | --help</opt></p>
  40
  41       <optdesc><p>Show help.</p></optdesc>
  42     </option>
  43
  44     <option>
  45       <p><opt>--version</opt></p>
  46
  47       <optdesc><p>Show version information.</p></optdesc>
  48     </option>
  49
  50     <option>
  51       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  52
  53       <optdesc><p>Choose the server to connect to.</p></optdesc>
  54     </option>
  55
  56     <option>
  57       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  58
  59       <optdesc><p>Specify the client name <file>pactl</file> shall pass to the server when connecting.</p></optdesc>
  60     </option>
  61
  62   </options>
  63
  64   <section name="Commands">
  65     <p>
  66         When supplied as arguments to the commands below, the special names \@DEFAULT_SINK@, \@DEFAULT_SOURCE@ and \@DEFAULT_MONITOR@
  67         can be used to specify the default sink, source and monitor respectively.
  68     </p>
  69
  70     <option>
  71       <p><opt>stat</opt></p>
  72       <optdesc><p>Dump a few statistics about the memory usage of the PulseAudio daemon.</p></optdesc>
  73     </option>
  74
  75     <option>
  76       <p><opt>info</opt></p>
  77       <optdesc><p>Dump some info about the PulseAudio daemon.</p></optdesc>
  78     </option>
  79
  80     <option>
  81       <p><opt>list</opt> [<arg>short</arg>] [<arg>TYPE</arg>]</p>
  82       <optdesc><p>Dump all currently loaded modules, available sinks, sources, streams, etc.  <arg>TYPE</arg> must be one of:
  83       modules, sinks, sources, sink-inputs, source-outputs, clients, samples, cards, message-handlers.  If not specified, all info is listed
  84       with the exception of the message-handlers. If short is given, output is in a tabular format, for easy parsing by scripts.</p></optdesc>
  85     </option>
  86
  87     <option>
  88       <p><opt>exit</opt></p>
  89       <optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc>
  90     </option>
  91
  92     <option>
  93       <p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p>
  94       <optdesc><p>Upload a sound from the specified audio file into
  95       the sample cache. The file types supported are those understood
  96       by <file>libsndfile</file>. The sample in the cache is named
  97       after the audio file, unless the name is explicitly
  98       specified.</p></optdesc>
  99     </option>
 100
 101     <option>
 102       <p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p>
 103       <optdesc><p>Play the specified sample from the sample cache. It
 104       is played on the default sink, unless the symbolic name or the
 105       numerical index of the sink to play it on is
 106       specified.</p></optdesc>
 107     </option>
 108
 109     <option>
 110       <p><opt>remove-sample</opt> <arg>NAME</arg></p>
 111       <optdesc><p>Remove the specified sample from the sample cache.</p></optdesc>
 112     </option>
 113
 114     <option>
 115       <p><opt>load-module</opt> <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</p>
 116       <optdesc><p>Load the specified module with the specified arguments into the running sound server.
 117       Prints the numeric index of the module just loaded to STDOUT. You can use it to unload the module later.</p></optdesc>
 118     </option>
 119
 120     <option>
 121       <p><opt>unload-module</opt> <arg>ID|NAME</arg></p>
 122       <optdesc><p>Unload the module instance identified by the specified numeric index or unload all modules by the specified name.</p></optdesc>
 123     </option>
 124
 125     <option>
 126       <p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p>
 127       <optdesc><p>Move the specified playback stream (identified by its numerical index) to the specified sink (identified by its symbolic name or numerical index).</p></optdesc>
 128     </option>
 129
 130     <option>
 131       <p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p>
 132       <optdesc><p>Move the specified recording stream (identified by its numerical index) to the specified source (identified by its symbolic name or numerical index).</p></optdesc>
 133     </option>
 134
 135     <option>
 136       <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>true|false</arg></p>
 137       <optdesc><p>Suspend or resume the specified sink (which may be
 138         specified either by its symbolic name or numerical index), depending whether true
 139         (suspend) or false (resume) is passed as last argument. Suspending
 140         a sink will pause all playback. Depending on the module implementing
 141         the sink this might have the effect that the underlying device is
 142         closed, making it available for other applications to use. The exact
 143         behaviour depends on the module.
 144       </p></optdesc>
 145     </option>
 146
 147     <option>
 148       <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>true|false</arg></p>
 149       <optdesc><p>Suspend or resume the specified source (which may be
 150         specified either by its symbolic name or numerical index), depending whether true
 151         (suspend) or false (resume) is passed as last argument. Suspending
 152         a source will pause all capturing. Depending on the module implementing
 153         the source this might have the effect that the underlying device is
 154         closed, making it available for other applications to use. The exact
 155         behaviour depends on the module.
 156       </p></optdesc>
 157     </option>
 158
 159     <option>
 160       <p><opt>set-card-profile</opt> <arg>CARD</arg> <arg>PROFILE</arg></p>
 161       <optdesc><p>Set the specified card (identified by its symbolic name or numerical index) to the specified profile (identified by its symbolic name).</p></optdesc>
 162     </option>
 163
 164     <option>
 165       <p><opt>get-default-sink</opt></p>
 166       <optdesc><p>Returns the symbolic name of the default sink.</p></optdesc>
 167     </option>
 168
 169     <option>
 170       <p><opt>set-default-sink</opt> <arg>SINK</arg></p>
 171       <optdesc><p>Make the specified sink (identified by its symbolic name or numerical index) the default sink.</p></optdesc>
 172     </option>
 173
 174     <option>
 175       <p><opt>set-sink-port</opt> <arg>SINK</arg> <arg>PORT</arg></p>
 176       <optdesc><p>Set the specified sink (identified by its symbolic name or numerical index) to the specified port (identified by its symbolic name).</p></optdesc>
 177     </option>
 178
 179     <option>
 180       <p><opt>get-default-source</opt></p>
 181       <optdesc><p>Returns the symbolic name of the default source.</p></optdesc>
 182     </option>
 183
 184     <option>
 185       <p><opt>set-default-source</opt> <arg>SOURCE</arg></p>
 186       <optdesc><p>Make the specified source (identified by its symbolic name or numerical index) the default source.</p></optdesc>
 187     </option>
 188
 189     <option>
 190       <p><opt>set-source-port</opt> <arg>SOURCE</arg> <arg>PORT</arg></p>
 191       <optdesc><p>Set the specified source (identified by its symbolic name or numerical index) to the specified port (identified by its symbolic name).</p></optdesc>
 192     </option>
 193
 194     <option>
 195       <p><opt>set-port-latency-offset</opt> <arg>CARD</arg> <arg>PORT</arg> <arg>OFFSET</arg></p>
 196       <optdesc><p>Set a latency offset to a specified port (identified by its symbolic name) that belongs to a card (identified by its symbolic name or numerical index).
 197       <arg>OFFSET</arg> is a number which represents the latency offset in microseconds</p></optdesc>
 198     </option>
 199
 200     <option>
 201       <p><opt>get-sink-volume</opt> <arg>SINK</arg></p>
 202       <optdesc><p>Get the volume of the specified sink (identified by its symbolic name or numerical index) displayed in the same format as the `info` command.</p></optdesc>
 203     </option>
 204
 205     <option>
 206       <p><opt>set-sink-volume</opt> <arg>SINK</arg> <arg>VOLUME [VOLUME ...]</arg></p>
 207       <optdesc><p>Set the volume of the specified sink (identified by its symbolic name or numerical index).
 208       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 209       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 210       adjustment will be relative to the current sink volume.  A single volume value affects all channels; if multiple
 211       volume values are given their number has to match the sink's number of channels.</p></optdesc>
 212     </option>
 213
 214     <option>
 215       <p><opt>get-source-volume</opt> <arg>SOURCE</arg></p>
 216 ```
 217       <optdesc><p>Get the volume of the specified source (identified by its symbolic name or numerical index) displayed in the same format as the `info` command.</p></optdesc>
 218     </option>
 219
 220     <option>
 221       <p><opt>set-source-volume</opt> <arg>SOURCE</arg> <arg>VOLUME [VOLUME ...]</arg></p>
 222       <optdesc><p>Set the volume of the specified source (identified by its symbolic name or numerical index).
 223       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 224       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 225       adjustment will be relative to the current source volume.  A single volume value affects all channels; if multiple
 226       volume values are given their number has to match the source's number of channels.</p></optdesc> </option>
 227
 228     <option>
 229       <p><opt>set-sink-input-volume</opt> <arg>INPUT</arg> <arg>VOLUME [VOLUME ...]</arg></p>
 230       <optdesc><p>Set the volume of the specified sink input (identified by its numerical index).
 231       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 232       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 233       adjustment will be relative to the current sink input volume.  A single volume value affects all channels; if multiple
 234       volume values are given their number has to match the sink input's number of channels.</p></optdesc> </option>
 235
 236     <option>
 237       <p><opt>set-source-output-volume</opt> <arg>OUTPUT</arg> <arg>VOLUME [VOLUME ...]</arg></p>
 238       <optdesc><p>Set the volume of the specified source output (identified by its numerical index).
 239       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 240       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 241       adjustment will be relative to the current source output volume.  A single volume value affects all channels; if multiple
 242       volume values are given their number has to match the source output's number of channels.</p></optdesc>
 243     </option>
 244
 245     <option>
 246       <p><opt>get-sink-mute</opt> <arg>SINK</arg></p>
 247       <optdesc><p>Get the mute status of the specified sink (identified by its symbolic name or numerical index).</p></optdesc>
 248     </option>
 249
 250     <option>
 251       <p><opt>set-sink-mute</opt> <arg>SINK</arg> <arg>1|0|toggle</arg></p>
 252       <optdesc><p>Set the mute status of the specified sink (identified by its symbolic name or numerical index).</p></optdesc>
 253     </option>
 254
 255     <option>
 256       <p><opt>get-source-mute</opt> <arg>SOURCE</arg></p>
 257       <optdesc><p>Get the mute status of the specified source (identified by its symbolic name or numerical index).</p></optdesc>
 258     </option>
 259
 260     <option>
 261       <p><opt>set-source-mute</opt> <arg>SOURCE</arg> <arg>1|0|toggle</arg></p>
 262       <optdesc><p>Set the mute status of the specified source (identified by its symbolic name or numerical index).</p></optdesc>
 263     </option>
 264
 265     <option>
 266       <p><opt>set-sink-input-mute</opt> <arg>INPUT</arg> <arg>1|0|toggle</arg></p>
 267       <optdesc><p>Set the mute status of the specified sink input (identified by its numerical index).</p></optdesc>
 268     </option>
 269
 270     <option>
 271       <p><opt>set-source-output-mute</opt> <arg>OUTPUT</arg> <arg>1|0|toggle</arg></p>
 272       <optdesc><p>Set the mute status of the specified source output (identified by its numerical index).</p></optdesc>
 273     </option>
 274
 275     <option>
 276       <p><opt>set-sink-formats</opt> <arg>SINK</arg> <arg>FORMATS</arg></p>
 277       <optdesc><p>Set the supported formats of the specified sink (identified
 278       by its numerical index) if supported by the sink. <arg>FORMATS</arg> is
 279       specified as a semi-colon (;) separated list of formats in the form
 280       'encoding[, key1=value1, key2=value2, ...]' (for example, AC3 at 32000,
 281       44100 and 48000 Hz would be specified as
 282       'ac3-iec61937, format.rate = "[ 32000, 44100, 48000 ]"'). See
 283       https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
 284       for possible encodings. </p></optdesc>
 285     </option>
 286
 287     <option>
 288       <p><opt>send-message</opt> <arg>RECIPIENT</arg> <arg>MESSAGE</arg> <arg>MESSAGE_PARAMETERS</arg></p>
 289       <optdesc><p>Send a message to the specified recipient object. If applicable an additional string containing
 290       message parameters can be specified. A string is returned as a response to the message. For available messages
 291       see https://cgit.freedesktop.org/pulseaudio/pulseaudio/tree/doc/messaging_api.txt.</p></optdesc>
 292     </option>
 293
 294     <option>
 295       <p><opt>subscribe</opt></p>
 296       <optdesc><p>Subscribe to events, pactl does not exit by itself, but keeps waiting for new events.</p></optdesc>
 297     </option>
 298
 299   </section>
 300
 301   <section name="Authors">
 302     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 303   </section>
 304
 305   <seealso>
 306     <p>
 307       <manref name="pulseaudio" section="1"/>,
 308       <manref name="pacmd" section="1"/>
 309     </p>
 310   </seealso>
 311
 312 </manpage>