New configuration option "IdleTimeout": exit daemon when idle
[ngircd-alex.git] / man / ngircd.8.tmpl
1 .\"
2 .\" ngircd(8) manual page template
3 .\"
4 .TH ngircd 8 "Oct 2012" ngIRCd "ngIRCd Manual"
5 .SH NAME
6 ngIRCd \- the "next generation" IRC daemon
7 .SH SYNOPSIS
8 .B ngircd
9 [
10 .I Options
11 ]
12 .SH DESCRIPTION
13 .BR ngIRCd
14 is a free, portable and lightweight Internet Relay Chat server for small
15 or private networks, developed under the GNU General Public License (GPL).
16 It is easy to configure, can cope with dynamic IP addresses, and supports
17 IPv6, SSL-protected connections as well as PAM for authentication.
18 It is written from scratch and not based on the original IRCd.
19 .PP
20 The name ngIRCd means
21 .IR "next generation IRC daemon",
22 which is a little bit exaggerated:
23 .IR "lightweight Internet Relay Chat server"
24 most probably would have been a better name :-)
25 .PP
26 Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, IRIX,
27 Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
28 .PP
29 As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
30 there are good chances that it also supports other UNIX-based operating
31 systems as well. By default, ngIRCd writes diagnostic and informational
32 messages using the syslog mechanism.
33 .SH OPTIONS
34 The default behavior of
35 .BR ngircd
36 is to read its standard configuration file (see below), to detach from the
37 controlling terminal and to wait for clients.
38 .PP
39 You can use these options to modify this default:
40 .TP
41 \fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
42 Use
43 .I file
44 as configuration file.
45 .TP
46 \fB\-n\fR, \fB\-\-nodaemon\fR
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 .TP
51 \fB\-p\fR, \fB\-\-passive\fR
52 Disable automatic connections to other servers. You can use the IRC command
53 CONNECT later on as IRC Operator to link this ngIRCd to other servers.
54 .TP
55 \fB\-t\fR, \fB\-\-configtest\fR
56 Read, validate and display the configuration; then exit.
57 .TP
58 \fB\-V\fR, \fB\-\-version\fR
59 Output version information and exit.
60 .TP
61 \fB\-h\fR, \fB\-\-help\fR
62 Display a brief help text and exit.
63 .SH FILES
64 .I :ETCDIR:/ngircd.conf
65 .RS
66 The system wide default configuration file.
67 .RE
68 .I :ETCDIR:/ngircd.motd
69 .RS
70 Default "message of the day" (MOTD).
71 .RE
72 .SH SIGNALS
73 The daemon understands the following signals:
74 .TP
75 \fBTERM\fR
76 Shut down all connections and terminate the daemon.
77 .TP
78 \fBHUP\fR
79 Shut down all listening sockets, re-read the configuration file and
80 re-initialize the daemon.
81 .SH HINTS
82 It's wise to use "ngircd \-\-configtest" to validate the configuration file
83 after changing it.
84 .SH DEBUGGING
85 When ngIRCd is compiled with debug code, that is, its source code has
86 been ./configure'd with "\-\-enable\-debug" and/or "\-\-enable\-sniffer" (witch
87 enables debug mode automatically as well), you can use two more command
88 line options and two more signals to debug problems with the daemon itself
89 or IRC clients:
90 .PP
91 \fBOptions:\fR
92 .TP
93 \fB\-d\fR, \fB\-\-debug\fR
94 Enable debug mode and log extra messages.
95 .TP
96 \fB\-s\fR, \fB\-\-sniffer\fR
97 Enable IRC protocol sniffer, which logs all sent and received IRC commands to
98 the console/syslog. This option requires that ngIRCd has been ./configure'd
99 with "\-\-enable\-sniffer" and enables debug mode automatically, too.
100 .PP
101 \fBSignals:\fR
102 .TP
103 \fBUSR1\fR
104 Toggle debug mode on and off during runtime.
105 .TP
106 \fBUSR2\fR
107 Dump internal server state to the console/syslog when debug mode is on (use
108 command line option \-\-debug or signal USR1).
109 .SH AUTHORS
110 Alexander Barton, <alex@barton.de>
111 .br
112 Florian Westphal, <fw@strlen.de>
113 .PP
114 Homepage: http://ngircd.barton.de/
115 .SH "SEE ALSO"
116 .BR ngircd.conf (5),
117 .BR ircd (8)
118 .\"
119 .\" -eof-