command_util: Generate properly documented command header files.

[paraslash.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index b0bbbadbfdde6ade5b2555365dc87f90ca52d5a1..e2e7ac97b307162af92093e3cce62a266f81a271 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -11,10 +11,11 @@ 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.
+for a list of required software. You don't need everything listed
+there. In particular, mp3, ogg vorbis and aac support are all
+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.
@@ -32,7 +33,7 @@ Install the package on all machines, you'd like this software to run on:
 There should be no errors but probably some warnings about missing
 software packages which usually implies that not all audio formats will
 be supported. If headers or libs are installed at unusual locations
-you might need to tell the configure script to find them.  Try
+you might need to tell the configure script where to find them. Try
 
        ./configure --help
 
@@ -55,21 +56,20 @@ 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.$user
+       key=~/.paraslash/key.pub.$LOGNAME
        perms=AFS_READ,AFS_WRITE,VSS_READ,VSS_WRITE
        mkdir -p ~/.paraslash
-       echo "user $user $key $perms" >> $target
+       echo "user $LOGNAME $key $perms" >> $target
 
 This gives "bar" the full privileges.
 
-Change to the bar account on client_host and generate the key-pair
+Change to the "bar" account on client_host and generate the key-pair
 with the commands
 
        key=~/.paraslash/key.$LOGNAME
        mkdir -p ~/.paraslash
-       (umask 077 && openssl genrsa -out $key)
+       (umask 077 && openssl genrsa -out $key 2048)
 
 Next, extract its public part:
 
@@ -94,7 +94,7 @@ Start para_server
 Before starting the server make sure you have write permissions to
 the directory /var/paraslash.
 
-       sudo chown $user /var/paraslash
+       sudo chown $LOGNAME /var/paraslash
 
 Alternatively, use the --afs_socket Option to specify a different
 location for the afs command socket.
@@ -208,10 +208,10 @@ socket is
 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
-for para_audiod or the config file ~/.paraslash/audiod.conf to change
-the default. Note that in this case you'll also have to specify the
-same value for para_audioc's -s option.
+If you want to change the location of the socket, use the --socket
+option for para_audiod or the config file ~/.paraslash/audiod.conf
+to change the default. Note that in this case you'll also have to
+specify the same value for para_audioc's --socket option.
 
 If para_server is playing, you should be able to listen to the audio
 stream as soon as para_audiod is started.  Once it is running, try