[FFmpeg-cvslog] doc/outdevs: extend documentation for caca -list* options

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Sat Jul 21 10:38:04 2012 +0200| [2fd880449a181b67e905b48fcbf08963312d2f0c] | committer: Stefano Sabatini

doc/outdevs: extend documentation for caca -list* options

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=2fd880449a181b67e905b48fcbf08963312d2f0c
---

 doc/outdevs.texi |   25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/doc/outdevs.texi b/doc/outdevs.texi
index 4c7a8d1..9499c0f 100644
--- a/doc/outdevs.texi
+++ b/doc/outdevs.texi
@@ -57,32 +57,53 @@ Set display driver.
 Set dithering algorithm. Dithering is necessary
 because the picture being rendered has usually far more colours than
 the available palette.
+The accepted values are listed with @code{-list_dither algorithms}.
 
 @item antialias
 Set antialias method. Antialiasing smoothens the rendered
 image and avoids the commonly seen staircase effect.
+The accepted values are listed with @code{-list_dither antialiases}.
 
 @item charset
 Set which characters are going to be used when rendering text.
+The accepted values are listed with @code{-list_dither charsets}.
 
 @item colors
 Set colors to be used when rendering text.
+The accepted values are listed with @code{-list_dither colors}.
 
 @item list_drivers
-List available drivers.
+If set to @option{true}, print a list of available drivers and exit.
 
 @item list_dither
-List available dither options.
+List available dither options related to the argument.
+The argument must be one of @code{algorithms}, @code{antialiases},
+ at code{charsets}, @code{colors}.
 @end table
 
 @subsection Examples
 
+ at itemize
+ at item
 The following command shows the @command{ffmpeg} output is an
 CACA window, forcing its size to 80x25:
 @example
 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
 @end example
 
+ at item
+Show the list of available drivers and exit:
+ at example
+ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
+ at end example
+
+ at item
+Show the list of available dither colors and exit:
+ at example
+ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
+ at end example
+ at end itemize
+
 @section oss
 
 OSS (Open Sound System) output device.