summaryrefslogtreecommitdiff
path: root/doc/sydra.8.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sydra.8.txt')
-rw-r--r--doc/sydra.8.txt14
1 files changed, 13 insertions, 1 deletions
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
-------