Update timestamp of ngircd(8) manual page

[ngircd-alex.git] / man / ngircd.8.tmpl

diff --git a/man/ngircd.8.tmpl b/man/ngircd.8.tmpl
index f874aa0bfa3599b1d45a2d5a7eceeffd2ddbe07b..cc2498d9669e07e4c16eae41350074f0d81722b5 100644 (file)
--- a/man/ngircd.8.tmpl
+++ b/man/ngircd.8.tmpl
@@ -1,7 +1,7 @@
 .\"
-.\" $Id: ngircd.8.tmpl,v 1.1 2006/12/25 16:13:26 alex Exp $
+.\" ngircd(8) manual page template
 .\"
-.TH ngircd 8 "August 2005" ngircd "ngIRCd Manual"
+.TH ngircd 8 "Jul 2011" ngircd "ngIRCd Manual"
 .SH NAME
 ngIRCd \- the next generation IRC daemon
 .SH SYNOPSIS
@@ -23,9 +23,10 @@ Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
 .PP
 As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
 there are good chances that it also supports other UNIX-based operating
-systems as well.
+systems as well. By default, ngIRCd writes diagnostic and informational messages using
+the syslog mechanism.
 .SH OPTIONS
-The default behaviour of
+The default behavior of
 .BR ngircd
 is to read its standard configuration file (see below), to detach from the
 controlling terminal and to wait for clients.
@@ -49,10 +50,10 @@ CONNECT later on as IRC Operator to link this ngIRCd to other servers.
 \fB\-t\fR, \fB\-\-configtest\fR
 Read, validate and display the configuration; then exit.
 .TP
-\fB\-\-version\fR
+\fB\-V\fR, \fB\-\-version\fR
 Output version information and exit.
 .TP
-\fB\-\-help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Display a brief help text and exit.
 .SH FILES
 .I :ETCDIR:/ngircd.conf
@@ -63,16 +64,49 @@ The system wide default configuration file.
 .RS
 Default "message of the day" (MOTD).
 .RE
-.SH AUTHOR
-Alexander Barton,
-.UR mailto:alex@barton.de
-alex@barton.de
-.UE
+.SH SIGNALS
+The daemon understands the following signals:
+.TP
+\fBTERM\fR
+Shut down all connections and terminate the daemon.
+.TP
+\fBHUP\fR
+Shut down all listening sockets, re-read the configuration file and
+re-initialize the daemon.
+.SH HINTS
+It's wise to use "ngircd \-\-configtest" to validate the configuration file
+after changing it.
+.SH DEBUGGING
+When ngIRCd is compiled with debug code, that is, its source code has
+been ./configure'd with "--enable-debug" and/or "--enable-sniffer" (witch
+enables debug mode automatically as well), you can use two more command
+line options and two more signals to debug problems with the daemon itself
+or IRC clients:
+.PP
+\fBOptions:\fR
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Enable debug mode and log extra messages.
+.TP
+\fB\-s\fR, \fB\-\-sniffer\fR
+Enable IRC protocol sniffer, which logs all sent and received IRC commands to
+the console/syslog. This option requires that ngIRCd has been ./configure'd
+with "--enable-sniffer" and enables debug mode automatically, too.
+.PP
+\fBSignals:\fR
+.TP
+\fBUSR1\fR
+Toggle debug mode on and off during runtime.
+.TP
+\fBUSR2\fR
+Dump internal server state to the console/syslog when debug mode is on (use
+command line option \-\-debug or signal USR1).
+.SH AUTHORS
+Alexander Barton, <alex@barton.de>
 .br
-Homepage:
-.UR http://ngircd.barton.de/
-http://ngircd.barton.de/
-.UE
+Florian Westphal, <fw@strlen.de>
+.PP
+Homepage: http://ngircd.barton.de/
 .SH "SEE ALSO"
 .BR ngircd.conf (5),
 .BR ircd (8)