[FFmpeg-cvslog] doc: add FFREPORT example
Lou Logan
git at videolan.org
Sat Dec 13 02:52:04 CET 2014
ffmpeg | branch: master | Lou Logan <lou at lrcd.com> | Thu Dec 11 11:46:54 2014 -0900| [10ef8f063bfa239c47f2301557a525870c2b88bf] | committer: Lou Logan
doc: add FFREPORT example
And fix a few nits.
Signed-off-by: Lou Logan <lou at lrcd.com>
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=10ef8f063bfa239c47f2301557a525870c2b88bf
---
doc/fftools-common-opts.texi | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/doc/fftools-common-opts.texi b/doc/fftools-common-opts.texi
index 54d1888..7d52c1a 100644
--- a/doc/fftools-common-opts.texi
+++ b/doc/fftools-common-opts.texi
@@ -204,21 +204,29 @@ directory.
This file can be useful for bug reports.
It also implies @code{-loglevel verbose}.
-Setting the environment variable @code{FFREPORT} to any value has the
+Setting the environment variable @env{FFREPORT} to any value has the
same effect. If the value is a ':'-separated key=value sequence, these
-options will affect the report; options values must be escaped if they
+options will affect the report; option values must be escaped if they
contain special characters or the options delimiter ':' (see the
-``Quoting and escaping'' section in the ffmpeg-utils manual). The
-following option is recognized:
+``Quoting and escaping'' section in the ffmpeg-utils manual).
+
+The following options are recognized:
@table @option
@item file
set the file name to use for the report; @code{%p} is expanded to the name
of the program, @code{%t} is expanded to a timestamp, @code{%%} is expanded
to a plain @code{%}
@item level
-set the log level
+set the log verbosity level using a numerical value (see @code{-loglevel}).
@end table
+For example, to output a report to a file named @file{ffreport.log}
+using a log level of @code{32} (alias for log level @code{info}):
+
+ at example
+FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+ at end example
+
Errors in parsing the environment variable are not fatal, and will not
appear in the report.
More information about the ffmpeg-cvslog
mailing list