summaryrefslogtreecommitdiff
path: root/doc/en/autogen/plugin_api/infos.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/autogen/plugin_api/infos.asciidoc')
-rw-r--r--doc/en/autogen/plugin_api/infos.asciidoc77
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/en/autogen/plugin_api/infos.asciidoc b/doc/en/autogen/plugin_api/infos.asciidoc
new file mode 100644
index 000000000..0a743ba48
--- /dev/null
+++ b/doc/en/autogen/plugin_api/infos.asciidoc
@@ -0,0 +1,77 @@
+[width="100%",cols="^1,^2,6,6",options="header"]
+|===
+| Plugin | Name | Description | Arguments
+
+| aspell | aspell_dict | comma-separated list of dictionaries used in buffer | buffer pointer ("0x12345678") or buffer full name ("irc.freenode.#weechat")
+
+| fifo | fifo_filename | name of FIFO pipe | -
+
+| irc | irc_buffer | get buffer pointer for an IRC server/channel/nick | server,channel,nick (channel and nicks are optional)
+
+| irc | irc_is_channel | 1 if string is a valid IRC channel name for server | server,channel (server is optional)
+
+| irc | irc_is_nick | 1 if string is a valid IRC nick name | nickname
+
+| irc | irc_nick | get current nick on a server | server name
+
+| irc | irc_nick_color | get nick color code | nickname
+
+| irc | irc_nick_color_name | get nick color name | nickname
+
+| irc | irc_nick_from_host | get nick from IRC host | IRC host (like `:nick!name@server.com`)
+
+| irc | irc_server_isupport | 1 if server supports this feature (from IRC message 005) | server,feature
+
+| irc | irc_server_isupport_value | value of feature, if supported by server (from IRC message 005) | server,feature
+
+| python | python2_bin | path to python 2.x interpreter | -
+
+| relay | relay_client_count | number of clients for relay | status name (optional): connecting, waiting_auth, connected, auth_failed, disconnected
+
+| weechat | charset_internal | WeeChat internal charset | -
+
+| weechat | charset_terminal | terminal charset | -
+
+| weechat | color_ansi_regex | POSIX extended regular expression to search ANSI escape codes | -
+
+| weechat | color_rgb2term | RGB color converted to terminal color (0-255) | rgb,limit (limit is optional and is set to 256 by default)
+
+| weechat | color_term2rgb | terminal color (0-255) converted to RGB color | color (terminal color: 0-255)
+
+| weechat | cursor_mode | 1 if cursor mode is enabled | -
+
+| weechat | date | WeeChat compilation date | -
+
+| weechat | dir_separator | directory separator | -
+
+| weechat | filters_enabled | 1 if filters are enabled | -
+
+| weechat | inactivity | keyboard inactivity (seconds) | -
+
+| weechat | locale | locale used for translating messages | -
+
+| weechat | term_height | height of terminal | -
+
+| weechat | term_width | width of terminal | -
+
+| weechat | version | WeeChat version | -
+
+| weechat | version_git | WeeChat git version (output of command "git describe" for a development version only, empty for a stable release) | -
+
+| weechat | version_number | WeeChat version (as number) | -
+
+| weechat | weechat_dir | WeeChat directory | -
+
+| weechat | weechat_libdir | WeeChat "lib" directory | -
+
+| weechat | weechat_localedir | WeeChat "locale" directory | -
+
+| weechat | weechat_sharedir | WeeChat "share" directory | -
+
+| weechat | weechat_site | WeeChat site | -
+
+| weechat | weechat_site_download | WeeChat site, download page | -
+
+| weechat | weechat_upgrading | 1 if WeeChat is upgrading (command `/upgrade`) | -
+
+|===