aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-12-17 12:55:28 +0100
committerStefano Sabatini <stefasab@gmail.com>2012-12-19 09:33:44 +0100
commitc2ac6477106a523984a3c8c8694c3f360ef9f41c (patch)
tree35fff913c6a7d2031a4d466eab26cc4223ee50a4 /doc
parent461716d3bfe3db70cee916e616435a659669dbf5 (diff)
downloadffmpeg-c2ac6477106a523984a3c8c8694c3f360ef9f41c.tar.gz
doc: rework synopsis section for ff* tools
Fix syntax, remove pointless introductory sentence, improve overall consistency.
Diffstat (limited to 'doc')
-rw-r--r--doc/ffmpeg.texi8
-rw-r--r--doc/ffplay.texi6
-rw-r--r--doc/ffprobe.texi8
-rw-r--r--doc/ffserver.texi8
4 files changed, 4 insertions, 26 deletions
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index b91e9f22f0..77ac10d720 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -11,13 +11,7 @@
@chapter Synopsis
-The generic syntax is:
-
-@example
-@c man begin SYNOPSIS
-ffmpeg [global options] [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
-@c man end
-@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 9886fd82ab..0a45a65e1d 100644
--- a/doc/ffplay.texi
+++ b/doc/ffplay.texi
@@ -11,11 +11,7 @@
@chapter Synopsis
-@example
-@c man begin SYNOPSIS
-ffplay [options] [@file{input_file}]
-@c man end
-@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 a5fa5b3fb7..ba120d8b2a 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -11,13 +11,7 @@
@chapter Synopsis
-The generic syntax is:
-
-@example
-@c man begin SYNOPSIS
-ffprobe [options] [@file{input_file}]
-@c man end
-@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 b85c724f18..3004d85894 100644
--- a/doc/ffserver.texi
+++ b/doc/ffserver.texi
@@ -11,13 +11,7 @@
@chapter Synopsys
-The generic syntax is:
-
-@example
-@c man begin SYNOPSIS
-ffserver [options]
-@c man end
-@end example
+ffserver [@var{options}]
@chapter Description
@c man begin DESCRIPTION