1 f6ce2d55 2006-12-25 alex .\"
 2 2f305331 2007-11-15 fw .\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $
 3 f6ce2d55 2006-12-25 alex .\"
 4 d02b0835 2008-05-13 alex .TH ngircd 8 "May 2008" ngircd "ngIRCd Manual"
 5 f6ce2d55 2006-12-25 alex .SH NAME
 6 f6ce2d55 2006-12-25 alex ngIRCd \- the next generation IRC daemon
 7 f6ce2d55 2006-12-25 alex .SH SYNOPSIS
 8 f6ce2d55 2006-12-25 alex .B ngircd [
 9 f6ce2d55 2006-12-25 alex .I Options
10 f6ce2d55 2006-12-25 alex .B ]
11 f6ce2d55 2006-12-25 alex .SH DESCRIPTION
12 f6ce2d55 2006-12-25 alex .BR ngIRCd
13 f6ce2d55 2006-12-25 alex is a free open source daemon for the Internet Relay Chat (IRC),
14 f6ce2d55 2006-12-25 alex developed under the GNU General Public License (GPL).
15 f6ce2d55 2006-12-25 alex .PP
16 f6ce2d55 2006-12-25 alex It's written from scratch and is not based upon the original IRCd like
17 f6ce2d55 2006-12-25 alex many others. It is easy to configure, supports server links (even with
18 f6ce2d55 2006-12-25 alex original ircd's) and runs on hosts with changing IP addresses (such as
19 f6ce2d55 2006-12-25 alex dial-in networks).
20 f6ce2d55 2006-12-25 alex .PP
21 f6ce2d55 2006-12-25 alex Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, IRIX,
22 f6ce2d55 2006-12-25 alex Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
23 f6ce2d55 2006-12-25 alex .PP
24 f6ce2d55 2006-12-25 alex As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
25 f6ce2d55 2006-12-25 alex there are good chances that it also supports other UNIX-based operating
26 2f305331 2007-11-15 fw systems as well. By default, ngIRCd writes diagnostic and informational messages using
27 2f305331 2007-11-15 fw the syslog mechanism.
28 f6ce2d55 2006-12-25 alex .SH OPTIONS
29 f6ce2d55 2006-12-25 alex The default behaviour of
30 f6ce2d55 2006-12-25 alex .BR ngircd
31 f6ce2d55 2006-12-25 alex is to read its standard configuration file (see below), to detach from the
32 f6ce2d55 2006-12-25 alex controlling terminal and to wait for clients.
33 f6ce2d55 2006-12-25 alex .PP
34 f6ce2d55 2006-12-25 alex You can use these options to modify this default:
35 f6ce2d55 2006-12-25 alex .TP
36 f6ce2d55 2006-12-25 alex \fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
37 f6ce2d55 2006-12-25 alex Use
38 f6ce2d55 2006-12-25 alex .I file
39 f6ce2d55 2006-12-25 alex as configuration file.
40 f6ce2d55 2006-12-25 alex .TP
41 f6ce2d55 2006-12-25 alex \fB\-n\fR, \fB\-\-nodaemon\fR
42 f6ce2d55 2006-12-25 alex Don't fork a child and don't detach from controlling terminal.
43 f6ce2d55 2006-12-25 alex All log messages go to the console and you can use CTRL-C to
44 f6ce2d55 2006-12-25 alex terminate the server.
45 f6ce2d55 2006-12-25 alex .TP
46 f6ce2d55 2006-12-25 alex \fB\-p\fR, \fB\-\-passive\fR
47 f6ce2d55 2006-12-25 alex Disable automatic connections to other servers. You can use the IRC command
48 f6ce2d55 2006-12-25 alex CONNECT later on as IRC Operator to link this ngIRCd to other servers.
49 f6ce2d55 2006-12-25 alex .TP
50 f6ce2d55 2006-12-25 alex \fB\-t\fR, \fB\-\-configtest\fR
51 f6ce2d55 2006-12-25 alex Read, validate and display the configuration; then exit.
52 f6ce2d55 2006-12-25 alex .TP
53 818a206a 2008-05-18 alex \fB\-V\fR, \fB\-\-version\fR
54 f6ce2d55 2006-12-25 alex Output version information and exit.
55 f6ce2d55 2006-12-25 alex .TP
56 818a206a 2008-05-18 alex \fB\-h\fR, \fB\-\-help\fR
57 f6ce2d55 2006-12-25 alex Display a brief help text and exit.
58 f6ce2d55 2006-12-25 alex .SH FILES
59 f6ce2d55 2006-12-25 alex .I :ETCDIR:/ngircd.conf
60 f6ce2d55 2006-12-25 alex .RS
61 f6ce2d55 2006-12-25 alex The system wide default configuration file.
62 f6ce2d55 2006-12-25 alex .RE
63 f6ce2d55 2006-12-25 alex .I :ETCDIR:/ngircd.motd
64 f6ce2d55 2006-12-25 alex .RS
65 f6ce2d55 2006-12-25 alex Default "message of the day" (MOTD).
66 f6ce2d55 2006-12-25 alex .RE
67 f6ce2d55 2006-12-25 alex .SH AUTHOR
68 f6ce2d55 2006-12-25 alex Alexander Barton,
69 f6ce2d55 2006-12-25 alex .UR mailto:alex@barton.de
70 f6ce2d55 2006-12-25 alex alex@barton.de
71 f6ce2d55 2006-12-25 alex .UE
72 f6ce2d55 2006-12-25 alex .br
73 f6ce2d55 2006-12-25 alex Homepage:
74 f6ce2d55 2006-12-25 alex .UR http://ngircd.barton.de/
75 f6ce2d55 2006-12-25 alex http://ngircd.barton.de/
76 f6ce2d55 2006-12-25 alex .UE
77 f6ce2d55 2006-12-25 alex .SH "SEE ALSO"
78 f6ce2d55 2006-12-25 alex .BR ngircd.conf (5),
79 f6ce2d55 2006-12-25 alex .BR ircd (8)
80 f6ce2d55 2006-12-25 alex .\"
81 f6ce2d55 2006-12-25 alex .\" -eof-