add a couple of more man pages

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2024 fefdeb5f-60dc-0310-8127-8f9354f1896f
This commit is contained in:
Lennart Poettering 2007-11-05 23:56:00 +00:00
parent bff4ca431b
commit 7fdc1ee083
8 changed files with 867 additions and 4 deletions

145
man/pactl.1.xml.in Normal file
View file

@ -0,0 +1,145 @@
<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
<!-- $Id$ -->
<!--
This file is part of PulseAudio.
PulseAudio is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with PulseAudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.
-->
<manpage name="pactl" section="1" desc="Control a running PulseAudio sound server">
<synopsis>
<cmd>pulseaudio [<arg>options</arg>] stat</cmd>
<cmd>pulseaudio [<arg>options</arg>] list</cmd>
<cmd>pulseaudio [<arg>options</arg>] exit</cmd>
<cmd>pulseaudio [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
<cmd>pulseaudio [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
<cmd>pulseaudio [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
<cmd>pulseaudio [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
<cmd>pulseaudio [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
<cmd>pulseaudio [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
<cmd>pulseaudio [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
<cmd>pulseaudio [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
<cmd>pulseaudio [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
<cmd>pulseaudio <opt>--help</opt></cmd>
<cmd>pulseaudio <opt>--version</opt></cmd>
</synopsis>
<description>
<p>PulseAudio is a networked low-latency sound server for Linux, POSIX and Windows systems.</p>
</description>
<options>
<option>
<p><opt>-h | --help</opt></p>
<optdesc><p>Show help.</p></optdesc>
</option>
<option>
<p><opt>--version</opt></p>
<optdesc><p>Show version information.</p></optdesc>
</option>
<option>
<p><opt>-s | --server</opt><arg>=SERVER</arg></p>
<optdesc><p>Choose the server to connect to.</p></optdesc>
</option>
<option>
<p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
<optdesc><p>Specify the client name <file>pactl</file> shall pass to the server when connecting.</p></optdesc>
</option>
<option>
<p><opt>stat</opt></p>
<optdesc><p>Dump a few statistics about the PulseAudio daemon.</p></optdesc>
</option>
<option>
<p><opt>list</opt></p>
<optdesc><p>Dump all currently loaded modules, available sinks, sources, streams and clients.</p></optdesc>
</option>
<option>
<p><opt>exit</opt></p>
<optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc>
</option>
<option>
<p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p>
<optdesc><p>Upload a sound from the specified audio file into
the sample cache. The file types supported are those understood
by <file>libsndfile</file>. The sample in the cache is named
after the audio file, unless the name is explicitly
specified.</p></optdesc>
</option>
<option>
<p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p>
<optdesc><p>Play the specified sample from the sample cache. It
is played on the default sink, unless the symbolic name or the
numerical index of the sink to play it on is
specified.</p></optdesc>
</option>
<option>
<p><opt>remove-sample</opt> <arg>NAME</arg></p>
<optdesc><p>Remove the specified sample from the sample cache.</p></optdesc>
</option>
<option>
<p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p>
<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>
</option>
<option>
<p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p>
<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>
</option>
</options>
<section name="Authors">
<p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
</section>
<section name="See also">
<p>
<manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
</p>
</section>
</manpage>