Updated manual page.

[ngircd-alex.git] / man / ngircd.8

diff --git a/man/ngircd.8 b/man/ngircd.8
index 18c21df6cb0fc2f0c2274c878cb102e02922fac3..65e8f52a5c74ab8d443c01e5e19465e7d2e152b3 100644 (file)
--- a/man/ngircd.8
+++ b/man/ngircd.8
@@ -1,7 +1,7 @@
 .\"
-.\" $Id: ngircd.8,v 1.1 2002/04/02 18:14:33 alex Exp $
+.\" $Id: ngircd.8,v 1.7 2003/03/10 00:37:52 alex Exp $
 .\"
-.TH ngircd 8 "March 2002" ngircd "User Manuals"
+.TH ngircd 8 "March 2003" ngircd "ngIRCd Manual"
 .SH NAME
 ngircd \- the next generation IRC daemon
 .SH SYNOPSIS
@@ -9,24 +9,70 @@ ngircd \- the next generation IRC daemon
 .I Options
 .B ]
 .SH DESCRIPTION
-ngIRCd is a portable IRC daemon written from scratch. It is easy to
-configure, supports server links (even with original ircds) and runs on
-hosts with changing IP addresses (such as dial-in networks). Currently
-supported platforms are A/UX, Darwin/Mac OS X, FreeBSD, Linux, NetBSD,
-and Windows with Cygwin.
+.BR ngircd
+is a free open source daemon for the Internet Relay Chat (IRC),
+developed under the GNU General Public License (GPL).
+
+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).
+
+Currently supported platforms (tested versions) are: AIX (3.2.5 with IBM XL
+C Compiler), A/UX (3.x, Apple pre-ANSI C Compiler and GNU C), FreeBSD
+(4.5/i386, GNU C), HP-UX (10.20, GNU C), IRIX (6.5, SGI MIPSpro C 7.30),
+Linux (2.2.x/i386, 2.4.x/i386 and 2.4.x/hppa, GNU C), Mac OS X (10.x, GNU C),
+NetBSD (1.5.2/i386 and 1.5.3/m68k, GNU C), Solaris (2.5.1 and 2.6, GNU C),
+and Windows with Cygwin (GNU C).
+
+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.
+
 .SH OPTIONS
-(coming soon, please see
-.B ngircd --help
-at the moment)
+The default behaviour of
+.BR ngircd
+is to read its standard configuration file (see below), to detach from the
+controlling terminal and to wait for clients.
+
+You can use these options to modify this default:
+.IP --configtest
+Read, validate and display the configuration; then exit.
+.IP "-f file, --config file"
+Use
+.I file
+as configuration file.
+.IP "-n, --nodaemon"
+Don't fork a child and don't detach from controlling terminal.
+All log messages go to the console.
+.IP "-p, --passive"
+Disable automatic connections to other servers. You can use the IRC command
+CONNECT later on as IRC Operator to link this ngIRCd to other servers.
+.IP --version
+Output version information and exit.
+.IP --help
+Display a brief help text and exit.
 .SH FILES
-(coming soon)
-.SH DIAGNOSTICS
-(coming soon)
+.I /usr/local/etc/ngircd.conf
+.RS
+The system wide default configuration file.
+.RE
+.I /usr/local/etc/ngircd.motd
+.RS
+Default "message of the day" (MOTD).
+.RE
 .SH AUTHOR
-Alexander Barton, <alex@barton.de>
-.\"Homepage: <http://arthur.ath.cx/~alex/ngircd/>
+Alexander Barton,
+.UR mailto:alex@barton.de
+alex@barton.de
+.UE
+.br
+Homepage:
+.UR http://arthur.ath.cx/~alex/ngircd/
+http://arthur.ath.cx/~alex/ngircd/
+.UE
 .SH "SEE ALSO"
-.BR ngircd.conf (5)
+.BR ngircd.conf (5),
 .BR ircd (8)
 .\"
 .\" -eof-