]> git.tuebingen.mpg.de Git - paraslash.git/commitdiff
update README
authorAndre <maan@p133.(none)>
Tue, 14 Mar 2006 16:44:22 +0000 (17:44 +0100)
committerAndre <maan@p133.(none)>
Tue, 14 Mar 2006 16:44:22 +0000 (17:44 +0100)
Mention the new dccp sender/receiver.

README

diff --git a/README b/README
index 872a0fa0b5461bad3f45c19915005c39758cb050..f0b77799449975703db4c8ec8633ff0d89349464 100644 (file)
--- a/README
+++ b/README
@@ -9,14 +9,17 @@ It contains the following programs:
 - para_server (obligatory):
 
        This server listens on a tcp port and accepts commands such as
 - para_server (obligatory):
 
        This server listens on a tcp port and accepts commands such as
-       play, stop, pause, next. However, there are many more commands.
+       play, stop, pause, next from authenticated clients.
 
 
-       For audio streaming, at least one sender must be activated.
-       At the moment, paraslash contains two internal senders:
+       For audio streaming, at least one of the three supported senders
+       of para_server  must be activated:
 
        The http sender is recommended for public streams that can
        be played by any player like mpg123, xmms, winamp...
 
 
        The http sender is recommended for public streams that can
        be played by any player like mpg123, xmms, winamp...
 
+       The dccp sender is experimental and requires kernel support
+       for the rather new datagram congestion control protocol.
+
        The ortp sender is recommended for LAN streaming and for
        private streams that require authentication.
 
        The ortp sender is recommended for LAN streaming and for
        private streams that require authentication.
 
@@ -40,11 +43,11 @@ It contains the following programs:
 
 - para_recv (optional)
 
 
 - para_recv (optional)
 
-       A command line http/ortp stream grabber.
+       A command line http/dccp/rtp stream grabber.
 
 - para_filter (optional)
 
 
 - para_filter (optional)
 
-       An filter program that converts from stdin and writes to
+       A filter program that converts from stdin and writes to
        stdout. This one is independent from the rest of paraslash,
        so it might be useful also for different purposes.
 
        stdout. This one is independent from the rest of paraslash,
        so it might be useful also for different purposes.
 
@@ -61,24 +64,23 @@ It contains the following programs:
 
 - para_audiod (optional, but recommended):
 
 
 - para_audiod (optional, but recommended):
 
-       The local daemon that starts playback and collects information
-       from para_server to be forwarded to local clients.
-
-       para_audiod reads the audio stream from the network if
-       para_server indicates that there is a stream available. It may
-       be sent through any of the supported filters (see para_filter
-       above) before the result is fed to the output software
-       (default: para_play) which must be capable of reading from
-       stdin, but is not restricted otherwise.
+       The local daemon that collects information from para_server. It
+       starts an appropriate receiver, filter and player as soon
+       as para_server announces the availability (and the type) of
+       an audio stream. para_audiod listens on a local socket and
+       sends status information about para_server and para_audiod
+       to local clients on request.
 
 - para_audioc (optional, but recommended)
 
 
 - para_audioc (optional, but recommended)
 
-       A small client that can talk to para_audiod. Used to control
-       para_audiod and to receive status info. It can also be used to
-       grab the stream at any point in the filter chain. para_audioc
-       is needed by para_gui, para_sdl_gui and para_krell, see below.
+       The client program which talks with para_audiod. Used to
+       control para_audiod, to receive status info, or to grab the
+       stream at any point in the filter chain.
+
+       para_audioc (hence para_audiod) is needed by para_gui,
+       para_sdl_gui and para_krell, see below.
 
 
-- para_gui (optional, but recommended):
+- para_gui (optional):
 
        Themable ncurses-based gui. It calls para_audioc and presents
        the obtained information in an ncurses window. para_gui
 
        Themable ncurses-based gui. It calls para_audioc and presents
        the obtained information in an ncurses window. para_gui