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