From 4308491c94ea7cf7ec0c8fa2714626e8c6702b4a Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Wed, 8 Oct 2014 02:05:56 +0200 Subject: add manpage for sydra-launch --- doc/sydra-launch.8.txt | 128 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 doc/sydra-launch.8.txt (limited to 'doc/sydra-launch.8.txt') 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 ] + [ -g|--groupname ] + [ -C|--chroot ] + [ -P|--write-pid ] + [ -L|--log :[,[,[..]]] ] + [ -U|--debug ] + [ -n|--appname ] + [ -p|--pipeline ] +.... + + +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 *:: + 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 *:: + run as this group. If no username is specified (*-u*) this gets ignored. + The default is to not drop privileges. + +*-C, --chroot *:: + Instruct *sydra-launch* to run in a chroot jail. The default is + to not run in chroot. + +*-P, --write-pid *:: + Instruct *sydra-launch* to write it's pid to this file. The default is + to not create a pid file. + +*-L, --log :[,[,[..]]]*:: + 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 [,[,]] + *file*;; log to file, parameters [,] + *stdout*;; log to standard output, parameters + *stderr*;; log to standard error, parameters + +*-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 *:: + This set the application name using 'g_set_prgname()'. It will be used for example + by xvimagesink for window title. + +*-p, --pipeline *:: + 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 + + +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. -- cgit v1.2.3