summaryrefslogtreecommitdiff
path: root/doc/ffprobe.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2011-10-02 11:59:38 +0200
committerStefano Sabatini <stefasab@gmail.com>2011-10-09 16:03:01 +0200
commit9806dda8a8b707b90c10074f0b5bfd54b7c6a97e (patch)
treee36c17cfc3c91817cd8ae7febf1c31ff523fa548 /doc/ffprobe.texi
parenteff7684b50b0443b65488273099b750c1c727f68 (diff)
ffprobe: create a dedicated "Writers" section in the manual
Also update documentation related to the output format.
Diffstat (limited to 'doc/ffprobe.texi')
-rw-r--r--doc/ffprobe.texi57
1 files changed, 46 insertions, 11 deletions
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index a5d5df8da8..597b6b5342 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -42,18 +42,11 @@ for specifying which information to display, and for setting how
ffprobe will show it.
ffprobe output is designed to be easily parsable by a textual filter,
-and consists of one or more sections of the form:
-@example
-[SECTION]
-key1=val1
-...
-keyN=valN
-[/SECTION]
-@end example
+and consists of one or more sections of a form defined by the selected
+writer, which is specified by the @option{print_format} option.
Metadata tags stored in the container or in the streams are recognized
-and printed in the corresponding "FORMAT" or "STREAM" section, and
-are prefixed by the string "TAG:".
+and printed in the corresponding "FORMAT" or "STREAM" section.
@c man end
@@ -89,7 +82,14 @@ options "-unit -prefix -byte_binary_prefix -sexagesimal".
@item -print_format @var{format}
Set the output printing format.
-Current available formats are "default" and "json".
+
+For example for printing the output in JSON format, specify:
+@example
+-print_format json
+@end example
+
+For more details on the available output printing formats, see the
+Writers section below.
@item -show_format
Show information about the container format of the input multimedia
@@ -118,6 +118,41 @@ Read @var{input_file}.
@end table
@c man end
+@chapter Writers
+@c man begin WRITERS
+
+A writer defines the output format adopted by @file{ffprobe}, and will be
+used for printing all the parts of the output.
+
+A writer may accept one or more arguments, which specify the options to
+adopt.
+
+A description of the currently available writers follows.
+
+@section default
+Default format.
+
+Print each section in the form:
+@example
+[SECTION]
+key1=val1
+...
+keyN=valN
+[/SECTION]
+@end example
+
+Metadata tags are printed as a line in the corresponding FORMAT or
+STREAM section, and are prefixed by the string "TAG:".
+
+@section json
+JSON based format.
+
+Each section is printed using JSON notation.
+
+For more information about JSON, see @url{http://www.json.org/}.
+
+@c man end WRITERS
+
@include decoders.texi
@include demuxers.texi
@include protocols.texi