add a couple of more man pages

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2024 fefdeb5f-60dc-0310-8127-8f9354f1896f

1 files changed, 160 insertions, 0 deletions

diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
new file mode 100644
index 00000000..35c7651b
--- /dev/null
+++ b/man/pacat.1.xml.in
@@ -0,0 +1,160 @@
+<?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="pacat" section="1" desc="Play back or record raw audio streams on a PulseAudio sound server">
+
+  <synopsis>
+    <cmd>pacat [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
+    <cmd>parec [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
+    <cmd>paplay <opt>--help</opt></cmd>
+    <cmd>paplay <opt>--version</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p><file>pacat</file> is a simple tool for playing back or
+    capturing raw audio files on a PulseAudio sound server.</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>-r | --record</opt></p>
+
+      <optdesc><p>Capture raw audio data and write it to the specified file or to STDOUT if none is specified. If the tool is called under the name <file>parec</file> this is the default.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-p | --playback</opt></p>
+
+      <optdesc><p>Read raw audio data from the specified file or STDIN if none is specified, and play it back. If the tool is called under the name <file>pacat</file> this is the default.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-v | --verbose</opt></p>
+
+      <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.</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>-d | --device</opt><arg>=SINKORSOURCE</arg></p>
+
+      <optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--stream-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--volume</opt><arg>=VOLUME</arg></p>
+
+      <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--rate</opt><arg>=SAMPLERATE</arg></p>
+
+      <optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--format</opt><arg>=FORMAT</arg></p>
+
+      <optdesc><p>Capture or play back audio with the specified sample
+      format. Specify one of <arg>u8</arg>, <arg>s16le</arg>,
+      <arg>s16be</arg>, <arg>float32le</arg>, <arg>float32be</arg>,
+      <arg>ulaw</arg>, <arg>alaw</arg>. Depending on the endianess of
+      the CPU the formats <arg>s16ne</arg>, <arg>s16re</arg>,
+      <arg>float32ne</arg>, <arg>float32re</arg> (for native,
+      resp. reverse endian) are available as aliases. Defaults to
+      s16ne.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--channels</opt><arg>=CHANNELS</arg></p>
+
+      <optdesc><p>Capture or play back audio with the specified number
+      of channels. If more than two channels are used it is
+      recommended to use the <opt>--channel-map</opt> option
+      below. Defaults to 2.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
+
+      <optdesc><p>Explicitly choose a channel map when playing back
+      this stream. The argument should be a comma separated list of
+      channel names: <arg>front-left</arg>, <arg>front-right</arg>,
+      <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
+      <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
+      <arg>front-left-of-center</arg>,
+      <arg>front-right-of-center</arg>, <arg>side-left</arg>,
+      <arg>side-right</arg>, <arg>top-center</arg>,
+      <arg>top-front-center</arg>, <arg>top-front-left</arg>,
+      <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
+      <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
+      the 32 auxiliary channel names <arg>aux0</arg> to
+      <arg>aux31</arg>.</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="paplay" section="1"/>
+    </p>
+  </section>
+
+</manpage>