paraslash 0.2.11
[paraslash.git] / FEATURES
index 3dde8e97e13803c8d19fcd7c380e1193f74a93b9..3551ee74dfd3e4cb08f8d470716969b787aeb7a5 100644 (file)
--- a/FEATURES
+++ b/FEATURES
@@ -1,8 +1,8 @@
 Features
 ========
 
-configurable audio streaming software
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+configurable audio streaming software:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        para_server streams binary audio data (mp3/ogg files) over
        local or remote networks. It contains two built-in streamers:
        the http streamer and the ortp streamer.
@@ -21,20 +21,33 @@ configurable audio streaming software
        converts the stream according to the given --filter command
        line options and writes the transformed stream to stdout.
 
-mysql-based audio file selector:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-       the (optional) mysql database tool manages some statistics on
-       your audio files. It contacts the mysql server to decide which
-       song to play next by sending a user-defined sql-query. This
-       allows rather sophisticated configurations and is explained
-       in detail in README.mysql.
+configurable audio file selectors:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+       There are three audio file selectors available:
+
+               - random
+               - playlist
+               - mysql
+
+       The first two of these are rather simple, and they are always
+       supported. They allow streaming of randomly selected files
+       or files given by a playlist respectively.
+
+       The (optional) mysql selector is more involved. It manages
+       statistics on your audio files and audio file selection is
+       done by sending a user-defined sql-query 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.
 
 small memory footprint:
 ~~~~~~~~~~~~~~~~~~~~~~~
        paraslash is lightweight. The stripped binary of para_server
-       with all its features compiled in (mysql/dopey dbtool,
-       mp3/ogg support, http/ortp support) is about 100K on i386
-       under Linux. para_audiod is even smaller.
+       with all its features compiled in (mysql/random/playlist
+       selector, mp3/ogg support, http/ortp support) is about 110K
+       on i386 under Linux. para_audiod is even smaller.
 
 command line interface, including shell:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -53,7 +66,7 @@ authentication/encryption via openssl:
 various user interfaces and utilities:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        o para_gui. Curses based interface, displays information in a
-        curses window and can be used to easily control para_server
+       curses window and can be used to easily control para_server
        and para_audiod.
 
        o para_sdl_gui. Shows pictures (on a per song basis) and