[FFmpeg-cvslog] r23541 - in trunk/doc: ffmpeg-doc.texi ffplay-doc.texi ffprobe-doc.texi ffserver-doc.texi

[stefano]

Author: stefano
Date: Wed Jun  9 00:32:29 2010
New Revision: 23541

Log:
Rename the ff* tools @chapters "Invocation" to "Synopsis", and place
them at the beginning of the file, for consistency with the final
ordering of the corresponding man pages.

Also create a separate @chapter for the "Options" section, as it is
done for the man pages, rather than merge it in the same section of
"Synopsis".

Modified:
   trunk/doc/ffmpeg-doc.texi
   trunk/doc/ffplay-doc.texi
   trunk/doc/ffprobe-doc.texi
   trunk/doc/ffserver-doc.texi

Modified: trunk/doc/ffmpeg-doc.texi
==============================================================================
--- trunk/doc/ffmpeg-doc.texi	Tue Jun  8 21:31:08 2010	(r23540)
+++ trunk/doc/ffmpeg-doc.texi	Wed Jun  9 00:32:29 2010	(r23541)
@@ -7,6 +7,16 @@
 @sp 3
 @end titlepage
 
+ at chapter Synopsis
+
+The generic syntax is:
+
+ at example
+ at c man begin SYNOPSIS
+ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
+ at c man end
+ at end example
+
 @chapter Description
 @c man begin DESCRIPTION
 
@@ -50,18 +60,7 @@ specified for the inputs.
 
 @c man end DESCRIPTION
 
- at chapter Invocation
-
- at section Syntax
-
-The generic syntax is:
-
- at example
- at c man begin SYNOPSIS
-ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
- at c man end
- at end example
-
+ at chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi

Modified: trunk/doc/ffplay-doc.texi
==============================================================================
--- trunk/doc/ffplay-doc.texi	Tue Jun  8 21:31:08 2010	(r23540)
+++ trunk/doc/ffplay-doc.texi	Wed Jun  9 00:32:29 2010	(r23541)
@@ -7,6 +7,13 @@
 @sp 3
 @end titlepage
 
+ at chapter Synopsis
+
+ at example
+ at c man begin SYNOPSIS
+ffplay [options] @file{input_file}
+ at c man end
+ at end example
 
 @chapter Description
 @c man begin DESCRIPTION
@@ -16,15 +23,7 @@ libraries and the SDL library. It is mos
 various FFmpeg APIs.
 @c man end
 
- at chapter Invocation
-
- at section Syntax
- at example
- at c man begin SYNOPSIS
-ffplay [options] @file{input_file}
- at c man end
- at end example
-
+ at chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi

Modified: trunk/doc/ffprobe-doc.texi
==============================================================================
--- trunk/doc/ffprobe-doc.texi	Tue Jun  8 21:31:08 2010	(r23540)
+++ trunk/doc/ffprobe-doc.texi	Wed Jun  9 00:32:29 2010	(r23541)
@@ -7,6 +7,16 @@
 @sp 3
 @end titlepage
 
+ at chapter Synopsis
+
+The generic syntax is:
+
+ at example
+ at c man begin SYNOPSIS
+ffprobe [options] [@file{input_file}]
+ at c man end
+ at end example
+
 @chapter Description
 @c man begin DESCRIPTION
 
@@ -45,18 +55,7 @@ are prefixed by the string ``TAG:''.
 
 @c man end
 
- at chapter Invocation
-
- at section Syntax
-
-The generic syntax is:
-
- at example
- at c man begin SYNOPSIS
-ffprobe [options] [@file{input_file}]
- at c man end
- at end example
-
+ at chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi

Modified: trunk/doc/ffserver-doc.texi
==============================================================================
--- trunk/doc/ffserver-doc.texi	Tue Jun  8 21:31:08 2010	(r23540)
+++ trunk/doc/ffserver-doc.texi	Wed Jun  9 00:32:29 2010	(r23541)
@@ -7,6 +7,15 @@
 @sp 3
 @end titlepage
 
+ at chapter Synopsys
+
+The generic syntax is:
+
+ at example
+ at c man begin SYNOPSIS
+ffserver [options]
+ at c man end
+ at end example
 
 @chapter Description
 @c man begin DESCRIPTION
@@ -226,15 +235,7 @@ You use this by adding the ?date= to the
 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
 @c man end
 
- at chapter Invocation
- at section Syntax
- at example
- at c man begin SYNOPSIS
-ffserver [options]
- at c man end
- at end example
-
- at section Options
+ at chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi