From b7dff48534d5f909d846e1fa40fa0d4467322bc3 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Thu, 25 Oct 2007 20:46:25 +0200 Subject: [PATCH] More documentation updates. --- INSTALL | 12 +++--- NEWS | 18 +++----- REQUIREMENTS | 35 ++++++++-------- server.c | 26 ++++++------ web/documentation.in.html | 87 +++++++++++++++++++++++---------------- 5 files changed, 94 insertions(+), 84 deletions(-) diff --git a/INSTALL b/INSTALL index f593f707..5b36e085 100644 --- a/INSTALL +++ b/INSTALL @@ -8,13 +8,13 @@ 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. You don't need everything -listed there. In particular, mp3, ogg vorbis and aac support is -optional. Autoconf will detect what is installed on your system -and will only try to build those executables that can be built with -your setup. +See REQUIREMENTS for a list of required software. You don't need +everything listed there. In particular, mp3, ogg vorbis and aac, ortp +support is optional. Autoconf 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 decodong library libmad) +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. diff --git a/NEWS b/NEWS index 2b5e3ff1..b4fbc5dc 100644 --- a/NEWS +++ b/NEWS @@ -13,39 +13,31 @@ for a major release like 0.2.x to 0.3.x. However, this release is smaller than the latest 0.2.x releases. The decrease in size is mostly due to the removal of some graphical tools -(which were only afternoon hacks anyway). But also the fact that the +(which were only quick hacks anyway). But also the fact that the mysql code is gone cuts down the size a bit. -Being independent of mysql comes at a cost: The ((stripped) binary +Being independent of mysql comes at a cost: The (stripped) binary size of para_server increases about 50K in i386. - - no more restrictions on unique basenames. - - independent of mysql: The new self-contained object storage layer (osl) replaces the mysql database. - - Lyrics support. - - Reliable audio file move/rename detection. - - the new osl-based audio file selector (afs) replaces the random, playlist and the mysql selector of paraslash-0.2.x. - - paraslash-0.2.x streams are now called "moods". Writing 0.3.x-mood definitions should be both easier and more powerful than writing 0.2.x-stream definitions. - - para_krell, para_slider, para_para_sdl_gui, para_dbadm have been removed. The world is a better place without them. However, para_gui is still there. - - - afs tracks audio file selection also in playlist mode. - - few easy-to-use afs commands replace the many not-so-easy-to-use - mysql commands ((and are available also in playlist mode). + mysql commands (and are available also in playlist mode). + - Improved error subsystem. + - The earth-shaking new logo. ---------------------------------------------- 0.2.17 (to be announced) "isotropic threshold" diff --git a/REQUIREMENTS b/REQUIREMENTS index 0a572b15..ca5040a0 100644 --- a/REQUIREMENTS +++ b/REQUIREMENTS @@ -6,7 +6,7 @@ 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 + - bash (most likely already installed) - 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: @@ -15,30 +15,31 @@ In any case you need Optional features: - - *mp3*: - 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/ + - *mp3*: The mp3 decoder of para_filter is based on libmad: + http://www.underbit.com/products/mad/. If you prefer to use + the libmad package provided by your distributor, make sure + to install the corresponding development package as well. + Note that libmad is not necessary for sending mp3 files. - - *ogg vorbis*: - 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. The source of these is also available at - http://www.xiph.org/downloads/ + - *ogg vorbis*: For ogg vorbis streams you'll need libogg, + libvorbis, libvorbisfile: http://www.xiph.org/downloads/. + The corresponding Debian packages are called libogg-dev + libvorbis-dev, other distributors chose similar names. + The source of these is also available at - *aac*: - For aac files (m4a) you'll need libfaad. Get it at - http://www.audiocoding.com/modules/wiki/?page=AAC + For aac files (m4a) you'll need libfaad. Get it at + http://www.audiocoding.com/modules/wiki/?page=AAC - *ortp*: - If you intend to use the optional ortp streamer, you'll need libortp: - http://www.linphone.org/ortp/ + If you intend to use the optional ortp streamer, you'll + need libortp: http://www.linphone.org/ortp/ Hacking the source: - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/ - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/ - grutatxt + - help2man + - doxygen + - global diff --git a/server.c b/server.c index c3244132..e3e3eada 100644 --- a/server.c +++ b/server.c @@ -14,10 +14,10 @@ * probably: * * - The main programs: \ref server.c, \ref audiod.c, \ref client.c, - * \ref audioc.c, \ref fsck.c + * \ref audioc.c, \ref fsck.c, * - Server: \ref server_command, \ref sender, * - Audio file selector: \ref audio_format_handler, \ref mood, \ref afs_table, - * - Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node + * - Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node. * * * The gory details, listed by topic: @@ -37,27 +37,27 @@ * * Lower levels: * - * - Scheduling: \ref sched.c, \ref sched.h + * - Scheduling: \ref sched.c, \ref sched.h, * - Networking: \ref net.c, * - File descriptors: \ref fd.c, * - Signals: \ref signal.c, * - Daemons: \ref daemon.c, - * - Strings: \ref string.c, string.h - * - Time: \ref time.c, time.h + * - Strings: \ref string.c, \ref string.h, + * - Time: \ref time.c, * - Spawning processes: \ref exec.c - * - Inter process communication: ipc.c, + * - Inter process communication: \ref ipc.c, * - The object storage layer: \ref osl.c, - * - Blob tables: blob.c, - * - Queueing chunks of audio data: \ref chunk_queue.c - * - The error subssystem: \ref error.h + * - Blob tables: \ref blob.c, + * - Queueing chunks of audio data: \ref chunk_queue.c, + * - The error subssystem: \ref error.h. * * Lov-level data structures: * * - Doubly linked lists: \ref list.h, - * - Red-black trees: \ref rbtree.h, \ref rbtree.c - * - Ring buffer: \ref ringbuffer.c, \ref ringbuffer.h - * - Hashing: \ref hash.h, \ref sha1.h, \ref sha1.c - * - Crypto: \ref crypt.c + * - Red-black trees: \ref rbtree.h, \ref rbtree.c, + * - Ring buffer: \ref ringbuffer.c, \ref ringbuffer.h, + * - Hashing: \ref hash.h, \ref sha1.h, \ref sha1.c, + * - Crypto: \ref crypt.c. * */ diff --git a/web/documentation.in.html b/web/documentation.in.html index 47e5cd2a..ef34ce92 100644 --- a/web/documentation.in.html +++ b/web/documentation.in.html @@ -1,39 +1,56 @@

Documentation

-Have a look at this - overview, -a pdf file containing a sketch which illustrates how the pieces of paraslash work -together. Read - README -for general information (including a list of required software), - INSTALL -for installation notes, and - README.mysql -for instructions on how to use the mysql audio file selector -shipped with paraslash. + + +

General information

+ +

+ +

Manual pages

+

-The various commands of para_server and para_audiod are explained in -the corresponding manual pages: -

-Further manual pages: - -

-

-As of version 0.2.10, the source code of paraslash's core programs is fully -documented. Have a look at the - Paraslash API Reference. -

-

Finally, you can RTFS online. + [para_server] + [para_audiod] + [para_client] + [para_audioc] + [para_write] + [para_recv] + [para_filter] + [para_write] + [para_gui] + [para_fade]

+ +

Source code documentation

+ +

-- 2.39.5