From 9e12f0bf5f45361a36f9d8c3abca24af55ca740c Mon Sep 17 00:00:00 2001 From: Anton Khirnov Date: Tue, 26 Jul 2011 19:04:43 +0200 Subject: Rename ffprobe to avprobe. --- doc/avplay.texi | 2 +- doc/avprobe.texi | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ffmpeg.texi | 2 +- doc/ffprobe.texi | 134 ------------------------------------------------------ doc/ffserver.texi | 2 +- 5 files changed, 137 insertions(+), 137 deletions(-) create mode 100644 doc/avprobe.texi delete mode 100644 doc/ffprobe.texi (limited to 'doc') diff --git a/doc/avplay.texi b/doc/avplay.texi index 0c74c59a3d..e8446b75d9 100644 --- a/doc/avplay.texi +++ b/doc/avplay.texi @@ -170,7 +170,7 @@ Seek to percentage in file corresponding to fraction of width. @settitle AVplay media player @c man begin SEEALSO -ffmpeg(1), ffprobe(1), ffserver(1) and the Libav HTML documentation +ffmpeg(1), avprobe(1), ffserver(1) and the Libav HTML documentation @c man end @c man begin AUTHORS diff --git a/doc/avprobe.texi b/doc/avprobe.texi new file mode 100644 index 0000000000..003f5e65c9 --- /dev/null +++ b/doc/avprobe.texi @@ -0,0 +1,134 @@ +\input texinfo @c -*- texinfo -*- + +@settitle avprobe Documentation +@titlepage +@center @titlefont{avprobe Documentation} +@end titlepage + +@top + +@contents + +@chapter Synopsis + +The generic syntax is: + +@example +@c man begin SYNOPSIS +avprobe [options] [@file{input_file}] +@c man end +@end example + +@chapter Description +@c man begin DESCRIPTION + +avprobe gathers information from multimedia streams and prints it in +human- and machine-readable fashion. + +For example it can be used to check the format of the container used +by a multimedia stream and the format and type of each media stream +contained in it. + +If a filename is specified in input, avprobe will try to open and +probe the file content. If the file cannot be opened or recognized as +a multimedia file, a positive exit code is returned. + +avprobe may be employed both as a standalone application or in +combination with a textual filter, which may perform more +sophisticated processing, e.g. statistical processing or plotting. + +Options are used to list some of the formats supported by avprobe or +for specifying which information to display, and for setting how +avprobe will show it. + +avprobe 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 + +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:". + +@c man end + +@chapter Options +@c man begin OPTIONS + +@include fftools-common-opts.texi + +@section Main options + +@table @option + +@item -f @var{format} +Force format to use. + +@item -unit +Show the unit of the displayed values. + +@item -prefix +Use SI prefixes for the displayed values. +Unless the "-byte_binary_prefix" option is used all the prefixes +are decimal. + +@item -byte_binary_prefix +Force the use of binary prefixes for byte values. + +@item -sexagesimal +Use sexagesimal format HH:MM:SS.MICROSECONDS for time values. + +@item -pretty +Prettify the format of the displayed values, it corresponds to the +options "-unit -prefix -byte_binary_prefix -sexagesimal". + +@item -show_format +Show information about the container format of the input multimedia +stream. + +All the container format information is printed within a section with +name "FORMAT". + +@item -show_packets +Show information about each packet contained in the input multimedia +stream. + +The information for each single packet is printed within a dedicated +section with name "PACKET". + +@item -show_streams +Show information about each media stream contained in the input +multimedia stream. + +Each media stream information is printed within a dedicated section +with name "STREAM". + +@end table +@c man end + +@include demuxers.texi +@include muxers.texi +@include protocols.texi +@include indevs.texi + +@ignore + +@setfilename avprobe +@settitle avprobe media prober + +@c man begin SEEALSO +ffmpeg(1), avplay(1), ffserver(1) and the Libav HTML documentation +@c man end + +@c man begin AUTHORS +The Libav developers +@c man end + +@end ignore + +@bye diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi index 6393516c6d..af9bdcd3f3 100644 --- a/doc/ffmpeg.texi +++ b/doc/ffmpeg.texi @@ -1079,7 +1079,7 @@ file to which you want to add them. @settitle ffmpeg video converter @c man begin SEEALSO -avplay(1), ffprobe(1), ffserver(1) and the Libav HTML documentation +avplay(1), avprobe(1), ffserver(1) and the Libav HTML documentation @c man end @c man begin AUTHORS diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi deleted file mode 100644 index 079cf659d7..0000000000 --- a/doc/ffprobe.texi +++ /dev/null @@ -1,134 +0,0 @@ -\input texinfo @c -*- texinfo -*- - -@settitle ffprobe Documentation -@titlepage -@center @titlefont{ffprobe Documentation} -@end titlepage - -@top - -@contents - -@chapter Synopsis - -The generic syntax is: - -@example -@c man begin SYNOPSIS -ffprobe [options] [@file{input_file}] -@c man end -@end example - -@chapter Description -@c man begin DESCRIPTION - -ffprobe gathers information from multimedia streams and prints it in -human- and machine-readable fashion. - -For example it can be used to check the format of the container used -by a multimedia stream and the format and type of each media stream -contained in it. - -If a filename is specified in input, ffprobe will try to open and -probe the file content. If the file cannot be opened or recognized as -a multimedia file, a positive exit code is returned. - -ffprobe may be employed both as a standalone application or in -combination with a textual filter, which may perform more -sophisticated processing, e.g. statistical processing or plotting. - -Options are used to list some of the formats supported by ffprobe or -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 - -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:". - -@c man end - -@chapter Options -@c man begin OPTIONS - -@include fftools-common-opts.texi - -@section Main options - -@table @option - -@item -f @var{format} -Force format to use. - -@item -unit -Show the unit of the displayed values. - -@item -prefix -Use SI prefixes for the displayed values. -Unless the "-byte_binary_prefix" option is used all the prefixes -are decimal. - -@item -byte_binary_prefix -Force the use of binary prefixes for byte values. - -@item -sexagesimal -Use sexagesimal format HH:MM:SS.MICROSECONDS for time values. - -@item -pretty -Prettify the format of the displayed values, it corresponds to the -options "-unit -prefix -byte_binary_prefix -sexagesimal". - -@item -show_format -Show information about the container format of the input multimedia -stream. - -All the container format information is printed within a section with -name "FORMAT". - -@item -show_packets -Show information about each packet contained in the input multimedia -stream. - -The information for each single packet is printed within a dedicated -section with name "PACKET". - -@item -show_streams -Show information about each media stream contained in the input -multimedia stream. - -Each media stream information is printed within a dedicated section -with name "STREAM". - -@end table -@c man end - -@include demuxers.texi -@include muxers.texi -@include protocols.texi -@include indevs.texi - -@ignore - -@setfilename ffprobe -@settitle ffprobe media prober - -@c man begin SEEALSO -ffmpeg(1), avplay(1), ffserver(1) and the Libav HTML documentation -@c man end - -@c man begin AUTHORS -The Libav developers -@c man end - -@end ignore - -@bye diff --git a/doc/ffserver.texi b/doc/ffserver.texi index 3d64b79377..05e52970dc 100644 --- a/doc/ffserver.texi +++ b/doc/ffserver.texi @@ -265,7 +265,7 @@ rather than as a daemon. @c man begin SEEALSO -ffmpeg(1), avplay(1), ffprobe(1), the @file{ffmpeg/doc/ffserver.conf} +ffmpeg(1), avplay(1), avprobe(1), the @file{ffmpeg/doc/ffserver.conf} example and the Libav HTML documentation @c man end -- cgit v1.2.3