man/ngircd.8.tmpl

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