ngIRCd Release 27

[ngircd-web.git] / documentation.php.en

diff --git a/documentation.php.en b/documentation.php.en
index 6abc8681b698bf402b9050ead425a6477bad8958..6aa718f51c1428cbf18321b3b4967fd6c0426784 100644 (file)
--- a/documentation.php.en
+++ b/documentation.php.en
@@ -9,8 +9,12 @@
        Supported platforms
 </h3>
 <p>
-       ngIRCd is being tested regularly on the following platforms (used
-       version in brackets). The systems that are officially supported are:
+       ngIRCd is mainly being developed and tested on current versions of
+       Linux, macOS, FreeBSD and OpenBSD.
+</p>
+<p>
+       In addition ngIRCd has been successfully compiled and run on the
+       following platforms:
 </p>
 <?php
        include('common/platforms.inc');
@@ -63,40 +67,31 @@
 <p>
        Documentation is compiled in the source package, some in the main
        directory (such as INSTALL, README, NEWS und COPYING), and some in
-       the sub directory <samp>doc</samp> (such as GIT.txt, FAQ.txt and the
+       the sub directory <samp>doc</samp> (such as SSL.txt, FAQ.txt and the
        exemplary configurations sample-ngircd.conf).
 </p>
 <p>
-       The documents of tha actual version can be found online here:
+       The documents of the current version can be found online here:
+</p>
+<?php
+       include('common/documentation-links.inc');
+?>
+<h3>
+       Manual Pages
+</h3>
+<p>
+       In addition, ngIRCd comes with two manual pages: <code>ngircd(8)</code>
+       (for the daemon) and <code>ngircd.conf(5)</code> (for its configuration
+       file). They have even more details and list all possible command line
+       parameters and configuration options. You can read them with the
+       <code>man</code> command (when they are installed locally on your
+       system, e.g. <code>man 8 ngircd</code> and <code>man 5
+       ngircd.conf</code>) or online here:
 </p>
 <ul>
-       <li><a href="doc/README">README</a></li>
-       <li><a href="doc/INSTALL">INSTALL</a></li>
-</ul>
-<ul>
-       <li><a href="doc/sample-ngircd.conf">sample-ngircd.conf</a>
-</ul>
-<ul>
-       <li><a href="doc/FAQ.txt">FAQ.txt</a>
-       <li><a href="doc/NEWS">NEWS</a>
-       <li><a href="doc/ChangeLog">ChangeLog</a>
-</ul>
-<ul>
-       <li><a href="doc/AUTHORS">AUTHORS</a>
-       <li><a href="doc/COPYING">COPYING</a>
-       <li><a href="doc/GIT.txt">GIT.txt</a>
-       <li><a href="doc/Platforms.txt">Platforms.txt</a>
-       <li><a href="doc/Protocol.txt">Protocol.txt</a>
-       <li><a href="doc/RFC.txt">RFC.txt</a>
-       <li><a href="doc/Services.txt">Services.txt</a>
-       <li><a href="doc/SSL.txt">SSL.txt</a>
-       <li><a href="doc/Zeroconf.txt">Zeroconf.txt</a>
-</ul>
-<ul>
-       <li><a href="doc/README-AUX.txt">README-AUX.txt</a>
-       <li><a href="doc/README-BeOS.txt">README-BeOS.txt</a> (deutsch)
+       <li>Daemon: <a href="man/ngircd.8.html">ngircd(8)</a></li>
+       <li>Configuration file: <a href="man/ngircd.conf.5.html">ngircd.conf(5)</a></li>
 </ul>
 <?php
        end_page();
 ?>
-