Don't let make write the filename into the output
[paraslash.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index f593f70..b0bbbad 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -7,14 +7,16 @@ Any knowledge of how to work with mouse and icons is not required.
 ---------------------------
 Install all needed packages
 ---------------------------
 ---------------------------
 Install all needed packages
 ---------------------------
-
-See README for a list of required software. You don't need everything
-listed there. In particular, mp3, ogg vorbis and aac support is
-optional. Autoconf 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 decodong library libmad)
+See
+<<
+<a href="REQUIREMENTS.html"> REQUIREMENTS </a>
+>>
+for a list of required software. You don't need everything listed there. In
+particular, mp3, ogg vorbis and aac support are all optional. Autoconf 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.
 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.
@@ -53,24 +55,25 @@ 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:
 
 As foo@server_host, create ~/.paraslash/server.users by typing the
 following commands:
 
+       user=bar
        target=~/.paraslash/server.users
        target=~/.paraslash/server.users
-       key=~/.paraslash/key.pub.bar
+       key=~/.paraslash/key.pub.$user
        perms=AFS_READ,AFS_WRITE,VSS_READ,VSS_WRITE
        mkdir -p ~/.paraslash
        perms=AFS_READ,AFS_WRITE,VSS_READ,VSS_WRITE
        mkdir -p ~/.paraslash
-       echo "user bar $key $perms" >> $target
+       echo "user $user $key $perms" >> $target
 
 This gives "bar" the full privileges.
 
 Change to the bar account on client_host and generate the key-pair
 with the commands
 
 
 This gives "bar" the full privileges.
 
 Change to the bar account on client_host and generate the key-pair
 with the commands
 
-       key=~/.paraslash/key.bar
+       key=~/.paraslash/key.$LOGNAME
        mkdir -p ~/.paraslash
        (umask 077 && openssl genrsa -out $key)
 
 Next, extract its public part:
 
        mkdir -p ~/.paraslash
        (umask 077 && openssl genrsa -out $key)
 
 Next, extract its public part:
 
-       pubkey=~/.paraslash/key.pub.bar
+       pubkey=~/.paraslash/key.pub.$LOGNAME
        openssl rsa -in $key -pubout -out $pubkey
 
 and copy the public key just created to server_host (you may
        openssl rsa -in $key -pubout -out $pubkey
 
 and copy the public key just created to server_host (you may
@@ -88,10 +91,18 @@ Finally, tell para_client to connect to server_host:
 Start para_server
 -----------------
 
 Start para_server
 -----------------
 
-For this first try, we'll use a debug level of two to make the
-output of para_server more verbose.
+Before starting the server make sure you have write permissions to
+the directory /var/paraslash.
+
+       sudo chown $user /var/paraslash
+
+Alternatively, use the --afs_socket Option to specify a different
+location for the afs command socket.
+
+For this first try, we'll use the info loglevel to make the output
+of para_server more verbose.
 
 
-       para_server -l 2
+       para_server -l info
 
 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
 
 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
@@ -136,8 +147,8 @@ Print a list of all audio files found with
 Start streaming manually
 ------------------------
 
 Start streaming manually
 ------------------------
 
-       para play
-       para stat 2
+       para_client play
+       para_client stat 2
 
 This starts streaming and dumps some information about the current
 audio file to stdout.
 
 This starts streaming and dumps some information about the current
 audio file to stdout.
@@ -153,7 +164,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):
 
 will be described next. Try the following on client_host (assuming
 Linux/ALSA and an mp3 stream):
 
-       para_recv -l 2 -r 'http -i server_host' > file.mp3
+       para_recv -l info -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
        # (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
@@ -185,7 +196,7 @@ supposed to play the audio stream. Try
 for help. Usually you have to specify only server_host as the receiver
 specifier for each supported audio format, like this:
 
 for help. Usually you have to specify only server_host as the receiver
 specifier for each supported audio format, like this:
 
-       para_audiod -l 2 -r 'mp3:http -i server_host'
+       para_audiod -l info -r 'mp3:http -i server_host'
 
 The preferred way to use para_audiod is to run it once at system start
 as an unprivileged user. para_audiod needs to create a "well-known"
 
 The preferred way to use para_audiod is to run it once at system start
 as an unprivileged user. para_audiod needs to create a "well-known"
@@ -194,7 +205,7 @@ socket is
 
        /var/paraslash/audiod_socket.$HOSTNAME
 
 
        /var/paraslash/audiod_socket.$HOSTNAME
 
-so the /var/paraslash directory should be owned by the user who
+so the /var/paraslash directory should be writable for the user who
 runs para_audiod.
 
 If you want to change the location of the socket, use the -s option
 runs para_audiod.
 
 If you want to change the location of the socket, use the -s option
@@ -237,4 +248,7 @@ arbitrary commands. There are several flavours of key-bindings:
          command>" instead of "<specified command>".
 
 This concludes the installation notes. Next thing you might to have a look
          command>" instead of "<specified command>".
 
 This concludes the installation notes. Next thing you might to have a look
-at is how to use paraslash's audio file selector. See README.afs.
+at is how to use paraslash's audio file selector. See
+<<
+<a href="README.afs.html"> README.afs</a>
+>>