diff --git a/doc/Admin.md b/doc/Admin.md index 53e5a2a4..1521ef38 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -4,7 +4,7 @@ * [Logging in and out](#logging-in-and-out) * [login](#login) * [logout](#logout) -* [User-management commands](#user-management-commands) +* [User-management](#user-management) * [useradd](#useradd) * [userdel](#userdel) * [userset](#userset) @@ -22,7 +22,7 @@ * [Checking user capabilities](#checking-user-capabilities) * [Listing users who have a capability](#listing-users-who-have-a-capability) * [User capabilities list](#user-capabilities-list) -* [Channel management commands](#channel-management-commands) +* [Channel management](#channel-management) * [join](#join) * [part](#part) * [chanadd](#chanadd) @@ -43,32 +43,32 @@ * [unban/unmute](#unbanunmute) * [invite](#invite) * [kick](#kick) -* [Module-management commands](#module-management-commands) +* [Module-management](#module-management) * [load](#load) * [unload](#unload) * [Listing modules](#listing-modules) -* [Plugin-management commands](#plugin-management-commands) +* [Plugin-management](#plugin-management) * [plug](#plug) * [unplug](#unplug) * [replug](#replug) * [pluglist](#pluglist) -* [Command metadata commands](#command-metadata-commands) +* [Command metadata](#command-metadata) * [cmdset](#cmdset) * [cmdunset](#cmdunset) * [Command metadata list](#command-metadata-list) * [Event-queue management](#event-queue-management) * [eventqueue](#eventqueue) -* [Process-management commands](#process-management-commands) +* [Process-management](#process-management) * [ps](#ps) * [kill](#kill) -* [Message-history/user-tracking commands](#message-historyuser-tracking-commands) +* [Message-history/user-tracking](#message-historyuser-tracking) * [recall](#recall) * [id](#id) * [aka](#aka) * [akalink](#akalink) * [akaunlink](#akaunlink) * [akadelete](#akadelete) -* [Miscellaneous commands](#miscellaneous-commands) +* [Miscellaneous](#miscellaneous) * [export](#export) * [refresh](#refresh) * [reload](#reload) @@ -93,7 +93,7 @@ Logs out of PBot. Usage: `logout` -## User-management commands +## User-management ### useradd Adds a new user to PBot. @@ -350,7 +350,7 @@ Name | Description | Belongs to group `can-voice-wildcard` | Allows the user to use wildcards with the [`voice`](#voice) command. | botowner, admin, chanop, chanmod `is-whitelisted` | The user is exempt from anti-flood, ban-evasion checks, wild-card kicking, etc. | botowner, admin, chanop -## Channel management commands +## Channel management ### join To temporarily join a channel, use the `join` command. The channels may be a comma- separated list. @@ -480,7 +480,7 @@ Removes a user from the channel. `` can be a comma-separated list of multi Usage from channel: `kick [reason]` From private message: `kick [reason]` -## Module-management commands +## Module-management Note that modules are "reloaded" each time they are executed. There is no need to `refresh` after editing a module. ### load @@ -505,7 +505,7 @@ it is included here for completeness. Usage: `list modules` -## Plugin-management commands +## Plugin-management ### plug Loads a plugin into PBot. @@ -532,7 +532,7 @@ Usage: `pluglist` GoogleSearch, Quotegrabs, RemindMe, RestrictedMod, Spinach, TypoSub, UrlTitles, Weather, Wolfram, Wttr -## Command metadata commands +## Command metadata ### cmdset Use `cmdset` to set various [metadata](#command-metadata-list) for built-in commands. @@ -583,7 +583,7 @@ Or to remove all `command` events in `#channel`: eventqueue remove command #channel * -## Process-management commands +## Process-management ### ps Lists all currently running background processes. @@ -609,7 +609,7 @@ Option | Description If neither options `-a` or `-t` are provided then the `pids...` option is required. -## Message-history/user-tracking commands +## Message-history/user-tracking Message history has an advanced user tracking algorithm in order to ensure that messages are being stored in the right message history accounts. The following commands query and manipulate the message history account links. @@ -731,7 +731,7 @@ Option | Description If neither options `-h` or `-n` are given, then the entire message history account will be deleted. -## Miscellaneous commands +## Miscellaneous These are some of the miscellaneous admin commands that have not been covered above or in the rest of the PBot documentation. diff --git a/doc/Commands.md b/doc/Commands.md index 36ea047d..37d0b857 100644 --- a/doc/Commands.md +++ b/doc/Commands.md @@ -28,17 +28,17 @@ * [date](#date) * [weather](#weather) * [Commands documented elsewhere](#commands-documented-elsewhere) - * [Administrative commands](#administrative-commands) + * [Administrative](#administrative) * [Logging in and out of PBot](#logging-in-and-out-of-pbot) * [login](Admin.md#login) * [logout](Admin.md#logout) - * [User-management commands](#user-management-commands) + * [User-management](#user-management) * [useradd](Admin.md#useradd) * [userdel](Admin.md#userdel) * [userset](Admin.md#userset) * [userunset](Admin.md#userunset) * [users](Admin.md#listing-users) - * [Channel-management commands](#channel-management-commands) + * [Channel-management](#channel-management) * [join](Admin.md#join) * [part](Admin.md#part) * [chanadd](Admin.md#chanadd) @@ -58,11 +58,11 @@ * [unban/unmute](Admin.md#unbanunmute) * [invite](Admin.md#invite) * [kick](Admin.md#kick) - * [Module-management commands](#module-management-commands) + * [Module-management](#module-management) * [load](Admin.md#load) * [unload](Admin.md#unload) * [list modules](Admin.md#listing-modules) - * [Plugin-management commands](#plugin-management-commands) + * [Plugin-management](#plugin-management) * [plug](Admin.md#plug) * [unplug](Admin.md#unplug) * [replug](Admin.md#replug) @@ -72,10 +72,10 @@ * [cmdunset](Admin.md#cmdunset) * [Event-queue management](#event-queue-management) * [eventqueue](Admin.md#eventqueue) - * [Process-management commands](#process-management-commands) + * [Process-management](#process-management) * [ps](Admin.md#ps) * [kill](Admin.md#kill) - * [Registry commands](#registry-commands) + * [Registry](#registry) * [regset](Registry.md#regset) * [regunset](Registry.md#regunset) * [regchange](Registry.md#regchange) @@ -83,7 +83,7 @@ * [regfind](Registry.md#regfind) * [regsetmeta](Registry.md#regsetmeta) * [regunsetmeta](Registry.md#regunsetmeta) - * [Message-history/user-tracking commands](#message-historyuser-tracking-commands) + * [Message-history/user-tracking](#message-historyuser-tracking) * [recall](Admin.md#recall) * [aka](Admin.md#aka) * [akalink](Admin.md#akalink) @@ -508,19 +508,19 @@ to have the command remember your location. Forecast: High: 72F/22C Low: 53F/11C Warmer with sunshine ## Commands documented elsewhere -### Administrative commands +### Administrative #### Logging in and out of PBot ##### [login](Admin.md#login) ##### [logout](Admin.md#logout) -#### User-management commands +#### User-management ##### [useradd](Admin.md#useradd) ##### [userdel](Admin.md#userdel) ##### [userset](Admin.md#userset) ##### [userunset](Admin.md#userunset) ##### [users](Admin.md#listing-users) -#### Channel-management commands +#### Channel-management ##### [join](Admin.md#join) ##### [part](Admin.md#part) ##### [chanadd](Admin.md#chanadd) @@ -541,13 +541,13 @@ to have the command remember your location. ##### [invite](Admin.md#invite) ##### [kick](Admin.md#kick) -#### Module-management commands +#### Module-management ##### [load](Admin.md#load) ##### [unload](Admin.md#unload) ##### [list modules](Admin.md#listing-modules) -#### Plugin-management commands +#### Plugin-management ##### [plug](Admin.md#plug) ##### [unplug](Admin.md#unplug) @@ -561,11 +561,11 @@ to have the command remember your location. #### Event-queue management ##### [eventqueue](Admin.md#eventqueue) -#### Process-management commands +#### Process-management ##### [ps](Admin.md#ps) ##### [kill](Admin.md#kill) -#### Registry commands +#### Registry ##### [regset](Registry.md#regset) ##### [regunset](Registry.md#regunset) ##### [regchange](Registry.md#regchange) @@ -574,7 +574,7 @@ to have the command remember your location. ##### [regsetmeta](Registry.md#regsetmeta) ##### [regunsetmeta](Registry.md#regunsetmeta) -#### Message-history/user-tracking commands +#### Message-history/user-tracking ##### [recall](Admin.md#recall) ##### [aka](Admin.md#aka) ##### [akalink](Admin.md#akalink) diff --git a/doc/README.md b/doc/README.md index f42b03a4..f6c3fcf9 100644 --- a/doc/README.md +++ b/doc/README.md @@ -71,17 +71,17 @@ * [date](Commands.md#date) * [weather](Commands.md#weather) * [Commands documented elsewhere](Commands.md#commands-documented-elsewhere) - * [Administrative commands](Commands.md#administrative-commands) + * [Administrative](Commands.md#administrative) * [Logging in and out of PBot](Commands.md#logging-in-and-out-of-pbot) - * [User-management commands](Commands.md#user-management-commands) - * [Channel-management commands](Commands.md#channel-management-commands) - * [Module-management commands](Commands.md#module-management-commands) - * [Plugin-management commands](Commands.md#plugin-management-commands) + * [User-management](Commands.md#user-management) + * [Channel-management](Commands.md#channel-management) + * [Module-management](Commands.md#module-management) + * [Plugin-management](Commands.md#plugin-management) * [Command metadata](Commands.md#command-metadata) * [Event-queue management](Commands.md#event-queue-management) - * [Process-management commands](Commands.md#process-management-commands) - * [Registry commands](Commands.md#registry-commands) - * [Message-history/user-tracking commands](Commands.md#message-historyuser-tracking-commands) + * [Process-management](Commands.md#process-management) + * [Registry](Commands.md#registry) + * [Message-history/user-tracking](Commands.md#message-historyuser-tracking) * [Miscellaneous admin commands](Commands.md#miscellaneous-admin-commands) * [Factoid commands](Commands.md#factoid-commands) * [Adding/removing factoids](Commands.md#addingremoving-factoids) @@ -95,7 +95,7 @@ * [Logging in and out](Admin.md#logging-in-and-out) * [login](Admin.md#login) * [logout](Admin.md#logout) - * [User-management commands](Admin.md#user-management-commands) + * [User-management](Admin.md#user-management) * [useradd](Admin.md#useradd) * [userdel](Admin.md#userdel) * [userset](Admin.md#userset) @@ -111,7 +111,7 @@ * [Checking user capabilities](Admin.md#checking-user-capabilities) * [Listing users who have a capability](Admin.md#listing-users-who-have-a-capability) * [User capabilities list](Admin.md#user-capabilities-list) - * [Channel management commands](Admin.md#channel-management-commands) + * [Channel management](Admin.md#channel-management) * [join](Admin.md#join) * [part](Admin.md#part) * [chanadd](Admin.md#chanadd) @@ -132,32 +132,32 @@ * [unban/unmute](Admin.md#unbanunmute) * [invite](Admin.md#invite) * [kick](Admin.md#kick) - * [Module-management commands](Admin.md#module-management-commands) + * [Module-management](Admin.md#module-management) * [load](Admin.md#load) * [unload](Admin.md#unload) * [Listing modules](Admin.md#listing-modules) - * [Plugin-management commands](Admin.md#plugin-management-commands) + * [Plugin-management](Admin.md#plugin-management) * [plug](Admin.md#plug) * [unplug](Admin.md#unplug) * [replug](Admin.md#replug) * [pluglist](Admin.md#pluglist) - * [Command metadata commands](Admin.md#command-metadata-commands) + * [Command metadata](Admin.md#command-metadata) * [cmdset](Admin.md#cmdset) * [cmdunset](Admin.md#cmdunset) * [Command metadata list](Admin.md#command-metadata-list) * [Event-queue management](Admin.md#event-queue-management) * [eventqueue](Admin.md#eventqueue) - * [Process-management commands](Admin.md#process-management-commands) + * [Process-management](Admin.md#process-management) * [ps](Admin.md#ps) * [kill](Admin.md#kill) - * [Message-history/user-tracking commands](Admin.md#message-historyuser-tracking-commands) + * [Message-history/user-tracking](Admin.md#message-historyuser-tracking) * [recall](Admin.md#recall) * [id](Admin.md#id) * [aka](Admin.md#aka) * [akalink](Admin.md#akalink) * [akaunlink](Admin.md#akaunlink) * [akadelete](Admin.md#akadelete) - * [Miscellaneous commands](Admin.md#miscellaneous-commands) + * [Miscellaneous](Admin.md#miscellaneous) * [export](Admin.md#export) * [refresh](Admin.md#refresh) * [reload](Admin.md#reload)