1. ffmpeg
  2. Commit a66d8cd91c2c521f86798e5385c012a5654e7175
Browse code

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

Stefano Sabatini authored on 2010/06/09 07:32:29
Showing 4 changed files
doc/ffmpeg-doc.texi
History View file @ a66d8cd
... ... 
@@ -7,6 +7,16 @@
7 7 
 @sp 3
8 8 
 @end titlepage
9 9
10 
+@chapter Synopsis
11 
+
12 
+The generic syntax is:
13 
+
14 
+@example
15 
+@c man begin SYNOPSIS
16 
+ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
17 
+@c man end
18 
+@end example
19 
+
10 20 
 @chapter Description
11 21 
 @c man begin DESCRIPTION
12 22
... ... 
@@ -50,18 +60,7 @@ specified for the inputs.
50 50
51 51 
 @c man end DESCRIPTION
52 52
53 
-@chapter Invocation
54 
-
55 
-@section Syntax
56 
-
57 
-The generic syntax is:
58 
-
59 
-@example
60 
-@c man begin SYNOPSIS
61 
-ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
62 
-@c man end
63 
-@end example
64 
-
53 
+@chapter Options
65 54 
 @c man begin OPTIONS
66 55
67 56 
 @include fftools-common-opts.texi
doc/ffplay-doc.texi
History View file @ a66d8cd
... ... 
@@ -7,6 +7,13 @@
7 7 
 @sp 3
8 8 
 @end titlepage
9 9
10 
+@chapter Synopsis
11 
+
12 
+@example
13 
+@c man begin SYNOPSIS
14 
+ffplay [options] @file{input_file}
15 
+@c man end
16 
+@end example
10 17
11 18 
 @chapter Description
12 19 
 @c man begin DESCRIPTION
... ... 
@@ -16,15 +23,7 @@ libraries and the SDL library. It is mostly used as a testbed for the
16 16 
 various FFmpeg APIs.
17 17 
 @c man end
18 18
19 
-@chapter Invocation
20 
-
21 
-@section Syntax
22 
-@example
23 
-@c man begin SYNOPSIS
24 
-ffplay [options] @file{input_file}
25 
-@c man end
26 
-@end example
27 
-
19 
+@chapter Options
28 20 
 @c man begin OPTIONS
29 21
30 22 
 @include fftools-common-opts.texi
doc/ffprobe-doc.texi
History View file @ a66d8cd
... ... 
@@ -7,6 +7,16 @@
7 7 
 @sp 3
8 8 
 @end titlepage
9 9
10 
+@chapter Synopsis
11 
+
12 
+The generic syntax is:
13 
+
14 
+@example
15 
+@c man begin SYNOPSIS
16 
+ffprobe [options] [@file{input_file}]
17 
+@c man end
18 
+@end example
19 
+
10 20 
 @chapter Description
11 21 
 @c man begin DESCRIPTION
12 22
... ... 
@@ -45,18 +55,7 @@ are prefixed by the string ``TAG:''.
45 45
46 46 
 @c man end
47 47
48 
-@chapter Invocation
49 
-
50 
-@section Syntax
51 
-
52 
-The generic syntax is:
53 
-
54 
-@example
55 
-@c man begin SYNOPSIS
56 
-ffprobe [options] [@file{input_file}]
57 
-@c man end
58 
-@end example
59 
-
48 
+@chapter Options
60 49 
 @c man begin OPTIONS
61 50
62 51 
 @include fftools-common-opts.texi
doc/ffserver-doc.texi
History View file @ a66d8cd
... ... 
@@ -7,6 +7,15 @@
7 7 
 @sp 3
8 8 
 @end titlepage
9 9
10 
+@chapter Synopsys
11 
+
12 
+The generic syntax is:
13 
+
14 
+@example
15 
+@c man begin SYNOPSIS
16 
+ffserver [options]
17 
+@c man end
18 
+@end example
10 19
11 20 
 @chapter Description
12 21 
 @c man begin DESCRIPTION
... ... 
@@ -226,15 +235,7 @@ You use this by adding the ?date= to the end of the URL for the stream.
226 226 
 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
227 227 
 @c man end
228 228
229 
-@chapter Invocation
230 
-@section Syntax
231 
-@example
232 
-@c man begin SYNOPSIS
233 
-ffserver [options]
234 
-@c man end
235 
-@end example
236 
-
237 
-@section Options
229 
+@chapter Options
238 230 
 @c man begin OPTIONS
239 231
240 232 
 @include fftools-common-opts.texi