mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-05-18 08:22:51 +00:00
Code Issues Projects Releases Wiki Activity

Added man pages.

Browse source 
Original commit message from CVS:
Added man pages.
This commit is contained in:
David I. Lehn 2001-03-16 01:06:50 +00:00
parent 2193791c6b
commit 82f6368bf0
10 changed files with 251 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Makefile.am
View file

@ -26,7 +26,9 @@ bin_SCRIPTS = gstreamer-config
m4datadir = $(datadir)/aclocal
m4data_DATA = gstreamer.m4
EXTRA_DIST = gstreamer.spec.in gstreamer-config.in gstreamer.m4 LICENSE REQUIREMENTS
man_MANS = gstreamer-config.1
EXTRA_DIST = gstreamer.spec.in gstreamer-config.in gstreamer.m4 LICENSE REQUIREMENTS $(man_MANS)
dist-hook:
cp gstreamer.spec $(distdir)

4
editor/Makefile.am
View file

@ -27,6 +27,8 @@ bin_PROGRAMS = gsteditor
gsteditor_SOURCES = editor.c
gsteditor_LDFLAGS = libgsteditor.la $(GST_LIBS)
man_MANS = gsteditor.1
gladedir = $(datadir)/gsteditor
glade_DATA = editor.glade editorelement.glade
@ -40,4 +42,4 @@ noinst_HEADERS = \
SUBDIRS = pixmaps
EXTRA_DIST = $(glade_DATA)
EXTRA_DIST = $(glade_DATA) $(man_MANS)

39
editor/gsteditor.1 Normal file
View file

@ -0,0 +1,39 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gsteditor - a graphical GStreamer pipeline editor
.SH SYNOPSIS
.B gsteditor [OPTION...] [FILE]
.SH DESCRIPTION
.PP
\fIgsteditor\fP is a graphical \fIGStreamer\fP pipeline editor. It can
load, save, and run pipelines.
.
.SH OPTIONS
.l
\fIgsteditor\fP accepts the following options:
.TP 8
.B FILE
Pipeline to load
.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\-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 gstreamer\-register (1),
.BR gstreamer\-inspect (1),
.BR gstreamer\-launch (1),
.BR gstmediaplay (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/

4
gstplay/Makefile.am
View file

@ -9,10 +9,12 @@ bin_PROGRAMS = gstmediaplay
lib_LTLIBRARIES = libgstmediaplay.la
man_MANS = gstmediaplay.1
gladedir = $(datadir)/gstmediaplay
glade_DATA = gstmediaplay.glade play.xpm stop.xpm pause.xpm
EXTRA_DIST = $(glade_DATA)
EXTRA_DIST = $(glade_DATA) $(man_MANS)
libgstmediaplay_la_SOURCES = \
gstplay.c \

39
gstplay/gstmediaplay.1 Normal file
View file

@ -0,0 +1,39 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gstmediaplay - a GStreamer media player
.SH SYNOPSIS
.B gstmediaplay [OPTION...] [FILE]
.SH DESCRIPTION
.PP
\fIgstmediaplay\fP is a media player based on the \fIGStreamer\fP
framework.
.
.SH OPTIONS
.l
\fIgstmediaplay\fP accepts the following options:
.TP 8
.B FILE
File to play on startup
.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\-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 gstreamer\-register (1),
.BR gstreamer\-inspect (1),
.BR gstreamer\-launch (1),
.BR gsteditor (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/

43
gstreamer-config.1 Normal file
View file

@ -0,0 +1,43 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gstreamer\-config - script to get information about the installed version of GStreamer
.SH SYNOPSIS
.B gstreamer\-config [\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version] [\-\-libs] [\-\-cflags]
.SH DESCRIPTION
.PP
\fIgstreamer\-config\fP is a tool that is used to configure to determine
the compiler and linker flags that should be used to compile
and link programs that use \fIGStreamer\fP. It is also used internally
to the .m4 macros for GNU autoconf that are included with \fIGStreamer\fP.
.
.SH OPTIONS
.l
\fIgstreamer\-config\fP accepts the following options:
.TP 8
.B \-\-version
Print the currently installed version of \fIGStreamer\fP on the standard output.
.TP 8
.B \-\-libs
Print the linker flags that are necessary to link a \fIGStreamer\fP program.
.TP 8
.B \-\-cflags
Print the compiler flags that are necessary to compile a \fIGStreamer\fP program.
.TP 8
.B \-\-prefix=PREFIX
If specified, use PREFIX instead of the installation prefix that \fIGStreamer\fP
was built with when computing the output for the \-\-cflags and
\-\-libs options. This option is also used for the exec prefix
if \-\-exec\-prefix was not specified. This option must be specified
before any \-\-libs or \-\-cflags options.
.TP 8
.B \-\-exec\-prefix=PREFIX
If specified, use PREFIX instead of the installation exec prefix that
\fIGStreamer\fP was built with when computing the output for the \-\-cflags
and \-\-libs options. This option must be specified before any
\-\-libs or \-\-cflags options.
.SH SEE ALSO
.BR gstreamer\-register (1),
.BR gstreamer\-inspect (1),
.BR gstreamer\-launch (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/

3
tools/Makefile.am
View file

@ -1,4 +1,7 @@
bin_PROGRAMS = gstreamer-launch gstreamer-register gstreamer-inspect
man_MANS = gstreamer-launch.1 gstreamer-register.1 gstreamer-inspect.1
LDADD = $(GST_LIBS)
EXTRA_DIST = $(man_MANS)

43
tools/gstreamer-inspect.1 Normal file
View file

@ -0,0 +1,43 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gstreamer\-inspect - print info about a GStreamer plugin or element
.SH SYNOPSIS
.B gstreamer\-register [OPTION...] [PLUGIN|ELEMENT]
.SH DESCRIPTION
.PP
\fIgstreamer\-inspect\fP is a tool to print out information on the
available \fIGStreamer\fP plugins, information on a plugin, or
information on an element. With no PLUGIN or ELEMENT option it
will list all plugins and elements.
.
.SH OPTIONS
.l
\fIgstreamer\-inspect\fP accepts the following 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\-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 gstreamer\-config (1),
.BR gstreamer\-register (1),
.BR gstreamer\-launch (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/

38
tools/gstreamer-launch.1 Normal file
View file

@ -0,0 +1,38 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gstreamer\-launch - build and run a GStreamer pipeline
.SH SYNOPSIS
.B gstreamer\-launch [OPTION...] PIPELINE\-DESCRIPTION
.SH DESCRIPTION
.PP
\fIgstreamer\-launch\fP is a tool that is used to build and run a basic
\fIGStreamer\fP pipeline.
.
See other docs, examples, and the source for description on how to
create a PIPELINE\-DESCRIPTION.
.
.SH OPTIONS
.l
\fIgstreamer\-launch\fP accepts the following options:
.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\-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 gstreamer\-register (1),
.BR gstreamer\-inspect (1),
.BR gstreamer\-config (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/

37
tools/gstreamer-register.1 Normal file
View file

@ -0,0 +1,37 @@
.TH GStreamer 1 "March 2001"
.SH NAME
gstreamer\-register - register GStreamer plugins
.SH SYNOPSIS
.B gstreamer\-register [OPTION...]
.SH DESCRIPTION
.PP
\fIgstreamer\-register\fP is a tool that is used to register all
the \fIGStreamer\fP plugins on your system. It creates a listing of their
properties such that on startup of \fIGStreamer\fP based application do not
need to load plugins until they need them.
.
.SH OPTIONS
.l
\fIgstreamer\-register\fP accepts the following options:
.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\-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 gstreamer\-config (1),
.BR gstreamer\-inspect (1),
.BR gstreamer\-launch (1)
.SH AUTHOR
The GStreamer team at http://gstreamer.net/