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></p>
  70       <optdesc><p>Dump a few statistics about the memory usage of the PulseAudio daemon.</p></optdesc>
  71     </option>
  72
  73     <option>
  74       <p><opt>info</opt></p>
  75       <optdesc><p>Dump some info about the PulseAudio daemon.</p></optdesc>
  76     </option>
  77
  78     <option>
  79       <p><opt>list</opt> [short] [<arg>TYPE</arg>]</p>
  80       <optdesc><p>Dump all currently loaded modules, available sinks, sources, streams, etc.  <arg>TYPE</arg> must be one of:
  81       modules, sinks, sources, sink-inputs, source-outputs, clients, samples, cards.  If not specified, all info is listed.  If
  82       short is given, output is in a tabular format, for easy parsing by scripts.</p></optdesc>
  83     </option>
  84
  85     <option>
  86       <p><opt>exit</opt></p>
  87       <optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc>
  88     </option>
  89
  90     <option>
  91       <p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p>
  92       <optdesc><p>Upload a sound from the specified audio file into
  93       the sample cache. The file types supported are those understood
  94       by <file>libsndfile</file>. The sample in the cache is named
  95       after the audio file, unless the name is explicitly
  96       specified.</p></optdesc>
  97     </option>
  98
  99     <option>
 100       <p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p>
 101       <optdesc><p>Play the specified sample from the sample cache. It
 102       is played on the default sink, unless the symbolic name or the
 103       numerical index of the sink to play it on is
 104       specified.</p></optdesc>
 105     </option>
 106
 107     <option>
 108       <p><opt>remove-sample</opt> <arg>NAME</arg></p>
 109       <optdesc><p>Remove the specified sample from the sample cache.</p></optdesc>
 110     </option>
 111
 112     <option>
 113       <p><opt>load-module</opt> <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</p>
 114       <optdesc><p>Load the specified module with the specified arguments into the running sound server.
 115       Prints the numeric index of the module just loaded to STDOUT. You can use it to unload the module later.</p></optdesc>
 116     </option>
 117
 118     <option>
 119       <p><opt>unload-module</opt> <arg>ID</arg></p>
 120       <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
 121     </option>
 122
 123     <option>
 124       <p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p>
 125       <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>
 126     </option>
 127
 128     <option>
 129       <p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p>
 130       <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>
 131     </option>
 132
 133     <option>
 134       <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
 135       <optdesc><p>Suspend or resume the specified sink (which my be
 136       specified either by its symbolic name, or by its numeric index),
 137       depending whether 1 (suspend) or 0 (resume) is passed as last
 138       argument. Suspending a sink will pause all playback. Depending
 139       on the module implementing the sink this might have the effect
 140       that the underlying device is closed, making it available for
 141       other applications to use. The exact behaviour depends on the
 142       module.</p></optdesc>
 143     </option>
 144
 145     <option>
 146       <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
 147       <optdesc><p>Suspend or resume the specified source (which my be
 148       specified either by its symbolic name, or by its numeric index),
 149       depending whether 1 (suspend) or 0 (resume) is passed as last
 150       argument. Suspending a source will pause all
 151       capturing. Depending on the module implementing the source this
 152       might have the effect that the underlying device is closed,
 153       making it available for other applications to use. The exact
 154       behaviour depends on the module.</p></optdesc>
 155     </option>
 156
 157     <option>
 158       <p><opt>set-card-profile</opt> <arg>CARD</arg> <arg>PROFILE</arg></p>
 159       <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>
 160     </option>
 161
 162     <option>
 163       <p><opt>set-sink-port</opt> <arg>SINK</arg> <arg>PORT</arg></p>
 164       <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>
 165     </option>
 166
 167     <option>
 168       <p><opt>set-source-port</opt> <arg>SOURCE</arg> <arg>PORT</arg></p>
 169       <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>
 170     </option>
 171
 172     <option>
 173       <p><opt>set-sink-volume</opt> <arg>SINK</arg> <arg>VOLUME</arg></p>
 174       <optdesc><p>Set the volume of the specified sink (identified by its symbolic name or numerical index).
 175       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 176       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 177       adjustment will be relative to the current sink volume.</p></optdesc>
 178     </option>
 179
 180     <option>
 181       <p><opt>set-source-volume</opt> <arg>SOURCE</arg> <arg>VOLUME</arg></p>
 182       <optdesc><p>Set the volume of the specified source (identified by its symbolic name or numerical index).
 183       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 184       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 185       adjustment will be relative to the current source volume.</p></optdesc> </option>
 186
 187     <option>
 188       <p><opt>set-sink-input-volume</opt> <arg>INPUT</arg> <arg>VOLUME</arg></p>
 189       <optdesc><p>Set the volume of the specified sink input (identified by its numerical index).
 190       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 191       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 192       adjustment will be relative to the current sink input volume.</p></optdesc> </option>
 193
 194     <option>
 195       <p><opt>set-source-output-volume</opt> <arg>OUTPUT</arg> <arg>VOLUME</arg></p>
 196       <optdesc><p>Set the volume of the specified source output (identified by its numerical index).
 197       <arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
 198       (e.g.  10%, 100%) or a decibel value (e.g. 0dB, 20dB).  If the volume specification start with a + or - the volume
 199       adjustment will be relative to the current source output volume.</p></optdesc>
 200     </option>
 201
 202     <option>
 203       <p><opt>set-sink-mute</opt> <arg>SINK</arg> <arg>1|0</arg></p>
 204       <optdesc><p>Set the mute status of the specified sink (identified by its symbolic name or numerical index).</p></optdesc>
 205     </option>
 206
 207     <option>
 208       <p><opt>set-source-mute</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
 209       <optdesc><p>Set the mute status of the specified source (identified by its symbolic name or numerical index).</p></optdesc>
 210     </option>
 211
 212     <option>
 213       <p><opt>set-sink-input-mute</opt> <arg>INPUT</arg> <arg>1|0</arg></p>
 214       <optdesc><p>Set the mute status of the specified sink input (identified by its numerical index).</p></optdesc>
 215     </option>
 216
 217     <option>
 218       <p><opt>subscribe</opt></p>
 219       <optdesc><p>Subscribe to events, pactl does not exit by itself, but keeps waiting for new events.</p></optdesc>
 220     </option>
 221
 222   </section>
 223
 224   <section name="Authors">
 225     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 226   </section>
 227
 228   <seealso>
 229     <p>
 230       <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
 231     </p>
 232   </seealso>
 233
 234 </manpage>