web/documentation.in.html

   1 <h1>Documentation</h1>
   2 <hr>
   3 Have a look at this
   4         <a href="overview.pdf">overview</a>,
   5 a pdf file containing a sketch which illustrates how the pieces of paraslash work
   6 together. Read
   7         <a href="README.html">README</a>
   8 for general information (including a list of required software),
   9         <a href="INSTALL.html">INSTALL</a>
  10 for installation notes, and
  11         <a href="README.mysql.html">README.mysql</a>
  12 for instructions on how to use the mysql audio file selector
  13 shipped with paraslash.
  14 <p>
  15 The various commands of para_server and para_audiod are explained in
  16 the corresponding manual pages:
  17 <ul>
  18         <li> <a href="man/para_server.html">para_server</a>. </li>
  19         <li> <a href="man/para_audiod.html">para_audiod</a>. </li>
  20 </ul>
  21 Further manual pages:
  22 <ul>
  23         <li> <a href="man/para_audioc.html">para_audioc</a> </li>
  24         <li> <a href="man/para_client.html">para_client</a> </li>
  25         <li> <a href="man/para_fade.html">para_fade</a> </li>
  26         <li> <a href="man/para_filter.html">para_filter</a> </li>
  27         <li> <a href="man/para_gui.html">para_gui</a> </li>
  28         <li> <a href="man/para_recv.html">para_recv</a> </li>
  29         <li> <a href="man/para_sdl_gui.html">para_sdl_gui</a> </li>
  30         <li> <a href="man/para_write.html">para_write</a> </li>
  31 </ul>
  32 </p>
  33 <p>
  34 As of version 0.2.10, the source code of paraslash's core programs is fully
  35 documented.  Have a look at the
  36         <a href="doxygen/html/index.html">Paraslash API Reference</a>.
  37 </p>
  38 <p> Finally, you can <a href="HTML/index.html">RTFS online</a>.
  39 </p>