[FFmpeg-devel] [PATCH] ffprobe: create a dedicated "Writers" section in the manual

Stefano Sabatini stefasab at gmail.com
Sun Oct 2 12:40:53 CEST 2011

Also update documentation related to the output format.
 doc/ffprobe.texi |   51 ++++++++++++++++++++++++++++++++++++++++-----------
 1 files changed, 40 insertions(+), 11 deletions(-)

diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index a5d5df8..59643c2 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:
- at example
- at 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,8 @@ options "-unit -prefix -byte_binary_prefix -sexagesimal".
 @item -print_format @var{format}
 Set the output printing format.
-Current available formats are "default" and "json".
+See the Writers section below.
 @item -show_format
 Show information about the container format of the input multimedia
@@ -118,6 +112,41 @@ Read @var{input_file}.
 @end table
 @c man end
+ at chapter Writers
+ at 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
+A description of the currently available writers follows.
+ at section default
+Default format.
+Print each section in the form:
+ at example
+ at end example
+Metadata tags are printed as a line in the corresponding FORMAT or
+STREAM section, and are prefixed by the string "TAG:".
+ at section json
+JSON based format.
+Each section is printed using JSON notation.
+For more information about JSON, see @url{http://www.json.org/}.
+ at c man end WRITERS
 @include decoders.texi
 @include demuxers.texi
 @include protocols.texi

More information about the ffmpeg-devel mailing list