summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorSjoerd Simons <sjoerd@debian.org>2010-12-05 10:37:05 +0000
committerSjoerd Simons <sjoerd@debian.org>2010-12-05 10:37:05 +0000
commitab0adf96be1ac81533bd85a4444cc3c393ac7ac0 (patch)
tree4471a588e0c490856c036d7c71269d19ce3c4b51 /man
parent0201790155d0719dfdd4785a06a5d5f06cfcd7c1 (diff)
Imported Upstream version 0.9.22
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.in6
-rw-r--r--man/pacat.156
-rw-r--r--man/pacat.1.xml.in96
-rw-r--r--man/pactl.13
-rw-r--r--man/pactl.1.xml.in6
5 files changed, 132 insertions, 35 deletions
diff --git a/man/Makefile.in b/man/Makefile.in
index 0976a1a..e54dc76 100644
--- a/man/Makefile.in
+++ b/man/Makefile.in
@@ -1,4 +1,4 @@
-# Makefile.in generated by automake 1.11 from Makefile.am.
+# Makefile.in generated by automake 1.11.1 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
@@ -262,6 +262,8 @@ PA_SYSTEM_RUNTIME_PATH = @PA_SYSTEM_RUNTIME_PATH@
PA_SYSTEM_STATE_PATH = @PA_SYSTEM_STATE_PATH@
PA_SYSTEM_USER = @PA_SYSTEM_USER@
PKG_CONFIG = @PKG_CONFIG@
+PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
+PKG_CONFIG_PATH = @PKG_CONFIG_PATH@
POFILES = @POFILES@
POSUB = @POSUB@
PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@
@@ -322,7 +324,6 @@ libdir = @libdir@
libexecdir = @libexecdir@
localedir = @localedir@
localstatedir = @localstatedir@
-lt_ECHO = @lt_ECHO@
mandir = @mandir@
mkdir_p = @mkdir_p@
modlibexecdir = @modlibexecdir@
@@ -340,6 +341,7 @@ target_alias = @target_alias@
top_build_prefix = @top_build_prefix@
top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
+udevrulesdir = @udevrulesdir@
pulseconfdir = $(sysconfdir)/pulse
CLEANFILES = $(noinst_DATA) $(am__append_1)
noinst_DATA = \
diff --git a/man/pacat.1 b/man/pacat.1
index 7ea2ff6..a79d44c 100644
--- a/man/pacat.1
+++ b/man/pacat.1
@@ -1,17 +1,23 @@
.TH pacat 1 User Manuals
.SH NAME
-pacat \- Play back or record raw audio streams on a PulseAudio sound server
+pacat \- Play back or record raw or encoded audio streams on a PulseAudio sound server
.SH SYNOPSIS
-\fBpacat [\fIoptions\fB] [\fIFILE\fB]
+\fBpaplay [\fIoptions\fB] [\fIFILE\fB]
+
+parecord [\fIoptions\fB] [\fIFILE\fB]
+
+pacat [\fIoptions\fB] [\fIFILE\fB]
parec [\fIoptions\fB] [\fIFILE\fB]
-paplay --help\fB
+pamon [\fIoptions\fB] [\fIFILE\fB]
+
+pacat --help\fB
-paplay --version\fB
+pacat --version\fB
\f1
.SH DESCRIPTION
-\fIpacat\f1 is a simple tool for playing back or capturing raw audio files on a PulseAudio sound server.
+\fIpacat\f1 is a simple tool for playing back or capturing raw or encoded audio files on a PulseAudio sound server.
.SH OPTIONS
.TP
\fB-h | --help\f1
@@ -21,10 +27,10 @@ Show help.
Show version information.
.TP
\fB-r | --record\f1
-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 \fIparec\f1 this is the default.
+Capture audio data and write it to the specified file or to STDOUT if none is specified. If the tool is called under the name \fIparec\f1 this is the default.
.TP
\fB-p | --playback\f1
-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 \fIpacat\f1 this is the default.
+Read audio data from the specified file or STDIN if none is specified, and play it back. If the tool is called under the name \fIpacat\f1 this is the default.
.TP
\fB-v | --verbose\f1
Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.
@@ -48,7 +54,7 @@ Specify the initial playback volume to use. Choose a value between 0 (silent) an
Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.
.TP
\fB--format\f1\fI=FORMAT\f1
-Capture or play back audio with the specified sample format. Specify one of \fBu8\f1, \fBs16le\f1, \fBs16be\f1, \fBs32le\f1, \fBs32be\f1, \fBfloat32le\f1, \fBfloat32be\f1, \fBulaw\f1, \fBalaw\f1. Depending on the endianess of the CPU the formats \fBs16ne\f1, \fBs16re\f1, \fBs32ne\f1, \fBs32re\f1, \fBfloat32ne\f1, \fBfloat32re\f1 (for native, resp. reverse endian) are available as aliases. Defaults to s16ne.
+Capture or play back audio with the specified sample format. Specify one of \fBu8\f1, \fBs16le\f1, \fBs16be\f1, \fBs32le\f1, \fBs32be\f1, \fBfloat32le\f1, \fBfloat32be\f1, \fBulaw\f1, \fBalaw\f1, \fBs32le\f1, \fBs32be\f1, \fBs24le\f1, \fBs24be\f1, \fBs24-32le\f1, \fBs24-32be\f1. Depending on the endianess of the CPU the formats \fBs16ne\f1, \fBs16re\f1, \fBs32ne\f1, \fBs32re\f1, \fBfloat32ne\f1, \fBfloat32re\f1, \fBs32ne\f1, \fBs32re\f1, \fBs24ne\f1, \fBs24re\f1, \fBs24-32ne\f1, \fBs24-32re\f1 (for native, resp. reverse endian) are available as aliases. Defaults to s16ne.
.TP
\fB--channels\f1\fI=CHANNELS\f1
Capture or play back audio with the specified number of channels. If more than two channels are used it is recommended to use the \fB--channel-map\f1 option below. Defaults to 2.
@@ -70,7 +76,39 @@ Never upmix or downmix channels.
.TP
\fB--no-remap\f1
Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.
+.TP
+\fB--latency\f1\fI=BYTES\f1
+Explicitly configure the latency, with a time specified in bytes in the selected sample format. If left out the server will pick the latency, usually relatively high for power saving reasons. Use either this option or \fB--latency-msec\f1, but not both.
+.TP
+\fB--latency-msec\f1\fI=MSEC\f1
+Explicitly configure the latency, with a time specified in miliseconds. If left out the server will pick the latency, usually relatively high for power saving reasons. Use either this option or \fB--latency\f1, but not both.
+.TP
+\fB--process-time\f1\fI=BYTES\f1
+Explicitly configure the process time, with a time specified in bytes in the selected sample format. If left out the server will pick the process time. Use either this option or \fB--process-time-msec\f1, but not both.
+.TP
+\fB--process-time-msec\f1\fI=MSEC\f1
+Explicitly configure the process time, with a time specified in miliseconds. If left out the server will pick the process time. Use either this option or \fB--process-time\f1, but not both.
+.TP
+\fB--property\f1\fI=PROPERTY=VALUE\f1
+Attach a property to the client and stream. May be used multiple times
+.TP
+\fB--raw\f1
+Play/record raw audio data. This is the default if this program is invoked as pacat
+,
+parec
+or
+pamon
+.
+.TP
+\fB--file-format\f1\fI[=FFORMAT]\f1
+Play/record encoded audio data in the file format specified. This is the default if this program is invoked as paplay
+and
+parecord
+.
+.TP
+\fB--list-file-formats\f1
+List supported file formats.
.SH AUTHORS
The PulseAudio Developers <mzchyfrnhqvb (at) 0pointer (dot) net>; PulseAudio is available from \fBhttp://pulseaudio.org/\f1
.SH SEE ALSO
-\fBpulseaudio(1)\f1, \fBpaplay(1)\f1
+\fBpulseaudio(1)\f1, \fBpactl(1)\f1
diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
index 68a3a12..2e27450 100644
--- a/man/pacat.1.xml.in
+++ b/man/pacat.1.xml.in
@@ -21,18 +21,22 @@ 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">
+<manpage name="pacat" section="1" desc="Play back or record raw or encoded audio streams on a PulseAudio sound server">
<synopsis>
+ <cmd>paplay [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
+ <cmd>parecord [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<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>
+ <cmd>pamon [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
+ <cmd>pacat <opt>--help</opt></cmd>
+ <cmd>pacat <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>
+ capturing raw or encoded audio files on a PulseAudio sound
+ server.</p>
</description>
<options>
@@ -52,13 +56,13 @@ USA.
<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>
+ <optdesc><p>Capture 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>
+ <optdesc><p>Read 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>
@@ -108,14 +112,17 @@ USA.
<optdesc><p>Capture or play back audio with the specified sample
format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
- <opt>s16be</opt>, <opt>s32le</opt>,
- <opt>s32be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
- <opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianess of
- the CPU the
- formats <opt>s16ne</opt>, <opt>s16re</opt>, <opt>s32ne</opt>, <opt>s32re</opt>,
- <opt>float32ne</opt>, <opt>float32re</opt> (for native,
- resp. reverse endian) are available as aliases. Defaults to
- s16ne.</p></optdesc>
+ <opt>s16be</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
+ <opt>float32le</opt>, <opt>float32be</opt>, <opt>ulaw</opt>,
+ <opt>alaw</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
+ <opt>s24le</opt>, <opt>s24be</opt>, <opt>s24-32le</opt>,
+ <opt>s24-32be</opt>. Depending on the endianess of the CPU the
+ formats <opt>s16ne</opt>, <opt>s16re</opt>, <opt>s32ne</opt>,
+ <opt>s32re</opt>, <opt>float32ne</opt>, <opt>float32re</opt>,
+ <opt>s32ne</opt>, <opt>s32re</opt>, <opt>s24ne</opt>,
+ <opt>s24re</opt>, <opt>s24-32ne</opt>, <opt>s24-32re</opt> (for
+ native, resp. reverse endian) are available as aliases. Defaults
+ to s16ne.</p></optdesc>
</option>
<option>
@@ -170,6 +177,65 @@ USA.
<optdesc><p>Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.</p></optdesc>
</option>
+ <option>
+ <p><opt>--latency</opt><arg>=BYTES</arg></p>
+ <optdesc><p>Explicitly configure the latency, with a time
+ specified in bytes in the selected sample format. If left out
+ the server will pick the latency, usually relatively high for
+ power saving reasons. Use either this option or
+ <opt>--latency-msec</opt>, but not both.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--latency-msec</opt><arg>=MSEC</arg></p>
+ <optdesc><p>Explicitly configure the latency, with a time
+ specified in miliseconds. If left out the server will pick the
+ latency, usually relatively high for power saving reasons. Use
+ either this option or <opt>--latency</opt>, but not
+ both.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--process-time</opt><arg>=BYTES</arg></p>
+ <optdesc><p>Explicitly configure the process time, with a time
+ specified in bytes in the selected sample format. If left out
+ the server will pick the process time. Use either this option or
+ <opt>--process-time-msec</opt>, but not both.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--process-time-msec</opt><arg>=MSEC</arg></p>
+ <optdesc><p>Explicitly configure the process time, with a time
+ specified in miliseconds. If left out the server will pick the
+ process time. Use either this option or <opt>--process-time</opt>,
+ but not both.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--property</opt><arg>=PROPERTY=VALUE</arg></p>
+ <optdesc><p>Attach a property to the client and stream. May be
+ used multiple times</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--raw</opt></p>
+ <optdesc><p>Play/record raw audio data. This is the default if
+ this program is invoked as <cmd>pacat</cmd>, <cmd>parec</cmd> or
+ <cmd>pamon</cmd>.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--file-format</opt><arg>[=FFORMAT]</arg></p>
+ <optdesc><p>Play/record encoded audio data in the file format
+ specified. This is the default if this program is invoked as
+ <cmd>paplay</cmd> and <cmd>parecord</cmd>.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>--list-file-formats</opt></p>
+ <optdesc><p>List supported file formats.</p></optdesc>
+ </option>
+
</options>
<section name="Authors">
@@ -178,7 +244,7 @@ USA.
<section name="See also">
<p>
- <manref name="pulseaudio" section="1"/>, <manref name="paplay" section="1"/>
+ <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>
</p>
</section>
diff --git a/man/pactl.1 b/man/pactl.1
index a48115d..dde6e19 100644
--- a/man/pactl.1
+++ b/man/pactl.1
@@ -78,9 +78,6 @@ Load the specified module with the specified arguments into the running sound se
\fBunload-module\f1 \fIID\f1
Unload the module instance identified by the specified numeric index.
.TP
-\fBunload-module\f1 \fIID\f1
-Unload the module instance identified by the specified numeric index.
-.TP
\fBsuspend-sink\f1 \fISINK\f1 \fI1|0\f1
Suspend or resume the specified sink (which my be specified either by its symbolic name, or by its numeric index), depending whether 1 (suspend) or 0 (resume) is passed as last argument. Suspending a sink will pause all playback. Depending on the module implementing the sink this might have the effect that the underlying device is closed, making it available for other applications to use. The exact behaviour depends on the module.
.TP
diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in
index 8d5bf1d..7ba768a 100644
--- a/man/pactl.1.xml.in
+++ b/man/pactl.1.xml.in
@@ -143,12 +143,6 @@ USA.
</option>
<option>
- <p><opt>unload-module</opt> <arg>ID</arg></p>
-
- <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
- </option>
-
- <option>
<p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
<optdesc><p>Suspend or resume the specified sink (which my be