mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-09 09:39:27 +00:00
Code Issues 1 Projects Releases Wiki Activity

tools/: cleanup man-pages, remove reference to gst-register, document env-vars

Browse source 
Original commit message from CVS:
* tools/README:
* tools/gst-feedback.1.in:
* tools/gst-inspect.1.in:
* tools/gst-launch.1.in:
* tools/gst-md5sum.1.in:
* tools/gst-typefind.1.in:
* tools/gst-xmlinspect.1.in:
* tools/gst-xmllaunch.1.in:
cleanup man-pages, remove reference to gst-register, document env-vars
This commit is contained in:
Stefan Kost 2006-01-12 16:31:35 +00:00
parent 3b1dfa5fec
commit 334b141a32
9 changed files with 85 additions and 87 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
ChangeLog
View file

@ -1,3 +1,15 @@
2006-01-12 Stefan Kost <ensonic@users.sf.net>
* tools/README:
* tools/gst-feedback.1.in:
* tools/gst-inspect.1.in:
* tools/gst-launch.1.in:
* tools/gst-md5sum.1.in:
* tools/gst-typefind.1.in:
* tools/gst-xmlinspect.1.in:
* tools/gst-xmllaunch.1.in:
cleanup man-pages, remove reference to gst-register, document env-vars
2006-01-12 Jan Schmidt <thaytan@mad.scientist.com>
* gst/gstbuffer.c: (gst_buffer_span):

13
tools/README
View file

@ -91,7 +91,7 @@ For an avi file (DivX, mjpeg,...)
gst-launch filesrc location=video.avi ! avidecoder video_00! { queue ! sdlvideosink } avidecoder0.audio_00! { queue ! osssink }
gst-complete
==================
@ -107,15 +107,6 @@ You can then enjoy context sensitive tab-completion of gst-launch
commands.
gst-register
==================
This tool will perform an introspection on all available plugins and will
create a registry file in /etc/gstreamer/reg.xml. Startup time will be
much faster since the gstreamer core doesn't have to bring all the plugins
files into memory at startup. As with gst-compprep you need to run this
as root for it too work correctly.
gst-inspect
=================
@ -130,6 +121,8 @@ will show all the plugins available and the elements they contain.
shows more info about the plugin/element.
gst-xmlinspect
=================

21
tools/gst-feedback.1.in
View file

@ -1,9 +1,9 @@
.TH GStreamer 1 "June 2002"
.SH NAME
.SH "NAME"
gst\-feedback - generate debug info for GStreamer bug reports
.SH SYNOPSIS
.SH "SYNOPSIS"
.B gst-feedback
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
\fIgst\-feedback\fP is a utility that scans the system for various
information that is useful to GStreamer developers to help diagnose
@ -16,7 +16,7 @@ NOTE: The current version of this script scans many dirs:
/usr/lib /usr/local/lib /home /usr/include /usr/local/include /home (again)
for various GStreamer installations. Depending on your system you may not
want to do this. Improvements to the script are welcome.
.SH USAGE
.SH "USAGE"
Generate the feedback information by running \fIgst\-feedback\fP:
.TP 8
.B gst\-feedback
@ -24,14 +24,15 @@ Generate the feedback information by running \fIgst\-feedback\fP:
Possibly redirect output and errors to a file:
.TP 8
.B gst\-feedback &> myfeedback
.SH WARNING
.SH "WARNING"
The \fIgst\-feedback\fP dumps a lot of information about a system, some
of which may be considered sensitive. If this is a concern, review the
information before posting to a public forum, such as the GStreamer bug
tracking system.
.SH SEE ALSO
.BR gst\-launch (1),
.BR gst\-register (1),
.
.SH "SEE ALSO"
.BR gst\-inspect (1),
.SH AUTHOR
The GStreamer team at http://gstreamer.net/
.BR gst\-launch (1),
.BR gst\-typefind (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/

29
tools/gst-inspect.1.in
View file

@ -1,19 +1,20 @@
.TH GStreamer 1 "March 2001"
.SH NAME
.TH GStreamer 1 "December 2005"
.SH "NAME"
gst\-inspect - print info about a GStreamer plugin or element
.SH SYNOPSIS
.SH "SYNOPSIS"
.B gst\-inspect [OPTION...] [PLUGIN|ELEMENT]
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
\fIgst\-inspect\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\fP will print
a list of all plugins and elements. When executed with a PLUGIN
or ELEMENT argument, \fIgst\-inspect\fP will print information
about that plug-in or element.
a list of all plugins and elements together with a sumary.
When executed with a PLUGIN or ELEMENT argument,
\fIgst\-inspect\fP will print information about that plug-in or
element.
.
.SH OPTIONS
.SH "OPTIONS"
.l
\fIgst\-inspect\fP accepts the following arguments and options:
.TP 8
@ -41,8 +42,10 @@ 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/
.
.SH "SEE ALSO"
.BR gst\-feedback (1),
.BR gst\-launch (1),
.BR gst\-typefind (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/

17
tools/gst-launch.1.in
View file

@ -9,7 +9,7 @@ gst\-launch \- build and run a GStreamer pipeline
\fIGStreamer\fP pipelines.
In simple form, a PIPELINE\-DESCRIPTION is a list of
elements separated by exclamation marks (!). Properties may be appended to
elements separated by exclamation marks (!). Properties may be appended to
elements, in the form \fIproperty=value\fR.
For a complete description of possible PIPELINE-DESCRIPTIONS see the section
@ -390,15 +390,16 @@ GST_DEBUG=totem:4,typefind:5
When this environment variable is set, coloured debug output is disabled.
.TP
\fBGST_REGISTRY\fR
Describe me
Path of the registry file. Default is ~/.gstreamer-0.9/registry.xml.
.TP
\fBGST_PLUGIN_PATH\fR
Set to directories in the form of $prefix/lib/gstreamer-0.10 to include plugins
in non-standart locations. The path does not need to repeat the default
GStreamer plugin path.
Specifies a list of directories to scan for additional plugins.
These take precedence over the system plugins.
.TP
\fBGST_PLUGIN_SYSTEM_PATH\fR
Describe me
Specifies a list of plugins that are always loaded by default. If not set,
this defaults to the system-installed path, and the plugins installed in the
user's home directory
.TP
\fBOIL_CPU_FLAGS\fR
Useful liboil environment variable. Set OIL_CPU_FLAGS=0 when valgrind or
@ -414,8 +415,8 @@ as mentioned above and run the program in gdb (or let it core dump). Then get
a stack trace in the usual way.
.
.SH "SEE ALSO"
.BR gst\-inspect (1)
.BR gst\-feedback (1),
.BR gst\-inspect (1),
.BR gst\-typefind (1)
.BR gst\-feedback (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/

33
tools/gst-md5sum.1.in
View file

@ -50,31 +50,12 @@ 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)
.BR gst\-feedback (1),
.BR gst\-inspect (1),
.BR gst\-launch (1),
.BR gst\-typefind (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.net/
***************
*** 16,24 ****
md5sum music.mp3
The pipeline should be incomplete, that is, a final sink element
- should be omitted, so that gst\-md5sum can connect the pipeline to
- an md5sink element.
See the man page for gst\-launch or the GStreamer docuementation for
more information on how to create a PARTIAL\-PIPELINE\-DESCRIPTION.
--- 16,27 ----
md5sum music.mp3
+ If the pipeline contains an md5sink element, gst-md5sum will query it
+ for the md5sum at the end of pipeline iteration.
+
+ If it doesn't contain an md5sink element, gst-md5sum will automatically
+ connect an md5sink to the right hand side of the given pipeline.
The pipeline should be incomplete, that is, a final sink element
See the man page for gst\-launch or the GStreamer docuementation for
more information on how to create a PARTIAL\-PIPELINE\-DESCRIPTION.
The GStreamer team at http://gstreamer.freedesktop.org/

18
tools/gst-typefind.1.in
View file

@ -1,15 +1,15 @@
.TH GStreamer 1 "May 2003"
.SH NAME
.SH "NAME"
gst\-typefind - print MIME type of file
.SH SYNOPSIS
.SH "SYNOPSIS"
.B gst\-typefind <file>
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
\fIgst\-typefind\fP uses the GStreamer type finding system to
determine the relevant GStreamer plugin to parse or decode \fBfile\fP,
and the corresponding MIME type.
.
.SH OPTIONS
.SH "OPTIONS"
.l
\fIgst\-typefind\fP accepts the following options:
.TP 8
@ -31,8 +31,10 @@ 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),
.
.SH "SEE ALSO"
.BR gst\-feedback (1),
.BR gst\-inspect (1),
.BR gst\-launch (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/

21
tools/gst-xmlinspect.1.in
View file

@ -1,9 +1,9 @@
.TH GStreamer 1 "March 2001"
.SH NAME
.SH "NAME"
gst\-xmlinspect - print info about a GStreamer plugin or element
.SH SYNOPSIS
.SH "SYNOPSIS"
.B gst\-xmlinspect [OPTION...] [PLUGIN|ELEMENT]
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
\fIgst\-xmlinspect\fP is a tool that prints out information on
available \fIGStreamer\fP plugins, information about a particular
@ -13,7 +13,7 @@ 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
.SH "OPTIONS"
.l
\fIgst\-xmlinspect\fP accepts the following arguments and options:
.TP 8
@ -41,8 +41,11 @@ 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/
.
.SH "SEE ALSO"
.BR gst\-feedback (1),
.BR gst\-inspect (1),
.BR gst\-launch (1),
.BR gst\-typefind (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/

8
tools/gst-xmllaunch.1.in
View file

@ -55,9 +55,11 @@ 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),
.BR gst\-register (1),
.BR gst\-feedback (1),
.BR gst\-inspect (1),
.BR gst\-launch (1),
.BR gst\-typefind (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.net/
The GStreamer team at http://gstreamer.freedesktop.org/