Add para_fsck.
[paraslash.git] / README
diff --git a/README b/README
index 54fb951..b311307 100644 (file)
--- a/README
+++ b/README
@@ -12,25 +12,21 @@ It contains the following programs:
 para_server (obligatory)
 -----------------------
 
-para_server streams binary audio data (mp3/ogg/m4a files) over local
-and/or remote networks. It listens on a tcp port and accepts commands
-such as play, stop, pause, next from authenticated clients. However,
-there are many more commands.
+para_server streams binary audio data (mp3/oggvorbis/m4a files)
+over local and/or remote networks. It listens on a tcp port and
+accepts commands such as play, stop, pause, next from authenticated
+clients. However, there are many more commands.
 
-It supports three builtin streaming methods (senders): http, dccp,
+It supports three builtin network streaming methods (senders): http, dccp,
 or rtp.
 
-The audio stream may be sent over the network by three different
-senders:
-
        * The http sender is recommended for public streams that can be played
          by any player like mpg123, xmms, itunes, 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 multicast LAN streaming
 
 It is possible to activate more than one sender simultaneously.
 
@@ -47,7 +43,7 @@ built in:
          to a mysql server which holds information on your audio files
          and maintains statistics on the available audio files. Audio
          file selection works by sending a user-defined sql-query
-         to the mysql server.  This allows rather sophisticated
+         to the mysql server. This allows rather sophisticated
          configurations and is explained in detail in README.mysql.
 
 It is possible to switch between all supported selectors at any time.
@@ -60,7 +56,7 @@ is even smaller.
 
 ------------------------
 para_client (obligatory)
------------------------
+------------------------
 
 The client program to connect to para_server.  paraslash commands
 are sent to para_server and the response is dumped to stdout. This
@@ -72,16 +68,16 @@ default.  For each user of paraslash you must create a public/secret
 key pair for authentication. The (authenticated) connection is crypted
 with a symmetric rc4 session key.
 
--------------------
+--------------------
 para_recv (optional)
--------------------
+--------------------
 
 A command line http/dccp/rtp stream grabber. The http mode of this tool
 can be used to receive date from any http streaming source.
 
----------------------
+----------------------
 para_filter (optional)
----------------------
+----------------------
 
 A filter program that converts from stdin and writes to stdout. It
 is completely independent from the rest of paraslash, so it might be
@@ -93,9 +89,9 @@ design. If more than one filter is specified, the given filters
 are 'piped' together in-memory, i.e. without calling any of the
 read(2)/write(2)/select(2) etc. functions.
 
-----------------------
+-----------------------
 para_write (obligatory)
-----------------------
+-----------------------
 
 A modular audio stream writer. It supports a simple file writer
 output plugin and optional wav/raw players for alsa (linux-only,
@@ -108,12 +104,11 @@ para_audiod (optional, but recommended)
 
 The local daemon that collects information from para_server.
 
-It runs on the client side and connects to para_server. The audio
-stream is read from the network and sent through any of paraslash's
-filters (decoder, volume normalizer,...). The resulting stream is
-written to an output plugin (writer), e.g. the alsa writer on linux
-systems. It is possible to capture the stream at any position in the
-filter chain.
+It runs on the client side and connects to para_server. The audio stream is
+read from the network and sent through any of paraslash's filters (decoder,
+volume normalizer). The resulting stream is written to an output plugin
+(writer), e.g. the alsa writer on linux systems. It is possible to capture the
+stream at any position in the filter chain.
 
 para_audiod starts an appropriate receiver, filter and player as soon as
 para_server announces the availability (and the type) of an audio stream.