GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-22 03:49:29 +01:00
Code Issues Projects Releases Wiki Activity

Rename execute-process to background-process

Browse Source
This commit is contained in:
Pragmatic Software 2020-02-14 23:15:59 -08:00
parent 0562cacc58
commit b14ef936b0
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -150,7 +150,7 @@ Any command can be flagged to be executed as a background process. For example,
make a Plugin that has a command that may potentially take a long time to complete, which could
cause PBot to be non-responsive...
Not a problem! You can use the [`cmdset`](doc/Admin.md#cmdset) command to set the `execute-process` [command metadata](doc/Admin.md#command-metadata-list)
Not a problem! You can use the [`cmdset`](doc/Admin.md#cmdset) command to set the `background-process` [command metadata](doc/Admin.md#command-metadata-list)
and the command will now run as a background process, allowing PBot to carry on with its duties.
The familiar [`ps`](doc/Admin.md#ps) and [`kill`](doc/Admin.md#kill) commands can be used to list and kill the background processes.

2
doc/Admin.md
View File

@ -550,7 +550,7 @@ Name | Description
`help` | The text to display for the [`help`](Commands.md#help) command.
`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.
`background-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