man/paplay.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 <!--
   6 This file is part of PulseAudio.
   7
   8 PulseAudio is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU Lesser General Public License as
  10 published by the Free Software Foundation; either version 2.1 of the
  11 License, or (at your option) any later version.
  12
  13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16 Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with PulseAudio; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 USA.
  22 -->
  23
  24 <manpage name="paplay" section="1" desc="Play back audio files on a PulseAudio sound server">
  25
  26   <synopsis>
  27     <cmd>paplay [<arg>options</arg>] <arg>FILE</arg></cmd>
  28     <cmd>paplay <opt>--help</opt></cmd>
  29     <cmd>paplay <opt>--version</opt></cmd>
  30   </synopsis>
  31
  32   <description>
  33     <p><file>paplay</file> is a simple tool for playing back audio
  34     files on a PulseAudio sound server. It understands all audio file
  35     formats supported by <file>libsndfile</file>.</p>
  36   </description>
  37
  38   <options>
  39
  40     <option>
  41       <p><opt>-h | --help</opt></p>
  42
  43       <optdesc><p>Show help.</p></optdesc>
  44     </option>
  45
  46     <option>
  47       <p><opt>--version</opt></p>
  48
  49       <optdesc><p>Show version information.</p></optdesc>
  50     </option>
  51
  52     <option>
  53       <p><opt>-v | --verbose</opt></p>
  54
  55       <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback.</p></optdesc>
  56     </option>
  57
  58     <option>
  59       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  60
  61       <optdesc><p>Choose the server to connect to.</p></optdesc>
  62     </option>
  63
  64     <option>
  65       <p><opt>-d | --device</opt><arg>=SINK</arg></p>
  66
  67       <optdesc><p>Specify the symbolic name of the sink to play this file on.</p></optdesc>
  68     </option>
  69
  70     <option>
  71       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  72
  73       <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
  74     </option>
  75
  76     <option>
  77       <p><opt>--stream-name</opt><arg>=NAME</arg></p>
  78
  79       <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
  80     </option>
  81
  82     <option>
  83       <p><opt>--volume</opt><arg>=VOLUME</arg></p>
  84
  85       <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
  86     </option>
  87
  88     <option>
  89       <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
  90
  91       <optdesc><p>Explicitly choose a channel map when playing back
  92       this stream. The argument should be a comma separated list of
  93       channel names: <arg>front-left</arg>, <arg>front-right</arg>,
  94       <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
  95       <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
  96       <arg>front-left-of-center</arg>,
  97       <arg>front-right-of-center</arg>, <arg>side-left</arg>,
  98       <arg>side-right</arg>, <arg>top-center</arg>,
  99       <arg>top-front-center</arg>, <arg>top-front-left</arg>,
 100       <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
 101       <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
 102       the 32 auxiliary channel names <arg>aux0</arg> to
 103       <arg>aux31</arg>.</p></optdesc>
 104     </option>
 105
 106   </options>
 107
 108   <section name="Limitations">
 109
 110     <p>Due to a limitation in <file>libsndfile</file>
 111     <file>paplay</file> currently does not always set the correct channel
 112     mapping for playback of multichannel (i.e. surround) audio files, even if the channel mapping information is
 113     available in the audio file.</p>
 114
 115   </section>
 116
 117   <section name="Authors">
 118     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 119   </section>
 120
 121   <section name="See also">
 122     <p>
 123       <manref name="pulseaudio" section="1"/>, <manref name="pacat" section="1"/>
 124     </p>
 125   </section>
 126
 127 </manpage>