Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5
authorAlexander Barton <alex@barton.de>
Mon, 31 Dec 2012 20:03:23 +0000 (21:03 +0100)
committerAlexander Barton <alex@barton.de>
Mon, 31 Dec 2012 20:03:23 +0000 (21:03 +0100)
doc/sample-ngircd.conf.tmpl
man/ngircd.conf.5.tmpl

index 997a983..3f80a9f 100644 (file)
        ;AdminInfo2 = Location
        ;AdminEMail = admin@irc.server
 
+       # Text file which contains the ngIRCd help text. This file is required
+       # to display help texts when using the "HELP <cmd>" command.
+       ;HelpFile = :ETCDIR:/ngircd.help
+
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
        Info = Server Info Text
index e3f62c8..681e86c 100644 (file)
@@ -101,6 +101,10 @@ IRC network and must contain at least one dot (".") character.
 Information about the server and the administrator, used by the ADMIN
 command. This information is not required by the server but by RFC!
 .TP
+\fBHelpFile\fR (string)
+Text file which contains the ngIRCd help text. This file is required
+to display help texts when using the "HELP <cmd>" command.
+.TP
 \fBInfo\fR (string)
 Info text of the server. This will be shown by WHOIS and LINKS requests for
 example.