diff options
author | Přemysl Eric Janouch <p@janouch.name> | 2021-08-06 17:14:13 +0200 |
---|---|---|
committer | Přemysl Eric Janouch <p@janouch.name> | 2021-08-06 17:18:06 +0200 |
commit | 5d285ffb962ec16b9b0f3e5d7425a3ea2fae2579 (patch) | |
tree | 9f2d8b4460cda182e5faf986e58697ac1209281b /xB.adoc | |
parent | 50057d5149dda340b3b47aca4096f4a6ec66b9ee (diff) | |
download | xK-5d285ffb962ec16b9b0f3e5d7425a3ea2fae2579.tar.gz xK-5d285ffb962ec16b9b0f3e5d7425a3ea2fae2579.tar.xz xK-5d285ffb962ec16b9b0f3e5d7425a3ea2fae2579.zip |
xB: fix up the special IPC command's name
To reflect the new disorder.
Diffstat (limited to 'xB.adoc')
-rw-r--r-- | xB.adoc | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -57,24 +57,24 @@ Plugins ------- Plugins communicate with the bot over their standard input and output streams using the IRC protocol. (Caveat: the standard C library doesn't automatically -flush FILE streams for pipes on newlines.) A special *ZYKLONB* command is -introduced for RPC, with the following subcommands: +flush FILE streams for pipes on newlines.) A special *XB* command is introduced +for RPC, with the following subcommands: -*ZYKLONB get_config* _key_:: +*XB get_config* _key_:: Request the value of the given configuration option. If no such option exists, the value will be empty. The response will be delivered in the following format: + ``` -ZYKLONB :value +XB :value ``` + This is particularly useful for retrieving the *prefix* string. -*ZYKLONB print* _message_:: +*XB print* _message_:: Make the bot print the _message_ on its standard output. -*ZYKLONB register*:: +*XB register*:: Once a plugin issues this command, it will start receiving all of the bot's incoming IRC traffic, which includes data from the initialization period. |