diff --git a/doc/Admin.md b/doc/Admin.md index a345baa2..aabea284 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -42,6 +42,10 @@ * [unplug](#unplug) * [replug](#replug) * [pluglist](#pluglist) +* [Command metadata commands](#command-metadata-commands) + * [cmdset](#cmdset) + * [cmdunset](#cmdunset) + * [Command metadata list](#command-metadata-list) * [Miscellaneous commands](#miscellaneous-commands) * [export](#export) * [refresh](#refresh) @@ -75,7 +79,7 @@ Parameter | Description `` | A unique name to identify this account (usually the `nick` of the admin, but can be any identifier). `` | Which channel the admin can administrate; use `global` for all channels. This field cannot be changed without removing and re-adding the admin. `` | What hostmask the admin is recognized/allowed to login from (e.g., `somenick!*@*somedomain.com` or `*@unaffiliated/someuser`). This field cannot be changed without removing and re-adding the admin. -`` | An integer representing their level of privileges. See [admin-levels](#admin-levels). +`` | An integer representing the admin's level of privileges. See [admin-levels](#admin-levels) and [`cmdset`](#cmdset). `` | The password the admin will use to login (from /msg!). A password is not required if the `stayloggedin` and `loggedin` metadata are set for the admin; however, a dummy password still needs to be set. ### adminrem @@ -86,6 +90,8 @@ Usage: `adminrem ` #### Admin levels This is a list of admin commands allowed by each admin level. Higher level admins have access to all lower level admin commands. +Note that you can use [`cmdset`](#cmdset) to adjust any command's admin level. + Level | Commands --- | --- 10 | actiontrigger, antispam, whitelist, blacklist, chanlist, ban, unban, mute, unmute, op, deop, voice, devoice, invite, kick, ignore, unignore @@ -315,6 +321,27 @@ Usage: `pluglist` !pluglist Loaded plugins: ActionTrigger, AntiAway, AntiKickAutoRejoin, AntiNickSpam, AntiRepeat, AntiTwitter, AutoRejoin, GoogleSearch, Quotegrabs, RemindMe, UrlTitles +## Command metadata commands + +### cmdset +Use `cmdset` to set various [metadata](#command-metadata-list) for built-in commands. + +Usage: `cmdset [key [value]]` + +Omit `` and `` to list all the keys and values for a factoid. Specify ``, but omit `` to see the value for a specific key. + +### cmdunset +Use `cmdset` to delete various [metadata](#command-metadata-list) from built-in commands. + +Usage: `cmdunset ` + +### Command metadata list + +Name | Description +--- | --- +`help` | The text to display for the [`help`](Commands.md#help) command. +`level` | The admin level of this command. See also [admin-levels](#admin-levels) + ## Miscellaneous commands These are some of the miscellaneous admin commands that have not been covered