X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=INSTALL;h=35914c81688be69720bcc8f6d3b6e8ba65fb6a0c;hp=9e53e1f3dbeccf49b6ee8647673823ee54bef7c2;hb=8a8cd0f5bb40dcfad68608193e8c57decd90b25e;hpb=ab5820c1ac8fe47084be69717503de2ce00b5956 diff --git a/INSTALL b/INSTALL index 9e53e1f3..35914c81 100644 --- a/INSTALL +++ b/INSTALL @@ -1,18 +1,22 @@ -Paraslash install notes -======================= +INSTALL +======= +---- Any knowledge of how to work with mouse and icons is not required. +--------------------------- Install all needed packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------- + See README for a list of required software. Don't be afraid of the long list of unusal libraries: Most of them are only needed for optional programs. Autoconf will detect what is installed on your system and will only build those executables that can be built with your setup. - +------------------------ Install server and client -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- + Install the package on all machines, you'd like this software to run on: (./configure && make) > /dev/null @@ -22,8 +26,10 @@ software). Then, as root, make install +----------------------------------- 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. @@ -62,10 +68,13 @@ server_host=client_host): Finally, tell para_client to connect to server_host: - echo 'hostname server_host' > ~/.paraslash/client.conf + conf=~/.paraslash/client.conf + echo 'hostname server_host' > $conf +----------------- Start 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 @@ -82,8 +91,9 @@ example) and try to retrieve the list of available commands and some server info. +------------------------ Start streaming manually -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ para_client play para_client stat 2 @@ -95,7 +105,8 @@ You should now be able to receive and listen to the stream. To check this, try the following on client_host (assuming alsa and an mp3 stream): - para_recv -r 'http -i server_host' > file.mp3 #interrupt after a few seconds + para_recv -r 'http -i server_host' > file.mp3 + # (interrupt after a few seconds) ls -l file.mp3 # should not be empty para_filter -f mp3dec -f wav < file.mp3 > file.wav ls -l file.wav # should be much bigger than file.mp3 @@ -107,38 +118,41 @@ and para_write to increase verbosity. Next, put the pieces together: - para_recv -r 'http -i server_host' | para_filter -f mp3dec -f wav | para_write -w alsa + para_recv -r 'http -i server_host' \ + | para_filter -f mp3dec -f wav \ + | para_write -w alsa or mpg123 http://server_host:8000/ or xmms http://server_host:8000/ +----------------------------- 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 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 and to offer to the clients some information on the current audio stream and on paraslash's internal state, you should run the local @@ -180,31 +194,26 @@ That should dump some information to stdout. Other commands include para_audioc term para_audioc cycle - +-------------- Start para_gui -~~~~~~~~~~~~~~ +-------------- + para_gui reads the output of "para_audioc stat" and displays that information in a curses window. It also allows you to bind keys to arbitrary commands. There are several flavours of key-bindings: - o internal: These are the built-in commands that can not be - changed (help, quit, loglevel, version...). - - o external: Shutdown curses before launching the given command. - Useful for starting other ncurses programs from within - para_gui, e.g. aumix or para_dbadm. Or, use - - para_client mbox - - to write a mailbox containing one mail for each file - in the mysql database and start mutt from within para_gui - to browse your collection! - - o display: Launch the command and display its stdout in - para_gui's bottom window. - - o para: Like display, but start "para_client " instead of "". + - internal: These are the built-in commands that can not be + changed (help, quit, loglevel, version...). + - external: Shutdown curses before launching the given command. + Useful for starting other ncurses programs from within + para_gui, e.g. aumix or para_dbadm. Or, use "para_client + mbox" to write a mailbox containing one mail for each file + in the mysql database and start mutt from within para_gui + to browse your collection! + - display: Launch the command and display its stdout in + para_gui's bottom window. + - para: Like display, but start "para_client " instead of "". That's all, congratulations. Check out all the other optional gimmics!