[FFmpeg-devel] [PATCH] doc: make x11grab examples consistent with option names

[Stefano Sabatini]

On date Saturday 2013-10-12 16:40:22 -0800, Lou Logan encoded:
> Change -r to -framerate, but either will work.
> Change -s to -video_size, but either will work.
> ---
>  doc/ffmpeg.texi |  4 ++--
>  doc/indevs.texi | 12 ++++++------
>  2 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index a067aeb..2bb65d5 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -1215,14 +1215,14 @@ standard mixer.
>  Grab the X11 display with ffmpeg via
>  
>  @example
> -ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
> +ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
>  @end example
>  
>  0.0 is display.screen number of your X11 server, same as
>  the DISPLAY environment variable.
>  
>  @example
> -ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
> +ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
>  @end example
>  
>  0.0 is display.screen number of your X11 server, same as the DISPLAY environment
> diff --git a/doc/indevs.texi b/doc/indevs.texi
> index 6bcb237..1d70138 100644
> --- a/doc/indevs.texi
> +++ b/doc/indevs.texi
> @@ -698,12 +698,12 @@ properties of your X11 display (e.g. grep for "name" or "dimensions").
>  
>  For example to grab from @file{:0.0} using @command{ffmpeg}:
>  @example
> -ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
> +ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
>  @end example
>  
>  Grab at position @code{10,20}:
>  @example
> -ffmpeg -f x11grab -r 25 -s cif -i :0.0+10,20 out.mpg
> +ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
>  @end example
>  
>  @subsection Options
> @@ -724,12 +724,12 @@ zero) to the edge of region.
>  
>  For example:
>  @example
> -ffmpeg -f x11grab -follow_mouse centered -r 25 -s cif -i :0.0 out.mpg
> +ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
>  @end example
>  
>  To follow only when the mouse pointer reaches within 100 pixels to edge:
>  @example
> -ffmpeg -f x11grab -follow_mouse 100 -r 25 -s cif -i :0.0 out.mpg
> +ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
>  @end example
>  
>  @item framerate
> @@ -745,12 +745,12 @@ know what is being grabbed if only a portion of the screen is grabbed.
>  
>  For example:
>  @example
> -ffmpeg -f x11grab -show_region 1 -r 25 -s cif -i :0.0+10,20 out.mpg
> +ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
>  @end example
>  
>  With @var{follow_mouse}:
>  @example
> -ffmpeg -f x11grab -follow_mouse centered -show_region 1 -r 25 -s cif -i :0.0 out.mpg
> +ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
>  @end example

LGTM, thanks.

Note: you could convert the list to an itemize environment for better
rendering.
-- 
FFmpeg = Fabulous and Fundamental Mastering Powerful Energized Gigant