diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 14 | ||||
| -rw-r--r-- | doc/sydra-rtp.8 (renamed from doc/sydra.8) | 30 | ||||
| -rw-r--r-- | doc/sydra-rtp.8.txt (renamed from doc/sydra.8.txt) | 34 |
3 files changed, 39 insertions, 39 deletions
diff --git a/doc/Makefile b/doc/Makefile index 8f609a7..09e6b49 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -39,17 +39,17 @@ VERSION=$(shell cat ../version) all: manpage -sydra.8: sydra.8.txt +sydra-rtp.8: sydra-rtp.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/\[FIXME: source\]/sydra-rtp ${VERSION}/' $@ + @ sed -i -e 's/\[FIXME: manual\]/sydra-rtp user manual/' $@ + @ sed -i -e 's/^sydra-rtp$$/\\fBsydra-rtp\\fR/' $@ @ sed -i -e 's/^ \[ \([^ ]*\)/ [ \\fB\1\\fR/' $@ -manpage: sydra.8 +manpage: sydra-rtp.8 clean: - rm -f sydra.8.xml + rm -f sydra-rtp.8.xml realclean: clean - rm -f sydra.8 + rm -f sydra-rtp.8 diff --git a/doc/sydra.8 b/doc/sydra-rtp.8 index 31d22c0..48a739f 100644 --- a/doc/sydra.8 +++ b/doc/sydra-rtp.8 @@ -1,5 +1,5 @@ '\" t -.\" Title: sydra +.\" Title: sydra-rtp .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> .\" Date: 10/02/2014 @@ -7,7 +7,7 @@ .\" Source: \ \& .\" Language: English .\" -.TH "SYDRA" "8" "10/02/2014" "\ \&" "\ \&" +.TH "SYDRA\-RTP" "8" "10/02/2014" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,11 +28,11 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -sydra \- toolbox for RTP based streams +sydra-rtp \- tool for RTP based streams .SH "SYNOPSIS" .sp .nf -\fBsydra\fR +sydra\-rtp [ \fB\-h|\-\-help\fR ] [ \fB\-D|\-\-nodaemonize\fR ] [ \fB\-u|\-\-username\fR <username> ] @@ -70,17 +70,17 @@ sydra \- toolbox for RTP based streams .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\&. This manpage describes \fBsydra\fR the basic utility for the task which is based on GStreamer and is written in C\&. The \fBsydra\fR utility creates a gstreamer pipeline to send or receive RTP\-based Audio/Video streams\&. For a bidirectional connection 2 instances of \fBsydra\fR are required on both sides of the communication\&. \fBsydra\fR has automatic client detection capabilities in the form of keep alive messages\&. These message are sent out by receivers to request RTP packets from a sender\&. The sender will send RTP packets to one or more receivers which request the stream\&. It also uses the keep alive messages to remove stale client \fIconnections\fR\&. A receiver can also request to be removed from the list of receivers\&. This ensures a fast and clean shutdown\&. The keepalive messages are also a simple way to work around NAT and firewalls (UDP hole punching)\&. +\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\&. This manpage describes \fBsydra\-rtp\fR the basic utility for the task which is based on GStreamer and is written in C\&. The \fBsydra\-rtp\fR utility creates a gstreamer pipeline to send or receive RTP\-based Audio/Video streams\&. For a bidirectional connection 2 instances of \fBsydra\-rtp\fR are required on both sides of the communication\&. \fBsydra\-rtp\fR has automatic client detection capabilities in the form of keep alive messages\&. These message are sent out by receivers to request RTP packets from a sender\&. The sender will send RTP packets to one or more receivers which request the stream\&. It also uses the keep alive messages to remove stale client \fIconnections\fR\&. A receiver can also request to be removed from the list of receivers\&. This ensures a fast and clean shutdown\&. The keepalive messages are also a simple way to work around NAT and firewalls (UDP hole punching)\&. .SH "OPTIONS" .sp -The following options can be passed to the \fBsydra\fR daemon: +The following options can be passed to the \fBsydra\-rtp\fR daemon: .sp \fBglobal options\fR .PP \fB\-D, \-\-nodaemonize\fR .RS 4 This option instructs -\fBsydra\fR +\fBsydra\-rtp\fR to run in foreground instead of becoming a daemon which is the default\&. .RE .PP @@ -97,14 +97,14 @@ run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\& \fB\-C, \-\-chroot <path>\fR .RS 4 Instruct -\fBsydra\fR +\fBsydra\-rtp\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 +\fBsydra\-rtp\fR to write it\(cqs pid to this file\&. The default is to not create a pid file\&. .RE .PP @@ -113,7 +113,7 @@ to write it\(cqs pid to this file\&. The default is to not create a pid file\&. 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 +\fBsyslog:3,sydra\-rtp,daemon\fR is added\&. The following targets are supported: @@ -142,7 +142,7 @@ log to standard error, parameters <level> \fB\-U, \-\-debug\fR .RS 4 This option instructs -\fBsydra\fR +\fBsydra\-rtp\fR to run in debug mode\&. It implicits \fB\-D\fR (don\(cqt daemonize) and adds a log target with the configuration @@ -159,7 +159,7 @@ This set the application name using \fB\-m, \-\-mode (sender|reciever)\fR .RS 4 This sets the main mode of -\fBsydra\fR\&. The sender will read raw video and audio from the source bin and send it via RTP to one or more receivers\&. +\fBsydra\-rtp\fR\&. The sender will read raw video and audio from the source bin and send it via RTP to one or more receivers\&. .RE .sp \fBsender\-mode only options\fR @@ -268,7 +268,7 @@ mode keepalive messages will be sent to this host\&. Leave empty to disable keep \fB\-o, \-\-rtp\-port\-base <port>\fR .RS 4 The base number for remote ports\&. -\fBsydra\fR +\fBsydra\-rtp\fR will send the RTP/RTCP packets using the following mapping: .sp .RS 4 @@ -331,7 +331,7 @@ The base number for local ports to bind to\&. The same mapping as for the remote This disables auto\-detection for clients in \fIsender\fR mode\&. Mind that if you disable the automatic client detection and also omit the rtp\-host option -\fBsydra\fR +\fBsydra\-rtp\fR won\(cqt send any RTP messages\&. If configured recording will work but this is most probably not what you want\&. .RE .PP @@ -377,7 +377,7 @@ based format string which will be used to create the name for the recorded file\ .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\&. +Most likely there are some bugs in \fBsydra\-rtp\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) diff --git a/doc/sydra.8.txt b/doc/sydra-rtp.8.txt index 3dc037c..4fd87b0 100644 --- a/doc/sydra.8.txt +++ b/doc/sydra-rtp.8.txt @@ -1,17 +1,17 @@ -sydra(8) -======== +sydra-rtp(8) +============ NAME ---- -sydra - toolbox for RTP based streams +sydra-rtp - tool for RTP based streams SYNOPSIS -------- .... -sydra +sydra-rtp [ -h|--help ] [ -D|--nodaemonize ] [ -u|--username <username> ] @@ -57,11 +57,11 @@ 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* the basic utility for the task which is +This manpage describes *sydra-rtp* the basic utility for the task which is based on GStreamer and is written in C. -The *sydra* utility creates a gstreamer pipeline to send or receive +The *sydra-rtp* utility creates a gstreamer pipeline to send or receive RTP-based Audio/Video streams. For a bidirectional connection 2 instances -of *sydra* are required on both sides of the communication. *sydra* has +of *sydra-rtp* are required on both sides of the communication. *sydra-rtp* has automatic client detection capabilities in the form of keep alive messages. These message are sent out by receivers to request RTP packets from a sender. The sender will send RTP packets to one or more receivers which request @@ -74,12 +74,12 @@ firewalls (UDP hole punching). OPTIONS ------- -The following options can be passed to the *sydra* daemon: +The following options can be passed to the *sydra-rtp* daemon: *global options* *-D, --nodaemonize*:: - This option instructs *sydra* to run in foreground + This option instructs *sydra-rtp* to run in foreground instead of becoming a daemon which is the default. *-u, --username <username>*:: @@ -91,11 +91,11 @@ The following options can be passed to the *sydra* daemon: The default is to not drop privileges. *-C, --chroot <path>*:: - Instruct *sydra* to run in a chroot jail. The default is + Instruct *sydra-rtp* 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 + Instruct *sydra-rtp* to write it's pid to this file. The default is to not create a pid file. *-L, --log <target>:<level>[,<param1>[,<param2>[..]]]*:: @@ -105,7 +105,7 @@ The following options can be passed to the *sydra* daemon: 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. + + config *syslog:3,sydra-rtp,daemon* is added. + The following targets are supported: *syslog*;; log to syslog daemon, parameters <level>[,<logname>[,<facility>]] @@ -114,7 +114,7 @@ The following options can be passed to the *sydra* daemon: *stderr*;; log to standard error, parameters <level> *-U, --debug*:: - This option instructs *sydra* to run in debug mode. It implicits *-D* + This option instructs *sydra-rtp* 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. @@ -124,7 +124,7 @@ The following options can be passed to the *sydra* daemon: by xvimagesink for window title. *-m, --mode (sender|reciever)*:: - This sets the main mode of *sydra*. The sender will read raw video and audio + This sets the main mode of *sydra-rtp*. The sender will read raw video and audio from the source bin and send it via RTP to one or more receivers. @@ -199,7 +199,7 @@ The following options can be passed to the *sydra* daemon: keepalive messages. *-o, --rtp-port-base <port>*:: - The base number for remote ports. *sydra* will send the RTP/RTCP packets using the following + The base number for remote ports. *sydra-rtp* will send the RTP/RTCP packets using the following mapping: * rtp-port-base + 0: RTP Video * rtp-port-base + 1: RTCP Video @@ -215,7 +215,7 @@ The following options can be passed to the *sydra* daemon: *-c, --no-auto-client*:: This disables auto-detection for clients in 'sender' mode. Mind that if you disable the - automatic client detection and also omit the rtp-host option *sydra* won't send any RTP + automatic client detection and also omit the rtp-host option *sydra-rtp* won't send any RTP messages. If configured recording will work but this is most probably not what you want. *-t, --timeout <timeout>*:: @@ -248,7 +248,7 @@ The following options can be passed to the *sydra* daemon: BUGS ---- -Most likely there are some bugs in *sydra*. If you find a bug, please let +Most likely there are some bugs in *sydra-rtp*. If you find a bug, please let the developers know at equinox@spreadspace.org. Of course, patches are preferred. |