.\"
-.\" $Id: ngircd.8,v 1.3 2002/04/02 20:38:50 alex Exp $
+.\" $Id: ngircd.8,v 1.11 2005/08/12 13:20:54 alex Exp $
.\"
-.TH ngircd 8 "March 2002" ngircd "ngIRCd Manual"
+.TH ngircd 8 "August 2005" ngircd "ngIRCd Manual"
.SH NAME
-ngircd \- the next generation IRC daemon
+ngIRCd \- the next generation IRC daemon
.SH SYNOPSIS
.B ngircd [
.I Options
.B ]
.SH DESCRIPTION
-.B 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).
+.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.
+.PP
+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.
.SH OPTIONS
-.IP --configtest
-read, validate and display configuration; then exit.
-.IP "-f file, --config file"
-use
+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.
+.PP
+You can use these options to modify this default:
+.TP
+\fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
+Use
.I file
as configuration file.
-.IP "-n, --nodaemon"
-don't fork and don't detatch from controlling terminal.
-.IP "-p, --passive"
-disable automatic connections to other servers.
-.IP --version
-output version information and exit.
-.IP --help
-display brief help text and exit.
+.TP
+\fB\-n\fR, \fB\-\-nodaemon\fR
+Don't fork a child and don't detach from controlling terminal.
+All log messages go to the console and you can use CTRL-C to
+terminate the server.
+.TP
+\fB\-p\fR, \fB\-\-passive\fR
+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.
+.TP
+\fB\-t\fR, \fB\-\-configtest\fR
+Read, validate and display the configuration; then exit.
+.TP
+\fB\-\-version\fR
+Output version information and exit.
+.TP
+\fB\-\-help\fR
+Display a brief help text and exit.
.SH FILES
.I /usr/local/etc/ngircd.conf
.RS
The system wide default configuration file.
-.SH DIAGNOSTICS
-(coming soon)
+.RE
+.I /usr/local/etc/ngircd.motd
+.RS
+Default "message of the day" (MOTD).
+.RE
.SH AUTHOR
Alexander Barton,
.UR mailto:alex@barton.de
.UE
.br
Homepage:
-.UR http://arthur.ath.cx/~alex/ngircd/
-http://arthur.ath.cx/~alex/ngircd/
+.UR http://ngircd.barton.de/
+http://ngircd.barton.de/
.UE
.SH "SEE ALSO"
-.BR ngircd.conf (5)
+.BR ngircd.conf (5),
.BR ircd (8)
.\"
.\" -eof-
projects / ngircd-alex.git / blobdiff