man/ngircd.8.html

   1 <!DOCTYPE html>
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
   3 <head>
   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" />
   7   <title>ngircd</title>
   8   <style>
   9     html {
  10       line-height: 1.5;
  11       font-family: Georgia, serif;
  12       font-size: 20px;
  13       color: #1a1a1a;
  14       background-color: #fdfdfd;
  15     }
  16     body {
  17       margin: 0 auto;
  18       max-width: 36em;
  19       padding-left: 50px;
  20       padding-right: 50px;
  21       padding-top: 50px;
  22       padding-bottom: 50px;
  23       hyphens: auto;
  24       overflow-wrap: break-word;
  25       text-rendering: optimizeLegibility;
  26       font-kerning: normal;
  27     }
  28     @media (max-width: 600px) {
  29       body {
  30         font-size: 0.9em;
  31         padding: 1em;
  32       }
  33       h1 {
  34         font-size: 1.8em;
  35       }
  36     }
  37     @media print {
  38       body {
  39         background-color: transparent;
  40         color: black;
  41         font-size: 12pt;
  42       }
  43       p, h2, h3 {
  44         orphans: 3;
  45         widows: 3;
  46       }
  47       h2, h3, h4 {
  48         page-break-after: avoid;
  49       }
  50     }
  51     p {
  52       margin: 1em 0;
  53     }
  54     a {
  55       color: #1a1a1a;
  56     }
  57     a:visited {
  58       color: #1a1a1a;
  59     }
  60     img {
  61       max-width: 100%;
  62     }
  63     h1, h2, h3, h4, h5, h6 {
  64       margin-top: 1.4em;
  65     }
  66     h5, h6 {
  67       font-size: 1em;
  68       font-style: italic;
  69     }
  70     h6 {
  71       font-weight: normal;
  72     }
  73     ol, ul {
  74       padding-left: 1.7em;
  75       margin-top: 1em;
  76     }
  77     li > ol, li > ul {
  78       margin-top: 0;
  79     }
  80     blockquote {
  81       margin: 1em 0 1em 1.7em;
  82       padding-left: 1em;
  83       border-left: 2px solid #e6e6e6;
  84       color: #606060;
  85     }
  86     code {
  87       font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
  88       font-size: 85%;
  89       margin: 0;
  90     }
  91     pre {
  92       margin: 1em 0;
  93       overflow: auto;
  94     }
  95     pre code {
  96       padding: 0;
  97       overflow: visible;
  98       overflow-wrap: normal;
  99     }
 100     .sourceCode {
 101      background-color: transparent;
 102      overflow: visible;
 103     }
 104     hr {
 105       background-color: #1a1a1a;
 106       border: none;
 107       height: 1px;
 108       margin: 1em 0;
 109     }
 110     table {
 111       margin: 1em 0;
 112       border-collapse: collapse;
 113       width: 100%;
 114       overflow-x: auto;
 115       display: block;
 116       font-variant-numeric: lining-nums tabular-nums;
 117     }
 118     table caption {
 119       margin-bottom: 0.75em;
 120     }
 121     tbody {
 122       margin-top: 0.5em;
 123       border-top: 1px solid #1a1a1a;
 124       border-bottom: 1px solid #1a1a1a;
 125     }
 126     th {
 127       border-top: 1px solid #1a1a1a;
 128       padding: 0.25em 0.5em 0.25em 0.5em;
 129     }
 130     td {
 131       padding: 0.125em 0.5em 0.25em 0.5em;
 132     }
 133     header {
 134       margin-bottom: 4em;
 135       text-align: center;
 136     }
 137     #TOC li {
 138       list-style: none;
 139     }
 140     #TOC ul {
 141       padding-left: 1.3em;
 142     }
 143     #TOC > ul {
 144       padding-left: 0;
 145     }
 146     #TOC a:not(:hover) {
 147       text-decoration: none;
 148     }
 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;}
 156   </style>
 157 </head>
 158 <body>
 159 <header id="title-block-header">
 160 <h1 class="title">ngircd</h1>
 161 <p class="date">Sep 2023</p>
 162 </header>
 163 <h1>NAME</h1>
 164 <p>ngIRCd - the "next generation" IRC daemon</p>
 165 <h1>SYNOPSIS</h1>
 166 <p><strong>ngircd</strong> [ <em>Options</em> ]</p>
 167 <h1>DESCRIPTION</h1>
 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>
 183 <h1>OPTIONS</h1>
 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>
 188 <dl>
 189 <dt><strong>-f</strong> <em>file</em>, <strong>--config</strong>
 190 <em>file</em></dt>
 191 <dd>
 192 <p>Use <em>file</em> as configuration file.</p>
 193 </dd>
 194 <dt><strong>-n</strong>, <strong>--nodaemon</strong></dt>
 195 <dd>
 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
 198 server.</p>
 199 </dd>
 200 <dt><strong>-p</strong>, <strong>--passive</strong></dt>
 201 <dd>
 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
 204 servers.</p>
 205 </dd>
 206 <dt><strong>-y</strong>, <strong>--syslog</strong></dt>
 207 <dd>
 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>
 211 </dd>
 212 </dl>
 213 <p>The following options prevent ngIRCd from starting regularly, but
 214 perform a specific action and then exit the daemon again:</p>
 215 <dl>
 216 <dt><strong>-h</strong>, <strong>--help</strong></dt>
 217 <dd>
 218 <p>Display a brief help text and exit.</p>
 219 </dd>
 220 <dt><strong>-t</strong>, <strong>--configtest</strong></dt>
 221 <dd>
 222 <p>Read, validate and display the configuration; then exit.</p>
 223 </dd>
 224 <dt><strong>-V</strong>, <strong>--version</strong></dt>
 225 <dd>
 226 <p>Output version information and exit.</p>
 227 </dd>
 228 </dl>
 229 <h1>FILES</h1>
 230 <p><em>/usr/local/etc/ngircd.conf</em></p>
 231 <blockquote>
 232 <p>The system wide default configuration file.</p>
 233 </blockquote>
 234 <p><em>/usr/local/etc/ngircd.motd</em></p>
 235 <blockquote>
 236 <p>Default "message of the day" (MOTD).</p>
 237 </blockquote>
 238 <h1>SIGNALS</h1>
 239 <p>The daemon understands the following signals:</p>
 240 <dl>
 241 <dt><strong>TERM</strong></dt>
 242 <dd>
 243 <p>Shut down all connections and terminate the daemon.</p>
 244 </dd>
 245 <dt><strong>HUP</strong></dt>
 246 <dd>
 247 <p>Shut down all listening sockets, re-read the configuration file and
 248 re-initialize the daemon.</p>
 249 </dd>
 250 </dl>
 251 <h1>HINTS</h1>
 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
 254 files!</p>
 255 <h1>DEBUGGING</h1>
 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>
 262 <dl>
 263 <dt><strong>-d</strong>, <strong>--debug</strong></dt>
 264 <dd>
 265 <p>Enable debug mode and log extra messages.</p>
 266 </dd>
 267 <dt><strong>-s</strong>, <strong>--sniffer</strong></dt>
 268 <dd>
 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>
 273 </dd>
 274 </dl>
 275 <p><strong>Signals:</strong></p>
 276 <dl>
 277 <dt><strong>USR1</strong></dt>
 278 <dd>
 279 <p>Toggle debug mode on and off during runtime.</p>
 280 </dd>
 281 <dt><strong>USR2</strong></dt>
 282 <dd>
 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>
 285 </dd>
 286 </dl>
 287 <h1>AUTHORS</h1>
 288 <p>Alexander Barton, &lt;alex@barton.de&gt;<br />
 289 Florian Westphal, &lt;fw@strlen.de&gt;</p>
 290 <p>Homepage: http://ngircd.barton.de/</p>
 291 <h1>SEE ALSO</h1>
 292 <p><strong>ngircd.conf</strong>(5), <strong>ircd</strong>(8)</p>
 293 </body>
 294 </html>