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

Stefano Sabatini git at videolan.org
Wed Dec 19 09:35:06 CET 2012


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Mon Dec 17 12:55:28 2012 +0100| [c2ac6477106a523984a3c8c8694c3f360ef9f41c] | committer: Stefano Sabatini

doc: rework synopsis section for ff* tools

Fix syntax, remove pointless introductory sentence, improve overall
consistency.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=c2ac6477106a523984a3c8c8694c3f360ef9f41c
---

 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 b91e9f2..77ac10d 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 9886fd8..0a45a65 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 a5fa5b3..ba120d8 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 b85c724..3004d85 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



More information about the ffmpeg-cvslog mailing list