summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTanu Kaskinen <tanuk@iki.fi>2020-04-16 18:27:48 +0300
committerTanu Kaskinen <tanuk@iki.fi>2020-04-23 15:24:24 +0000
commit36a4923f9bd05d4c5e2e8b1765f18edf452b9251 (patch)
tree0c899d500696e1a3947ab6a62a8c842c2e3532d6 /man
parent743fa02c5f150ab187e3927fecd062ac3e8d0ee1 (diff)
downloadpulseaudio-36a4923f9bd05d4c5e2e8b1765f18edf452b9251.tar.gz
Point to SupportedAudioFormats wiki page where appropriate
I documented the supported PCM sample formats and compressed audio encodings in the wiki, let's add some pointers to the new documentation.
Diffstat (limited to 'man')
-rw-r--r--man/pacat.1.xml.in15
-rw-r--r--man/pactl.1.xml.in14
-rw-r--r--man/pulse-daemon.conf.5.xml.in13
3 files changed, 15 insertions, 27 deletions
diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
index bfef710d1..8fcb51d92 100644
--- a/man/pacat.1.xml.in
+++ b/man/pacat.1.xml.in
@@ -116,18 +116,9 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
<p><opt>--format</opt><arg>=FORMAT</arg></p>
<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>, <opt>s32le</opt>, <opt>s32be</opt>,
- <opt>s24le</opt>, <opt>s24be</opt>, <opt>s24-32le</opt>,
- <opt>s24-32be</opt>. Depending on the endianness 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>
+ format. See
+ https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
+ for supported values. Defaults to s16ne.</p></optdesc>
</option>
<option>
diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in
index 71c2826a3..cff628f34 100644
--- a/man/pactl.1.xml.in
+++ b/man/pactl.1.xml.in
@@ -243,11 +243,15 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
<option>
<p><opt>set-sink-formats</opt> <arg>SINK</arg> <arg>FORMATS</arg></p>
- <optdesc><p>Set the supported formats of the specified sink (identified by its numerical index) if supported by the sink.
- <arg>FORMATS</arg> is specified as a semi-colon (;) separated list of formats in the form
- 'encoding[, key1=value1, key2=value2, ...]' (for example, AC3 at 32000, 44100 and 48000 Hz would be specified as
- 'ac3-iec61937, format.rate = "[ 32000, 44100, 48000 ]"').
- </p></optdesc> </option>
+ <optdesc><p>Set the supported formats of the specified sink (identified
+ by its numerical index) if supported by the sink. <arg>FORMATS</arg> is
+ specified as a semi-colon (;) separated list of formats in the form
+ 'encoding[, key1=value1, key2=value2, ...]' (for example, AC3 at 32000,
+ 44100 and 48000 Hz would be specified as
+ 'ac3-iec61937, format.rate = "[ 32000, 44100, 48000 ]"'). See
+ https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
+ for possible encodings. </p></optdesc>
+ </option>
<option>
<p><opt>subscribe</opt></p>
diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
index 780bd189e..d76e0b31d 100644
--- a/man/pulse-daemon.conf.5.xml.in
+++ b/man/pulse-daemon.conf.5.xml.in
@@ -490,16 +490,9 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
<option>
<p><opt>default-sample-format=</opt> The default sampling
- format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
- <opt>s16be</opt>, <opt>s24le</opt>, <opt>s24be</opt>,
- <opt>s24-32le</opt>, <opt>s24-32be</opt>, <opt>s32le</opt>,
- <opt>s32be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
- <opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianness of
- the CPU the formats <opt>s16ne</opt>, <opt>s16re</opt>,
- <opt>s24ne</opt>, <opt>s24re</opt>, <opt>s24-32ne</opt>,
- <opt>s24-32re</opt>, <opt>s32ne</opt>, <opt>s32re</opt>,
- <opt>float32ne</opt>, <opt>float32re</opt> (for native,
- resp. reverse endian) are available as aliases.</p>
+ format. See
+ https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
+ for possible values.</p>
</option>
<option>