tools: add man page for new gst-play-1.0 utility

https://bugzilla.gnome.org/show_bug.cgi?id=553520
This commit is contained in:
Tim-Philipp Müller 2013-08-17 16:53:30 +01:00
parent 8cd2d0a672
commit ab72118d29
2 changed files with 37 additions and 2 deletions

View file

@ -1,5 +1,6 @@
man_MANS = \
gst-discoverer-@GST_API_VERSION@.1
gst-discoverer-@GST_API_VERSION@.1 \
gst-play-@GST_API_VERSION@.1
bin_PROGRAMS = \
gst-discoverer-@GST_API_VERSION@ \
@ -11,7 +12,7 @@ gst_play_@GST_API_VERSION@_SOURCES = gst-play.c
CLEANFILES = $(bin_SCRIPTS) $(bin_PROGRAMS)
EXTRA_DIST = gst-discoverer-1.0.1
EXTRA_DIST = $(man_MANS)
LDADD = $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_API_VERSION@.la \

34
tools/gst-play-1.0.1 Normal file
View file

@ -0,0 +1,34 @@
.TH "GStreamer" "1" "August 2013" "" ""
.SH "NAME"
gst\-play\-1.0 \- Simple command line playback testing tool
.SH "SYNOPSIS"
\fBgst\-play\-1.0\fR \fIFILE|DIRECTORY|URI [FILE2|DIRECTORY2|URI2]\fR
.SH "DESCRIPTION"
.LP
\fIgst\-play\-1.0\fP is a command line tool that can be used to test
basic playback using the playbin element. You can pass it individual files,
URIs or whole directories (in which case it will recurse into sub-directories
as well).
.SH "OPTIONS"
.l
\fIgst\-play\-1.0\fP accepts the following options:
.TP 8
.B \-\-help
Print help synopsis and available command line options
.TP 8
.B \-\-version
Print version and exit
.TP 8
.B \-\-audiosink=SOMESINK
Use SOMESINK as audio sink instead of autoaudiosink.
.TP 8
.B \-\-videosink=SOMESINK
Use SOMESINK as video sink instead of autovideosink.
.TP 8
.SH "SEE ALSO"
.BR gst\-inspect\-1.0 (1),
.BR gst\-launch\-1.0 (1),
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/