Browse Source

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
tags/n0.8
Stefano Sabatini 15 years ago
parent
commit
a66d8cd91c
4 changed files with 40 additions and 42 deletions
  1. +11
    -12
      doc/ffmpeg-doc.texi
  2. +8
    -9
      doc/ffplay-doc.texi
  3. +11
    -12
      doc/ffprobe-doc.texi
  4. +10
    -9
      doc/ffserver-doc.texi

+ 11
- 12
doc/ffmpeg-doc.texi View File

@@ -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


+ 8
- 9
doc/ffplay-doc.texi View File

@@ -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


+ 11
- 12
doc/ffprobe-doc.texi View File

@@ -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


+ 10
- 9
doc/ffserver-doc.texi View File

@@ -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


Loading…
Cancel
Save