Merge branch 't/nonblock_api'
[paraslash.git] / web / documentation.in.html
index bd522d3be8985d53fe0e8981172d41b90cdb1843..2789112a9657cc5d925d5faddab5234ad5813afc 100644 (file)
@@ -1,25 +1,44 @@
 <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="manual.html">user manual</a>,
+               Installation, Configuration and Usage.
+       </li>
+
+</ul></p>
+
+<h2> Manual pages </h2>
+
 <p>
-The various commands of para_server and para_audiod are explained in
-paraslash's
-       <a href="doc/html/index.html">manual pages</a>.
-</p>
-<p>
-As of version 0.2.10, the source of para_server and para_audiod 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_afh.man.html">para_afh</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>