From 56d185aa1f95190d2136de04448d651908df052c Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Sun, 8 Mar 2020 16:26:05 -0700 Subject: [PATCH] doc/Admin.md: add eventqueue command --- doc/Admin.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/Admin.md b/doc/Admin.md index 74cfcfdc..101c90ba 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -56,6 +56,8 @@ * [cmdset](#cmdset) * [cmdunset](#cmdunset) * [Command metadata list](#command-metadata-list) +* [Event queue commands](#event-queue-commands) + * [eventqueue](#eventqueue) * [Process management commands](#process-management-commands) * [ps](#ps) * [kill](#kill) @@ -542,6 +544,21 @@ 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. `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 +### eventqueue +Manages the PBot event queue. Can be used to add commands that run at a future time. + +Usage: `eventqueue list [filter regex] | add | delete + +For example, to schedule a command to run 10 seconds from now: + + eventqueue add "10 seconds" echo Ta-da! + Command added to event queue. + + 10 seconds later ... + + Ta-da! + ## Process management commands ### ps Lists all currently running background processes.