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

This commit is contained in:
Alexander Barton 2012-12-31 21:03:23 +01:00
parent f68aa02272
commit d2a1f6aa4b
2 changed files with 8 additions and 0 deletions

View File

@ -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

View 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.