ges: add a basic unix man page for ges-launch-1.0

Do not list all the possible options in the man page but only the help
options.

This is in order to avoid duplication and prevent the man page from
becoming obsolete in case the options change in the code but do not get
updated in the man page.

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

diff --git a/tools/Makefile.am b/tools/Makefile.am
index d534a2a..88bbed3 100644 (file)
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -6,3 +6,7 @@ LDADD = $(top_builddir)/ges/libges-@GST_API_VERSION@.la $(GST_PBUTILS_LIBS) $(GS
 noinst_HEADERS = ges-validate.h ges-launcher.h utils.h
 
 ges_launch_@GST_API_VERSION@_SOURCES = ges-validate.c ges-launch.c ges-launcher.c utils.c
+
+man_MANS = ges-launch-1.0.1
+
+EXTRA_DIST = ges-launch-1.0.1

diff --git a/tools/ges-launch-1.0.1 b/tools/ges-launch-1.0.1
new file mode 100644 (file)
index 0000000..238db50
--- /dev/null
+++ b/tools/ges-launch-1.0.1
@@ -0,0 +1,48 @@
+.TH GES\-LAUNCH\-1.0 "1" "December 2016" "GStreamer Editing Services API version 1.0" "User Commands"
+.SH NAME
+ges\-launch\-1.0 \- create and render multimedia timelines
+.SH "SYNOPSIS"
+\fBges\-launch\-1.0\fR \fI[OPTION...]\fR
+.SH DESCRIPTION
+ges\-launch\-1.0 creates a multimedia timeline and plays it back,
+or renders it to the specified format.
+.PP
+It can load a timeline from an existing project, or create one
+from the specified commands.
+.PP
+You can learn more about individual ges\-launch\-1.0 commands with
+"ges\-launch\-1.0 help command".
+.PP
+By default, ges\-launch\-1.0 is in "playback\-mode".
+.SH "OPTIONS"
+For the full list of \fIges\-launch\-1.0\fP options see the command line help:
+.TP 8
+\fB\-h\fR, \fB\-\-help\fR
+Show help options
+.TP 8
+\fB\-\-help\-all\fR
+Show all help options
+.TP 8
+\fB\-\-help\-gst\fR
+Show GStreamer Options
+.TP 8
+\fB\-\-help\-GES\fR
+Show GES Options
+.TP 8
+\fB\-\-help\-project\fR
+Show project\-related options
+.TP 8
+\fB\-\-help\-rendering\fR
+Show rendering options
+.TP 8
+\fB\-\-help\-playback\fR
+Show playback options
+.TP 8
+\fB\-\-help\-informative\fR
+Show informative options
+.SH "SEE ALSO"
+For more detailed info and some examples of use, also check out the on-line documentation:
+.br
+https://gstreamer.freedesktop.org/documentation/tools/ges-launch.html
+.SH "AUTHOR"
+Antonio Ospite https://ao2.it

diff --git a/tools/meson.build b/tools/meson.build
index e90d70d..6595d30 100644 (file)
--- a/tools/meson.build
+++ b/tools/meson.build
@@ -11,3 +11,5 @@ executable('ges-launch-@0@'.format(apiversion),
     c_args : [ges_tool_args],
     dependencies : deps
 )
+
+install_man('ges-launch-1.0.1')