]> jfr.im git - erebus.git/commitdiff
oops some words in README
authorJohn Runyon <redacted>
Mon, 4 Sep 2023 03:30:31 +0000 (21:30 -0600)
committerJohn Runyon <redacted>
Mon, 4 Sep 2023 03:30:31 +0000 (21:30 -0600)
README.md

index 61cf004a448b80814340736e57636303cac7ddbb..1d7f696dab6b27c976e59c7a0103cb0e2aa8de38 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,20 +32,22 @@ Buffering
 ---------
 The bot includes message buffering, with two different message queues (plus a "fast" message which sends immediately). This is to help prevent the bot from being flooded off the network by malicious users.
 
-Unfortunately this does mean that the bot can be overwhelmed and take quite a while to respond. As an admin, you can use the QCLEAR command to clear the queues. If you control the IRC server, you can exempt the bot from flooding checks and then set `[erebus] nofakelag = 1` in the bot.config
+Unfortunately this does mean that the bot can be overwhelmed and take quite a while to respond. As an admin, you can use the QCLEAR command to clear the queues. If you control the IRC server, you can exempt the bot from flooding checks and then set `[erebus] nofakelag = 1` in the bot.config. This will turn off message buffering completely.
 
 
 Online Help
 -----------
 A command listing, with most (but not all) of the standard modules, is available at https://jfr.im/help/
 
-So long as you don't prohibit loading of the help module with `[autoloads] help = 0`, command info will be available at 
+So long as you don't prohibit loading of the help module with `[autoloads] help = 0`, command info will be available with `!HELP <command>`
 
 However, due to the message buffering mentioned above, there is no command listing available over IRC unless nofakelag is enabled. In order to generate a command listing, you must do the following:
 1. Set `[help] path` in the config file, if needed, to a path which exists and is available on the web. f.e. `[help] path = /home/jrunyon/public_html/help/%(#)d.txt`. Several values are available, for use with !GENHELP; they are the same as the prefix characters @#+- (see !HELP GENHELP). This determines the path to which !GENHELP will save output files.
 1. Set `[help] url` in the config file to a path where help can be found, f.e. `[help] url = https://jfr.im/help/%d.txt`. %d (or %s) will be replaced with the user's level. This determines the URL which is provided to users when they !SHOWCOMMANDS
 1. Run `!GENHELP` whenever you change which modules (or commands) are available, or else just set `[help] autogen = 1`.
 
+(With nofakelag = 1, !SHOWCOMMANDS will spam the user with the whole list of commands.)
+
 
 Support
 -------