GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc/Admin.md: Add process management commands

This commit is contained in:
Pragmatic Software 2020-02-14 23:05:45 -08:00
parent fa171688d8
commit 7d84a84a97
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/Admin.md
View File

@ -57,6 +57,9 @@
* [cmdset](#cmdset) * [cmdset](#cmdset)
* [cmdunset](#cmdunset) * [cmdunset](#cmdunset)
* [Command metadata list](#command-metadata-list) * [Command metadata list](#command-metadata-list)
* [Process management commands](#process-management-commands)
* [ps](#ps)
* [kill](#kill)
* [Miscellaneous commands](#miscellaneous-commands) * [Miscellaneous commands](#miscellaneous-commands)
* [export](#export) * [export](#export)
* [refresh](#refresh) * [refresh](#refresh)
@ -477,7 +480,6 @@ 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 commands
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
@ -503,7 +505,6 @@ it is included here for completeness.
Usage: `list modules` Usage: `list modules`
## Plugin management commands ## Plugin management commands
### plug ### plug
Loads a plugin into PBot. Loads a plugin into PBot.
@ -531,7 +532,6 @@ Usage: `pluglist`
Weather, Wttr Weather, Wttr
## Command metadata commands ## Command metadata commands
### 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.
@ -545,14 +545,25 @@ Use `cmdset` to delete various [metadata](#command-metadata-list) from built-in
Usage: `cmdunset <command> <key>` Usage: `cmdunset <command> <key>`
### Command metadata list ### Command metadata list
Name | Description Name | Description
--- | --- --- | ---
`help` | The text to display for the [`help`](Commands.md#help) command. `help` | The text to display for the [`help`](Commands.md#help) command.
`cap-required` | If this is set to a true value then the command requires that users have the `can-<command name>` [capability](#user-capabilities) before they can invoke it. `cap-required` | When set to a true value then the command requires that users have the `can-<command name>` [capability](#user-capabilities) before they can invoke it.
`dont-replace-pronouns` | When set to a true value then pronouns such as "my", "me", "your", etc, will not be intuitively replaced with nicks and such.
`execute-process` | When set to a true value then this command will be executed as a background process. Use this for commands that can potentially take a long time to complete.
## Process management commands
### ps
Lists all currently running background process.
Usage: `ps`
### kill
Sends the interrupt signal to selected running background processes.
Usage: `kill <pids...>`
## Miscellaneous commands ## Miscellaneous commands
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.