From 35e735ad7d020534f1a4d1887033fa14e1b84a7f Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Fri, 14 Feb 2020 22:58:16 -0800 Subject: [PATCH] README.md: add section about processes --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 078348ec..eb5cbff6 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ PBot is a versatile IRC Bot written in Perl * [Chaining](#chaining) * [Variables](#variables) * [Inline invocation](#inline-invocation) + * [Background processing](#background-processing) * [Factoids](#factoids) * [Code Factoids](#code-factoids) * [Plugins](#plugins) @@ -144,6 +145,16 @@ is addressed to a nick, the output will also be addressed to them. newuser13: PBot version 2696 2020-01-04 newuser13: To learn all about me, see https://github.com/pragma-/pbot/tree/master/doc +#### Background processing +Any command can be flagged to execute as a background process. For example, suppose you +make a Plugin that has a command that may potentially take a long time to complete, which could +cause PBot to be non-responsive until the command completes... + +Not a problem! You can use the [`cmdset`](doc/Commands.md#cmdset) command to set the `execute-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 while the command runs. + +The familiar [`ps`](doc/Admin.md#ps) and [`kill`](doc/Admin.md#kill) commands can be used to list and kill the background processes. + ### Factoids Factoids are a very special type of command. Anybody interacting with PBot can create, edit, delete and invoke factoids. Factoids can be locked by the