[FFmpeg-devel] [PATCH] doc/libavutil: add "Logging" chapter

Stefano Sabatini stefasab at gmail.com
Thu Nov 15 11:40:40 CET 2012


In particular, mention the environment variable which affect the logging
color.
---
 doc/libavutil.texi |   17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/libavutil.texi b/doc/libavutil.texi
index e5304bb..e9fc1b2 100644
--- a/doc/libavutil.texi
+++ b/doc/libavutil.texi
@@ -20,6 +20,23 @@ enumerations for pixel and sample formats).
 
 @c man end DESCRIPTION
 
+ at chapter Logging
+ at c man begin LOGGING
+
+The libavutil library provides some logging utilities through the
+ at file{libavutil/log.h} interface. The logging level in the FFmpeg
+tools can be set through the @code{loglevel} option.
+
+By default the library logs to stderr. If coloring is supported by the
+terminal, colors are used to mark errors and warnings. Log coloring
+can be disabled setting the environment variable
+ at env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
+the environment variable @env{AV_LOG_FORCE_COLOR}. The use of the
+environment variable @env{NO_COLOR} is deprecated and will be dropped
+in a following FFmpeg version.
+
+ at c man end LOGGING
+
 @include syntax.texi
 @include eval.texi
 
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list