diff options
author | Tim-Philipp Müller <tim@centricular.net> | 2012-08-18 21:13:01 +0100 |
---|---|---|
committer | Tim-Philipp Müller <tim@centricular.net> | 2012-08-18 21:13:01 +0100 |
commit | daa046c1b60b813520152bdb1a2ced1835e47ac3 (patch) | |
tree | eca8b7c6eb256cb3574130eeb74f237194289bcc /tools | |
parent | 2a6a450001f3470678464690911d20bc49963542 (diff) |
tools: add basic man page for gst-discoverer
https://bugzilla.gnome.org/show_bug.cgi?id=681905
Diffstat (limited to 'tools')
-rw-r--r-- | tools/Makefile.am | 5 | ||||
-rw-r--r-- | tools/gst-discoverer.1.in | 37 |
2 files changed, 40 insertions, 2 deletions
diff --git a/tools/Makefile.am b/tools/Makefile.am index b88e1c62f..946b1f9b2 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -2,7 +2,8 @@ bin_SCRIPTS = \ gst-visualise-@GST_API_VERSION@ man_MANS = \ - gst-visualise-@GST_API_VERSION@.1 + gst-visualise-@GST_API_VERSION@.1 \ + gst-discoverer-@GST_API_VERSION@.1 bin_PROGRAMS = \ gst-discoverer-@GST_API_VERSION@ @@ -12,7 +13,7 @@ gst_discoverer_@GST_API_VERSION@_SOURCES = gst-discoverer.c CLEANFILES = $(man_MANS) $(bin_SCRIPTS) $(bin_PROGRAMS) EXTRA_DIST = \ - gst-visualise-m.m gst-visualise.1.in + gst-visualise-m.m gst-visualise.1.in gst-discoverer.1.in LDADD = $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_API_VERSION@.la \ diff --git a/tools/gst-discoverer.1.in b/tools/gst-discoverer.1.in new file mode 100644 index 000000000..c266596b8 --- /dev/null +++ b/tools/gst-discoverer.1.in @@ -0,0 +1,37 @@ +.TH "GStreamer" "1" "August 2012" "" "" +.SH "NAME" +gst\-discoverer\-1.0 \- Display file metadata and stream information +.SH "SYNOPSIS" +\fBgst\-discoverer\-1.0\fR \fIFILE|DIRECTORY|URI [FILE2|DIRECTORY2|URI2]\fR +.SH "DESCRIPTION" +.LP +\fIgst\-discoverer\-1.0\fP is a tool that can be used to print +basic metadata and stream information about a media file. It can be run on +individual files or whole directories. It will recurse into sub-directories +in that case. + +.SH "OPTIONS" +.l +\fIgst\-discoverer\-1.0\fP accepts the following options: +.TP 8 +.B \-\-help +Print help synopsis and available FLAGS +.TP 8 +.B \-v, \-\-verbose +Output all available information +.TP 8 +.B \-a, \-\-async +Use asynchronous code path +.TP 8 +.B \-t, \-\-timeout=T +Specify timeout in seconds (default: 10 seconds) +.TP 8 +.B \-c, \-\-toc +Output TOC (chapters and editions) if available +.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/ |