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>pulseaudio [<arg>options</arg>] stat</cmd>
  30     <cmd>pulseaudio [<arg>options</arg>] list</cmd>
  31     <cmd>pulseaudio [<arg>options</arg>] exit</cmd>
  32     <cmd>pulseaudio [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
  33     <cmd>pulseaudio [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
  34     <cmd>pulseaudio [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
  35     <cmd>pulseaudio [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
  36     <cmd>pulseaudio [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
  37     <cmd>pulseaudio [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
  38     <cmd>pulseaudio [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
  39     <cmd>pulseaudio [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
  40     <cmd>pulseaudio [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
  41     <cmd>pulseaudio <opt>--help</opt></cmd>
  42     <cmd>pulseaudio <opt>--version</opt></cmd>
  43   </synopsis>
  44
  45   <description>
  46     <p>PulseAudio is a networked low-latency sound server for Linux, POSIX and Windows systems.</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   </options>
 134
 135   <section name="Authors">
 136     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 137   </section>
 138
 139   <section name="See also">
 140     <p>
 141       <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
 142     </p>
 143   </section>
 144
 145 </manpage>