tools: add man page for new gst-play-1.0 utility
authorTim-Philipp Müller <tim@centricular.net>
Sat, 17 Aug 2013 15:53:30 +0000 (16:53 +0100)
committerTim-Philipp Müller <tim@centricular.net>
Sat, 17 Aug 2013 15:53:30 +0000 (16:53 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=553520

tools/Makefile.am
tools/gst-play-1.0.1 [new file with mode: 0644]

index 37e6d03..3d0711e 100644 (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 \
diff --git a/tools/gst-play-1.0.1 b/tools/gst-play-1.0.1
new file mode 100644 (file)
index 0000000..0ef5cfc
--- /dev/null
@@ -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/