doc: put manpages in doc/man

Put all manpage files together.

https://bugzilla.gnome.org/show_bug.cgi?id=775950

5 files changed, 235 insertions, 1 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1648c9d..3429f09 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,6 +5,10 @@
 #
 # Copyright (C) 2011 Igalia S.L. All rights reserved.
 
-SUBDIRS = grilo
+SUBDIRS = man
+
+if ENABLE_GTK_DOC
+SUBDIRS += grilo
+endif
 
 -include $(top_srcdir)/git.mk
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 0000000..bf467e5
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,14 @@
+#
+# Makefile.am
+#
+# Author: Juan A. Suarez Romero <jasuarez@igalia.com>
+#
+# Copyright (C) 2016 Igalia S.L. All rights reserved.
+
+dist_man1_MANS = grl-inspect-0.3.1 grl-launch-0.3.1
+
+if BUILD_GRILO_TEST_UI
+dist_man1_MANS += grilo-test-ui-0.3.1
+endif
+
+-include $(top_srcdir)/git.mk
diff --git a/doc/man/grilo-test-ui-0.3.1 b/doc/man/grilo-test-ui-0.3.1
new file mode 100644
index 0000000..3f0fe41
--- /dev/null
+++ b/doc/man/grilo-test-ui-0.3.1
@@ -0,0 +1,41 @@
+.\"                                      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 grilo-test-ui 1 "August 25, 2014"
+.\" 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
+grilo-test-ui \- Grilo test UI
+.SH SYNOPSIS
+.B grilo-test-ui
+.RI [ options ]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B grilo-test-ui
+command.
+.PP
+\fBgrilo-test-ui\fP is a graphical interface for Grilo that allows the
+user to perform queries and see their results.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Show summary of grilo-test-ui options.
+.TP
+.B \-\-help\-grl
+Show summary of Grilo options.
+.TP
+.B \-\-help\-all
+Show summary of all options.
+.SH AUTHOR
+This manual page was written by Alberto Garcia <berto@igalia.com>.
diff --git a/doc/man/grl-inspect-0.3.1 b/doc/man/grl-inspect-0.3.1
new file mode 100644
index 0000000..f7b8f91
--- /dev/null
+++ b/doc/man/grl-inspect-0.3.1
@@ -0,0 +1,58 @@
+.\"                                      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 Grilo sources and keys
+.SH SYNOPSIS
+.B grl-inspect
+.RI [ options ]
+.RI [ source | key ]
+.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 and metadata keys. 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.
+.PP
+Alternatively, using \fB-k\fP prints out information about the available
+metadata keys.
+.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
+.B \-k
+Show information about metadata keys
+.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).
+If not specified, by default it waits 1 second.
+.TP
+.BI \-c,\ \-\-config " config-file"
+Configuration file to use with the plugins.
+.SH AUTHOR
+This manual page was written by Alberto Garcia <berto@igalia.com>.
diff --git a/doc/man/grl-launch-0.3.1 b/doc/man/grl-launch-0.3.1
new file mode 100644
index 0000000..7057160
--- /dev/null
+++ b/doc/man/grl-launch-0.3.1
@@ -0,0 +1,117 @@
+.\"                                      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-launch 1 "August 25, 2014"
+.\" 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-launch \- run Grilo operations from the command line
+.SH SYNOPSIS
+.B grl-launch
+.RI [ OPTIONS ]
+.RI OPERATION
+.RI PARAMETERS
+.SH DESCRIPTION
+This manual page documents briefly the
+.B grl-launch
+command.
+.PP
+\fBgrl-launch\fP is a tool that allows the user to run Grilo
+operations from the command line.
+.SH OPERATIONS
+.TP
+.BI browse "\| <source>|<media box>\^"
+.TP
+.BI may_resolve "\| <key> <source>|<media box> [<source>]\^"
+.TP
+.BI query "\| <expression> <source>\^"
+.TP
+.BI resolve "\| <source>|<media> [<source>]\^"
+.TP
+.BI search "\| <term> <source>\^"
+.TP
+.BI monitor "\| <source>\^"
+.TP
+.BI test_media_from_uri "\| <uri> [<source>]\^"
+.TP
+.BI media_from_uri "\| <uri> <source>\^"
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Show summary of grl-launch options.
+.TP
+.B \-\-help\-grl
+Show summary of Grilo options.
+.TP
+.B \-\-help\-all
+Show summary of all options.
+.TP
+.B \-C, --config
+Configuration file to send to sources
+.TP
+.B \-c, --count
+Number of elements to return
+.TP
+.B \-d, --delay
+Wait some seconds before performing the operation (default 1 second)
+.TP
+.B \-f, --flags=full|fast_only|idle_relay
+List of comma-separated flags to use
+.TP
+.B \-F, --full
+Full serialize
+.TP
+.B \-k, --keys
+List of comma-separated keys to retrieve
+.TP
+.B \-S, --serialize
+Serialize
+.TP
+.B \-s, --skip
+Number of elements to skip
+.TP
+.B \-T, --titles
+Print column titles (useful for CSV spreadsheets)
+.TP
+.B \-V, --version
+Print version
+.SH EXAMPLES
+Print the ID for all the items searched in the Tracker source:
+.PP
+.nf
+.RS
+grl-launch-0.3 search "" -S grl-tracker-source
+.RE
+.fi
+.PP
+.TP
+Print the ID and title for the items in the Apple Trailers source:
+.PP
+.nf
+.RS
+grl-launch-0.3 -k id,title browse grl-appletrailers-lua
+.RE
+.fi
+.PP
+.TP
+Print the title for the videos indexed by Tracker:
+.PP
+.nf
+.RS
+grl-launch-0.3 -S browse -k title grlcontainer://grl-tracker-source/videos
+.RE
+.fi
+.PP
+.SH AUTHOR
+This manual page was written by Alberto Garcia <berto@igalia.com>.