gstreamer/tools/gst-inspect-1.0.1
Antonio Ospite 2a5a8dd3c7 tools: ship the final man pages directly, no more man pages templates
Don't use templates for the man pages, the API version change is a rare
event, so it's not really worth keeping in place the "sed" boilerplate
to have it set at build time.

Shipping the final man pages directly also makes it easer to install the
man pages with meson (in a future commit).

Note that now all the occurrences of the programs names have the API
version as a suffix.

Traditionally the example command lines looked like:

  gst-launch ...

Now they look like:

  gst-launch-1.0 ...

This reflects the actual programs names and makes it easier to copy and
paste the example commands.

Also, the .gitignore file is adjusted not to ignore the final man pages
anymore.

You may need to clean your src/build directory before pulling in this
patch.

https://bugzilla.gnome.org/show_bug.cgi?id=773917
2016-11-23 09:09:05 +00:00

57 lines
1.7 KiB
Groff

.TH GStreamer 1 "December 2005"
.SH "NAME"
gst\-inspect\-1.0 \- print info about a GStreamer plugin or element
.SH "SYNOPSIS"
.B gst\-inspect\-1.0 [OPTION...] [PLUGIN|ELEMENT]
.SH "DESCRIPTION"
.PP
\fIgst\-inspect\-1.0\fP is a tool that prints out information on
available \fIGStreamer\fP plugins, information about a particular
plugin, or information about a particular element. When executed
with no PLUGIN or ELEMENT argument, \fIgst\-inspect\-1.0\fP will print
a list of all plugins and elements together with a summary.
When executed with a PLUGIN or ELEMENT argument,
\fIgst\-inspect\-1.0\fP will print information about that plug-in or
element.
.
.SH "OPTIONS"
.l
\fIgst\-inspect\-1.0\fP accepts the following arguments and options:
.TP 8
.B PLUGIN
Name of a plugin
.TP 8
.B ELEMENT
Name of an element
.TP 8
.B \-\-help
Print help synopsis and available FLAGS
.TP 8
.B \-\-gst\-info\-mask=FLAGS
\fIGStreamer\fP info flags to set (list with \-\-help)
.TP 8
.B \-a, \-\-print\-all
Print all plugins and elements
.TP 8
.B \-\-print\-plugin\-auto\-install\-info
Print a machine-parsable list of features the specified plugin provides.
Useful in connection with external automatic plugin installation mechanisms.
.TP 8
.B \-\-gst\-debug\-mask=FLAGS
\fIGStreamer\fP debugging flags to set (list with \-\-help)
.TP 8
.B \-\-gst\-mask=FLAGS
\fIGStreamer\fP info and debugging flags to set (list with \-\-help)
.TP 8
.B \-\-gst\-plugin\-spew
\fIGStreamer\fP info flags to set
Enable printout of errors while loading \fIGStreamer\fP plugins
.TP 8
.B \-\-gst\-plugin\-path=PATH
Add directories separated with ':' to the plugin search path
.
.SH "SEE ALSO"
.BR gst\-launch\-1.0 (1),
.BR gst\-typefind\-1.0 (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/