[FFmpeg-devel] [PATCH] doc: rework synopsis section for ff* tools

Stefano Sabatini stefasab at gmail.com
Mon Dec 17 12:58:43 CET 2012


Fix syntax, remove pointless introductory sentence, improve overall
consistency.
---
 doc/ffmpeg.texi   |    8 +-------
 doc/ffplay.texi   |    6 +-----
 doc/ffprobe.texi  |    8 +-------
 doc/ffserver.texi |    8 +-------
 4 files changed, 4 insertions(+), 26 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 63a5c59..c59b00a 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -11,13 +11,7 @@
 
 @chapter Synopsis
 
-The generic syntax is:
-
- at example
- at c man begin SYNOPSIS
-ffmpeg [global options] [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
- at c man end
- at end example
+ffmpeg [@var{global_options}] @{[@var{input_file_options}] -i @file{input_file}@} ... @{[@var{output_file_options}] @file{output_file}@} ...
 
 @chapter Description
 @c man begin DESCRIPTION
diff --git a/doc/ffplay.texi b/doc/ffplay.texi
index b9fa2a4..cf1264b 100644
--- a/doc/ffplay.texi
+++ b/doc/ffplay.texi
@@ -11,11 +11,7 @@
 
 @chapter Synopsis
 
- at example
- at c man begin SYNOPSIS
-ffplay [options] [@file{input_file}]
- at c man end
- at end example
+ffplay [@var{options}] [@file{input_file}]
 
 @chapter Description
 @c man begin DESCRIPTION
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index dbd2b65..6259490 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -11,13 +11,7 @@
 
 @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
+ffprobe [@var{options}] [@file{input_file}]
 
 @chapter Description
 @c man begin DESCRIPTION
diff --git a/doc/ffserver.texi b/doc/ffserver.texi
index fc98a98..fabb6d9 100644
--- a/doc/ffserver.texi
+++ b/doc/ffserver.texi
@@ -11,13 +11,7 @@
 
 @chapter Synopsys
 
-The generic syntax is:
-
- at example
- at c man begin SYNOPSIS
-ffserver [options]
- at c man end
- at end example
+ffserver [@var{options}]
 
 @chapter Description
 @c man begin DESCRIPTION
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list