aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2010-06-08 22:32:29 +0000
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2010-06-08 22:32:29 +0000
commita66d8cd91c2c521f86798e5385c012a5654e7175 (patch)
treeab90f63115fcad9b5006ee83de5f54b52253dba2
parent120a083fb7125dbab3fce5b02be89f1b21b1dfdd (diff)
downloadffmpeg-a66d8cd91c2c521f86798e5385c012a5654e7175.tar.gz
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
-rw-r--r--doc/ffmpeg-doc.texi23
-rw-r--r--doc/ffplay-doc.texi17
-rw-r--r--doc/ffprobe-doc.texi23
-rw-r--r--doc/ffserver-doc.texi19
4 files changed, 40 insertions, 42 deletions
diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index c783695f3b..342fe184ee 100644
--- 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 9510726d16..41db3dc1ca 100644
--- 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 f8a16b2808..a1a11c16fd 100644
--- 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 cebb289f22..77deb85317 100644
--- 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