Add man page for gstreamer-complete

Original commit message from CVS:
Add man page for gstreamer-complete

diff --git a/tools/Makefile.am b/tools/Makefile.am
index e0bbeeb..a1c0db2 100644 (file)
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -1,7 +1,8 @@
 bin_PROGRAMS = gstreamer-launch gstreamer-register gstreamer-inspect \
        gstreamer-compprep gstreamer-complete
 
-man_MANS = gstreamer-launch.1 gstreamer-register.1 gstreamer-inspect.1
+man_MANS = gstreamer-launch.1 gstreamer-register.1 gstreamer-inspect.1 \
+       gstreamer-complete.1
 
 LDADD = $(GST_LIBS)
 

diff --git a/tools/gstreamer-complete.1 b/tools/gstreamer-complete.1
new file mode 100644 (file)
index 0000000..9ebaa0a
--- /dev/null
+++ b/tools/gstreamer-complete.1
@@ -0,0 +1,30 @@
+.TH GStreamer 1 "June 2001"
+.SH NAME
+gstreamer\-complete - do bash completion for gstreamer\-launch command\-lines
+.SH SYNOPSIS
+.B  complete -C gstreamer\-complete gstreamer\-launch
+.SH DESCRIPTION
+.PP
+\fIgstreamer\-complete\fP is a utility enabling bash to provide
+context sensitive tab completion for \fIgstreamer\-launch\fP command\-lines.
+.
+See other docs for the syntax of \fIgstreamer\-launch\fP command\-lines.
+.
+You must have a version of bash which supports Programmable Completion.
+Versions of bash which support this provide the \fIcomplete\fP builtin
+command.
+.
+.SH USAGE
+Generate the registry of available plugins by running
+\fIgstreamer\-compprep\fP.
+.
+In your .bash_profile or other appropriate place, run
+.TP 8
+.B  complete -C gstreamer\-complete gstreamer\-launch
+.SH SEE ALSO
+.BR gstreamer\-lanuch (1),
+.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-launch.1 b/tools/gstreamer-launch.1
index 6d37068..340034a 100644 (file)
--- a/tools/gstreamer-launch.1
+++ b/tools/gstreamer-launch.1
@@ -31,6 +31,7 @@ Enable printout of errors while loading \fIGStreamer\fP plugins
 .B  \-\-gst\-plugin\-path=PATH
 Add directories separated with ':' to the plugin search path
 .SH SEE ALSO
+.BR gstreamer\-complete (1),
 .BR gstreamer\-register (1),
 .BR gstreamer\-inspect (1),
 .BR gstreamer\-config (1)