client_common.c: Kill invalid FIXME.
[paraslash.git] / web / documentation.in.html
index 47e5cd2ae1e966d8bb06527ff576058cda915328..af50cd4782b6f3829a9c8361ef67052e41792f41 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="para_server.man.html">para_server</a>]
+       [<a href="para_audiod.man.html">para_audiod</a>]
+       [<a href="para_client.man.html">para_client</a>]
+       [<a href="para_audioc.man.html">para_audioc</a>]
+       [<a href="para_fsck.man.html">para_write</a>]
+       [<a href="para_recv.man.html">para_recv</a>]
+       [<a href="para_filter.man.html">para_filter</a>]
+       [<a href="para_write.man.html">para_write</a>]
+       [<a href="para_gui.man.html">para_gui</a>]
+       [<a href="para_fade.man.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>