[PATCH 1/6] 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.

Stefano Sabatini stefano.sabatini-lala
Tue May 4 16:59:26 CEST 2010


Also create a separate @chapter for the Options as it is done for the
man pages, rather than merge it in the same chapter of "Synopsis".
---
 doc/ffmpeg-doc.texi   |   23 +++++++++++------------
 doc/ffplay-doc.texi   |   17 ++++++++---------
 doc/ffprobe-doc.texi  |   23 +++++++++++------------
 doc/ffserver-doc.texi |   19 ++++++++++---------
 4 files changed, 40 insertions(+), 42 deletions(-)

diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index 000be50..dbe852c 100644
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -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
diff --git a/doc/ffplay-doc.texi b/doc/ffplay-doc.texi
index 2ae7392..eb3510a 100644
--- a/doc/ffplay-doc.texi
+++ b/doc/ffplay-doc.texi
@@ -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 mostly used as a testbed for the
 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
diff --git a/doc/ffprobe-doc.texi b/doc/ffprobe-doc.texi
index 723c01f..d35e6ce 100644
--- a/doc/ffprobe-doc.texi
+++ b/doc/ffprobe-doc.texi
@@ -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
diff --git a/doc/ffserver-doc.texi b/doc/ffserver-doc.texi
index 7a59678..c4aebc3 100644
--- a/doc/ffserver-doc.texi
+++ b/doc/ffserver-doc.texi
@@ -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 end of the URL for the stream.
 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
-- 
1.7.1


--4SFOXa2GPu3tIq4H--



More information about the ffmpeg-devel mailing list