added manpage

3 files changed, 296 insertions, 0 deletions

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..8f609a7
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,55 @@
+##
+##  sydra
+##
+##  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.
+##  Sydra is based on GStreamer and is written in C.
+##
+##
+##  Copyright (C) 2014 Christian Pointner <equinox@spreadspace.org>
+##
+##  This file is part of sydra.
+##
+##  sydra 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.
+##
+##  sydra is distributed in the hope that it will be useful,
+##  but WITHOUT ANY WARRANTY; without even the implied warranty of
+##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+##  GNU General Public License for more details.
+##
+##  You should have received a copy of the GNU General Public License
+##  along with sydra. If not, see <http://www.gnu.org/licenses/>.
+##
+##  In addition, as a special exception, the copyright holders hereby
+##  grant permission for non-GPL-compatible GStreamer plugins to be used
+##  and distributed together with GStreamer and sydra.
+##  This permission goes above and beyond the permissions granted by the
+##  GPL license sydra is covered by.
+##
+
+VERSION=$(shell cat ../version)
+
+.PHONY: clean
+
+all: manpage
+
+sydra.8: sydra.8.txt
+	a2x -f manpage $<
+	@ sed -i -e 's/\[FIXME: source\]/sydra ${VERSION}/' $@
+	@ sed -i -e 's/\[FIXME: manual\]/sydra user manual/' $@
+	@ sed -i -e 's/^sydra$$/\\fBsydra\\fR/' $@
+	@ sed -i -e 's/^  \[ \([^ ]*\)/  [ \\fB\1\\fR/' $@
+
+manpage: sydra.8
+
+clean:
+	rm -f sydra.8.xml
+
+realclean: clean
+	rm -f sydra.8
diff --git a/doc/sydra.8 b/doc/sydra.8
new file mode 100644
index 0000000..d8b3337
--- /dev/null
+++ b/doc/sydra.8
@@ -0,0 +1,135 @@
+'\" t
+.\"     Title: sydra
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\"      Date: 10/02/2014
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "SYDRA" "8" "10/02/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 \- toolbox for RTP based streams
+.SH "SYNOPSIS"
+.sp
+.nf
+\fBsydra\fR
+  [ \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 ]
+.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\&. \fBSydra\fR is based on GStreamer and is written in C\&.
+.SH "OPTIONS"
+.sp
+The following options can be passed to the \fBsydra\fR daemon:
+.PP
+\fB\-D, \-\-nodaemonize\fR
+.RS 4
+This option instructs
+\fBsydra\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\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\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,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\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
+.SH "BUGS"
+.sp
+Most likely there are some bugs in \fBsydra\fR\&. If you find a bug, please let the developers know at equinox@spreadspace\&.org\&. Of course, patches are preferred\&.
+.SH "SEE ALSO"
+.sp
+\fBstrftime\fR(3), \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.8.txt b/doc/sydra.8.txt
new file mode 100644
index 0000000..6330b71
--- /dev/null
+++ b/doc/sydra.8.txt
@@ -0,0 +1,106 @@
+sydra(8)
+========
+
+NAME
+----
+
+sydra - toolbox for RTP based streams
+
+
+SYNOPSIS
+--------
+
+....
+sydra
+  [ -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 ]
+....
+
+
+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.
+*Sydra* is based on GStreamer and is written in C.
+
+OPTIONS
+-------
+
+The following options can be passed to the *sydra* daemon:
+
+*-D, --nodaemonize*::
+   This option instructs *sydra* 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* to run in a chroot jail. The default is
+   to not run in chroot.
+
+*-P, --write-pid <filename>*::
+   Instruct *sydra* 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,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* 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.
+
+
+BUGS
+----
+Most likely there are some bugs in *sydra*. If you find a bug, please let
+the developers know at equinox@spreadspace.org. Of course, patches are preferred.
+
+
+SEE ALSO
+--------
+
+*strftime*(3), *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.