X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=man%2Fngircd.8;h=94874f4f817b55087dd6304bb6413a249a665c2f;hp=9957785a1877413f299a5158149f5a2e391d60c9;hb=b588eaed024fa067d1afd82749e593e218c77e37;hpb=bee32fb05af020594a93b36fe56a1c03e5273052 diff --git a/man/ngircd.8 b/man/ngircd.8 index 9957785a..94874f4f 100644 --- a/man/ngircd.8 +++ b/man/ngircd.8 @@ -1,7 +1,7 @@ .\" -.\" $Id: ngircd.8,v 1.2 2002/04/02 20:19:22 alex Exp $ +.\" $Id: ngircd.8,v 1.8 2003/03/10 00:58:06 alex Exp $ .\" -.TH ngircd 8 "March 2002" ngircd "ngIRCd Manual" +.TH ngircd 8 "March 2003" ngircd "ngIRCd Manual" .SH NAME ngircd \- the next generation IRC daemon .SH SYNOPSIS @@ -9,45 +9,75 @@ ngircd \- the next generation IRC daemon .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 (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). +.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. .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\-\-configtest\fR +Read, validate and display the configuration; then exit. +.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. +.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\-\-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 alex@barton.de .UE -.PP +.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-