gst-stats: use the rusage stats
[platform/upstream/gstreamer.git] / tools / gst-launch.1.in
index ce6d45a..c04ddc6 100644 (file)
@@ -77,7 +77,9 @@ for each category. Level is in the range 0-9 where 0 will show no messages, and
 Note that the order of categories and levels is important, wildcards at the
 end may override levels set earlier. The log levels are: 1=ERROR, 2=WARNING,
 3=FIXME, 4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP. Since GStreamer 1.2 one
-can also use the debug level names, e.g. \-\-gst\-debug=*sink:LOG
+can also use the debug level names, e.g. \-\-gst\-debug=*sink:LOG. A full
+description of the various debug levels can be found in the GStreamer core
+library API documentation, in the "Running GStreamer Applications" section.
 
 Use \-\-gst\-debug\-help to show category names
 
@@ -90,7 +92,7 @@ Sets the threshold for printing debugging messages.  A higher level
 will print more messages.  The useful range is 0-9, with the default
 being 0. Level 6 (LOG level) will show all information that is usually
 required for debugging purposes. Higher levels are only useful in very
-specific cases.
+specific cases. See above for the full list of levels.
 .TP 8
 .B  \-\-gst\-debug\-no\-color
 \fIGStreamer\fP normally prints debugging messages so that the
@@ -99,6 +101,16 @@ ANSI escape sequences.  Using this option causes \fIGStreamer\fP
 to print messages without color. Setting the \fBGST_DEBUG_NO_COLOR\fR
 environment variable will achieve the same thing.
 .TP 8
+.B  \-\-gst\-debug\-color\-mode
+\fIGStreamer\fP normally prints debugging messages so that the
+messages are color-coded when printed to a terminal that handles
+ANSI escape sequences (on *nix), or uses W32 console API to color the
+messages printed into a console (on W32). Using this option causes
+\fIGStreamer\fP to print messages without color ('off' or 'disable'),
+print messages with default colors ('on' or 'auto'), or print messages
+using ANSI escape sequences for coloring ('unix'). Setting the
+\fBGST_DEBUG_COLOR_MODE\fR environment variable will achieve the same thing.
+.TP 8
 .B  \-\-gst\-debug\-disable
 Disables debugging.
 .TP 8
@@ -322,13 +334,13 @@ This example also shows how to refer to specific pads by name if an element
 (here: textoverlay) has multiple sink or source pads.
 
 .B
-        gst\-launch textoverlay name=overlay ! videoconvert ! videoscale !  autovideosink   filesrc location=movie.avi ! decodebin2 ! videoconvert ! overlay.video_sink   filesrc location=movie.srt ! subparse ! overlay.text_sink
+        gst\-launch textoverlay name=overlay ! videoconvert ! videoscale !  autovideosink   filesrc location=movie.avi ! decodebin ! videoconvert ! overlay.video_sink   filesrc location=movie.srt ! subparse ! overlay.text_sink
 
 .br
-Play an AVI movie with an external text subtitle stream using playbin2
+Play an AVI movie with an external text subtitle stream using playbin
 
 .B
-        gst\-launch playbin2 uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt
+        gst\-launch playbin uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt
 
 .B Network streaming
 
@@ -404,20 +416,26 @@ samples and a sample rate between 32kHz and 64KHz.
 .SH "ENVIRONMENT VARIABLES"
 .TP
 \fBGST_DEBUG\fR
-Comma-separated list of debug categories and levels, e.g.
-GST_DEBUG=totem:4,typefind:5
+Comma-separated list of debug categories and levels (e.g.
+GST_DEBUG=totem:4,typefind:5). '*' is allowed as a wildcard as part of
+debug category names (e.g. GST_DEBUG=*sink:6,*audio*:6). Since 1.2.0 it is
+also possible to specify the log level by name (1=ERROR, 2=WARN, 3=FIXME,
+4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP) (e.g. GST_DEBUG=*audio*:LOG)
 .TP
 \fBGST_DEBUG_NO_COLOR\fR
 When this environment variable is set, coloured debug output is disabled.
 .TP
 \fBGST_DEBUG_DUMP_DOT_DIR\fR
-When set to a filesystem path, store dot files of pipeline graphs there.
+When set to a filesystem path, store 'dot' files of pipeline graphs there.
+These can then later be converted into an image using the 'dot' utility from
+the graphviz set of tools, like this: dot foo.dot -Tsvg -o foo.svg (png or jpg
+are also possible as output format)
 .TP
 \fBGST_REGISTRY\fR
 Path of the plugin registry file. Default is
-~/.gstreamer-GST_API_VERSION/registry-CPU.bin where CPU is the machine/cpu type
-GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64', 'ppc', etc. (check
-the output of "uname -i" and "uname -m" for details).
+~/.cache/gstreamer-GST_API_VERSION/registry-CPU.bin where CPU is the
+machine/cpu type GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64',
+'ppc', etc. (check the output of "uname -i" and "uname -m" for details).
 .TP
 \fBGST_REGISTRY_UPDATE\fR
 Set to "no" to force GStreamer to assume that no plugins have changed,