code.delx.au - pulseaudio/blob - 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 <!-- $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="paplay" section="1" desc="Play back audio files on a PulseAudio sound server">
  27
  28   <synopsis>
  29     <cmd>paplay [<arg>options</arg>] <arg>FILE</arg></cmd>
  30     <cmd>paplay <opt>--help</opt></cmd>
  31     <cmd>paplay <opt>--version</opt></cmd>
  32   </synopsis>
  33
  34   <description>
  35     <p><file>paplay</file> is a simple tool for playing back audio
  36     files on a PulseAudio sound server. It understands all audio file
  37     formats supported by <file>libsndfile</file>.</p>
  38   </description>
  39
  40   <options>
  41
  42     <option>
  43       <p><opt>-h | --help</opt></p>
  44
  45       <optdesc><p>Show help.</p></optdesc>
  46     </option>
  47
  48     <option>
  49       <p><opt>--version</opt></p>
  50
  51       <optdesc><p>Show version information.</p></optdesc>
  52     </option>
  53
  54     <option>
  55       <p><opt>-v | --verbose</opt></p>
  56
  57       <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback.</p></optdesc>
  58     </option>
  59
  60     <option>
  61       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  62
  63       <optdesc><p>Choose the server to connect to.</p></optdesc>
  64     </option>
  65
  66     <option>
  67       <p><opt>-d | --device</opt><arg>=SINK</arg></p>
  68
  69       <optdesc><p>Specify the symbolic name of the sink to play this file on.</p></optdesc>
  70     </option>
  71
  72     <option>
  73       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  74
  75       <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
  76     </option>
  77
  78     <option>
  79       <p><opt>--stream-name</opt><arg>=NAME</arg></p>
  80
  81       <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
  82     </option>
  83
  84     <option>
  85       <p><opt>--volume</opt><arg>=VOLUME</arg></p>
  86
  87       <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
  88     </option>
  89
  90     <option>
  91       <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
  92
  93       <optdesc><p>Explicitly choose a channel map when playing back
  94       this stream. The argument should be a comma separated list of
  95       channel names: <arg>front-left</arg>, <arg>front-right</arg>,
  96       <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
  97       <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
  98       <arg>front-left-of-center</arg>,
  99       <arg>front-right-of-center</arg>, <arg>side-left</arg>,
 100       <arg>side-right</arg>, <arg>top-center</arg>,
 101       <arg>top-front-center</arg>, <arg>top-front-left</arg>,
 102       <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
 103       <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
 104       the 32 auxiliary channel names <arg>aux0</arg> to
 105       <arg>aux31</arg>.</p></optdesc>
 106     </option>
 107
 108   </options>
 109
 110   <section name="Limitations">
 111
 112     <p>Due to a limitation in <file>libsndfile</file>
 113     <file>paplay</file> currently does not always set the correct channel
 114     mapping for playback of multichannel (i.e. surround) audio files, even if the channel mapping information is
 115     available in the audio file.</p>
 116
 117   </section>
 118
 119   <section name="Authors">
 120     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 121   </section>
 122
 123   <section name="See also">
 124     <p>
 125       <manref name="pulseaudio" section="1"/>, <manref name="pacat" section="1"/>
 126     </p>
 127   </section>
 128
 129 </manpage>