2002-04-02 18:14:33 +00:00
|
|
|
.\"
|
2008-12-05 23:20:59 +00:00
|
|
|
.\" ngircd(8) manual page template
|
2002-04-02 18:14:33 +00:00
|
|
|
.\"
|
2010-12-01 21:04:01 +00:00
|
|
|
.TH ngircd 8 "Dec 2010" ngircd "ngIRCd Manual"
|
2002-04-02 18:14:33 +00:00
|
|
|
.SH NAME
|
2005-06-04 13:39:20 +00:00
|
|
|
ngIRCd \- the next generation IRC daemon
|
2002-04-02 18:14:33 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B ngircd [
|
|
|
|
|
.I Options
|
|
|
|
|
.B ]
|
|
|
|
|
.SH DESCRIPTION
|
2005-06-04 13:39:20 +00:00
|
|
|
.BR ngIRCd
|
2003-03-09 23:08:24 +00:00
|
|
|
is a free open source daemon for the Internet Relay Chat (IRC),
|
|
|
|
|
developed under the GNU General Public License (GPL).
|
2003-03-10 00:58:06 +00:00
|
|
|
.PP
|
2003-03-09 23:08:24 +00:00
|
|
|
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).
|
2003-03-10 00:58:06 +00:00
|
|
|
.PP
|
2005-06-04 13:39:20 +00:00
|
|
|
Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, IRIX,
|
|
|
|
|
Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
|
2003-03-10 00:58:06 +00:00
|
|
|
.PP
|
2003-03-09 23:08:24 +00:00
|
|
|
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
|
2007-11-15 01:03:29 +00:00
|
|
|
systems as well. By default, ngIRCd writes diagnostic and informational messages using
|
|
|
|
|
the syslog mechanism.
|
2002-04-02 18:14:33 +00:00
|
|
|
.SH OPTIONS
|
2003-03-09 23:08:24 +00:00
|
|
|
The default behaviour of
|
2003-03-10 00:35:51 +00:00
|
|
|
.BR ngircd
|
2003-03-09 23:08:24 +00:00
|
|
|
is to read its standard configuration file (see below), to detach from the
|
|
|
|
|
controlling terminal and to wait for clients.
|
2003-03-10 00:58:06 +00:00
|
|
|
.PP
|
2003-03-09 23:08:24 +00:00
|
|
|
You can use these options to modify this default:
|
2003-03-10 00:58:06 +00:00
|
|
|
.TP
|
|
|
|
|
\fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
|
2003-03-09 23:08:24 +00:00
|
|
|
Use
|
2002-04-02 20:19:22 +00:00
|
|
|
.I file
|
|
|
|
|
as configuration file.
|
2003-03-10 00:58:06 +00:00
|
|
|
.TP
|
|
|
|
|
\fB\-n\fR, \fB\-\-nodaemon\fR
|
2003-03-09 23:08:24 +00:00
|
|
|
Don't fork a child and don't detach from controlling terminal.
|
2005-06-04 13:39:20 +00:00
|
|
|
All log messages go to the console and you can use CTRL-C to
|
|
|
|
|
terminate the server.
|
2003-03-10 00:58:06 +00:00
|
|
|
.TP
|
|
|
|
|
\fB\-p\fR, \fB\-\-passive\fR
|
2003-03-09 23:08:24 +00:00
|
|
|
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.
|
2003-03-10 00:58:06 +00:00
|
|
|
.TP
|
2004-04-05 10:59:10 +00:00
|
|
|
\fB\-t\fR, \fB\-\-configtest\fR
|
|
|
|
|
Read, validate and display the configuration; then exit.
|
|
|
|
|
.TP
|
2008-02-15 19:29:24 +00:00
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
2003-03-09 23:08:24 +00:00
|
|
|
Output version information and exit.
|
2003-03-10 00:58:06 +00:00
|
|
|
.TP
|
2008-02-15 19:29:24 +00:00
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
2003-03-09 23:08:24 +00:00
|
|
|
Display a brief help text and exit.
|
2002-04-02 18:14:33 +00:00
|
|
|
.SH FILES
|
2006-12-25 16:13:26 +00:00
|
|
|
.I :ETCDIR:/ngircd.conf
|
2002-04-02 20:19:22 +00:00
|
|
|
.RS
|
|
|
|
|
The system wide default configuration file.
|
2003-03-09 23:08:24 +00:00
|
|
|
.RE
|
2006-12-25 16:13:26 +00:00
|
|
|
.I :ETCDIR:/ngircd.motd
|
2003-03-09 23:08:24 +00:00
|
|
|
.RS
|
|
|
|
|
Default "message of the day" (MOTD).
|
|
|
|
|
.RE
|
2010-12-01 21:04:28 +00:00
|
|
|
.SH SIGNALS
|
|
|
|
|
The daemon understands the following signals:
|
|
|
|
|
.TP
|
|
|
|
|
\fBTERM\fR
|
|
|
|
|
Shut down all conections and terminate the daemon.
|
|
|
|
|
.TP
|
|
|
|
|
\fBHUP\fR
|
|
|
|
|
Shut down all listening sockets, re-read the configuration file and
|
|
|
|
|
re-initialize the daemon.
|
2008-12-30 18:20:09 +00:00
|
|
|
.SH HINTS
|
|
|
|
|
It's wise to use "ngircd \-\-configtest" to validate the configuration file
|
|
|
|
|
after changing it.
|
2010-12-01 21:04:01 +00:00
|
|
|
.SH AUTHORS
|
|
|
|
|
Alexander Barton, <alex@barton.de>
|
2002-04-02 20:38:50 +00:00
|
|
|
.br
|
2010-12-01 21:04:01 +00:00
|
|
|
Florian Westphal, <fw@strlen.de>
|
|
|
|
|
.PP
|
|
|
|
|
Homepage: http://ngircd.barton.de/
|
2002-04-02 18:14:33 +00:00
|
|
|
.SH "SEE ALSO"
|
2002-09-16 11:11:21 +00:00
|
|
|
.BR ngircd.conf (5),
|
2002-04-02 18:14:33 +00:00
|
|
|
.BR ircd (8)
|
|
|
|
|
.\"
|
|
|
|
|
.\" -eof-
|
