about summary refs log tree commit diff
path: root/man
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2013-01-02 23:41:46 +0100
committerAlexander Barton <alex@barton.de>2013-01-02 23:41:46 +0100
commit68cb1a8c2e507e7c99f787fab3540b904cfa1cc1 (patch)
tree479f748b608bc765142ea897a13bded87338da08 /man
parent21493731dffa0f5d9f62d24cdef290be6a6856fd (diff)
parent950aeec3ff0e15c456ac32d8fecee8c73f7c5df3 (diff)
downloadngircd-68cb1a8c2e507e7c99f787fab3540b904cfa1cc1.tar.gz
ngircd-68cb1a8c2e507e7c99f787fab3540b904cfa1cc1.zip
Merge branch 'bug145-ProvideHelp'
* bug145-ProvideHelp:
  Use "${docdir}/Commands.txt" as help text file
  Add a note that "help file" is updated on startup and REHASH only
  Add doc/Commands.txt which should document all commands
  Implement Help() function parsing and returning the help text
  Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5
  Implement new configuration option "HelpFile"
  IRC_HELP(): Code cleanup
  Refactor Read_Motd() into Read_TextFile()
Diffstat (limited to 'man')
-rw-r--r--man/ngircd.conf.5.tmpl6
1 files changed, 6 insertions, 0 deletions
diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index e3f62c84..859c6a8a 100644
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -101,6 +101,12 @@ 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.
+Please note: Changes made to this file take effect when ngircd starts up
+or is instructed to re-read its configuration file.
+.TP
 \fBInfo\fR (string)
 Info text of the server. This will be shown by WHOIS and LINKS requests for
 example.