diff options
Diffstat (limited to 'man/paplay.1.xml.in')
-rw-r--r-- | man/paplay.1.xml.in | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/man/paplay.1.xml.in b/man/paplay.1.xml.in new file mode 100644 index 00000000..bab45dc3 --- /dev/null +++ b/man/paplay.1.xml.in @@ -0,0 +1,129 @@ +<?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="paplay" section="1" desc="Play back audio files on a PulseAudio sound server"> + + <synopsis> + <cmd>paplay [<arg>options</arg>] <arg>FILE</arg></cmd> + <cmd>paplay <opt>--help</opt></cmd> + <cmd>paplay <opt>--version</opt></cmd> + </synopsis> + + <description> + <p><file>paplay</file> is a simple tool for playing back audio + files on a PulseAudio sound server. It understands all audio file + formats supported by <file>libsndfile</file>.</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>-v | --verbose</opt></p> + + <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback.</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>=SINK</arg></p> + + <optdesc><p>Specify the symbolic name of the sink to play this file on.</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>--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="Limitations"> + + <p>Due to a limitation in <file>libsndfile</file> + <file>paplay</file> currently does not always set the correct channel + mapping for playback of multichannel (i.e. surround) audio files, even if the channel mapping information is + available in the audio file.</p> + + </section> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="pacat" section="1"/> + </p> + </section> + +</manpage> |