GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2025-04-26 01:37:51 +02:00
Code Issues Projects Releases Wiki Activity

doc: improvements

Browse Source
This commit is contained in:
Pragmatic Software 2020-03-08 17:59:05 -07:00
parent 6541cc68b6
commit 72807b9ea7
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/Admin.md
View File

@ -56,7 +56,7 @@
* [cmdset](#cmdset) * [cmdset](#cmdset)
* [cmdunset](#cmdunset) * [cmdunset](#cmdunset)
* [Command metadata list](#command-metadata-list) * [Command metadata list](#command-metadata-list)
* [Event queue commands](#event-queue-commands) * [Event queue management](#event-queue-management)
* [eventqueue](#eventqueue) * [eventqueue](#eventqueue)
* [Process management commands](#process-management-commands) * [Process management commands](#process-management-commands)
* [ps](#ps) * [ps](#ps)
@ -544,18 +544,18 @@ Name | Description
`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. `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-timeout` | The timeout, in seconds, before the process is automatically killed. If not set then the `processmanager.default_timeout` [registry](Registry.md) value will be used. `process-timeout` | The timeout, in seconds, before the process is automatically killed. If not set then the `processmanager.default_timeout` [registry](Registry.md) value will be used.
## Event queue commands ## Event queue management
### eventqueue ### eventqueue
Manages the PBot event queue. Can be used to add commands that run at a future time. Manages the PBot event queue. Can be used to add commands that run at a future time.
Usage: `eventqueue list [filter regex] | add <relative time> <command> | delete <regex>` Usage: `eventqueue list [filter regex] | add <relative time> <command> | remove <regex>`
For example, to schedule a command to run 1 hour from now: For example, to schedule a command to run 1 hour from now:
<pragma-> eventqueue add "1 hour" echo Ta-da! <pragma-> eventqueue add "1 hour" echo Ta-da!
<PBot> Command added to event queue. <PBot> Command added to event queue.
<pragma-> eventqueue list echo <pragma-> eventqueue list
<PBot> Queued events: 1) in 1h: output #channel /say Ta-da! <PBot> Queued events: 1) in 1h: output #channel /say Ta-da!
... 1 hour later ... ... 1 hour later ...

2
doc/README.md
View File

@ -130,7 +130,7 @@
* [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 commands](Admin.md#event-queue-commands) * [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 commands](Admin.md#process-management-commands)
* [ps](Admin.md#ps) * [ps](Admin.md#ps)