code.delx.au - pulseaudio/blob - man/pacat.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="pacat" section="1" desc="Play back or record raw audio streams on a PulseAudio sound server">
  27
  28   <synopsis>
  29     <cmd>pacat [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  30     <cmd>parec [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  31     <cmd>paplay <opt>--help</opt></cmd>
  32     <cmd>paplay <opt>--version</opt></cmd>
  33   </synopsis>
  34
  35   <description>
  36     <p><file>pacat</file> is a simple tool for playing back or
  37     capturing raw audio files on a PulseAudio sound server.</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>-r | --record</opt></p>
  56
  57       <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>
  58     </option>
  59
  60     <option>
  61       <p><opt>-p | --playback</opt></p>
  62
  63       <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>
  64     </option>
  65
  66     <option>
  67       <p><opt>-v | --verbose</opt></p>
  68
  69       <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.</p></optdesc>
  70     </option>
  71
  72     <option>
  73       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  74
  75       <optdesc><p>Choose the server to connect to.</p></optdesc>
  76     </option>
  77
  78     <option>
  79       <p><opt>-d | --device</opt><arg>=SINKORSOURCE</arg></p>
  80
  81       <optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc>
  82     </option>
  83
  84     <option>
  85       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  86
  87       <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
  88     </option>
  89
  90     <option>
  91       <p><opt>--stream-name</opt><arg>=NAME</arg></p>
  92
  93       <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
  94     </option>
  95
  96     <option>
  97       <p><opt>--volume</opt><arg>=VOLUME</arg></p>
  98
  99       <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
 100     </option>
 101
 102     <option>
 103       <p><opt>--rate</opt><arg>=SAMPLERATE</arg></p>
 104
 105       <optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc>
 106     </option>
 107
 108     <option>
 109       <p><opt>--format</opt><arg>=FORMAT</arg></p>
 110
 111       <optdesc><p>Capture or play back audio with the specified sample
 112       format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
 113       <opt>s16be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
 114       <opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianess of
 115       the CPU the formats <opt>s16ne</opt>, <opt>s16re</opt>,
 116       <opt>float32ne</opt>, <opt>float32re</opt> (for native,
 117       resp. reverse endian) are available as aliases. Defaults to
 118       s16ne.</p></optdesc>
 119     </option>
 120
 121     <option>
 122       <p><opt>--channels</opt><arg>=CHANNELS</arg></p>
 123
 124       <optdesc><p>Capture or play back audio with the specified number
 125       of channels. If more than two channels are used it is
 126       recommended to use the <opt>--channel-map</opt> option
 127       below. Defaults to 2.</p></optdesc>
 128     </option>
 129
 130     <option>
 131       <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
 132
 133       <optdesc><p>Explicitly choose a channel map when playing back
 134       this stream. The argument should be a comma separated list of
 135       channel names: <opt>front-left</opt>, <opt>front-right</opt>,
 136       <opt>mono</opt>, <opt>front-center</opt>, <opt>rear-left</opt>,
 137       <opt>rear-right</opt>, <opt>rear-center</opt>, <opt>lfe</opt>,
 138       <opt>front-left-of-center</opt>,
 139       <opt>front-right-of-center</opt>, <opt>side-left</opt>,
 140       <opt>side-right</opt>, <opt>top-center</opt>,
 141       <opt>top-front-center</opt>, <opt>top-front-left</opt>,
 142       <opt>top-front-right</opt>, <opt>top-rear-left</opt>,
 143       <opt>top-rear-right</opt>, <opt>top-rear-center</opt>, or any of
 144       the 32 auxiliary channel names <opt>aux0</opt> to
 145       <opt>aux31</opt>.</p></optdesc>
 146     </option>
 147
 148     <option>
 149       <p><opt>--fix-format</opt></p>
 150       <optdesc><p>If passed, the sample format of the stream is changed to the native format of the sink the stream is connected to.</p></optdesc>
 151     </option>
 152
 153     <option>
 154       <p><opt>--fix-rate</opt></p>
 155       <optdesc><p>If passed, the sampling rate of the stream is changed to the native rate of the sink the stream is connected to.</p></optdesc>
 156     </option>
 157
 158     <option>
 159       <p><opt>--fix-channels</opt></p>
 160       <optdesc><p>If passed, the number of channels and the channel map of the stream is changed to the native number of channels and the native channel map of the sink the stream is connected to.</p></optdesc>
 161     </option>
 162
 163     <option>
 164       <p><opt>--no-remix</opt></p>
 165       <optdesc><p>Never upmix or downmix channels.</p></optdesc>
 166     </option>
 167
 168     <option>
 169       <p><opt>--no-remap</opt></p>
 170       <optdesc><p>Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.</p></optdesc>
 171     </option>
 172
 173   </options>
 174
 175   <section name="Authors">
 176     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 177   </section>
 178
 179   <section name="See also">
 180     <p>
 181       <manref name="pulseaudio" section="1"/>, <manref name="paplay" section="1"/>
 182     </p>
 183   </section>
 184
 185 </manpage>