diff options
Diffstat (limited to 'doc/en/includes/autogen_api_infos_hashtable.en.adoc')
-rw-r--r-- | doc/en/includes/autogen_api_infos_hashtable.en.adoc | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/en/includes/autogen_api_infos_hashtable.en.adoc b/doc/en/includes/autogen_api_infos_hashtable.en.adoc new file mode 100644 index 000000000..1d66f3d90 --- /dev/null +++ b/doc/en/includes/autogen_api_infos_hashtable.en.adoc @@ -0,0 +1,18 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// + +// ======================================== api_infos_hashtable ======================================== + +// tag::infos_hashtable[] +[width="100%",cols="^1,^2,6,6,8",options="header"] +|=== +| Plugin | Name | Description | Hashtable (input) | Hashtable (output) + +| irc | irc_message_parse | parse an IRC message | "message": IRC message, "server": server name (optional) | "tags": tags, "message_without_tags": message without the tags, "nick": nick, "user": user, "host": host, "command": command, "channel": channel, "arguments": arguments (includes channel), "text": text (for example user message), "pos_command": index of "command" message ("-1" if "command" was not found), "pos_arguments": index of "arguments" message ("-1" if "arguments" was not found), "pos_channel": index of "channel" message ("-1" if "channel" was not found), "pos_text": index of "text" message ("-1" if "text" was not found) + +| irc | irc_message_split | split an IRC message (to fit in 512 bytes by default) | "message": IRC message, "server": server name (optional) | "msg1" ... "msgN": messages to send (without final "\r\n"), "args1" ... "argsN": arguments of messages, "count": number of messages + +|=== +// end::infos_hashtable[] |