Use non-blocking API for signal handling.

[paraslash.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index e2e7ac97b307162af92093e3cce62a266f81a271..aba5c35f162285e50bd4ca8d1d427a35b7008b06 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -17,16 +17,17 @@ optional. The configure script will detect what is installed on your
 system and will only try to build those executables that can be built
 with your setup.
 
-Note that no special library (not even the mp3 decoding library libmad)
-is needed for para_server if you only want to stream mp3 files.
-Also, it's fine to use para_server on a box without sound card as
-para_server only sends the audio stream to connected clients.
+Note that no special library (not even the mp3 decoding library
+libmad) is needed for para_server if you only want to stream mp3 or
+wma files. Also, it's fine to use para_server on a box without sound
+card as para_server only sends the audio stream to connected clients.
 
 -------------------------
 Install server and client
 -------------------------
 
-Install the package on all machines, you'd like this software to run on:
+Install the paraslash package on all machines, you'd like this software
+to run on:
 
        (./configure && make) > /dev/null
 
@@ -43,12 +44,14 @@ successfully, execute as root,
        make install
 
 -----------------------------------
-Setup user list and create rsa keys
+Setup user list and create RSA keys
 -----------------------------------
 
-If you already have your rsa keys, skip this step. If you are new
-to paraslash, you have to generate an rsa key pair for each user you
-want to allow to connect. You need at least one user.
+Note that the RSA keys for paraslash 0.3.x will not work for version
+0.4.x as the new version requires stronger (2048 bit) keys. If you
+already have your 2048 bit keys, skip this step. If you are new to
+paraslash, you have to generate a key pair for each user you 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.
@@ -56,11 +59,12 @@ as user foo, and that you want to connect from client_host as user bar.
 As foo@server_host, create ~/.paraslash/server.users by typing the
 following commands:
 
+       user=bar
        target=~/.paraslash/server.users
-       key=~/.paraslash/key.pub.$LOGNAME
+       key=~/.paraslash/key.pub.$user
        perms=AFS_READ,AFS_WRITE,VSS_READ,VSS_WRITE
        mkdir -p ~/.paraslash
-       echo "user $LOGNAME $key $perms" >> $target
+       echo "user $user $key $perms" >> $target
 
 This gives "bar" the full privileges.
 
@@ -120,11 +124,11 @@ Create the database
 
        para_client init
 
-This creates some empty tables under ~/.paraslash/afs_database.
-You normally don't need to look at these tables, but it's good
-to know that you can start from scratch with
+This creates some empty tables under ~/.paraslash/afs_database-0.4.
+You normally don't need to look at these tables, but it's good to
+know that you can start from scratch with
 
-       rm -rf ~/.paraslash/afs_database
+       rm -rf ~/.paraslash/afs_database-0.4
 
 in case something went wrong.
 
@@ -148,7 +152,7 @@ Start streaming manually
 ------------------------
 
        para_client play
-       para_client stat 2
+       para_client -- stat -n=2
 
 This starts streaming and dumps some information about the current
 audio file to stdout.
@@ -164,7 +168,7 @@ Paraslash comes with its own receiving and playing software, which
 will be described next. Try the following on client_host (assuming
 Linux/ALSA and an mp3 stream):
 
-       para_recv -l info -r 'http -i server_host' > file.mp3
+       para_recv -r 'http -i server_host' > file.mp3
        # (interrupt with CTRL+C after a few seconds)
        ls -l file.mp3 # should not be empty
        para_filter -f mp3dec -f wav < file.mp3 > file.wav