the paraslash-0.2.11 release tarball
[paraslash.git] / README
diff --git a/README b/README
index 2c0dc76..872a0fa 100644 (file)
--- a/README
+++ b/README
@@ -8,9 +8,8 @@ It contains the following programs:
 
 - para_server (obligatory):
 
-        This server listens on a specified tcp port and accepts the
-        usual commands such as play, stop, pause, next. However, there
-        are many more commands.
+       This server listens on a tcp port and accepts commands such as
+       play, stop, pause, next. However, there are many more commands.
 
        For audio streaming, at least one sender must be activated.
        At the moment, paraslash contains two internal senders:
@@ -25,20 +24,19 @@ It contains the following programs:
        All senders have the same set of commands that allow to
        control the access permissions of the stream.
 
-       para_server needs a database tool to work, mainly to determine
-       which song to stream next. There are two database tools
-       available: mysql and random. The former is recommended as
-       the random database tool is only meant as a fallback and
-       as a starting point for people that want to write their own
-       database tool for paraslash.
+       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
+       chooses audio files randomly and  playlist can handle, well,
+       playlists. Both are always supported.
 
-       The mysql database tool connects to a mysql server which
+       The optional mysql selector connects to a mysql server which
        holds information on your audio files. It has several unusual
        features, see README.mysql for details.
 
 - para_client (obligatory):
 
-        The client program to connect to para_server.
+       The client program to connect to para_server.
 
 - para_recv (optional)
 
@@ -59,6 +57,7 @@ It contains the following programs:
 - para_play (optional)
 
        A small wav/raw player for alsa.
+       Debian package: libasound2-dev
 
 - para_audiod (optional, but recommended):
 
@@ -81,20 +80,21 @@ It contains the following programs:
 
 - para_gui (optional, but recommended):
 
-        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.
+       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):
 
-        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 dbtool):
+- para_krell (optional, only useful in conjunction with the mysql selector):
 
        A plugin for gkrellm which shows small pictures of the
        current song. It allows you to launch 27 different commands
@@ -105,13 +105,13 @@ It contains the following programs:
 
        A (Linux-only) alarm clock and volume-fader.
 
-- para_dbadm (optional, only useful in conjunction with the mysql dbtool):
+- para_dbadm (optional, only useful in conjunction with the mysql selector):
 
        Very simple curses-based frontend which uses libmenu. Useful
        for quickly changing the attributes of the current song
        (e.g. from para_gui as an external command).
 
-- para_slider (optional, only useful in conjunction with the mysql dbtool):
+- para_slider (optional, only useful in conjunction with the mysql selector):
 
        A small X application which shows a scrollbar for each
        attribute defined in the mysql database. It creates a stream
@@ -142,7 +142,7 @@ In any case you need
 
        - software mixing, e.g. ALSA and the direct mixing plugin (dmix)
 
-If you want to use the mysql-based dbtool (recommended), you also need
+If you want to use the mysql-based audio file selector, you also need
 
        - mysql-server
        - mysql-client
@@ -165,6 +165,8 @@ If you want to stream ogg vorbis files you'll need:
 
                http://www.xiph.org/downloads/
 
+Debian packages: libogg-dev libvorbis-dev
+
 Note that para_audiod still works even if neither mp3 nor ogg support
 was compiled in. You'll have to use the --no_default_filters option
 in this case (and e.g. "mpg123 -" as the stream write command).
@@ -210,9 +212,9 @@ Distribution of paraslash is covered by the GNU GPL. See file COPYING.
 
 LIMITATIONS:
 ~~~~~~~~~~~~
-The mysql database tool assumes that the basenames of your audio files
-are unique. If this is not the case, don't use this database tool,
-rename your files, or create your own database tool.
+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:
 ~~~~~~~~~~~