doc/fftools-common-opts: document -help long and full output
authorStefano Sabatini <stefasab@gmail.com>
Mon, 16 Sep 2013 22:14:54 +0000 (00:14 +0200)
committerStefano Sabatini <stefasab@gmail.com>
Tue, 17 Sep 2013 10:30:40 +0000 (12:30 +0200)
doc/fftools-common-opts.texi

index 3892a4a..2d31199 100644 (file)
@@ -59,10 +59,18 @@ Show license.
 
 @item -h, -?, -help, --help [@var{arg}]
 Show help. An optional parameter may be specified to print help about a specific
-item.
+item. If no argument is specified, only basic (non advanced) tool
+options are shown.
 
 Possible values of @var{arg} are:
 @table @option
+@item long
+Print advanced tool options in addition to the basic tool options.
+
+@item full
+Print complete list of options, including shared and private options
+for encoders, decoders, demuxers, muxers, filters, etc.
+
 @item decoder=@var{decoder_name}
 Print detailed information about the decoder named @var{decoder_name}. Use the
 @option{-decoders} option to get a list of all decoders.
@@ -82,7 +90,6 @@ Print detailed information about the muxer named @var{muxer_name}. Use the
 @item filter=@var{filter_name}
 Print detailed information about the filter name @var{filter_name}. Use the
 @option{-filters} option to get a list of all filters.
-
 @end table
 
 @item -version