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>] stat</cmd>
  28     <cmd>pactl [<arg>options</arg>] list</cmd>
  29     <cmd>pactl [<arg>options</arg>] exit</cmd>
  30     <cmd>pactl [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
  31     <cmd>pactl [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
  32     <cmd>pactl [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
  33     <cmd>pactl [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
  34     <cmd>pactl [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
  35     <cmd>pactl [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
  36     <cmd>pactl [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
  37     <cmd>pactl [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
  38     <cmd>pactl [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
  39     <cmd>pactl <opt>--help</opt></cmd>
  40     <cmd>pactl <opt>--version</opt></cmd>
  41   </synopsis>
  42
  43   <description>
  44     <p><file>pactl</file> can be used to issue control commands to the PulseAudio sound server.</p>
  45
  46     <p><file>pactl</file> only exposes a subset of the available operations. For the full set use the <manref name="pacmd" section="1"/>.</p>
  47   </description>
  48
  49   <options>
  50
  51     <option>
  52       <p><opt>-h | --help</opt></p>
  53
  54       <optdesc><p>Show help.</p></optdesc>
  55     </option>
  56
  57     <option>
  58       <p><opt>--version</opt></p>
  59
  60       <optdesc><p>Show version information.</p></optdesc>
  61     </option>
  62
  63     <option>
  64       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  65
  66       <optdesc><p>Choose the server to connect to.</p></optdesc>
  67     </option>
  68
  69     <option>
  70       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  71
  72       <optdesc><p>Specify the client name <file>pactl</file> shall pass to the server when connecting.</p></optdesc>
  73     </option>
  74
  75     <option>
  76       <p><opt>stat</opt></p>
  77
  78       <optdesc><p>Dump a few statistics about the PulseAudio daemon.</p></optdesc>
  79     </option>
  80
  81     <option>
  82       <p><opt>list</opt></p>
  83
  84       <optdesc><p>Dump all currently loaded modules, available sinks, sources, streams and clients.</p></optdesc>
  85     </option>
  86
  87     <option>
  88       <p><opt>exit</opt></p>
  89
  90       <optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc>
  91     </option>
  92
  93
  94     <option>
  95       <p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p>
  96
  97       <optdesc><p>Upload a sound from the specified audio file into
  98       the sample cache. The file types supported are those understood
  99       by <file>libsndfile</file>. The sample in the cache is named
 100       after the audio file, unless the name is explicitly
 101       specified.</p></optdesc>
 102
 103     </option>
 104
 105     <option>
 106       <p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p>
 107
 108       <optdesc><p>Play the specified sample from the sample cache. It
 109       is played on the default sink, unless the symbolic name or the
 110       numerical index of the sink to play it on is
 111       specified.</p></optdesc>
 112
 113     </option>
 114
 115     <option>
 116       <p><opt>remove-sample</opt> <arg>NAME</arg></p>
 117
 118       <optdesc><p>Remove the specified sample from the sample cache.</p></optdesc>
 119     </option>
 120
 121     <option>
 122       <p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p>
 123
 124       <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>
 125     </option>
 126
 127     <option>
 128       <p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p>
 129
 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>load-module</opt> <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</p>
 135
 136       <optdesc><p>Load the specified module with the specified arguments into the running sound server. Prints the numeric index of the module just loaded to STDOUT. You can use it to unload the module later.</p></optdesc>
 137     </option>
 138
 139     <option>
 140       <p><opt>unload-module</opt> <arg>ID</arg></p>
 141
 142       <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
 143     </option>
 144
 145     <option>
 146       <p><opt>unload-module</opt> <arg>ID</arg></p>
 147
 148       <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
 149     </option>
 150
 151     <option>
 152       <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
 153
 154       <optdesc><p>Suspend or resume the specified sink (which my be
 155       specified either by its symbolic name, or by its numeric index),
 156       depending whether 1 (suspend) or 0 (resume) is passed as last
 157       argument. Suspending a sink will pause all playback. Depending
 158       on the module implementing the sink this might have the effect
 159       that the underlying device is closed, making it available for
 160       other applications to use. The exact behaviour depends on the
 161       module.</p></optdesc>
 162     </option>
 163
 164     <option>
 165       <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
 166
 167       <optdesc><p>Suspend or resume the specified source (which my be
 168       specified either by its symbolic name, or by its numeric index),
 169       depending whether 1 (suspend) or 0 (resume) is passed as last
 170       argument. Suspending a source will pause all
 171       capturing. Depending on the module implementing the source this
 172       might have the effect that the underlying device is closed,
 173       making it available for other applications to use. The exact
 174       behaviour depends on the module.</p></optdesc>
 175     </option>
 176
 177   </options>
 178
 179   <section name="Authors">
 180     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 181   </section>
 182
 183   <section name="See also">
 184     <p>
 185       <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
 186     </p>
 187   </section>
 188
 189 </manpage>