summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2014-10-02 05:05:41 +0200
committerChristian Pointner <equinox@spreadspace.org>2014-10-02 05:05:41 +0200
commita733c63095faeccbe5bbe11406e6e3e64cd7bfd2 (patch)
treef1020ab6441dd94ee9384ac17b17741400b438ee /doc
parentadded alle options to the manpage (diff)
improved explanation of sydra
Diffstat (limited to 'doc')
-rw-r--r--doc/sydra.82
-rw-r--r--doc/sydra.8.txt14
2 files changed, 14 insertions, 2 deletions
diff --git a/doc/sydra.8 b/doc/sydra.8
index 6e875d4..31d22c0 100644
--- a/doc/sydra.8
+++ b/doc/sydra.8
@@ -70,7 +70,7 @@ 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\&. \fBSydra\fR is based on GStreamer and is written in C\&.
+\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)\&.
.SH "OPTIONS"
.sp
The following options can be passed to the \fBsydra\fR daemon:
diff --git a/doc/sydra.8.txt b/doc/sydra.8.txt
index 532f6de..3dc037c 100644
--- a/doc/sydra.8.txt
+++ b/doc/sydra.8.txt
@@ -57,7 +57,19 @@ 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.
+This manpage describes *sydra* 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
+RTP-based Audio/Video streams. For a bidirectional connection 2 instances
+of *sydra* are required on both sides of the communication. *sydra* 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
+'connections'. 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).
OPTIONS
-------