From 82f6368bf074e2d13e3c78376e9c495a62ad125d Mon Sep 17 00:00:00 2001 From: "David I. Lehn" Date: Fri, 16 Mar 2001 01:06:50 +0000 Subject: [PATCH] Added man pages. Original commit message from CVS: Added man pages. --- Makefile.am | 4 +++- editor/Makefile.am | 4 +++- editor/gsteditor.1 | 39 ++++++++++++++++++++++++++++++++++ gstplay/Makefile.am | 4 +++- gstplay/gstmediaplay.1 | 39 ++++++++++++++++++++++++++++++++++ gstreamer-config.1 | 43 ++++++++++++++++++++++++++++++++++++++ tools/Makefile.am | 3 +++ tools/gstreamer-inspect.1 | 43 ++++++++++++++++++++++++++++++++++++++ tools/gstreamer-launch.1 | 38 +++++++++++++++++++++++++++++++++ tools/gstreamer-register.1 | 37 ++++++++++++++++++++++++++++++++ 10 files changed, 251 insertions(+), 3 deletions(-) create mode 100644 editor/gsteditor.1 create mode 100644 gstplay/gstmediaplay.1 create mode 100644 gstreamer-config.1 create mode 100644 tools/gstreamer-inspect.1 create mode 100644 tools/gstreamer-launch.1 create mode 100644 tools/gstreamer-register.1 diff --git a/Makefile.am b/Makefile.am index 2fc9edfef4..ebdf9fbc8a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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) diff --git a/editor/Makefile.am b/editor/Makefile.am index a40beda3a4..0b426547b1 100644 --- a/editor/Makefile.am +++ b/editor/Makefile.am @@ -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) diff --git a/editor/gsteditor.1 b/editor/gsteditor.1 new file mode 100644 index 0000000000..6667e6084a --- /dev/null +++ b/editor/gsteditor.1 @@ -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/ diff --git a/gstplay/Makefile.am b/gstplay/Makefile.am index 93629faf2d..1dcc03c2fd 100644 --- a/gstplay/Makefile.am +++ b/gstplay/Makefile.am @@ -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 \ diff --git a/gstplay/gstmediaplay.1 b/gstplay/gstmediaplay.1 new file mode 100644 index 0000000000..b88c097886 --- /dev/null +++ b/gstplay/gstmediaplay.1 @@ -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/ diff --git a/gstreamer-config.1 b/gstreamer-config.1 new file mode 100644 index 0000000000..254ae3129f --- /dev/null +++ b/gstreamer-config.1 @@ -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/ diff --git a/tools/Makefile.am b/tools/Makefile.am index d203155426..f723d5d02d 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -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) diff --git a/tools/gstreamer-inspect.1 b/tools/gstreamer-inspect.1 new file mode 100644 index 0000000000..ec7fcd8e80 --- /dev/null +++ b/tools/gstreamer-inspect.1 @@ -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/ diff --git a/tools/gstreamer-launch.1 b/tools/gstreamer-launch.1 new file mode 100644 index 0000000000..6d370687d0 --- /dev/null +++ b/tools/gstreamer-launch.1 @@ -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/ diff --git a/tools/gstreamer-register.1 b/tools/gstreamer-register.1 new file mode 100644 index 0000000000..d0fe5a49d1 --- /dev/null +++ b/tools/gstreamer-register.1 @@ -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/