summaryrefslogtreecommitdiff
path: root/doc/en/includes/autogen_api_infos.en.adoc
blob: e2038de17737ca76fb7b9ecb9a41988da8ff807d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//

// tag::infos[]
[width="100%",cols="^1,^2,6,6",options="header"]
|===
| Plugin | Name | Description | Arguments

| fifo | fifo_filename | name of FIFO pipe | -

| guile | guile_eval | evaluation of source code | source code to execute

| guile | guile_interpreter | name of the interpreter used | -

| guile | guile_version | version of the interpreter used | -

| 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_message_ignored | 1 if the nick is ignored (message is not displayed) | server,message (message is the raw IRC message)

| irc | irc_is_nick | 1 if string is a valid IRC nick name | server,nickname (server is optional)

| irc | irc_nick | get current nick on a server | server name

| irc | irc_nick_color | get nick color code (*deprecated* since version 1.5, replaced by "nick_color") | nickname

| irc | irc_nick_color_name | get nick color name (*deprecated* since version 1.5, replaced by "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

| javascript | javascript_eval | evaluation of source code | source code to execute

| javascript | javascript_interpreter | name of the interpreter used | -

| javascript | javascript_version | version of the interpreter used | -

| lua | lua_eval | evaluation of source code | source code to execute

| lua | lua_interpreter | name of the interpreter used | -

| lua | lua_version | version of the interpreter used | -

| perl | perl_eval | evaluation of source code | source code to execute

| perl | perl_interpreter | name of the interpreter used | -

| perl | perl_version | version of the interpreter used | -

| php | php_eval | evaluation of source code | source code to execute

| php | php_interpreter | name of the interpreter used | -

| php | php_version | version of the interpreter used | -

| python | python2_bin | path to Python 2.x interpreter (*deprecated* since version 2.6, scripts must use Python 3 only) | -

| python | python_eval | evaluation of source code | source code to execute

| python | python_interpreter | name of the interpreter used | -

| python | python_version | version of the interpreter used | -

| relay | relay_client_count | number of clients for relay | protocol,status (both are optional, for each argument "*" means all; protocols: irc, weechat; statuses: connecting, waiting_auth, connected, auth_failed, disconnected)

| ruby | ruby_eval | evaluation of source code | source code to execute

| ruby | ruby_interpreter | name of the interpreter used | -

| ruby | ruby_version | version of the interpreter used | -

| spell | spell_dict | comma-separated list of dictionaries used in buffer | buffer pointer ("0x12345678") or buffer full name ("irc.freenode.#weechat")

| tcl | tcl_eval | evaluation of source code | source code to execute

| tcl | tcl_interpreter | name of the interpreter used | -

| tcl | tcl_version | version of the interpreter used | -

| weechat | auto_connect | 1 if automatic connection to servers is enabled, 0 if it has been disabled by the user (option "-a" or "--no-connect") | -

| 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/time | -

| 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 | nick_color | get nick color code | nickname;colors (colors is an optional comma-separated list of colors to use; background is allowed for a color with format text:background; if colors is present, WeeChat options with nick colors and forced nick colors are ignored)

| weechat | nick_color_name | get nick color name | nickname;colors (colors is an optional comma-separated list of colors to use; background is allowed for a color with format text:background; if colors is present, WeeChat options with nick colors and forced nick colors are ignored)

| weechat | pid | WeeChat PID (process ID) | -

| weechat | term_color_pairs | number of color pairs supported in terminal | -

| weechat | term_colors | number of colors supported in terminal | -

| weechat | term_height | height of terminal | -

| weechat | term_width | width of terminal | -

| weechat | totp_generate | generate a Time-based One-Time Password (TOTP) | secret (in base32), timestamp (optional, current time by default), number of digits (optional, between 4 and 10, 6 by default)

| weechat | totp_validate | validate a Time-based One-Time Password (TOTP): 1 if TOTP is correct, otherwise 0 | secret (in base32), one-time password, timestamp (optional, current time by default), number of passwords before/after to test (optional, 0 by default)

| weechat | uptime | WeeChat uptime (format: "days:hh:mm:ss") | "days" (number of days) or "seconds" (number of seconds) (optional)

| 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_daemon | 1 if WeeChat is running in daemon mode (headless, in background) | -

| weechat | weechat_dir | WeeChat directory | -

| weechat | weechat_headless | 1 if WeeChat is running headless | -

| 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`) | -

|===
// end::infos[]