[grilo] doc: Add manpage for grl-inspect
- From: Iago Toral Quiroga <itoral src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [grilo] doc: Add manpage for grl-inspect
- Date: Wed, 29 Jun 2011 08:44:28 +0000 (UTC)
commit 2cc9b619344275c56ada2819cbc88667b073beaf
Author: Alberto Garcia <agarcia igalia com>
Date: Tue Jun 28 23:11:24 2011 +0200
doc: Add manpage for grl-inspect
Signed-off-by: Iago Toral Quiroga <itoral igalia com>
Makefile.am | 2 ++
grl-inspect.1 | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 53 insertions(+), 0 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index e364cc2..ba3d7b9 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -24,6 +24,8 @@ if BUILD_GRILO_NET
pkgconfig_DATA += grilo-net-0.2.pc
endif
+man1_MANS = grl-inspect.1
+
MAINTAINERCLEANFILES = \
aclocal.m4 \
compile \
diff --git a/grl-inspect.1 b/grl-inspect.1
new file mode 100644
index 0000000..efaed93
--- /dev/null
+++ b/grl-inspect.1
@@ -0,0 +1,51 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH grl-inspect 1 "June 28, 2011"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+grl-inspect \- show information about a Grilo source or plugin
+.SH SYNOPSIS
+.B grl-inspect
+.RI [ options ]
+.RI [ source ]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B grl-inspect
+command.
+.PP
+\fBgrl-inspect\fP is a tool that prints out information on available Grilo
+sources. When executed with no SOURCE argument, grl-inspect will print
+the list of all plugins and sources. When executed with a SOURCE,
+grl-inspect will print information about that source.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Show summary of grl-inspect options.
+.TP
+.B \-\-help\-grl
+Show summary of Grilo options.
+.TP
+.B \-\-help\-all
+Show summary of all options.
+.TP
+.BI \-d,\ \-\-delay " seconds"
+Wait for some seconds before showing results. Useful when plugins may
+need some time for the source discovery process (example: UPnP).
+.TP
+.BI \-c,\ \-\-config " config-file"
+Configuration file to use with the plugins.
+.SH AUTHOR
+This manual page was written by Alberto Garcia <agarcia igalia com>.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]