[FFmpeg-devel] [PATCH] doc/indevs: document missing options in x11grab section

[Clément Bœsch]

On Wed, Aug 08, 2012 at 11:22:21AM +0200, Stefano Sabatini wrote:
> Add documentation for options draw_mouse, framerate, and video_size.
> 
> In particular, fix trac ticket #1314.
> ---
>  doc/indevs.texi |   10 ++++++++++
>  1 files changed, 10 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/indevs.texi b/doc/indevs.texi
> index a9f2fe4..701db91 100644
> --- a/doc/indevs.texi
> +++ b/doc/indevs.texi
> @@ -640,6 +640,9 @@ ffmpeg -f x11grab -r 25 -s cif -i :0.0+10,20 out.mpg
>  @subsection Options
>  
>  @table @option
> + at item draw_mouse
> +When set to 1, draw the mouse pointer. Default value is @code{1}.
> +

I like that @code{}, but what are the overall rules usage? Why not use it
for the first '1'.

>  @item follow_mouse
>  Make the grabbed area follow the mouse. The argument can be
>  @code{centered} or a number of pixels @var{PIXELS}.
> @@ -659,6 +662,10 @@ To follow only when the mouse pointer reaches within 100 pixels to edge:
>  ffmpeg -f x11grab -follow_mouse 100 -r 25 -s cif -i :0.0 out.mpg
>  @end example
>  
> + at item framerate
> +Set the grabbing frame rate. Default value is @code{ntsc},
> +corresponding to a framerate of 30000/1001.
                                   ^^^^^^^^^^
...or here?

> +
>  @item show_region
>  Show grabbed region on screen.
>  
> @@ -675,6 +682,9 @@ With @var{follow_mouse}:
>  @example
>  ffmpeg -f x11grab -follow_mouse centered -show_region 1 -r 25 -s cif -i :0.0 out.mpg
>  @end example
> +
> + at item video_size
> +Set the video frame size. Default value is @code{vga}.
>  @end table
>  
>  @c man end INPUT DEVICES

Maybe also add an example with the draw_mouse option.

LGTM with or without those remarks.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120808/1dd34ed2/attachment.asc>