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".

Originally committed as revision 23541 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index c783695f3b35231c2685151edac2d838a4ce31a9..342fe184ee4b35a46c9f08716c0ebf70379acf68 100644 (file)
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -7,6 +7,16 @@
 @sp 3
 @end titlepage
 
+@chapter Synopsis
+
+The generic syntax is:
+
+@example
+@c man begin SYNOPSIS
+ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
+@c man end
+@end example
+
 @chapter Description
 @c man begin DESCRIPTION
 
@@ -50,18 +60,7 @@ specified for the inputs.
 
 @c man end DESCRIPTION
 
-@chapter Invocation
-
-@section Syntax
-
-The generic syntax is:
-
-@example
-@c man begin SYNOPSIS
-ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
-@c man end
-@end example
-
+@chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi

diff --git a/doc/ffplay-doc.texi b/doc/ffplay-doc.texi
index 9510726d1615f8fa869a381298e5c1aaccfdd8b5..41db3dc1caebd29a6694b5a9655e85d5f9e01707 100644 (file)
--- a/doc/ffplay-doc.texi
+++ b/doc/ffplay-doc.texi
@@ -7,6 +7,13 @@
 @sp 3
 @end titlepage
 
+@chapter Synopsis
+
+@example
+@c man begin SYNOPSIS
+ffplay [options] @file{input_file}
+@c man end
+@end example
 
 @chapter Description
 @c man begin DESCRIPTION
@@ -16,15 +23,7 @@ libraries and the SDL library. It is mostly used as a testbed for the
 various FFmpeg APIs.
 @c man end
 
-@chapter Invocation
-
-@section Syntax
-@example
-@c man begin SYNOPSIS
-ffplay [options] @file{input_file}
-@c man end
-@end example
-
+@chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi

diff --git a/doc/ffprobe-doc.texi b/doc/ffprobe-doc.texi
index f8a16b28082ad803b45d4b7e8797118b2a795db4..a1a11c16fd678730e9bb33095959a82614d7a1cc 100644 (file)
--- a/doc/ffprobe-doc.texi
+++ b/doc/ffprobe-doc.texi
@@ -7,6 +7,16 @@
 @sp 3
 @end titlepage
 
+@chapter Synopsis
+
+The generic syntax is:
+
+@example
+@c man begin SYNOPSIS
+ffprobe [options] [@file{input_file}]
+@c man end
+@end example
+
 @chapter Description
 @c man begin DESCRIPTION
 
@@ -45,18 +55,7 @@ are prefixed by the string ``TAG:''.
 
 @c man end
 
-@chapter Invocation
-
-@section Syntax
-
-The generic syntax is:
-
-@example
-@c man begin SYNOPSIS
-ffprobe [options] [@file{input_file}]
-@c man end
-@end example
-
+@chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi

diff --git a/doc/ffserver-doc.texi b/doc/ffserver-doc.texi
index cebb289f22019a5c3741313af18c8e3c6efbcd53..77deb85317e46db961c6c487c8b358da6ef249eb 100644 (file)
--- a/doc/ffserver-doc.texi
+++ b/doc/ffserver-doc.texi
@@ -7,6 +7,15 @@
 @sp 3
 @end titlepage
 
+@chapter Synopsys
+
+The generic syntax is:
+
+@example
+@c man begin SYNOPSIS
+ffserver [options]
+@c man end
+@end example
 
 @chapter Description
 @c man begin DESCRIPTION
@@ -226,15 +235,7 @@ You use this by adding the ?date= to the end of the URL for the stream.
 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
 @c man end
 
-@chapter Invocation
-@section Syntax
-@example
-@c man begin SYNOPSIS
-ffserver [options]
-@c man end
-@end example
-
-@section Options
+@chapter Options
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi