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

[Lou Logan]

Change -r to -framerate (-r will still work).
Change -s to -video_size (-s will still work).

Also:
Itemize some x11grab examples.
Add a few Texinfo @-commands.
---
 doc/ffmpeg.texi | 15 ++++++++-------
 doc/indevs.texi | 34 ++++++++++++++++++++++++----------
 2 files changed, 32 insertions(+), 17 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index a067aeb..5d2146b 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -1212,21 +1212,22 @@ standard mixer.
 
 @section X11 grabbing
 
-Grab the X11 display with ffmpeg via
+Grab the X11 display with @command{ffmpeg}:
 
 @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.
+ at code{0.0} is display.screen number of your X11 server, same as the
+ at env{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
-variable. 10 is the x-offset and 20 the y-offset for the grabbing.
+ at code{0.0} is display.screen number of your X11 server, same as the
+ at env{DISPLAY} environment variable. @code{10} is the x-offset and
+ at code{20} the y-offset for the grabbing.
 
 @section Video and Audio file format conversion
 
diff --git a/doc/indevs.texi b/doc/indevs.texi
index 6bcb237..7b92f52 100644
--- a/doc/indevs.texi
+++ b/doc/indevs.texi
@@ -694,17 +694,22 @@ default to 0.
 Check the X11 documentation (e.g. man X) for more detailed information.
 
 Use the @command{dpyinfo} program for getting basic information about the
-properties of your X11 display (e.g. grep for "name" or "dimensions").
+properties of your X11 display (e.g. @command{grep} for "name" or
+"dimensions").
 
-For example to grab from @file{:0.0} using @command{ffmpeg}:
+ at itemize
+ at item
+To grab from @file{:0.0}:
 @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
 
+ at item
 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
+ at end itemize
 
 @subsection Options
 
@@ -722,15 +727,20 @@ pointer and keeps the pointer at the center of region; otherwise, the region
 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
 zero) to the edge of region.
 
-For example:
+ at itemize
+ at item
+To follow the mouse pointer with the pointer centered in the grabbing
+region:
 @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
 
+ at item
 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
+ at end itemize
 
 @item framerate
 Set the grabbing frame rate. Default value is @code{ntsc},
@@ -743,15 +753,19 @@ If @var{show_region} is specified with @code{1}, then the grabbing
 region will be indicated on screen. With this option, it is easy to
 know what is being grabbed if only a portion of the screen is grabbed.
 
-For example:
+ at itemize
+ at item
+To show the grabbed region on screen:
 @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
 
+ at item
 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 -videosize cif -i :0.0 out.mpg
 @end example
+ at end itemize
 
 @item video_size
 Set the video frame size. Default value is @code{vga}.
-- 
1.8.4