documentation.php.en

   1 <?php
   2         include('includes/common.php');
   3         begin_page('en', 'Documentation');
   4 ?>
   5 <h2>
   6         Documentation
   7 </h2>
   8 <h3 id="platforms">
   9         Supported platforms
  10 </h3>
  11 <p>
  12         ngIRCd is mainly being developed and tested on current versions of
  13         Linux, Mac OS X, and FreeBSD.
  14 </p>
  15 <p>
  16         In addition ngIRCd has been successfully compiled and run on the
  17         following platforms:
  18 </p>
  19 <?php
  20         include('common/platforms.inc');
  21 ?>
  22 <p>
  23         As the ngIRCd complies to common UNIX standards and uses GNU automake
  24         and GNU autoconf, chances are that it can be ported to or adapted for
  25         further UNIXoid systems.
  26 </p>
  27 <h3 id="install">
  28         Installation
  29 </h3>
  30 <p>
  31         ngIRCd is designed for UNIXoid systems and the installation on a
  32         modern UNIX-like system, which is supported by GNU automake and GNU
  33         autoconf, shouldn't cause any problems.
  34 </p>
  35 <p>
  36         Typically it looks like this:
  37 </p>
  38 <blockquote><p><code>
  39         tar xzf ngircd-&lt;version&gt;.tar.gz<br>
  40         cd ngircd-&lt;version&gt;<br>
  41         ./configure<br>
  42         make
  43 </code></p></blockquote>
  44 <p>
  45         Now, the executing server (normally <code>ngircd</code>) should be in
  46         <code>src/ngircd</code>.
  47 </p>
  48 <blockquote><p><code>
  49         make install
  50 </code></p></blockquote>
  51 <p>
  52         The executing server has now been installed in
  53         <code>/usr/local/sbin</code>.
  54 </p>
  55 <p>
  56         The configuration file <code>ngircd.conf</code> is now expected in
  57         the server directory <code>/usr/local/etc</code>; an exemplary
  58         configuration file can be found in the directory <code>doc</code>.
  59 </p>
  60 <p>
  61         Further comments on the installation and configuration can be found
  62         in the file <a href="doc/INSTALL">INSTALL</a>.
  63 </p>
  64 <h3>
  65         Documentation
  66 </h3>
  67 <p>
  68         Documentation is compiled in the source package, some in the main
  69         directory (such as INSTALL, README, NEWS und COPYING), and some in
  70         the sub directory <samp>doc</samp> (such as SSL.txt, FAQ.txt and the
  71         exemplary configurations sample-ngircd.conf).
  72 </p>
  73 <p>
  74         The documents of tha actual version can be found online here:
  75 </p>
  76 <ul>
  77         <li><a href="doc/README">README</a></li>
  78         <li><a href="doc/INSTALL">INSTALL</a></li>
  79 </ul>
  80 <ul>
  81         <li><a href="doc/sample-ngircd.conf">sample-ngircd.conf</a>
  82 </ul>
  83 <ul>
  84         <li><a href="doc/FAQ.txt">FAQ.txt</a>
  85         <li><a href="doc/NEWS">NEWS</a>
  86         <li><a href="doc/ChangeLog">ChangeLog</a>
  87 </ul>
  88 <ul>
  89         <li><a href="doc/AUTHORS">AUTHORS</a>
  90         <li><a href="doc/Bopm.txt">Bopm.txt</a>
  91         <li><a href="doc/Capabilities.txt">Capabilities.txt</a>
  92         <li><a href="doc/Commands.txt">Commands.txt</a>
  93         <li><a href="doc/Contributing.txt">Contributing.txt</a>
  94         <li><a href="doc/COPYING">COPYING</a>
  95         <li><a href="doc/HowToRelease.txt">HowToRelease.txt</a>
  96         <li><a href="doc/Modes.txt">Modes.txt</a>
  97         <li><a href="doc/PAM.txt">PAM.txt</a>
  98         <li><a href="doc/Platforms.txt">Platforms.txt</a>
  99         <li><a href="doc/Protocol.txt">Protocol.txt</a>
 100         <li><a href="doc/RFC.txt">RFC.txt</a>
 101         <li><a href="doc/Services.txt">Services.txt</a>
 102         <li><a href="doc/SSL.txt">SSL.txt</a>
 103 </ul>
 104 <ul>
 105         <li><a href="doc/README-AUX.txt">README-AUX.txt</a>
 106         <li><a href="doc/README-BeOS.txt">README-BeOS.txt</a> (deutsch)
 107         <li><a href="doc/README-Interix.txt">README-Interix.txt</a>
 108 </ul>
 109 <?php
 110         end_page();
 111 ?>
 112