Remove an overambitious sanity check in the fecdec filter.

[paraslash.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 583f72abf7d9a4e1d4aa0c84f0f4fa4581ffbf7f..70c3094754cbb3426a80ec8c8f23b10242192cd6 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -12,10 +12,10 @@ See
 <a href="REQUIREMENTS.html"> REQUIREMENTS </a>
 >>
 for a list of required software. You don't need everything listed
 <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, ortp 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.
+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.
 
 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.


@@ -33,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
 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
 
 
        ./configure --help
 


@@ -56,16 +56,15 @@ 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.$user
+       key=~/.paraslash/key.pub.$LOGNAME

        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 $user $key $perms" >> $target
+       echo "user $LOGNAME $key $perms" >> $target

 
 This gives "bar" the full privileges.
 
 
 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
 with the commands
 
        key=~/.paraslash/key.$LOGNAME


@@ -92,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.

 
 

-       para_server -l 2
+       sudo chown $LOGNAME /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 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


@@ -140,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.


@@ -157,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


@@ -189,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"


@@ -201,10 +208,10 @@ socket is
 so the /var/paraslash directory should be writable for the user who
 runs para_audiod.
 
 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
 
 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