tools/: Add man page. (bug #140219)

Original commit message from CVS:
* tools/Makefile.am:
* tools/gst-xmlinspect.1.in:  Add man page. (bug #140219)
This commit is contained in:
David Schleef 2004-07-04 23:36:29 +00:00
parent 31749816f4
commit e44786e7a0
3 changed files with 57 additions and 2 deletions

View file

@ -1,3 +1,8 @@
2004-07-04 David Schleef <ds@schleef.org>
* tools/Makefile.am:
* tools/gst-xmlinspect.1.in: Add man page. (bug #140219)
2004-07-04 David Schleef <ds@schleef.org>
* common/m4/gst-doc.m4: Check for docbook2html 0.6.10 (bug #139909)

View file

@ -123,8 +123,8 @@ GST_OTHER_MAN = \
gst-inspect-@GST_MAJORMINOR@.1 \
gst-launch-@GST_MAJORMINOR@.1 \
gst-md5sum-@GST_MAJORMINOR@.1 \
gst-typefind-@GST_MAJORMINOR@.1
# gst-xmlinspect-@GST_MAJORMINOR@.1
gst-typefind-@GST_MAJORMINOR@.1 \
gst-xmlinspect-@GST_MAJORMINOR@.1
manpages = $(GST_REGISTRY_MAN) $(GST_LOADSAVE_MAN) $(GST_OTHER_MAN)
@ -144,6 +144,7 @@ EXTRA_DIST = \
gst-md5sum.1.in \
gst-register.1.in \
gst-typefind.1.in \
gst-xmlinspect.1.in \
gst-xmllaunch.1.in \
gst-feedback-m.m
@ -157,6 +158,7 @@ EXTRA_DIST = \
-e s,gst-md5sum,gst-md5sum-@GST_MAJORMINOR@,g \
-e s,gst-register,gst-register-@GST_MAJORMINOR@,g \
-e s,gst-typefind,gst-typefind-@GST_MAJORMINOR@,g \
-e s,gst-xmlinspect,gst-xmlinspect-@GST_MAJORMINOR@,g \
-e s,gst-xmllaunch,gst-xmllaunch-@GST_MAJORMINOR@,g \
$< >$@

48
tools/gst-xmlinspect.1.in Normal file
View file

@ -0,0 +1,48 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gst\-xmlinspect - print info about a GStreamer plugin or element
.SH SYNOPSIS
.B gst\-xmlinspect [OPTION...] [PLUGIN|ELEMENT]
.SH DESCRIPTION
.PP
\fIgst\-xmlinspect\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\-xmlinspect\fP will print
a list of all plugins and elements. When executed with a PLUGIN
or ELEMENT argument, \fIgst\-xmlinspect\fP will print information
about that plug-in or element as an XML document.
.
.SH OPTIONS
.l
\fIgst\-xmlinspect\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 \-\-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\-register (1),
.BR gst\-launch (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/