aacdec: raise min buffer size to 1000 bytes.
[paraslash.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 41a45c4..adb75c5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -32,7 +32,8 @@ want to allow to connect. You need at least one user.
 Let's assume that you'd like to run the server on host server_host
 as user foo, and that you want to connect from client_host as user bar.
 
-As foo@server_host, create ~/.paraslash/server.users:
+As foo@server_host, create ~/.paraslash/server.users by typing the
+following commands:
 
        target=~/.paraslash/server.users
        key=~/.paraslash/key.pub.bar
@@ -54,7 +55,9 @@ Next, extract its public part:
        pubkey=~/.paraslash/key.pub.bar
        openssl rsa -in $key -pubout -out $pubkey
 
-and copy the public key just created to server_host:
+and copy the public key just created to server_host (you may
+skip this step for a single-user setup, i.e. if foo=bar and
+server_host=client_host):
 
        scp $pubkey foo@server_host:.paraslash/
 
@@ -64,7 +67,12 @@ Finally, tell para_client to connect to server_host:
 
 Start para_server
 ~~~~~~~~~~~~~~~~~
-       para_server
+For the first try, we'll use the default audio file selector, the
+"random" selector which chooses audio files from the given directory
+by random. You have to tell para_server via the --random_dir command
+line option where this selector should look for audio files.
+
+       para_server --random_dir=/my/mp3/directory
 
 Now you can use para_client to connect to the server and issue
 commands. Open a new shell (as "bar" on "client_host" in the above
@@ -75,32 +83,6 @@ example) and try
 
 to retrieve the list of available commands and some server info.
 
-
-Choose an audio file selector
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-paraslash has three different audio file selectors: random (default),
-plm (the playlist manager) and mysql.
-
-       The random selector chooses files randomly from the given
-       directory.
-
-       The playlist selector allows to send a playlist to para_server
-       via the lpl (load playlist) command. para_server will choose
-       files from the loaded playlist in sequential order.
-
-       The mysql selector stores information about your audio
-       files in a mysql database. It is much more involved than
-       the other two selectors and lets you chose files in many
-       interesting ways. If you like to use the mysql selector,
-       read README.mysql and follow the instructions given there.
-       Return to this document when ready.
-
-The current audio file selector can be changed at runtime via
-
-       para_client cdt new_selector
-
-
-
 Start streaming manually
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -116,7 +98,7 @@ on client_host:
 
        mp3:
 
-       para_recv -r 'http -i server_host' | para_filter -f mp3dec -f wav | para_play
+       para_recv -r 'http -i server_host' | para_filter -f mp3dec -f wav | para_write -w alsa
        or
        mpg123 http://server_host:8000/
        or
@@ -124,12 +106,36 @@ on client_host:
 
        ogg:
 
-       para_recv -r 'http -i server_host' | para_filter -f oggdec -f wav | para_play
+       para_recv -r 'http -i server_host' | para_filter -f oggdec -f wav | para_write -w alsa
 
-If this works, proceede. Otherwise doublecheck what is logged by
+If this works, proceed. Otherwise doublecheck what is logged by
 para_server and use the --loglevel option of para_recv, para_filter
 to increase verbosity.
 
+Choose an audio file selector
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+paraslash has three different audio file selectors: random (default),
+playlist and mysql.
+
+       The random selector chooses files randomly from the given
+       directory.
+
+       The playlist selector allows to send a playlist to para_server
+       via the lpl (load playlist) command. para_server will choose
+       files from the loaded playlist in sequential order.
+
+       The mysql selector stores information about your audio
+       files in a mysql database. It is much more involved than
+       the other two selectors and lets you chose files in many
+       interesting ways. If you like to use the mysql selector,
+       read README.mysql and follow the instructions given there.
+       Return to this document when ready.
+
+The current audio file selector can be changed at runtime via
+
+       para_client chs new_selector
+
+
 Configure para_audiod
 ~~~~~~~~~~~~~~~~~~~~~
 In order to automatically start the right decoder at the right time
@@ -174,23 +180,23 @@ information in a curses window. It also allows you to bind keys to
 arbitrary commands. There are several flavours of key-bindings:
 
        o internal: These are the built-in commands that can not be
-         changed (help, quit, loglevel, version...).
+       changed (help, quit, loglevel, version...).
 
-        o external: Shutdown curses before launching the given command.
-          Useful for starting other ncurses programs from within
-          para_gui, e.g. aumix or para_dbadm. Or, use
+       o external: Shutdown curses before launching the given command.
+       Useful for starting other ncurses programs from within
+       para_gui, e.g. aumix or para_dbadm. Or, use
 
                para_client mbox
 
-         to write a mailbox containing one mail for each file
-          in the mysql database and start mutt from within para_gui
-          to browse your collection!
+       to write a mailbox containing one mail for each file
+       in the mysql database and start mutt from within para_gui
+       to browse your collection!
 
        o display: Launch the command and display its stdout in
-         para_gui's bottom window.
+       para_gui's bottom window.
 
        o para: Like display, but start "para_client <specified
-         command>" instead of "<specified command>".
+       command>" instead of "<specified command>".
 
 
 That's all, congratulations. Check out all the other optional gimmics!