add manpage for sydra-launch

3 files changed, 291 insertions, 1 deletions

diff --git a/doc/Makefile b/doc/Makefile
index 185a01b..9d3d722 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -45,10 +45,19 @@ sydra-rtp.8: sydra-rtp.8.txt
 	@ sed -i -e 's/^sydra-rtp$$/\\fBsydra-rtp\\fR/' $@
 	@ sed -i -e 's/^  \[ \([^ ]*\)/  [ \\fB\1\\fR/' $@
 
-manpage: sydra-rtp.8
+sydra-launch.8: sydra-launch.8.txt
+	a2x -f manpage $<
+	@ sed -i -e 's/\[FIXME: source\]/sydra-launch ${VERSION}/' $@
+	@ sed -i -e 's/\[FIXME: manual\]/sydra-launch user manual/' $@
+	@ sed -i -e 's/^sydra-launch$$/\\fBsydra-launch\\fR/' $@
+	@ sed -i -e 's/^  \[ \([^ ]*\)/  [ \\fB\1\\fR/' $@
+
+manpage: sydra-rtp.8 sydra-launch.8
 
 clean:
 	rm -f sydra-rtp.8.xml
+	rm -f sydra-launch.8.xml
 
 realclean: clean
 	rm -f sydra-rtp.8
+	rm -f sydra-launch.8
diff --git a/doc/sydra-launch.8 b/doc/sydra-launch.8
new file mode 100644
index 0000000..d8f3135
--- /dev/null
+++ b/doc/sydra-launch.8
@@ -0,0 +1,153 @@
+'\" t
+.\"     Title: sydra-launch
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\"      Date: 10/08/2014
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "SYDRA\-LAUNCH" "8" "10/08/2014" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+sydra-launch \- tool to start gst\-launch style pipelines
+.SH "SYNOPSIS"
+.sp
+.nf
+sydra\-launch
+  [ \fB\-h|\-\-help\fR ]
+  [ \fB\-D|\-\-nodaemonize\fR ]
+  [ \fB\-u|\-\-username\fR <username> ]
+  [ \fB\-g|\-\-groupname\fR <groupname> ]
+  [ \fB\-C|\-\-chroot\fR <path> ]
+  [ \fB\-P|\-\-write\-pid\fR <filename> ]
+  [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
+  [ \fB\-U|\-\-debug\fR ]
+  [ \fB\-n|\-\-appname\fR <name> ]
+  [ \fB\-p|\-\-pipeline\fR <pipeline description> ]
+.fi
+.SH "DESCRIPTION"
+.sp
+\fBsydra\fR is a toolbox which allows you to set up multiple bidirectional Video/Audio streams from external locations\&. \fBsydra\fR has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival\&.
+.sp
+This manpage describes \fBsydra\-launch\fR which is basically a gst\-launch equivalent\&. The utility creates and runs a gstreamer pipeline which is configured through command line arguments\&. The syntax for the pipeline description is the same as for gst\-launch\&. The sole purpose of this program is that it allows to set the app\-name which will get used for example by xvimagesink to set the window title\&. This is needed for sydra to tell a tiling window manager where a window should be shown\&.
+.SH "OPTIONS"
+.sp
+The following options can be passed to the \fBsydra\-launch\fR daemon:
+.sp
+\fBglobal options\fR
+.PP
+\fB\-D, \-\-nodaemonize\fR
+.RS 4
+This option instructs
+\fBsydra\-launch\fR
+to run in foreground instead of becoming a daemon which is the default\&.
+.RE
+.PP
+\fB\-u, \-\-username <username>\fR
+.RS 4
+run as this user\&. If no group is specified (\fB\-g\fR) the default group of the user is used\&. The default is to not drop privileges\&.
+.RE
+.PP
+\fB\-g, \-\-groupname <groupname>\fR
+.RS 4
+run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&.
+.RE
+.PP
+\fB\-C, \-\-chroot <path>\fR
+.RS 4
+Instruct
+\fBsydra\-launch\fR
+to run in a chroot jail\&. The default is to not run in chroot\&.
+.RE
+.PP
+\fB\-P, \-\-write\-pid <filename>\fR
+.RS 4
+Instruct
+\fBsydra\-launch\fR
+to write it\(cqs pid to this file\&. The default is to not create a pid file\&.
+.RE
+.PP
+\fB\-L, \-\-log <target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR
+.RS 4
+add log target to logging system\&. This can be invoked several times in order to log to different targets at the same time\&. Every target has its own log level which is a number between 0 and 5\&. Where 0 means disabling log and 5 means debug messages are enabled\&.
+
+The file target can be used more than once with different levels\&. If no target is provided at the command line a single target with the config
+\fBsyslog:3,sydra\-launch,daemon\fR
+is added\&.
+
+The following targets are supported:
+.PP
+\fBsyslog\fR
+.RS 4
+log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
+.RE
+.PP
+\fBfile\fR
+.RS 4
+log to file, parameters <level>[,<path>]
+.RE
+.PP
+\fBstdout\fR
+.RS 4
+log to standard output, parameters <level>
+.RE
+.PP
+\fBstderr\fR
+.RS 4
+log to standard error, parameters <level>
+.RE
+.RE
+.PP
+\fB\-U, \-\-debug\fR
+.RS 4
+This option instructs
+\fBsydra\-launch\fR
+to run in debug mode\&. It implicits
+\fB\-D\fR
+(don\(cqt daemonize) and adds a log target with the configuration
+\fBstdout:5\fR
+(logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
+.RE
+.PP
+\fB\-n, \-\-appname <name>\fR
+.RS 4
+This set the application name using
+\fIg_set_prgname()\fR\&. It will be used for example by xvimagesink for window title\&.
+.RE
+.PP
+\fB\-p, \-\-pipeline <pipeline description>\fR
+.RS 4
+A gst\-launch\-style description for the pipeline to get started\&. This uses the same syntax as gst\-launch\&. Example:
+\fIvideotestsrc ! video/x\-raw,format=I420,width=864,height=480 ! xvimagesink\fR
+.RE
+.SH "BUGS"
+.sp
+Most likely there are some bugs in \fBsydra\-launch\fR\&. If you find a bug, please let the developers know at equinox@spreadspace\&.org\&. Of course, patches are preferred\&.
+.SH "SEE ALSO"
+.sp
+\fBgst\-launch\fR(1)
+.SH "AUTHORS"
+.sp
+Christian Pointner <equinox@spreadspace\&.org>
+.SH "COPYING"
+.sp
+Copyright (C) 2014 Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&.
diff --git a/doc/sydra-launch.8.txt b/doc/sydra-launch.8.txt
new file mode 100644
index 0000000..181de78
--- /dev/null
+++ b/doc/sydra-launch.8.txt
@@ -0,0 +1,128 @@
+sydra-launch(8)
+===============
+
+NAME
+----
+
+sydra-launch - tool to start gst-launch style pipelines
+
+
+SYNOPSIS
+--------
+
+....
+sydra-launch
+  [ -h|--help ]
+  [ -D|--nodaemonize ]
+  [ -u|--username <username> ]
+  [ -g|--groupname <groupname> ]
+  [ -C|--chroot <path> ]
+  [ -P|--write-pid <filename> ]
+  [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
+  [ -U|--debug ]
+  [ -n|--appname <name> ]
+  [ -p|--pipeline <pipeline description> ]
+....
+
+
+DESCRIPTION
+-----------
+
+*sydra* is a toolbox which allows you to set up multiple bidirectional
+Video/Audio streams from external locations.
+*sydra* has been written to be used for the Elevate Festival in Graz
+Austria in order to involve external locations to present themselves
+at the festival.
+
+This manpage describes *sydra-launch* which is basically a gst-launch equivalent.
+The utility creates and runs a gstreamer pipeline which is configured through
+command line arguments. The syntax for the pipeline description is the same as for
+gst-launch. The sole purpose of this program is that it allows to set the app-name
+which will get used for example by xvimagesink to set the window title. This is needed
+for sydra to tell a tiling window manager where a window should be shown.
+
+OPTIONS
+-------
+
+The following options can be passed to the *sydra-launch* daemon:
+
+*global options*
+
+*-D, --nodaemonize*::
+   This option instructs *sydra-launch* to run in foreground
+   instead of becoming a daemon which is the default.
+
+*-u, --username <username>*::
+   run as this user. If no group is specified (*-g*) the default group of
+   the user is used. The default is to not drop privileges.
+
+*-g, --groupname <groupname>*::
+   run as this group. If no username is specified (*-u*) this gets ignored.
+   The default is to not drop privileges.
+
+*-C, --chroot <path>*::
+   Instruct *sydra-launch* to run in a chroot jail. The default is
+   to not run in chroot.
+
+*-P, --write-pid <filename>*::
+   Instruct *sydra-launch* to write it's pid to this file. The default is
+   to not create a pid file.
+
+*-L, --log <target>:<level>[,<param1>[,<param2>[..]]]*::
+   add log target to logging system. This can be invoked several times
+   in order to log to different targets at the same time. Every target
+   has its own log level which is a number between 0 and 5. Where 0 means
+   disabling log and 5 means debug messages are enabled. +
+   The file target can be used more than once with different levels.
+   If no target is provided at the command line a single target with the
+   config *syslog:3,sydra-launch,daemon* is added. +
+   The following targets are supported:
+
+   *syslog*;; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
+   *file*;; log to file, parameters <level>[,<path>]
+   *stdout*;; log to standard output, parameters <level>
+   *stderr*;; log to standard error, parameters <level>
+
+*-U, --debug*::
+   This option instructs *sydra-launch* to run in debug mode. It implicits *-D*
+   (don't daemonize) and adds a log target with the configuration
+   *stdout:5* (logging with maximum level). In future releases there might
+   be additional output when this option is supplied.
+
+*-n, --appname <name>*::
+   This set the application name using 'g_set_prgname()'. It will be used for example
+   by xvimagesink for window title.
+
+*-p, --pipeline <pipeline description>*::
+   A gst-launch-style description for the pipeline to get started. This uses the same
+   syntax as gst-launch.
+   Example:
+     'videotestsrc ! video/x-raw,format=I420,width=864,height=480 ! xvimagesink'
+
+
+
+
+BUGS
+----
+Most likely there are some bugs in *sydra-launch*. If you find a bug, please let
+the developers know at equinox@spreadspace.org. Of course, patches are preferred.
+
+
+SEE ALSO
+--------
+
+*gst-launch*(1)
+
+AUTHORS
+-------
+
+Christian Pointner <equinox@spreadspace.org>
+
+
+COPYING
+-------
+
+Copyright \(C) 2014 Christian Pointner. This  program is  free
+software: you can redistribute it and/or modify it under the terms
+of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or any later version.