]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - README
projects / paraslash.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
README: Kill "obligatory" and "optional" tags.
[paraslash.git] / README
diff --git a/README b/README
index d4521bc5298122d493884d6159dde3578d9fa68c..30be045846d2242bd80ccbb4ee5111727510e680 100644 (file)
--- a/README
+++ b/README
@@ -8,9 +8,9 @@ _Play, archive, rate and stream large audio sets happily_
 
 It contains the following programs:
 
 
 It contains the following programs:
 
------------------------
-para_server (obligatory)
------------------------
+-----------
+para_server
+-----------
 
 para_server streams binary audio data (mp3/oggvorbis/m4a files)
 over local and/or remote networks. It listens on a tcp port and
 
 para_server streams binary audio data (mp3/oggvorbis/m4a files)
 over local and/or remote networks. It listens on a tcp port and
@@ -33,7 +33,9 @@ It is possible to activate more than one sender simultaneously.
 The built-in audio file selector of paraslash is used to manage your
 audio files. It maintains statistics on the usage of all available audio
 files such as last played time, and the number of times each file was
 The built-in audio file selector of paraslash is used to manage your
 audio files. It maintains statistics on the usage of all available audio
 files such as last played time, and the number of times each file was
-selected. Its features include
+selected.
+
+Its features include
 
        * attributes: Allow fine-grained audio file selection.
 
 
        * attributes: Allow fine-grained audio file selection.
 
@@ -43,7 +45,7 @@ selected. Its features include
 
        * playlist table. Stores arbitrary many playlists.
 
 
        * playlist table. Stores arbitrary many playlists.
 
-       * mood mode. Audio file selection works by spcifying mood
+       * mood mode. Audio file selection works by specifying mood
          methods involving attributes, pattern matching for file names
          and more.  This allows rather sophisticated configurations
          and is explained in more detail in INSTALL.
          methods involving attributes, pattern matching for file names
          and more.  This allows rather sophisticated configurations
          and is explained in more detail in INSTALL.
@@ -56,9 +58,9 @@ stripped binary of para_server with all its features compiled in
 mp3/ogg/aac support, http/dccp/ortp support) is about 150K on i386
 under Linux. para_audiod (see below) is even smaller.
 
 mp3/ogg/aac support, http/dccp/ortp support) is about 150K on i386
 under Linux. para_audiod (see below) is even smaller.
 
-------------------------
-para_client (obligatory)
-------------------------
+-----------
+para_client
+-----------
 
 The client program to connect to para_server.  paraslash commands
 are sent to para_server and the response is dumped to stdout. This
 
 The client program to connect to para_server.  paraslash commands
 are sent to para_server and the response is dumped to stdout. This
@@ -70,16 +72,16 @@ default.  For each user of paraslash you must create a public/secret
 key pair for authentication. The (authenticated) connection is encrypted
 with a symmetric rc4 session key.
 
 key pair for authentication. The (authenticated) connection is encrypted
 with a symmetric rc4 session key.
 
---------------------
-para_recv (optional)
---------------------
+---------
+para_recv
+---------
 
 A command line http/dccp/rtp stream grabber. The http mode of this tool
 can be used to receive date from any http streaming source.
 
 
 A command line http/dccp/rtp stream grabber. The http mode of this tool
 can be used to receive date from any http streaming source.
 
-----------------------
-para_filter (optional)
-----------------------
+-----------
+para_filter
+-----------
 
 A filter program that converts from stdin and writes to stdout. It
 is completely independent from the rest of paraslash, so it might be
 
 A filter program that converts from stdin and writes to stdout. It
 is completely independent from the rest of paraslash, so it might be
@@ -91,18 +93,18 @@ design. If more than one filter is specified, the given filters
 are 'piped' together in-memory, i.e. without calling any of the
 read(2)/write(2)/select(2) etc. functions.
 
 are 'piped' together in-memory, i.e. without calling any of the
 read(2)/write(2)/select(2) etc. functions.
 
------------------------
-para_write (obligatory)
------------------------
+----------
+para_write
+----------
 
 A modular audio stream writer. It supports a simple file writer
 output plug-in and optional wav/raw players for alsa (linux-only,
 Debian package: libasound2-dev) and Mac OS. para_write can also be
 used as a stand-alone wav or raw audio player.
 
 
 A modular audio stream writer. It supports a simple file writer
 output plug-in and optional wav/raw players for alsa (linux-only,
 Debian package: libasound2-dev) and Mac OS. para_write can also be
 used as a stand-alone wav or raw audio player.
 
----------------------------------------
-para_audiod (optional, but recommended)
----------------------------------------
+-----------
+para_audiod
+-----------
 
 The local daemon that collects information from para_server.
 
 
 The local daemon that collects information from para_server.
 
@@ -117,9 +119,9 @@ para_server announces the availability (and the type) of an audio stream.
 Moreover, it listens on a local socket and sends status information about
 para_server and para_audiod to local clients on request.
 
 Moreover, it listens on a local socket and sends status information about
 para_server and para_audiod to local clients on request.
 
---------------------------------------
-para_audioc (optional, but recommended)
---------------------------------------
+-----------
+para_audioc
+-----------
 
 The client program which talks with para_audiod. Used to control
 para_audiod, to receive status info, or to grab the stream at any
 
 The client program which talks with para_audiod. Used to control
 para_audiod, to receive status info, or to grab the stream at any
@@ -128,65 +130,34 @@ point in the filter chain.
 para_audioc (hence para_audiod) is needed by para_gui, para_sdl_gui
 and para_krell, see below.
 
 para_audioc (hence para_audiod) is needed by para_gui, para_sdl_gui
 and para_krell, see below.
 
--------------------
-para_gui (optional)
--------------------
+--------
+para_gui
+--------
 
 Themable ncurses-based gui. It calls para_audioc and presents
 the obtained information in an ncurses window. para_gui provides
 key-bindings for the most common commands and new key-bindings can
 be added easily.
 
 
 Themable ncurses-based gui. It calls para_audioc and presents
 the obtained information in an ncurses window. para_gui provides
 key-bindings for the most common commands and new key-bindings can
 be added easily.
 
---------------------
-para_fade (optional)
---------------------
+---------
+para_fade
+---------
 
 A (Linux-only) alarm clock and volume-fader.
 
 
 A (Linux-only) alarm clock and volume-fader.
 
---------------------------
-bash_completion (optional)
---------------------------
+---------------
+bash_completion
+---------------
 
 A small bash script for inclusion in ~/.bashrc. It gives you command
 line completion for some paraslash commands.
 
 
 A small bash script for inclusion in ~/.bashrc. It gives you command
 line completion for some paraslash commands.
 
-------------
-Requirements
-------------
-
-In any case you need
-
-       - gcc, the gnu compiler collection (shipped with distro): gcc-3.3
-         or newer is required.
-       - gnu make (shipped with disto, might be called gmake)
-       - bash
-       - openssl (needed by server, client): usually shipped with
-         distro, but you might have to install the "development package"
-         (called libssl-dev on debian systems) as well:
-         http://www.openssl.org/
-       - software mixing, e.g. ALSA and the direct mixing plugin (dmix)
-
-The mp3 decoder of para_filter is based on libmad: If you prefer to
-use the libmad package provided by your distributor, make sure to
-install the corresponding development package as well.  Otherwise,
-just download libmad from http://www.underbit.com/products/mad/
-
-For ogg vorbis streams you'll need libogg, libvorbis, libvorbisfile,
-The corresponding Debian packages are called libogg-dev libvorbis-dev,
-other distributors chose similar names.  All of these are also
-available at http://www.xiph.org/downloads/
-
-For aac files (m4a) you'll need libfaad. Get it at
-http://www.audiocoding.com/modules/wiki/?page=AAC
-
-If you intend to use the optional ortp streamer, you'll need libortp:
-http://www.linphone.org/ortp/
-
 -------
 LICENSE
 -------
 
 -------
 LICENSE
 -------
 
-Distribution of paraslash is covered by the GNU GPL. See file COPYING.
+Distribution of paraslash is covered by the GNU GPL, version 2. See file
+COPYING.
 
 ----------
 THE AUTHOR
 
 ----------
 THE AUTHOR
paraslash - network audio streaming tools