From d9f939fe8a68267a62b68546b17e1ec9a34aab0b Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Thu, 1 Nov 2007 16:14:32 +0100 Subject: [PATCH] README: Kill "obligatory" and "optional" tags. All para_* executables are optional: The server-side programs are not needed on a client and vice versa. --- README | 61 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/README b/README index 0173fb3b..30be0458 100644 --- a/README +++ b/README @@ -8,9 +8,9 @@ _Play, archive, rate and stream large audio sets happily_ 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 @@ -58,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. ------------------------- -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 @@ -72,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. --------------------- -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. ----------------------- -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 @@ -93,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. ------------------------ -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. ---------------------------------------- -para_audiod (optional, but recommended) ---------------------------------------- +----------- +para_audiod +----------- The local daemon that collects information from para_server. @@ -119,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. --------------------------------------- -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 @@ -130,27 +130,28 @@ point in the filter chain. 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. --------------------- -para_fade (optional) --------------------- +--------- +para_fade +--------- 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. + ------- LICENSE ------- -- 2.39.5