]> arthur.barton.de Git - ngircd-alex.git/blobdiff - man/ngircd.8.tmpl
WEBIRC: Don't respect hostname when DNS is disabled
[ngircd-alex.git] / man / ngircd.8.tmpl
index cc2498d9669e07e4c16eae41350074f0d81722b5..524fe3c1885a90af0d3efbf566a89eff1df691c7 100644 (file)
@@ -1,30 +1,37 @@
 .\"
 .\" ngircd(8) manual page template
 .\"
-.TH ngircd 8 "Jul 2011" ngircd "ngIRCd Manual"
+.TH ngircd 8 "Oct 2013" ngIRCd "ngIRCd Manual"
 .SH NAME
-ngIRCd \- the next generation IRC daemon
+ngIRCd \- the "next generation" IRC daemon
 .SH SYNOPSIS
-.B ngircd [
+.B ngircd
+[
 .I Options
-.B ]
+]
 .SH DESCRIPTION
 .BR ngIRCd
-is a free open source daemon for the Internet Relay Chat (IRC),
-developed under the GNU General Public License (GPL).
+is a free, portable and lightweight Internet Relay Chat server for small
+or private networks, developed under the GNU General Public License (GPL).
+It is easy to configure, can cope with dynamic IP addresses, and supports
+IPv6, SSL-protected connections as well as PAM for authentication.
+It is written from scratch and not based on the original IRCd.
 .PP
-It's written from scratch and is not based upon the original IRCd like
-many others. It is easy to configure, supports server links (even with
-original ircd's) and runs on hosts with changing IP addresses (such as
-dial-in networks).
-.PP
-Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, IRIX,
-Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
+The name ngIRCd means
+.IR "next generation IRC daemon",
+which is a little bit exaggerated:
+.IR "lightweight Internet Relay Chat server"
+most probably would have been a better name :-)
 .PP
+Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, Hurd, IRIX,
+Linux, Mac OS X, Minix, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
 As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
 there are good chances that it also supports other UNIX-based operating
-systems as well. By default, ngIRCd writes diagnostic and informational messages using
-the syslog mechanism.
+systems as well.
+.PP
+By default ngIRCd logs diagnostic and informational messages using the syslog
+mechanism, or writes directly to the console when running in the foreground
+(see below).
 .SH OPTIONS
 The default behavior of
 .BR ngircd
@@ -78,7 +85,7 @@ It's wise to use "ngircd \-\-configtest" to validate the configuration file
 after changing it.
 .SH DEBUGGING
 When ngIRCd is compiled with debug code, that is, its source code has
-been ./configure'd with "--enable-debug" and/or "--enable-sniffer" (witch
+been ./configure'd with "\-\-enable\-debug" and/or "\-\-enable\-sniffer" (witch
 enables debug mode automatically as well), you can use two more command
 line options and two more signals to debug problems with the daemon itself
 or IRC clients:
@@ -91,7 +98,7 @@ Enable debug mode and log extra messages.
 \fB\-s\fR, \fB\-\-sniffer\fR
 Enable IRC protocol sniffer, which logs all sent and received IRC commands to
 the console/syslog. This option requires that ngIRCd has been ./configure'd
-with "--enable-sniffer" and enables debug mode automatically, too.
+with "\-\-enable\-sniffer" and enables debug mode automatically, too.
 .PP
 \fBSignals:\fR
 .TP