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