Add gstreamer-compprep man page.
authorRichard Boulton <richard@tartarus.org>
Thu, 7 Jun 2001 10:58:40 +0000 (10:58 +0000)
committerRichard Boulton <richard@tartarus.org>
Thu, 7 Jun 2001 10:58:40 +0000 (10:58 +0000)
Original commit message from CVS:
Add gstreamer-compprep man page.

tools/Makefile.am
tools/gstreamer-complete.1
tools/gstreamer-compprep.1 [new file with mode: 0644]
tools/gstreamer-register.1

index a1c0db2a7aa2603b738ba6e19b137727fab2c47f..d3cc4c210cde878882ec49ecd7d1de999e877351 100644 (file)
@@ -2,7 +2,7 @@ bin_PROGRAMS = gstreamer-launch gstreamer-register gstreamer-inspect \
        gstreamer-compprep gstreamer-complete
 
 man_MANS = gstreamer-launch.1 gstreamer-register.1 gstreamer-inspect.1 \
-       gstreamer-complete.1
+       gstreamer-complete.1 gstreamer-compprep.1
 
 LDADD = $(GST_LIBS)
 
index 9ebaa0a01936813850b0b3cac6739220aa170653..a7af9c640d5752e214ffcff40f29ecfc18e6eb8d 100644 (file)
@@ -22,6 +22,7 @@ In your .bash_profile or other appropriate place, run
 .TP 8
 .B  complete -C gstreamer\-complete gstreamer\-launch
 .SH SEE ALSO
+.BR gstreamer\-compreg (1),
 .BR gstreamer\-lanuch (1),
 .BR gstreamer\-register (1),
 .BR gstreamer\-inspect (1),
diff --git a/tools/gstreamer-compprep.1 b/tools/gstreamer-compprep.1
new file mode 100644 (file)
index 0000000..c1d62b9
--- /dev/null
@@ -0,0 +1,29 @@
+.TH GStreamer 1 "June 2001"
+.SH NAME
+gstreamer\-compprep - create the registry for gstreamer\-complete
+.SH SYNOPSIS
+.B  compprep
+.SH DESCRIPTION
+.PP
+\fIgstreamer\-compprep\fP is a utility to build the registry of gstreamer
+elements and their features to enable context sensitive tab completion for
+\fIgstreamer\-launch\fP command\-lines to be performed by
+\fIgstreamer\-complete\fP.
+.
+By default, the registry is stored in /etc/gstreamer/compreg.xml
+.
+.SH USAGE
+Whenever the available gstreamer plugins are modified, generate the registry of available plugins by running
+\fIgstreamer\-compprep\fP.
+.SH FILES
+.TP 8
+/etc/gstreamer/compreg.xml
+Registry generated by \fIgstreamer\-compprep\fP and used by \fIgstreamer\-complete\fP.
+.SH SEE ALSO
+.BR gstreamer\-complete (1),
+.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/
index bc8bda1ac5c94df02825f900bd4e89b50df32eb0..9edf9bee94881a032e76299cb0d8ec56d78e651c 100644 (file)
@@ -35,6 +35,7 @@ Add directories separated with ':' to the plugin search path
 .SH SEE ALSO
 .BR gstreamer\-config (1),
 .BR gstreamer\-inspect (1),
-.BR gstreamer\-launch (1)
+.BR gstreamer\-launch (1),
+.BR gstreamer\-compreg (1)
 .SH AUTHOR
 The GStreamer team at http://gstreamer.net/