[FFmpeg-devel] [PATCH] doc/fftools-common-opts: document -help full output

Lou Logan lou at lrcd.com
Tue Sep 17 00:52:29 CEST 2013


On Tue, 17 Sep 2013 00:21:32 +0200, Stefano Sabatini wrote:

> From c692fae82526e59dd744f6ec5d321587c3d16e5d Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Tue, 17 Sep 2013 00:14:54 +0200
> Subject: [PATCH] doc/fftools-common-opts: document -help long and full output
> 
> ---
>  doc/fftools-common-opts.texi | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/fftools-common-opts.texi b/doc/fftools-common-opts.texi
> index 3892a4a..2cebf56 100644
> --- a/doc/fftools-common-opts.texi
> +++ b/doc/fftools-common-opts.texi
> @@ -59,10 +59,19 @@ 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
> + at item long
> +Print advanced tool options in addition to the basic tool options.x

typo: s/.x/.

> +
> + at item full
> +Print complete list of options, containing shared options
> +(encoders, decoders, demuxers, muxers, filters, etc.) and private
> +options for all the available components.

Some re-wording and comma placement made this easier to read (for me at
least):

  Print complete list of options, including shared options (encoders,
  decoders, demuxers, muxers, filters, etc.) and private options, for
  all available components.

Otherwise, good.


More information about the ffmpeg-devel mailing list