summaryrefslogtreecommitdiff
path: root/man/pacat.1
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/pacat.1
parent0201790155d0719dfdd4785a06a5d5f06cfcd7c1 (diff)
Imported Upstream version 0.9.22
Diffstat (limited to 'man/pacat.1')
-rw-r--r--man/pacat.156
1 files changed, 47 insertions, 9 deletions
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