X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=man%2Fngircd.8.tmpl;h=f0703f35e191629911b6d68f205319f683a71f8d;hp=5c60a47a3c067335f11b1bb29db9c9e1366b1cb1;hb=107bfdc821cfb179996e1186cff0ec4970ef4fbd;hpb=aad49bd260494878aed6795c7a897ad1d28c3082 diff --git a/man/ngircd.8.tmpl b/man/ngircd.8.tmpl index 5c60a47a..f0703f35 100644 --- a/man/ngircd.8.tmpl +++ b/man/ngircd.8.tmpl @@ -1,7 +1,7 @@ .\" -.\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $ +.\" ngircd(8) manual page template .\" -.TH ngircd 8 "May 2008" ngircd "ngIRCd Manual" +.TH ngircd 8 "Mar 2012" ngircd "ngIRCd Manual" .SH NAME ngIRCd \- the next generation IRC daemon .SH SYNOPSIS @@ -26,7 +26,7 @@ there are good chances that it also supports other UNIX-based operating 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. @@ -50,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 @@ -64,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, .br -Homepage: -.UR http://ngircd.barton.de/ -http://ngircd.barton.de/ -.UE +Florian Westphal, +.PP +Homepage: http://ngircd.barton.de/ .SH "SEE ALSO" .BR ngircd.conf (5), .BR ircd (8)