More documentation updates.
authorAndre Noll <maan@systemlinux.org>
Thu, 25 Oct 2007 18:46:25 +0000 (20:46 +0200)
committerAndre Noll <maan@systemlinux.org>
Thu, 25 Oct 2007 18:46:25 +0000 (20:46 +0200)
INSTALL
NEWS
REQUIREMENTS
server.c
web/documentation.in.html

diff --git a/INSTALL b/INSTALL
index f593f70..5b36e08 100644 (file)
--- 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 2b5e3ff..b4fbc5d 100644 (file)
--- 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"
index 0a572b1..ca5040a 100644 (file)
@@ -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
index c324413..e3e3ead 100644 (file)
--- a/server.c
+++ b/server.c
  * 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:
  *
  * 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.
  *
  */
 
index 47e5cd2..ef34ce9 100644 (file)
@@ -1,39 +1,56 @@
 <h1>Documentation</h1>
 <hr>
-Have a look at this
-       <a href="overview.pdf">overview</a>,
-a pdf file containing a sketch which illustrates how the pieces of paraslash work
-together. Read
-       <a href="README.html">README</a>
-for general information (including a list of required software),
-       <a href="INSTALL.html">INSTALL</a>
-for installation notes, and
-       <a href="README.mysql.html">README.mysql</a>
-for instructions on how to use the mysql audio file selector
-shipped with paraslash.
+
+
+<h2> General information </h2>
+
+<p><ul>
+       <li> <a href="overview.pdf">overview.pdf</a>,
+
+               a pdf file containing a sketch which illustrates how
+               the pieces of paraslash work together.
+
+       </li>
+       <li> <a href="REQUIREMENTS.html">REQUIREMENTS</a>,
+               list of required and optional software.
+       </li>
+
+       <li> <a href="README.html">README</a>,
+               the paraslash executables, with brief descriptions.
+       </li>
+
+       <li> <a href="INSTALL.html">INSTALL</a>,
+               installation and configuration notes.
+       </li>
+
+       <li> <a href="README.afs.html">README.afs</a>,
+               audio file selector documentation.
+       </li>
+
+</ul></p>
+
+<h2> Manual pages </h2>
+
 <p>
-The various commands of para_server and para_audiod are explained in
-the corresponding manual pages:
-<ul>
-       <li> <a href="man/para_server.html">para_server</a>. </li>
-       <li> <a href="man/para_audiod.html">para_audiod</a>. </li>
-</ul>
-Further manual pages:
-<ul>
-       <li> <a href="man/para_audioc.html">para_audioc</a> </li>
-       <li> <a href="man/para_client.html">para_client</a> </li>
-       <li> <a href="man/para_fade.html">para_fade</a> </li>
-       <li> <a href="man/para_filter.html">para_filter</a> </li>
-       <li> <a href="man/para_gui.html">para_gui</a> </li>
-       <li> <a href="man/para_recv.html">para_recv</a> </li>
-       <li> <a href="man/para_sdl_gui.html">para_sdl_gui</a> </li>
-       <li> <a href="man/para_write.html">para_write</a> </li>
-</ul>
-</p>
-<p>
-As of version 0.2.10, the source code of paraslash's core programs is fully
-documented.  Have a look at the
-       <a href="doxygen/html/index.html">Paraslash API Reference</a>.
-</p>
-<p> Finally, you can <a href="HTML/index.html">RTFS online</a>.
+       [<a href="man/para_server.html">para_server</a>]
+       [<a href="man/para_audiod.html">para_audiod</a>]
+       [<a href="man/para_client.html">para_client</a>]
+       [<a href="man/para_audioc.html">para_audioc</a>]
+       [<a href="man/para_fsck.html">para_write</a>]
+       [<a href="man/para_recv.html">para_recv</a>]
+       [<a href="man/para_filter.html">para_filter</a>]
+       [<a href="man/para_write.html">para_write</a>]
+       [<a href="man/para_gui.html">para_gui</a>]
+       [<a href="man/para_fade.html">para_fade</a>]
 </p>
+
+<h2> Source code documentation </h2>
+
+<p><ul>
+
+       <li> <a href="doxygen/html/index.html">API
+       Reference</a>. </li>
+
+       <li> <a href="HTML/index.html">Browsable source</a>. </li>
+
+</ul></p>