summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNicolas George <nicolas.george@normalesup.org>2012-11-02 13:15:51 +0100
committerNicolas George <nicolas.george@normalesup.org>2012-11-04 10:52:43 +0100
commit1fa47f8deafed3263ecdf5b0eb4807b77cfbb868 (patch)
tree308ab5ed68b144b4117d1d2770f5097dbaaa4b50 /doc
parent3bdf4971bab4d6f945035c42c551f76bf426d29b (diff)
cmdutils: allow to set the report file name.
The file name can be set by setting the FFREPORT environment variable to "file=something". Fix trac ticket #1823.
Diffstat (limited to 'doc')
-rw-r--r--doc/avtools-common-opts.texi16
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/avtools-common-opts.texi b/doc/avtools-common-opts.texi
index 1fc12aa966..d43ff6e015 100644
--- a/doc/avtools-common-opts.texi
+++ b/doc/avtools-common-opts.texi
@@ -151,8 +151,20 @@ directory.
This file can be useful for bug reports.
It also implies @code{-loglevel verbose}.
-Note: setting the environment variable @code{FFREPORT} to any value has the
-same effect.
+Setting the environment variable @code{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
+@ref{quoting_and_escaping, escaped} if they contain special characters or
+the options delimiter ':'. The following option is 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{%}
+@end table
+
+Errors in parsing the environment variable are not fatal, and will not
+appear in the report.
@item -cpuflags flags (@emph{global})
Allows setting and clearing cpu flags. This option is intended