[FFmpeg-devel] [PATCH 2/4] doc/indevs: make pulse dev formatting consistent with other devices

[Lukasz Marek]

Signed-off-by: Lukasz Marek <lukasz.m.luki at gmail.com>
---
 doc/indevs.texi |   78 ++++++++++++++-----------------------------------------
 1 file changed, 20 insertions(+), 58 deletions(-)

diff --git a/doc/indevs.texi b/doc/indevs.texi
index 5cc03f9..832958e 100644
--- a/doc/indevs.texi
+++ b/doc/indevs.texi
@@ -485,10 +485,9 @@ For more information about OSS see:
 
 @section pulse
 
-pulseaudio input device.
+PulseAudio input device.
 
-To enable this input device during configuration you need libpulse-simple
-installed in your system.
+To enable this output device you need to configure FFmpeg with --enable-libpulse.
 
 The filename to provide to the input device is a source device or the
 string "default"
@@ -496,76 +495,39 @@ string "default"
 To list the pulse source devices and their properties you can invoke
 the command @command{pactl list sources}.
 
- at example
-ffmpeg -f pulse -i default /tmp/pulse.wav
- at end example
-
- at subsection @var{server} AVOption
-
-The syntax is:
- at example
--server @var{server name}
- at end example
-
-Connects to a specific server.
-
- at subsection @var{name} AVOption
-
-The syntax is:
- at example
--name @var{application name}
- at end example
+ at subsection Options
+ at table @option
+ at item server
+Connects to a specific server. Default server is used when not provided.
 
+ at item name
 Specify the application name pulse will use when showing active clients,
-by default it is the LIBAVFORMAT_IDENT string
-
- at subsection @var{stream_name} AVOption
-
-The syntax is:
- at example
--stream_name @var{stream name}
- at end example
+by default it is the LIBAVFORMAT_IDENT string.
 
+ at item stream_name
 Specify the stream name pulse will use when showing active streams,
-by default it is "record"
-
- at subsection @var{sample_rate} AVOption
-
-The syntax is:
- at example
--sample_rate @var{samplerate}
- at end example
+by default it is "record".
 
+ at item sample_rate
 Specify the samplerate in Hz, by default 48kHz is used.
 
- at subsection @var{channels} AVOption
-
-The syntax is:
- at example
--channels @var{N}
- at end example
-
+ at item channels
 Specify the channels in use, by default 2 (stereo) is set.
 
- at subsection @var{frame_size} AVOption
-
-The syntax is:
- at example
--frame_size @var{bytes}
- at end example
-
+ at item frame_size
 Specify the number of byte per frame, by default it is set to 1024.
 
- at subsection @var{fragment_size} AVOption
+ at item fragment_size
+Specify the minimal buffering fragment in PulseAudio, it will affect the
+audio latency. By default it is unset.
+ at end table
 
-The syntax is:
+ at subsection Examples
+Record a stream from default device:
 @example
--fragment_size @var{bytes}
+ffmpeg -f pulse -i default /tmp/pulse.wav
 @end example
 
-Specify the minimal buffering fragment in pulseaudio, it will affect the
-audio latency. By default it is unset.
-
 @section sndio
 
 sndio input device.
-- 
1.7.10.4