From ccc962d9f2f62079a213dcabfd8b576f6d629d0e Mon Sep 17 00:00:00 2001 From: reality Date: Fri, 10 May 2013 18:38:57 +0000 Subject: [PATCH] update admin docs [#351] --- modules/admin/README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/modules/admin/README.md b/modules/admin/README.md index 0a0583c..6aff5a4 100644 --- a/modules/admin/README.md +++ b/modules/admin/README.md @@ -26,6 +26,15 @@ channel, it will attempt to give the caller ops in the current channel. Perform a git pull, and then execute the 'reload' command. Saves a lot of time updating! +#### version [module] +Shows the git version of the currently loaded revision of DBot. If module is +provided, it will attempt to get the revision of the module (this is only useful +for submodules). + +#### status [module] +Show the recorded status for a given module, this is helpful for debugging +issues when loading or for checking if a module is loaded. + #### reload Reload all of the modules currently in use by DBot. By using this, all module functionality should be reloadable and replaceable without having to restart the @@ -46,12 +55,18 @@ loaded by the standard DBot process. Unload a currently loaded module. This removes the module, and then triggers a reload of all modules. -#### ban [user] [command] -Ban a user from using a command. Command may be replaced with '\*,' which will -ban a user from use of all commands. Users banned from all commands will still -be subject to module listeners. +#### setconfig [path] [value] +Set a config value at path to be a certain value persistently. For example, if +you want to change the web module to listen on port 9001, you can run _setconfig +web.webPort 9001_. -#### unban [user] [command] -Unban a user from using a given command. If a user was previously banned using -the '\*' wildcard, they may also be unbanned from such by replacing command with -an asterisk here as well. +#### pushconfig [path] [value] +Push a new value to an existing config array. For example, if you want to add +the user 'batman62' to the DBot moderators, you can run _pushconfig moderators +batman62_. + +#### showconfig [path] +Use this to explore and view the DBot configuration. If called without a path, +it will display the config keys in the root; if the path is a subkey, it will +show all config keys under that key. If you give it an actual key, it'll show you +the currently effective config value.