ngircd(8)

1ngircd(8)                        ngIRCd Manual                       ngircd(8)
2
3
4

NAME

6       ngIRCd - the "next generation" IRC daemon
7

SYNOPSIS

9       ngircd [ Options ]
10

DESCRIPTION

12       ngIRCd  is  a free, portable and lightweight Internet Relay Chat server
13       for small or private networks, developed under the GNU  General  Public
14       License  (GPL).   It  is  easy  to  configure, can cope with dynamic IP
15       addresses, and supports IPv6, SSL-protected connections as well as  PAM
16       for  authentication.   It  is written from scratch and not based on the
17       original IRCd.
18
19       The name ngIRCd means next generation IRC daemon, which is a little bit
20       exaggerated: lightweight Internet Relay Chat server most probably would
21       have been a better name :-)
22
23       Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX,  Hurd,
24       IRIX,  Linux,  Mac  OS  X, Minix, NetBSD, OpenBSD, Solaris, and Windows
25       with Cygwin.  As ngIRCd relies on UNIX standards and uses GNU  automake
26       and  GNU  autoconf  there  are good chances that it also supports other
27       UNIX-based operating systems as well.
28
29       By default ngIRCd logs diagnostic and informational messages using  the
30       syslog mechanism, or writes directly to the console when running in the
31       foreground (see below).
32

OPTIONS

34       The default behavior of ngircd is to read  its  standard  configuration
35       file  (see  below), to detach from the controlling terminal and to wait
36       for clients.
37
38       You can use these options to modify this default:
39
40       -f file, --config file
41              Use file as configuration file.
42
43       -n, --nodaemon
44              Don't fork a child and don't detach from  controlling  terminal.
45              All  log  messages  go  to the console and you can use CTRL-C to
46              terminate the server.
47
48       -p, --passive
49              Disable automatic connections to other servers. You can use  the
50              IRC command CONNECT later on as IRC Operator to link this ngIRCd
51              to other servers.
52
53       -t, --configtest
54              Read, validate and display the configuration; then exit.
55
56       -V, --version
57              Output version information and exit.
58
59       -h, --help
60              Display a brief help text and exit.
61

FILES

63       /etc/ngircd.conf
64              The system wide default configuration file.
65       /etc/ngircd.motd
66              Default "message of the day" (MOTD).
67

SIGNALS

69       The daemon understands the following signals:
70
71       TERM   Shut down all connections and terminate the daemon.
72
73       HUP    Shut down all listening sockets, re-read the configuration  file
74              and re-initialize the daemon.
75

HINTS

77       It's  wise  to  use "ngircd --configtest" to validate the configuration
78       file after changing it.
79

DEBUGGING

81       When ngIRCd is compiled with debug code, that is, its source  code  has
82       been  ./configure'd  with  "--enable-debug"  and/or  "--enable-sniffer"
83       (witch enables debug mode automatically as well), you can use two  more
84       command  line  options  and two more signals to debug problems with the
85       daemon itself or IRC clients:
86
87       Options:
88
89       -d, --debug
90              Enable debug mode and log extra messages.
91
92       -s, --sniffer
93              Enable IRC protocol sniffer, which logs all  sent  and  received
94              IRC  commands  to  the console/syslog. This option requires that
95              ngIRCd  has  been  ./configure'd  with  "--enable-sniffer"   and
96              enables debug mode automatically, too.
97
98       Signals:
99
100       USR1   Toggle debug mode on and off during runtime.
101
102       USR2   Dump internal server state to the console/syslog when debug mode
103              is on (use command line option --debug or signal USR1).
104

AUTHORS

106       Alexander Barton, <alex@barton.de>
107       Florian Westphal, <fw@strlen.de>
108
109       Homepage: http://ngircd.barton.de/
110