Blame
Date:
Sat Jan 2 13:23:45 2021 UTC
Message:
Update AUTHORS file
001
2006-12-25
alex
.\"
002
2008-12-05
alex
.\" ngircd(8) manual page template
003
2006-12-25
alex
.\"
004
2020-01-01
alex
.TH ngircd 8 "Jan 2021" ngIRCd "ngIRCd Manual"
005
2006-12-25
alex
.SH NAME
006
2012-10-09
alex
ngIRCd \- the "next generation" IRC daemon
007
2006-12-25
alex
.SH SYNOPSIS
008
2012-10-09
alex
.B ngircd
009
2012-10-09
alex
[
010
2006-12-25
alex
.I Options
011
2012-10-09
alex
]
012
2006-12-25
alex
.SH DESCRIPTION
013
2006-12-25
alex
.BR ngIRCd
014
2012-10-09
alex
is a free, portable and lightweight Internet Relay Chat server for small
015
2012-10-09
alex
or private networks, developed under the GNU General Public License (GPL).
016
2006-12-25
alex
.PP
017
2020-05-26
alex
The server is quite easy to configure, can handle dynamic IP addresses, and
018
2020-05-26
alex
optionally supports IDENT, IPv6 connections, SSL-protected links, and PAM for
019
2020-05-26
alex
user authentication as well as character set conversion for legacy clients. The
020
2020-05-26
alex
server has been written from scratch and is not based on the "forefather", the
021
2020-05-26
alex
daemon of the IRCNet.
022
2020-05-26
alex
.PP
023
2012-10-09
alex
The name ngIRCd means
024
2020-05-26
alex
.IR "next-generation IRC daemon",
025
2012-10-09
alex
which is a little bit exaggerated:
026
2012-10-09
alex
.IR "lightweight Internet Relay Chat server"
027
2012-10-09
alex
most probably would have been a better name :-)
028
2006-12-25
alex
.PP
029
2013-07-17
alex
Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, Hurd, IRIX,
030
2013-07-17
alex
Linux, Mac OS X, Minix, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
031
2006-12-25
alex
As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
032
2006-12-25
alex
there are good chances that it also supports other UNIX-based operating
033
2013-07-17
alex
systems as well.
034
2013-07-17
alex
.PP
035
2013-07-17
alex
By default ngIRCd logs diagnostic and informational messages using the syslog
036
2013-07-17
alex
mechanism, or writes directly to the console when running in the foreground
037
2013-07-17
alex
(see below).
038
2006-12-25
alex
.SH OPTIONS
039
2011-06-28
alex
The default behavior of
040
2006-12-25
alex
.BR ngircd
041
2006-12-25
alex
is to read its standard configuration file (see below), to detach from the
042
2006-12-25
alex
controlling terminal and to wait for clients.
043
2006-12-25
alex
.PP
044
2006-12-25
alex
You can use these options to modify this default:
045
2006-12-25
alex
.TP
046
2006-12-25
alex
\fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
047
2006-12-25
alex
Use
048
2006-12-25
alex
.I file
049
2006-12-25
alex
as configuration file.
050
2006-12-25
alex
.TP
051
2006-12-25
alex
\fB\-n\fR, \fB\-\-nodaemon\fR
052
2006-12-25
alex
Don't fork a child and don't detach from controlling terminal.
053
2006-12-25
alex
All log messages go to the console and you can use CTRL-C to
054
2006-12-25
alex
terminate the server.
055
2006-12-25
alex
.TP
056
2006-12-25
alex
\fB\-p\fR, \fB\-\-passive\fR
057
2006-12-25
alex
Disable automatic connections to other servers. You can use the IRC command
058
2006-12-25
alex
CONNECT later on as IRC Operator to link this ngIRCd to other servers.
059
2006-12-25
alex
.TP
060
2006-12-25
alex
\fB\-t\fR, \fB\-\-configtest\fR
061
2006-12-25
alex
Read, validate and display the configuration; then exit.
062
2006-12-25
alex
.TP
063
2008-05-18
alex
\fB\-V\fR, \fB\-\-version\fR
064
2006-12-25
alex
Output version information and exit.
065
2006-12-25
alex
.TP
066
2008-05-18
alex
\fB\-h\fR, \fB\-\-help\fR
067
2006-12-25
alex
Display a brief help text and exit.
068
2006-12-25
alex
.SH FILES
069
2006-12-25
alex
.I :ETCDIR:/ngircd.conf
070
2006-12-25
alex
.RS
071
2006-12-25
alex
The system wide default configuration file.
072
2006-12-25
alex
.RE
073
2006-12-25
alex
.I :ETCDIR:/ngircd.motd
074
2006-12-25
alex
.RS
075
2006-12-25
alex
Default "message of the day" (MOTD).
076
2006-12-25
alex
.RE
077
2010-12-01
alex
.SH SIGNALS
078
2010-12-01
alex
The daemon understands the following signals:
079
2010-12-01
alex
.TP
080
2010-12-01
alex
\fBTERM\fR
081
2011-06-28
alex
Shut down all connections and terminate the daemon.
082
2010-12-01
alex
.TP
083
2010-12-01
alex
\fBHUP\fR
084
2010-12-01
alex
Shut down all listening sockets, re-read the configuration file and
085
2010-12-01
alex
re-initialize the daemon.
086
2009-12-30
alex
.SH HINTS
087
2009-12-30
alex
It's wise to use "ngircd \-\-configtest" to validate the configuration file
088
2009-12-30
alex
after changing it.
089
2011-06-28
alex
.SH DEBUGGING
090
2011-06-28
alex
When ngIRCd is compiled with debug code, that is, its source code has
091
2012-03-12
alex
been ./configure'd with "\-\-enable\-debug" and/or "\-\-enable\-sniffer" (witch
092
2011-06-28
alex
enables debug mode automatically as well), you can use two more command
093
2011-06-28
alex
line options and two more signals to debug problems with the daemon itself
094
2011-06-28
alex
or IRC clients:
095
2011-06-28
alex
.PP
096
2011-06-28
alex
\fBOptions:\fR
097
2011-06-28
alex
.TP
098
2011-06-28
alex
\fB\-d\fR, \fB\-\-debug\fR
099
2011-06-28
alex
Enable debug mode and log extra messages.
100
2011-06-28
alex
.TP
101
2011-06-28
alex
\fB\-s\fR, \fB\-\-sniffer\fR
102
2011-06-28
alex
Enable IRC protocol sniffer, which logs all sent and received IRC commands to
103
2011-06-28
alex
the console/syslog. This option requires that ngIRCd has been ./configure'd
104
2012-03-12
alex
with "\-\-enable\-sniffer" and enables debug mode automatically, too.
105
2011-06-28
alex
.PP
106
2011-06-28
alex
\fBSignals:\fR
107
2011-06-28
alex
.TP
108
2011-06-28
alex
\fBUSR1\fR
109
2011-06-28
alex
Toggle debug mode on and off during runtime.
110
2011-06-28
alex
.TP
111
2011-06-28
alex
\fBUSR2\fR
112
2011-06-28
alex
Dump internal server state to the console/syslog when debug mode is on (use
113
2011-06-28
alex
command line option \-\-debug or signal USR1).
114
2010-12-01
alex
.SH AUTHORS
115
2010-12-01
alex
Alexander Barton, <alex@barton.de>
116
2006-12-25
alex
.br
117
2010-12-01
alex
Florian Westphal, <fw@strlen.de>
118
2010-12-01
alex
.PP
119
2010-12-01
alex
Homepage: http://ngircd.barton.de/
120
2006-12-25
alex
.SH "SEE ALSO"
121
2006-12-25
alex
.BR ngircd.conf (5),
122
2006-12-25
alex
.BR ircd (8)
123
2006-12-25
alex
.\"
124
2006-12-25
alex
.\" -eof-
IRCNow