GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-25 21:39:27 +01:00
Code Issues Projects Releases Wiki Activity

Doc: remove trailing "command" text from various headings

Browse Source
This commit is contained in:
Pragmatic Software 2021-09-14 21:30:44 -07:00
parent 44e1506f28
commit 6c273d263c
3 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/Admin.md
View File

@ -4,7 +4,7 @@
* [Logging in and out](#logging-in-and-out) * [Logging in and out](#logging-in-and-out)
* [login](#login) * [login](#login)
* [logout](#logout) * [logout](#logout)
* [User-management commands](#user-management-commands) * [User-management](#user-management)
* [useradd](#useradd) * [useradd](#useradd)
* [userdel](#userdel) * [userdel](#userdel)
* [userset](#userset) * [userset](#userset)
@ -22,7 +22,7 @@
* [Checking user capabilities](#checking-user-capabilities) * [Checking user capabilities](#checking-user-capabilities)
* [Listing users who have a capability](#listing-users-who-have-a-capability) * [Listing users who have a capability](#listing-users-who-have-a-capability)
* [User capabilities list](#user-capabilities-list) * [User capabilities list](#user-capabilities-list)
* [Channel management commands](#channel-management-commands) * [Channel management](#channel-management)
* [join](#join) * [join](#join)
* [part](#part) * [part](#part)
* [chanadd](#chanadd) * [chanadd](#chanadd)
@ -43,32 +43,32 @@
* [unban/unmute](#unbanunmute) * [unban/unmute](#unbanunmute)
* [invite](#invite) * [invite](#invite)
* [kick](#kick) * [kick](#kick)
* [Module-management commands](#module-management-commands) * [Module-management](#module-management)
* [load](#load) * [load](#load)
* [unload](#unload) * [unload](#unload)
* [Listing modules](#listing-modules) * [Listing modules](#listing-modules)
* [Plugin-management commands](#plugin-management-commands) * [Plugin-management](#plugin-management)
* [plug](#plug) * [plug](#plug)
* [unplug](#unplug) * [unplug](#unplug)
* [replug](#replug) * [replug](#replug)
* [pluglist](#pluglist) * [pluglist](#pluglist)
* [Command metadata commands](#command-metadata-commands) * [Command metadata](#command-metadata)
* [cmdset](#cmdset) * [cmdset](#cmdset)
* [cmdunset](#cmdunset) * [cmdunset](#cmdunset)
* [Command metadata list](#command-metadata-list) * [Command metadata list](#command-metadata-list)
* [Event-queue management](#event-queue-management) * [Event-queue management](#event-queue-management)
* [eventqueue](#eventqueue) * [eventqueue](#eventqueue)
* [Process-management commands](#process-management-commands) * [Process-management](#process-management)
* [ps](#ps) * [ps](#ps)
* [kill](#kill) * [kill](#kill)
* [Message-history/user-tracking commands](#message-historyuser-tracking-commands) * [Message-history/user-tracking](#message-historyuser-tracking)
* [recall](#recall) * [recall](#recall)
* [id](#id) * [id](#id)
* [aka](#aka) * [aka](#aka)
* [akalink](#akalink) * [akalink](#akalink)
* [akaunlink](#akaunlink) * [akaunlink](#akaunlink)
* [akadelete](#akadelete) * [akadelete](#akadelete)
* [Miscellaneous commands](#miscellaneous-commands) * [Miscellaneous](#miscellaneous)
* [export](#export) * [export](#export)
* [refresh](#refresh) * [refresh](#refresh)
* [reload](#reload) * [reload](#reload)
@ -93,7 +93,7 @@ Logs out of PBot.
Usage: `logout` Usage: `logout`
## User-management commands ## User-management
### useradd ### useradd
Adds a new user to PBot. 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 `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 `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 ### join
To temporarily join a channel, use the `join` command. The channels may be a comma- To temporarily join a channel, use the `join` command. The channels may be a comma-
separated list. separated list.
@ -480,7 +480,7 @@ Removes a user from the channel. `<nick>` can be a comma-separated list of multi
Usage from channel: `kick <nick> [reason]` Usage from channel: `kick <nick> [reason]`
From private message: `kick <channel> <nick> [reason]` From private message: `kick <channel> <nick> [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. Note that modules are "reloaded" each time they are executed. There is no need to `refresh` after editing a module.
### load ### load
@ -505,7 +505,7 @@ it is included here for completeness.
Usage: `list modules` Usage: `list modules`
## Plugin-management commands ## Plugin-management
### plug ### plug
Loads a plugin into PBot. Loads a plugin into PBot.
@ -532,7 +532,7 @@ Usage: `pluglist`
GoogleSearch, Quotegrabs, RemindMe, RestrictedMod, Spinach, TypoSub, UrlTitles, GoogleSearch, Quotegrabs, RemindMe, RestrictedMod, Spinach, TypoSub, UrlTitles,
Weather, Wolfram, Wttr Weather, Wolfram, Wttr
## Command metadata commands ## Command metadata
### cmdset ### cmdset
Use `cmdset` to set various [metadata](#command-metadata-list) for built-in commands. 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`:
<pragma-> eventqueue remove command #channel * <pragma-> eventqueue remove command #channel *
## Process-management commands ## Process-management
### ps ### ps
Lists all currently running background processes. 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. 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 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 messages are being stored in the right message history accounts. The following commands
query and manipulate the message history account links. 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. 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 These are some of the miscellaneous admin commands that have not been covered
above or in the rest of the PBot documentation. above or in the rest of the PBot documentation.

32
doc/Commands.md
View File

@ -28,17 +28,17 @@
* [date](#date) * [date](#date)
* [weather](#weather) * [weather](#weather)
* [Commands documented elsewhere](#commands-documented-elsewhere) * [Commands documented elsewhere](#commands-documented-elsewhere)
* [Administrative commands](#administrative-commands) * [Administrative](#administrative)
* [Logging in and out of PBot](#logging-in-and-out-of-pbot) * [Logging in and out of PBot](#logging-in-and-out-of-pbot)
* [login](Admin.md#login) * [login](Admin.md#login)
* [logout](Admin.md#logout) * [logout](Admin.md#logout)
* [User-management commands](#user-management-commands) * [User-management](#user-management)
* [useradd](Admin.md#useradd) * [useradd](Admin.md#useradd)
* [userdel](Admin.md#userdel) * [userdel](Admin.md#userdel)
* [userset](Admin.md#userset) * [userset](Admin.md#userset)
* [userunset](Admin.md#userunset) * [userunset](Admin.md#userunset)
* [users](Admin.md#listing-users) * [users](Admin.md#listing-users)
* [Channel-management commands](#channel-management-commands) * [Channel-management](#channel-management)
* [join](Admin.md#join) * [join](Admin.md#join)
* [part](Admin.md#part) * [part](Admin.md#part)
* [chanadd](Admin.md#chanadd) * [chanadd](Admin.md#chanadd)
@ -58,11 +58,11 @@
* [unban/unmute](Admin.md#unbanunmute) * [unban/unmute](Admin.md#unbanunmute)
* [invite](Admin.md#invite) * [invite](Admin.md#invite)
* [kick](Admin.md#kick) * [kick](Admin.md#kick)
* [Module-management commands](#module-management-commands) * [Module-management](#module-management)
* [load](Admin.md#load) * [load](Admin.md#load)
* [unload](Admin.md#unload) * [unload](Admin.md#unload)
* [list modules](Admin.md#listing-modules) * [list modules](Admin.md#listing-modules)
* [Plugin-management commands](#plugin-management-commands) * [Plugin-management](#plugin-management)
* [plug](Admin.md#plug) * [plug](Admin.md#plug)
* [unplug](Admin.md#unplug) * [unplug](Admin.md#unplug)
* [replug](Admin.md#replug) * [replug](Admin.md#replug)
@ -72,10 +72,10 @@
* [cmdunset](Admin.md#cmdunset) * [cmdunset](Admin.md#cmdunset)
* [Event-queue management](#event-queue-management) * [Event-queue management](#event-queue-management)
* [eventqueue](Admin.md#eventqueue) * [eventqueue](Admin.md#eventqueue)
* [Process-management commands](#process-management-commands) * [Process-management](#process-management)
* [ps](Admin.md#ps) * [ps](Admin.md#ps)
* [kill](Admin.md#kill) * [kill](Admin.md#kill)
* [Registry commands](#registry-commands) * [Registry](#registry)
* [regset](Registry.md#regset) * [regset](Registry.md#regset)
* [regunset](Registry.md#regunset) * [regunset](Registry.md#regunset)
* [regchange](Registry.md#regchange) * [regchange](Registry.md#regchange)
@ -83,7 +83,7 @@
* [regfind](Registry.md#regfind) * [regfind](Registry.md#regfind)
* [regsetmeta](Registry.md#regsetmeta) * [regsetmeta](Registry.md#regsetmeta)
* [regunsetmeta](Registry.md#regunsetmeta) * [regunsetmeta](Registry.md#regunsetmeta)
* [Message-history/user-tracking commands](#message-historyuser-tracking-commands) * [Message-history/user-tracking](#message-historyuser-tracking)
* [recall](Admin.md#recall) * [recall](Admin.md#recall)
* [aka](Admin.md#aka) * [aka](Admin.md#aka)
* [akalink](Admin.md#akalink) * [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 Forecast: High: 72F/22C Low: 53F/11C Warmer with sunshine
## Commands documented elsewhere ## Commands documented elsewhere
### Administrative commands ### Administrative
#### Logging in and out of PBot #### Logging in and out of PBot
##### [login](Admin.md#login) ##### [login](Admin.md#login)
##### [logout](Admin.md#logout) ##### [logout](Admin.md#logout)
#### User-management commands #### User-management
##### [useradd](Admin.md#useradd) ##### [useradd](Admin.md#useradd)
##### [userdel](Admin.md#userdel) ##### [userdel](Admin.md#userdel)
##### [userset](Admin.md#userset) ##### [userset](Admin.md#userset)
##### [userunset](Admin.md#userunset) ##### [userunset](Admin.md#userunset)
##### [users](Admin.md#listing-users) ##### [users](Admin.md#listing-users)
#### Channel-management commands #### Channel-management
##### [join](Admin.md#join) ##### [join](Admin.md#join)
##### [part](Admin.md#part) ##### [part](Admin.md#part)
##### [chanadd](Admin.md#chanadd) ##### [chanadd](Admin.md#chanadd)
@ -541,13 +541,13 @@ to have the command remember your location.
##### [invite](Admin.md#invite) ##### [invite](Admin.md#invite)
##### [kick](Admin.md#kick) ##### [kick](Admin.md#kick)
#### Module-management commands #### Module-management
##### [load](Admin.md#load) ##### [load](Admin.md#load)
##### [unload](Admin.md#unload) ##### [unload](Admin.md#unload)
##### [list modules](Admin.md#listing-modules) ##### [list modules](Admin.md#listing-modules)
#### Plugin-management commands #### Plugin-management
##### [plug](Admin.md#plug) ##### [plug](Admin.md#plug)
##### [unplug](Admin.md#unplug) ##### [unplug](Admin.md#unplug)
@ -561,11 +561,11 @@ to have the command remember your location.
#### Event-queue management #### Event-queue management
##### [eventqueue](Admin.md#eventqueue) ##### [eventqueue](Admin.md#eventqueue)
#### Process-management commands #### Process-management
##### [ps](Admin.md#ps) ##### [ps](Admin.md#ps)
##### [kill](Admin.md#kill) ##### [kill](Admin.md#kill)
#### Registry commands #### Registry
##### [regset](Registry.md#regset) ##### [regset](Registry.md#regset)
##### [regunset](Registry.md#regunset) ##### [regunset](Registry.md#regunset)
##### [regchange](Registry.md#regchange) ##### [regchange](Registry.md#regchange)
@ -574,7 +574,7 @@ to have the command remember your location.
##### [regsetmeta](Registry.md#regsetmeta) ##### [regsetmeta](Registry.md#regsetmeta)
##### [regunsetmeta](Registry.md#regunsetmeta) ##### [regunsetmeta](Registry.md#regunsetmeta)
#### Message-history/user-tracking commands #### Message-history/user-tracking
##### [recall](Admin.md#recall) ##### [recall](Admin.md#recall)
##### [aka](Admin.md#aka) ##### [aka](Admin.md#aka)
##### [akalink](Admin.md#akalink) ##### [akalink](Admin.md#akalink)

32
doc/README.md
View File

@ -71,17 +71,17 @@
* [date](Commands.md#date) * [date](Commands.md#date)
* [weather](Commands.md#weather) * [weather](Commands.md#weather)
* [Commands documented elsewhere](Commands.md#commands-documented-elsewhere) * [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) * [Logging in and out of PBot](Commands.md#logging-in-and-out-of-pbot)
* [User-management commands](Commands.md#user-management-commands) * [User-management](Commands.md#user-management)
* [Channel-management commands](Commands.md#channel-management-commands) * [Channel-management](Commands.md#channel-management)
* [Module-management commands](Commands.md#module-management-commands) * [Module-management](Commands.md#module-management)
* [Plugin-management commands](Commands.md#plugin-management-commands) * [Plugin-management](Commands.md#plugin-management)
* [Command metadata](Commands.md#command-metadata) * [Command metadata](Commands.md#command-metadata)
* [Event-queue management](Commands.md#event-queue-management) * [Event-queue management](Commands.md#event-queue-management)
* [Process-management commands](Commands.md#process-management-commands) * [Process-management](Commands.md#process-management)
* [Registry commands](Commands.md#registry-commands) * [Registry](Commands.md#registry)
* [Message-history/user-tracking commands](Commands.md#message-historyuser-tracking-commands) * [Message-history/user-tracking](Commands.md#message-historyuser-tracking)
* [Miscellaneous admin commands](Commands.md#miscellaneous-admin-commands) * [Miscellaneous admin commands](Commands.md#miscellaneous-admin-commands)
* [Factoid commands](Commands.md#factoid-commands) * [Factoid commands](Commands.md#factoid-commands)
* [Adding/removing factoids](Commands.md#addingremoving-factoids) * [Adding/removing factoids](Commands.md#addingremoving-factoids)
@ -95,7 +95,7 @@
* [Logging in and out](Admin.md#logging-in-and-out) * [Logging in and out](Admin.md#logging-in-and-out)
* [login](Admin.md#login) * [login](Admin.md#login)
* [logout](Admin.md#logout) * [logout](Admin.md#logout)
* [User-management commands](Admin.md#user-management-commands) * [User-management](Admin.md#user-management)
* [useradd](Admin.md#useradd) * [useradd](Admin.md#useradd)
* [userdel](Admin.md#userdel) * [userdel](Admin.md#userdel)
* [userset](Admin.md#userset) * [userset](Admin.md#userset)
@ -111,7 +111,7 @@
* [Checking user capabilities](Admin.md#checking-user-capabilities) * [Checking user capabilities](Admin.md#checking-user-capabilities)
* [Listing users who have a capability](Admin.md#listing-users-who-have-a-capability) * [Listing users who have a capability](Admin.md#listing-users-who-have-a-capability)
* [User capabilities list](Admin.md#user-capabilities-list) * [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) * [join](Admin.md#join)
* [part](Admin.md#part) * [part](Admin.md#part)
* [chanadd](Admin.md#chanadd) * [chanadd](Admin.md#chanadd)
@ -132,32 +132,32 @@
* [unban/unmute](Admin.md#unbanunmute) * [unban/unmute](Admin.md#unbanunmute)
* [invite](Admin.md#invite) * [invite](Admin.md#invite)
* [kick](Admin.md#kick) * [kick](Admin.md#kick)
* [Module-management commands](Admin.md#module-management-commands) * [Module-management](Admin.md#module-management)
* [load](Admin.md#load) * [load](Admin.md#load)
* [unload](Admin.md#unload) * [unload](Admin.md#unload)
* [Listing modules](Admin.md#listing-modules) * [Listing modules](Admin.md#listing-modules)
* [Plugin-management commands](Admin.md#plugin-management-commands) * [Plugin-management](Admin.md#plugin-management)
* [plug](Admin.md#plug) * [plug](Admin.md#plug)
* [unplug](Admin.md#unplug) * [unplug](Admin.md#unplug)
* [replug](Admin.md#replug) * [replug](Admin.md#replug)
* [pluglist](Admin.md#pluglist) * [pluglist](Admin.md#pluglist)
* [Command metadata commands](Admin.md#command-metadata-commands) * [Command metadata](Admin.md#command-metadata)
* [cmdset](Admin.md#cmdset) * [cmdset](Admin.md#cmdset)
* [cmdunset](Admin.md#cmdunset) * [cmdunset](Admin.md#cmdunset)
* [Command metadata list](Admin.md#command-metadata-list) * [Command metadata list](Admin.md#command-metadata-list)
* [Event-queue management](Admin.md#event-queue-management) * [Event-queue management](Admin.md#event-queue-management)
* [eventqueue](Admin.md#eventqueue) * [eventqueue](Admin.md#eventqueue)
* [Process-management commands](Admin.md#process-management-commands) * [Process-management](Admin.md#process-management)
* [ps](Admin.md#ps) * [ps](Admin.md#ps)
* [kill](Admin.md#kill) * [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) * [recall](Admin.md#recall)
* [id](Admin.md#id) * [id](Admin.md#id)
* [aka](Admin.md#aka) * [aka](Admin.md#aka)
* [akalink](Admin.md#akalink) * [akalink](Admin.md#akalink)
* [akaunlink](Admin.md#akaunlink) * [akaunlink](Admin.md#akaunlink)
* [akadelete](Admin.md#akadelete) * [akadelete](Admin.md#akadelete)
* [Miscellaneous commands](Admin.md#miscellaneous-commands) * [Miscellaneous](Admin.md#miscellaneous)
* [export](Admin.md#export) * [export](Admin.md#export)
* [refresh](Admin.md#refresh) * [refresh](Admin.md#refresh)
* [reload](Admin.md#reload) * [reload](Admin.md#reload)