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 <!-- $Id$ -->
   6
   7 <!--
   8 This file is part of PulseAudio.
   9
  10 PulseAudio is free software; you can redistribute it and/or modify it
  11 under the terms of the GNU Lesser General Public License as
  12 published by the Free Software Foundation; either version 2.1 of the
  13 License, or (at your option) any later version.
  14
  15 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  18 Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with PulseAudio; if not, write to the Free Software
  22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23 USA.
  24 -->
  25
  26 <manpage name="pactl" section="1" desc="Control a running PulseAudio sound server">
  27
  28   <synopsis>
  29     <cmd>pactl [<arg>options</arg>] stat</cmd>
  30     <cmd>pactl [<arg>options</arg>] list</cmd>
  31     <cmd>pactl [<arg>options</arg>] exit</cmd>
  32     <cmd>pactl [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
  33     <cmd>pactl [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
  34     <cmd>pactl [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
  35     <cmd>pactl [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
  36     <cmd>pactl [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
  37     <cmd>pactl [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
  38     <cmd>pactl [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
  39     <cmd>pactl [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
  40     <cmd>pactl [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
  41     <cmd>pactl <opt>--help</opt></cmd>
  42     <cmd>pactl <opt>--version</opt></cmd>
  43   </synopsis>
  44
  45   <description>
  46     <p><file>pactl</file> can be used to issue control commands to the PulseAudio sound server.</p>
  47
  48     <p><file>pactl</file> only exposes a subset of the available operations. For the full set use the <manref name="pacmd" section="1"/>.</p>
  49   </description>
  50
  51   <options>
  52
  53     <option>
  54       <p><opt>-h | --help</opt></p>
  55
  56       <optdesc><p>Show help.</p></optdesc>
  57     </option>
  58
  59     <option>
  60       <p><opt>--version</opt></p>
  61
  62       <optdesc><p>Show version information.</p></optdesc>
  63     </option>
  64
  65     <option>
  66       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  67
  68       <optdesc><p>Choose the server to connect to.</p></optdesc>
  69     </option>
  70
  71     <option>
  72       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  73
  74       <optdesc><p>Specify the client name <file>pactl</file> shall pass to the server when connecting.</p></optdesc>
  75     </option>
  76
  77     <option>
  78       <p><opt>stat</opt></p>
  79
  80       <optdesc><p>Dump a few statistics about the PulseAudio daemon.</p></optdesc>
  81     </option>
  82
  83     <option>
  84       <p><opt>list</opt></p>
  85
  86       <optdesc><p>Dump all currently loaded modules, available sinks, sources, streams and clients.</p></optdesc>
  87     </option>
  88
  89     <option>
  90       <p><opt>exit</opt></p>
  91
  92       <optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc>
  93     </option>
  94
  95
  96     <option>
  97       <p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p>
  98
  99       <optdesc><p>Upload a sound from the specified audio file into
 100       the sample cache. The file types supported are those understood
 101       by <file>libsndfile</file>. The sample in the cache is named
 102       after the audio file, unless the name is explicitly
 103       specified.</p></optdesc>
 104
 105     </option>
 106
 107     <option>
 108       <p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p>
 109
 110       <optdesc><p>Play the specified sample from the sample cache. It
 111       is played on the default sink, unless the symbolic name or the
 112       numerical index of the sink to play it on is
 113       specified.</p></optdesc>
 114
 115     </option>
 116
 117     <option>
 118       <p><opt>remove-sample</opt> <arg>NAME</arg></p>
 119
 120       <optdesc><p>Remove the specified sample from the sample cache.</p></optdesc>
 121     </option>
 122
 123     <option>
 124       <p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p>
 125
 126       <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>
 127     </option>
 128
 129     <option>
 130       <p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p>
 131
 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>load-module</opt> <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</p>
 137
 138       <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>
 139     </option>
 140
 141     <option>
 142       <p><opt>unload-module</opt> <arg>ID</arg></p>
 143
 144       <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
 145     </option>
 146
 147     <option>
 148       <p><opt>unload-module</opt> <arg>ID</arg></p>
 149
 150       <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
 151     </option>
 152
 153     <option>
 154       <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
 155
 156       <optdesc><p>Suspend or resume the specified sink (which my be
 157       specified either by its symbolic name, or by its numeric index),
 158       depending whether 1 (suspend) or 0 (resume) is passed as last
 159       argument. Suspending a sink will pause all playback. Depending
 160       on the module implementing the sink this might have the effect
 161       that the underlying device is closed, making it available for
 162       other applications to use. The exact behaviour depends on the
 163       module.</p></optdesc>
 164     </option>
 165
 166     <option>
 167       <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
 168
 169       <optdesc><p>Suspend or resume the specified source (which my be
 170       specified either by its symbolic name, or by its numeric index),
 171       depending whether 1 (suspend) or 0 (resume) is passed as last
 172       argument. Suspending a source will pause all
 173       capturing. Depending on the module implementing the source this
 174       might have the effect that the underlying device is closed,
 175       making it available for other applications to use. The exact
 176       behaviour depends on the module.</p></optdesc>
 177     </option>
 178
 179   </options>
 180
 181   <section name="Authors">
 182     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 183   </section>
 184
 185   <section name="See also">
 186     <p>
 187       <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
 188     </p>
 189   </section>
 190
 191 </manpage>