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