From: Alexander Barton <alex@barton.de>
Date: Mon, 31 Dec 2012 20:03:23 +0000 (+0100)
Subject: Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5
X-Git-Tag: rel-21-rc1~163^2~4
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=commitdiff_plain;h=d2a1f6aa4be7e42dd76e5342b309b8331d86bab4

Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5
---

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index 997a983d..3f80a9f9 100644
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -33,6 +33,10 @@
 	;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
diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index e3f62c84..681e86c7 100644
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -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.