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 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, macOS, 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\-y\fR, \fB\-\-syslog\fR
  61 Write log messages to the syslog even when running in the foreground. This only
  62 makes sense when
  63 .I \-n/\-\-nodaemon
  64 was given on the command line
  65 .I before
  66 this option!
  67 .PP
  68 The following options prevent ngIRCd from starting regularly, but perform a
  69 specific action and then exit the daemon again:
  70 .TP
  71 \fB\-h\fR, \fB\-\-help\fR
  72 Display a brief help text and exit.
  73 .TP
  74 \fB\-t\fR, \fB\-\-configtest\fR
  75 Read, validate and display the configuration; then exit.
  76 .TP
  77 \fB\-V\fR, \fB\-\-version\fR
  78 Output version information and exit.
  79 .SH FILES
  80 .I :ETCDIR:/ngircd.conf
  81 .RS
  82 The system wide default configuration file.
  83 .RE
  84 .I :ETCDIR:/ngircd.motd
  85 .RS
  86 Default "message of the day" (MOTD).
  87 .RE
  88 .SH SIGNALS
  89 The daemon understands the following signals:
  90 .TP
  91 \fBTERM\fR
  92 Shut down all connections and terminate the daemon.
  93 .TP
  94 \fBHUP\fR
  95 Shut down all listening sockets, re-read the configuration file and
  96 re-initialize the daemon.
  97 .SH HINTS
  98 It is
  99 .I always wise
 100 to use "ngircd \-\-configtest" to validate the configuration of ngIRCd after
 101 making changes to the configuration files!
 102 .SH DEBUGGING
 103 When ngIRCd is compiled with debug code, that is, its source code has
 104 been ./configure'd with "\-\-enable\-debug" and/or "\-\-enable\-sniffer" (witch
 105 enables debug mode automatically as well), you can use two more command
 106 line options and two more signals to debug problems with the daemon itself
 107 or IRC clients:
 108 .PP
 109 \fBOptions:\fR
 110 .TP
 111 \fB\-d\fR, \fB\-\-debug\fR
 112 Enable debug mode and log extra messages.
 113 .TP
 114 \fB\-s\fR, \fB\-\-sniffer\fR
 115 Enable IRC protocol sniffer, which logs all sent and received IRC commands to
 116 the console/syslog. This option requires that ngIRCd has been ./configure'd
 117 with "\-\-enable\-sniffer" and enables debug mode automatically, too.
 118 .PP
 119 \fBSignals:\fR
 120 .TP
 121 \fBUSR1\fR
 122 Toggle debug mode on and off during runtime.
 123 .TP
 124 \fBUSR2\fR
 125 Dump internal server state to the console/syslog when debug mode is on (use
 126 command line option \-\-debug or signal USR1).
 127 .SH AUTHORS
 128 Alexander Barton, <alex@barton.de>
 129 .br
 130 Florian Westphal, <fw@strlen.de>
 131 .PP
 132 Homepage: http://ngircd.barton.de/
 133 .SH "SEE ALSO"
 134 .BR ngircd.conf (5),
 135 .BR ircd (8)
 136 .\"
 137 .\" -eof-