From: Andre Noll Date: Sun, 5 Jul 2009 08:38:01 +0000 (+0200) Subject: Documentation updates for 0.4. X-Git-Tag: v0.4.0~67 X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=0322a7faaf28dfc2b4d545586926adfae7bf036e Documentation updates for 0.4. --- diff --git a/INSTALL b/INSTALL index 47709ccf..092bf873 100644 --- 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 mp3 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. ------------------------- 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. @@ -121,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. @@ -149,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. @@ -165,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 diff --git a/NEWS b/NEWS index dff82086..793e3234 100644 --- a/NEWS +++ b/NEWS @@ -1,6 +1,24 @@ NEWS ==== +--------------------------------------------------- +0.4.0 (to be announced) "simultaneous independence" +--------------------------------------------------- + +Two significant changes which require the new version number: The +improved authentication dialog and the fact that the database code +has been moved to a library, libosl. To use the new version, you have +to generate new RSA keys, see INSTALL for details. A shell script is +provided for conversion of the 0.3 database to the new 0.4 format. + + - stronger crypto for client authentication + - the database code has been moved to a library + - improved status item handling + - the new parser-friendly listing mode for the ls and stat commands + - mandatory rc4 encryption + - major audio format handler cleanups + - improved tag handling + ------------------------------------------------- 0.3.5 (to be announced) "symplectic separability" ------------------------------------------------- diff --git a/README.afs b/README.afs index ca01df6a..ef51c294 100644 --- a/README.afs +++ b/README.afs @@ -78,10 +78,10 @@ A mood consists of a unique name and its *mood definition*, which is a set of *mood lines* containing expressions in terms of attributes and other data contained in the database. -A mood defines a subset of audio files called the *admissible audio -files* for that mood. At any time, at most one mood can be *active* -which means that para_server is going to select only files from that -subset of admissible files. +A mood defines a subset of audio files called the *admissible audio files* +for that mood. At any time, at most one mood can be *active* which +means that para_server is going to select only files from that subset +of admissible files. So in order to create a mood definition one has to write a set of mood lines. Mood lines come in three flavours: Accept lines, deny diff --git a/REQUIREMENTS b/REQUIREMENTS index c1743fd2..1991737b 100644 --- a/REQUIREMENTS +++ b/REQUIREMENTS @@ -3,6 +3,10 @@ Requirements In any case you need + - libosl: If you are compiling from git the osl sources should + have been cloned automatically. It is also available for + download from http://git.tuebingen.mpg.de/osl. Or run the + command "git clone git://git.tuebingen.mpg.de/osl" - gcc, the gnu compiler collection (shipped with distro): gcc-3.3 or newer is required. - gnu make (shipped with disto, might be called gmake)