gst-inspect: Colored output
[platform/upstream/gstreamer.git] / tools / gst-inspect-1.0.1
1 .TH GStreamer 1 "December 2005"
2 .SH "NAME"
3 gst\-inspect\-1.0 \- print info about a GStreamer plugin or element
4 .SH "SYNOPSIS"
5 .B  gst\-inspect\-1.0 [OPTION...] [PLUGIN|ELEMENT]
6 .SH "DESCRIPTION"
7 .PP
8 \fIgst\-inspect\-1.0\fP is a tool that prints out information on
9 available \fIGStreamer\fP plugins, information about a particular
10 plugin, or information about a particular element.  When executed
11 with no PLUGIN or ELEMENT argument, \fIgst\-inspect\-1.0\fP will print
12 a list of all plugins and elements together with a summary.
13 When executed with a PLUGIN or ELEMENT argument,
14 \fIgst\-inspect\-1.0\fP will print information about that plug-in or
15 element.
16 .
17 .SH "OPTIONS"
18 .l
19 \fIgst\-inspect\-1.0\fP accepts the following arguments and options:
20 .TP 8
21 .B  PLUGIN
22 Name of a plugin
23 .TP 8
24 .B  ELEMENT
25 Name of an element
26 .TP 8
27 .B  \-\-help
28 Print help synopsis and available FLAGS
29 .TP 8
30 .B  \-\-gst\-info\-mask=FLAGS
31 \fIGStreamer\fP info flags to set (list with \-\-help)
32 .TP 8
33 .B  \-a, \-\-print\-all
34 Print all plugins and elements
35 .TP 8
36 .B  \-b, \-\-print\-blacklist
37 Print list of blacklisted files
38 .TP 8
39 .B  \-\-plugin
40 List the plugin contents
41 .TP 8
42 .B  \-\-types=Element/Types
43 Allow inspecting only elements that match all the element types filtered
44 in this slash (\'/\') separated list of element types. Those types correspond to
45 what is also called \'klass\' which is a string describing the type of
46 element, like \'Decoder\', \'Audio\', \'Encoder\' etc... This options
47 implies that only elements will be printed (not typefind functions or
48 tracers).
49 .TP 8
50 .B  \-\-exists
51 Check if the specified element or plugin exists
52 .TP 8
53 .B  \-\-atleast\-version
54 When checking if an element or plugin exists, also check that its version
55 is at least the version specified
56 .TP 8
57 .B  \-u, \-\-uri\-handlers
58 Print supported URI schemes, with the elements that implement them
59 .TP 8
60 .B  \-u, \-\-no\-colors
61 Disable colors in output. You can also achieve the same by setting
62 \'GST_INSPECT_NO_COLORS\' environment variable to any value.
63 .TP 8
64 .B  \-\-print\-plugin\-auto\-install\-info
65 Print a machine-parsable list of features the specified plugin provides.
66 Useful in connection with external automatic plugin installation mechanisms.
67 .TP 8
68 .B  \-\-gst\-debug\-mask=FLAGS
69 \fIGStreamer\fP debugging flags to set (list with \-\-help)
70 .TP 8
71 .B  \-\-gst\-mask=FLAGS
72 \fIGStreamer\fP info and debugging flags to set (list with \-\-help)
73 .TP 8
74 .B  \-\-gst\-plugin\-spew
75 \fIGStreamer\fP info flags to set
76 Enable printout of errors while loading \fIGStreamer\fP plugins
77 .TP 8
78 .B  \-\-gst\-plugin\-path=PATH
79 Add directories separated with ':' to the plugin search path
80 .
81 .SH "SEE ALSO"
82 .BR gst\-launch\-1.0 (1),
83 .BR gst\-typefind\-1.0 (1)
84 .SH "AUTHOR"
85 The GStreamer team at http://gstreamer.freedesktop.org/