new codename, reset version to git

[paraslash.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index f0d1ec8cedc70f9b9076df56d6dc9260416e0278..adb75c5c6e02c0f8528485d3fa3d959762b1e801 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -32,7 +32,8 @@ 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.
 
-As foo@server_host, create ~/.paraslash/server.users:
+As foo@server_host, create ~/.paraslash/server.users by typing the
+following commands:
 
        target=~/.paraslash/server.users
        key=~/.paraslash/key.pub.bar
@@ -54,7 +55,9 @@ Next, extract its public part:
        pubkey=~/.paraslash/key.pub.bar
        openssl rsa -in $key -pubout -out $pubkey
 
-and copy the public key just created to server_host:
+and copy the public key just created to server_host (you may
+skip this step for a single-user setup, i.e. if foo=bar and
+server_host=client_host):
 
        scp $pubkey foo@server_host:.paraslash/
 
@@ -64,7 +67,12 @@ Finally, tell para_client to connect to server_host:
 
 Start para_server
 ~~~~~~~~~~~~~~~~~
-       para_server
+For the first try, we'll use the default audio file selector, the
+"random" selector which chooses audio files from the given directory
+by random. You have to tell para_server via the --random_dir command
+line option where this selector should look for audio files.
+
+       para_server --random_dir=/my/mp3/directory
 
 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
@@ -75,31 +83,6 @@ example) and try
 
 to retrieve the list of available commands and some server info.
 
-
-Choose an audio file selector
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-paraslash has three different audio file selectors: random (default),
-playlist and mysql.
-
-       The random selector chooses files randomly from the given
-       directory.
-
-       The playlist selector allows to send a playlist to para_server
-       via the lpl (load playlist) command. para_server will choose
-       files from the loaded playlist in sequential order.
-
-       The mysql selector stores information about your audio
-       files in a mysql database. It is much more involved than
-       the other two selectors and lets you chose files in many
-       interesting ways. If you like to use the mysql selector,
-       read README.mysql and follow the instructions given there.
-       Return to this document when ready.
-
-The current audio file selector can be changed at runtime via
-
-       para_client chs new_selector
-
-
 Start streaming manually
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -125,10 +108,34 @@ on client_host:
 
        para_recv -r 'http -i server_host' | para_filter -f oggdec -f wav | para_write -w alsa
 
-If this works, proceede. Otherwise doublecheck what is logged by
+If this works, proceed. Otherwise doublecheck what is logged by
 para_server and use the --loglevel option of para_recv, para_filter
 to increase verbosity.
 
+Choose an audio file selector
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+paraslash has three different audio file selectors: random (default),
+playlist and mysql.
+
+       The random selector chooses files randomly from the given
+       directory.
+
+       The playlist selector allows to send a playlist to para_server
+       via the lpl (load playlist) command. para_server will choose
+       files from the loaded playlist in sequential order.
+
+       The mysql selector stores information about your audio
+       files in a mysql database. It is much more involved than
+       the other two selectors and lets you chose files in many
+       interesting ways. If you like to use the mysql selector,
+       read README.mysql and follow the instructions given there.
+       Return to this document when ready.
+
+The current audio file selector can be changed at runtime via
+
+       para_client chs new_selector
+
+
 Configure para_audiod
 ~~~~~~~~~~~~~~~~~~~~~
 In order to automatically start the right decoder at the right time