new codename, reset version to git

[paraslash.git] / README

diff --git a/README b/README
index 70c91445fe5254f98d647051194996106a011e66..5073ca55e4b9542db34787910277401db7d0048a 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.
 


@@ -24,10 +27,10 @@ It contains the following programs:
        All senders have the same set of commands that allow to
        control the access permissions of the stream.
 
        All senders have the same set of commands that allow to
        control the access permissions of the stream.
 

-       para_server needs an  "audio file selector" to work, mainly
+       para_server needs an "audio file selector" to work, mainly

        to determine which song to stream next. There are three
        selectors available: random, playlist and mysql. The former
        to determine which song to stream next. There are three
        selectors available: random, playlist and mysql. The former

-       chooses audio files randomly and  playlist  can handle, well,
+       chooses audio files randomly and  playlist can handle, well,

        playlists. Both are always supported.
 
        The optional mysql selector connects to a mysql server which
        playlists. Both are always supported.
 
        The optional mysql selector connects to a mysql server which


@@ -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.
 


@@ -54,44 +57,45 @@ It contains the following programs:
        the given filters are 'piped' together in-memory, i.e. without
        calling any of the read(2)/write(2)/select(2) etc. functions.
 
        the given filters are 'piped' together in-memory, i.e. without
        calling any of the read(2)/write(2)/select(2) etc. functions.
 

-- para_play (optional)
+- para_write (obligatory)

 
 

-       A small wav/raw player for alsa.
+       A modular audio stream writer. It supports a simple file
+       writer output plugin and an optional wav/raw player for alsa.

        Debian package: libasound2-dev
 
 - para_audiod (optional, but recommended):
 
        Debian package: libasound2-dev
 
 - 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_gui (optional, but recommended):
+       para_audioc (hence para_audiod) is needed by para_gui,
+       para_sdl_gui and para_krell, see below.

 
 

-        Themable ncurses-based gui. It calls para_audioc and presents
-        the obtained information in an ncurses window. para_gui
-        provides key-bindings for the most common commands and new
-        key-bindings can be added easily.
+- para_gui (optional):
+
+       Themable ncurses-based gui. It calls para_audioc and presents
+       the obtained information in an ncurses window. para_gui
+       provides key-bindings for the most common commands and new
+       key-bindings can be added easily.

 
 - para_sdl_gui (optional):
 
 
 - para_sdl_gui (optional):
 

-        SDL-based gui. Similar to para_gui but presents its output in
-        an X window (fullscreen mode is also available) and can display
-        jpg images on a per song basis. para_sdl_gui provides an input
-        prompt to enter arbitrary commands. However, it can also be used
-        non-interactively (e.g. as a screen saver) via the -i switch.
+       SDL-based gui. Similar to para_gui but presents its output
+       in an X window (fullscreen mode is also available) and can
+       display jpg images on a per song basis. para_sdl_gui provides
+       an input prompt to enter arbitrary commands. However, it
+       can also be used non-interactively (e.g. as a screen saver)
+       via the -i switch.

 
 - para_krell (optional, only useful in conjunction with the mysql selector):
 
 
 - para_krell (optional, only useful in conjunction with the mysql selector):
 


@@ -127,11 +131,8 @@ REQUIREMENTS:
 ~~~~~~~~~~~~~
 In any case you need
 
 ~~~~~~~~~~~~~
 In any case you need
 

-       - gcc, the gnu compiler collection (shipped with distro): gcc-3
-       or newer is prefered, but gcc-2.95 is still supported. Note
-       that gcc-2.95 may spit out many warnings like unused function
-       parameters and missing initializers. These are all harmless
-       and may be ignored.
+       - gcc, the gnu compiler collection (shipped with distro): gcc-3.3
+       or newer is required.

 
        - openssl (needed by server, client): usually shipped with
        distro, but you might have to install the "development"
 
        - openssl (needed by server, client): usually shipped with
        distro, but you might have to install the "development"


@@ -160,7 +161,7 @@ make sure to install the corresponding development package as well.
 If you want to stream ogg vorbis files you'll need:
 
        - libogg, libvorbis, libvorbisfile, and a command line ogg vorbis
 If you want to stream ogg vorbis files you'll need:
 
        - libogg, libvorbis, libvorbisfile, and a command line ogg vorbis

-               player, e.g. para_filter or ogg123.
+               decoder, e.g. para_filter or ogg123.

 
                http://www.xiph.org/downloads/
 
 
                http://www.xiph.org/downloads/
 


@@ -209,12 +210,6 @@ LICENSE:
 ~~~~~~~~
 Distribution of paraslash is covered by the GNU GPL. See file COPYING.
 
 ~~~~~~~~
 Distribution of paraslash is covered by the GNU GPL. See file COPYING.
 

-LIMITATIONS:
-~~~~~~~~~~~~
-The mysql selector assumes that the basenames of your audio files are
-unique. If this is not the case, don't use this selector, rename your
-files, or create your own one.
-

 THE AUTHOR:
 ~~~~~~~~~~~
 Author: Andre Noll <maan@systemlinux.org>
 THE AUTHOR:
 ~~~~~~~~~~~
 Author: Andre Noll <maan@systemlinux.org>