2 <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
4 <meta charset="utf-8" />
5 <meta name="generator" content="pandoc" />
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
11 font-family: Georgia, serif;
14 background-color: #fdfdfd;
24 overflow-wrap: break-word;
25 text-rendering: optimizeLegibility;
28 @media (max-width: 600px) {
39 background-color: transparent;
48 page-break-after: avoid;
63 h1, h2, h3, h4, h5, h6 {
81 margin: 1em 0 1em 1.7em;
83 border-left: 2px solid #e6e6e6;
87 font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
98 overflow-wrap: normal;
101 background-color: transparent;
105 background-color: #1a1a1a;
112 border-collapse: collapse;
116 font-variant-numeric: lining-nums tabular-nums;
119 margin-bottom: 0.75em;
123 border-top: 1px solid #1a1a1a;
124 border-bottom: 1px solid #1a1a1a;
127 border-top: 1px solid #1a1a1a;
128 padding: 0.25em 0.5em 0.25em 0.5em;
131 padding: 0.125em 0.5em 0.25em 0.5em;
147 text-decoration: none;
149 code{white-space: pre-wrap;}
150 span.smallcaps{font-variant: small-caps;}
151 span.underline{text-decoration: underline;}
152 div.column{display: inline-block; vertical-align: top; width: 50%;}
153 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
154 ul.task-list{list-style: none;}
155 .display.math{display: block; text-align: center; margin: 0.5rem auto;}
159 <header id="title-block-header">
160 <h1 class="title">ngircd</h1>
161 <p class="date">Sep 2023</p>
164 <p>ngIRCd - the "next generation" IRC daemon</p>
166 <p><strong>ngircd</strong> [ <em>Options</em> ]</p>
168 <p><strong>ngIRCd</strong> is a free, portable and lightweight Internet
169 Relay Chat (IRC) server for small or private networks, developed under
170 the GNU General Public License (GPL).</p>
171 <p>The server is quite easy to configure and runs as a single-node
172 server or can be part of a network of ngIRCd servers in a LAN or across
173 the internet. It optionally supports the IPv6 protocol,
174 SSL/TLS-protected client-server and server-server links, the Pluggable
175 Authentication Modules (PAM) system for user authentication, IDENT
176 requests, and character set conversion for legacy clients.</p>
177 <p>The name ngIRCd stands for <em>next-generation IRC daemon</em>, which
178 is a little bit exaggerated: <em>lightweight Internet Relay Chat
179 server</em> most probably would have been a better name :-)</p>
180 <p>By default ngIRCd logs diagnostic and informational messages using
181 the syslog mechanism, or writes directly to the console when running in
182 the foreground (see below).</p>
184 <p>The default behavior of <strong>ngircd</strong> is to read its
185 standard configuration file (see below), to detach from the controlling
186 terminal and to wait for clients.</p>
187 <p>You can use these options to modify this default:</p>
189 <dt><strong>-f</strong> <em>file</em>, <strong>--config</strong>
192 <p>Use <em>file</em> as configuration file.</p>
194 <dt><strong>-n</strong>, <strong>--nodaemon</strong></dt>
196 <p>Don't fork a child and don't detach from controlling terminal. All
197 log messages go to the console and you can use CTRL-C to terminate the
200 <dt><strong>-p</strong>, <strong>--passive</strong></dt>
202 <p>Disable automatic connections to other servers. You can use the IRC
203 command CONNECT later on as IRC Operator to link this ngIRCd to other
206 <dt><strong>-y</strong>, <strong>--syslog</strong></dt>
208 <p>Write log messages to the syslog even when running in the foreground.
209 This only makes sense when <em>-n/--nodaemon</em> was given on the
210 command line <em>before</em> this option!</p>
213 <p>The following options prevent ngIRCd from starting regularly, but
214 perform a specific action and then exit the daemon again:</p>
216 <dt><strong>-h</strong>, <strong>--help</strong></dt>
218 <p>Display a brief help text and exit.</p>
220 <dt><strong>-t</strong>, <strong>--configtest</strong></dt>
222 <p>Read, validate and display the configuration; then exit.</p>
224 <dt><strong>-V</strong>, <strong>--version</strong></dt>
226 <p>Output version information and exit.</p>
230 <p><em>/usr/local/etc/ngircd.conf</em></p>
232 <p>The system wide default configuration file.</p>
234 <p><em>/usr/local/etc/ngircd.motd</em></p>
236 <p>Default "message of the day" (MOTD).</p>
239 <p>The daemon understands the following signals:</p>
241 <dt><strong>TERM</strong></dt>
243 <p>Shut down all connections and terminate the daemon.</p>
245 <dt><strong>HUP</strong></dt>
247 <p>Shut down all listening sockets, re-read the configuration file and
248 re-initialize the daemon.</p>
252 <p>It is <em>always wise</em> to use "ngircd --configtest" to validate
253 the configuration of ngIRCd after making changes to the configuration
256 <p>When ngIRCd is compiled with debug code, that is, its source code has
257 been ./configure'd with "--enable-debug" and/or "--enable-sniffer"
258 (witch enables debug mode automatically as well), you can use two more
259 command line options and two more signals to debug problems with the
260 daemon itself or IRC clients:</p>
261 <p><strong>Options:</strong></p>
263 <dt><strong>-d</strong>, <strong>--debug</strong></dt>
265 <p>Enable debug mode and log extra messages.</p>
267 <dt><strong>-s</strong>, <strong>--sniffer</strong></dt>
269 <p>Enable IRC protocol sniffer, which logs all sent and received IRC
270 commands to the console/syslog. This option requires that ngIRCd has
271 been ./configure'd with "--enable-sniffer" and enables debug mode
272 automatically, too.</p>
275 <p><strong>Signals:</strong></p>
277 <dt><strong>USR1</strong></dt>
279 <p>Toggle debug mode on and off during runtime.</p>
281 <dt><strong>USR2</strong></dt>
283 <p>Dump internal server state to the console/syslog when debug mode is
284 on (use command line option --debug or signal USR1).</p>
288 <p>Alexander Barton, <alex@barton.de><br />
289 Florian Westphal, <fw@strlen.de></p>
290 <p>Homepage: http://ngircd.barton.de/</p>
292 <p><strong>ngircd.conf</strong>(5), <strong>ircd</strong>(8)</p>