[FFmpeg-devel] [PATCH] Document the common ff* tools options in a dedicated manual section

Stefano Sabatini stefano.sabatini-lala
Wed Feb 17 01:20:53 CET 2010


On date Tuesday 2010-02-16 00:42:37 +0100, Stefano Sabatini encoded:
> Hi, as in subject.
> 
> This helps the user to distinguish between the generic options, and
> the specific options supported by each ff* tool.
> 
> Regards.
> -- 
> FFmpeg = Faithless & Frenzy Moronic Patchable Exxagerate Generator

> Index: ffmpeg/doc/ffmpeg-doc.texi
> ===================================================================
> --- ffmpeg.orig/doc/ffmpeg-doc.texi	2010-02-16 00:37:03.000000000 +0100
> +++ ffmpeg/doc/ffmpeg-doc.texi	2010-02-16 00:39:05.000000000 +0100
> @@ -222,10 +222,12 @@
>  @c man end
>  
>  @c man begin OPTIONS
> +
> + at include fftools-common-opts.texi
> +
>  @section Main options
>  
>  @table @option
> - at include fftools-common-opts.texi
>  
>  @item -f @var{fmt}
>  Force format.
> Index: ffmpeg/doc/ffplay-doc.texi
> ===================================================================
> --- ffmpeg.orig/doc/ffplay-doc.texi	2010-02-16 00:37:04.000000000 +0100
> +++ ffmpeg/doc/ffplay-doc.texi	2010-02-16 00:38:46.000000000 +0100
> @@ -26,10 +26,12 @@
>  @end example
>  
>  @c man begin OPTIONS
> +
> + at include fftools-common-opts.texi
> +
>  @section Main options
>  
>  @table @option
> - at include fftools-common-opts.texi
>  @item -x @var{width}
>  Force displayed width.
>  @item -y @var{height}
> Index: ffmpeg/doc/ffserver-doc.texi
> ===================================================================
> --- ffmpeg.orig/doc/ffserver-doc.texi	2010-02-16 00:37:04.000000000 +0100
> +++ ffmpeg/doc/ffserver-doc.texi	2010-02-16 00:39:25.000000000 +0100
> @@ -236,8 +236,10 @@
>  
>  @section Options
>  @c man begin OPTIONS
> - at table @option
> +
>  @include fftools-common-opts.texi
> +
> + at table @option
>  @item -f @var{configfile}
>  Use @file{configfile} instead of @file{/etc/ffserver.conf}.
>  @item -n
> Index: ffmpeg/doc/fftools-common-opts.texi
> ===================================================================
> --- ffmpeg.orig/doc/fftools-common-opts.texi	2010-02-16 00:37:13.000000000 +0100
> +++ ffmpeg/doc/fftools-common-opts.texi	2010-02-16 00:37:54.000000000 +0100
> @@ -1,3 +1,9 @@
> + at section Generic options
> +
> +These options are shared amongst the ff* tools.
> +
> + at table @option
> +
>  @item -L
>  Show license.
>  
> @@ -63,3 +69,4 @@
>  @item debug
>  @end table
>  
> + at end table

I'll apply the usual rule of one week+application if there won't be
comments on this.

Regards.
-- 
FFmpeg = Fostering & Free Mortal Philosofic Extravagant Ghost



More information about the ffmpeg-devel mailing list