man/ngircd.8.tmpl

   1 .\"
   2 .\" ngircd(8) manual page template
   3 .\"
   4 .TH ngircd 8 "Sep 2023" 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 (IRC) 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 and runs as a single-node server or can
  18 be part of a network of ngIRCd servers in a LAN or across the internet. It
  19 optionally supports the IPv6 protocol, SSL/TLS-protected client-server and
  20 server-server links, the Pluggable Authentication Modules (PAM) system for user
  21 authentication, IDENT requests, and character set conversion for legacy
  22 clients.
  23 .PP
  24 The name ngIRCd stands for
  25 .IR "next-generation IRC daemon",
  26 which is a little bit exaggerated:
  27 .IR "lightweight Internet Relay Chat server"
  28 most probably would have been a better name :-)
  29 .PP
  30 By default ngIRCd logs diagnostic and informational messages using the syslog
  31 mechanism, or writes directly to the console when running in the foreground
  32 (see below).
  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\-y\fR, \fB\-\-syslog\fR
  56 Write log messages to the syslog even when running in the foreground. This only
  57 makes sense when
  58 .I \-n/\-\-nodaemon
  59 was given on the command line
  60 .I before
  61 this option!
  62 .PP
  63 The following options prevent ngIRCd from starting regularly, but perform a
  64 specific action and then exit the daemon again:
  65 .TP
  66 \fB\-h\fR, \fB\-\-help\fR
  67 Display a brief help text and exit.
  68 .TP
  69 \fB\-t\fR, \fB\-\-configtest\fR
  70 Read, validate and display the configuration; then exit.
  71 .TP
  72 \fB\-V\fR, \fB\-\-version\fR
  73 Output version information and exit.
  74 .SH FILES
  75 .I :ETCDIR:/ngircd.conf
  76 .RS
  77 The system wide default configuration file.
  78 .RE
  79 .I :ETCDIR:/ngircd.motd
  80 .RS
  81 Default "message of the day" (MOTD).
  82 .RE
  83 .SH SIGNALS
  84 The daemon understands the following signals:
  85 .TP
  86 \fBTERM\fR
  87 Shut down all connections and terminate the daemon.
  88 .TP
  89 \fBHUP\fR
  90 Shut down all listening sockets, re-read the configuration file and
  91 re-initialize the daemon.
  92 .SH HINTS
  93 It is
  94 .I always wise
  95 to use "ngircd \-\-configtest" to validate the configuration of ngIRCd after
  96 making changes to the configuration files!
  97 .SH DEBUGGING
  98 ngIRCd can log additional debug messages, which can be enabled with the command
  99 line option \-\-debug (\-d) or by sending the USR1 signal to the running daemon.
 100 Some of those messages may leak personal information, be very technical and can
 101 be very verbose. Therefore the debug mode is meant for troubleshooting only and
 102 should definitely be disabled during normal operation!
 103 .PP
 104 In addition, a "protocol sniffer" can be enabled on build time by passing the
 105 "\-\-enable\-sniffer" option to the ./configure script which enables the
 106 "\-\-sniffer" (\-s) command line option (which is not available by default):
 107 this "sniffer" logs all incoming and outgoing IRC commands on all connections,
 108 which can be handy to debug problems with the daemon itself or IRC clients.
 109 .PP
 110 Both modes are indicated in the version string shown by the IRC "VERSION"
 111 command: if the version ends in a dot (like in "26.1."), the daemon operates in
 112 "normal" mode (the version used in the example is "26.1"). If it ends in ".1"
 113 (like in "26.1.1") the "debug-mode" is enabled; and if it ends in ".2" (like in
 114 "26.1.2") the "IRC sniffer" is enabled, too.
 115 .PP
 116 \fBOptions:\fR
 117 .TP
 118 \fB\-d\fR, \fB\-\-debug\fR
 119 Enable debug mode and log extra messages.
 120 .TP
 121 \fB\-s\fR, \fB\-\-sniffer\fR
 122 Enable IRC protocol sniffer, which logs all sent and received IRC commands to
 123 the console/syslog. This option requires that ngIRCd has been ./configure'd
 124 with "\-\-enable\-sniffer" and enables debug mode automatically, too.
 125 .PP
 126 \fBSignals:\fR
 127 .PP
 128 Note: Usage of these signals is broadcasted to all users with the +s ("receive
 129 server notices") mode set!
 130 .TP
 131 \fBUSR1\fR
 132 Toggle debug mode on and off during runtime.
 133 .TP
 134 \fBUSR2\fR
 135 Dump internal server state to the console/syslog when debug mode is on (use
 136 command line option \-\-debug or signal USR1).
 137 .SH AUTHORS
 138 Alexander Barton, <alex@barton.de>
 139 .br
 140 Florian Westphal, <fw@strlen.de>
 141 .PP
 142 Homepage: http://ngircd.barton.de/
 143 .SH "SEE ALSO"
 144 .BR ngircd.conf (5),
 145 .BR ircd (8)
 146 .\"
 147 .\" -eof-