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).
15
16       The server is quite easy to configure, can handle dynamic IP addresses,
17       and optionally supports IDENT, IPv6 connections,  SSL-protected  links,
18       and PAM for user authentication as well as character set conversion for
19       legacy clients. The server has been written from  scratch  and  is  not
20       based on the "forefather", the daemon of the IRCNet.
21
22       The name ngIRCd means next-generation IRC daemon, which is a little bit
23       exaggerated: lightweight Internet Relay Chat server most probably would
24       have been a better name :-)
25
26       Currently  supported platforms include AIX, A/UX, FreeBSD, HP-UX, Hurd,
27       IRIX, Linux, Mac OS X, Minix, NetBSD,  OpenBSD,  Solaris,  and  Windows
28       with  Cygwin.  As ngIRCd relies on UNIX standards and uses GNU automake
29       and GNU autoconf there are good chances that  it  also  supports  other
30       UNIX-based operating systems as well.
31
32       By  default ngIRCd logs diagnostic and informational messages using the
33       syslog mechanism, or writes directly to the console when running in the
34       foreground (see below).
35

OPTIONS

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

FILES

66       /etc/ngircd.conf
67              The system wide default configuration file.
68       /etc/ngircd.motd
69              Default "message of the day" (MOTD).
70

SIGNALS

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

HINTS

80       It's wise to use "ngircd --configtest" to  validate  the  configuration
81       file after changing it.
82

DEBUGGING

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

AUTHORS

109       Alexander Barton, <alex@barton.de>
110       Florian Westphal, <fw@strlen.de>
111
112       Homepage: http://ngircd.barton.de/
113

SEE ALSO

115       ngircd.conf(5), ircd(8)
116
117
118
119ngIRCd                             May 2020                          ngircd(8)
Impressum