~ubuntu-branches/ubuntu/wily/weechat/wily

« back to all changes in this revision

Viewing changes to doc/en/autogen/plugin_api/infos.asciidoc

  • Committer: Package Import Robot
  • Author(s): Emmanuel Bouthenot
  • Date: 2014-09-28 17:41:10 UTC
  • mfrom: (29.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20140928174110-bwlsn7gqmqfftnmb
Tags: 1.0.1-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
[width="100%",cols="^1,^2,6,6",options="header"]
 
2
|===
 
3
| Plugin | Name | Description | Arguments
 
4
 
 
5
| aspell | aspell_dict | comma-separated list of dictionaries used in buffer | buffer pointer ("0x12345678") or buffer full name ("irc.freenode.#weechat")
 
6
 
 
7
| fifo | fifo_filename | name of FIFO pipe | -
 
8
 
 
9
| irc | irc_buffer | get buffer pointer for an IRC server/channel/nick | server,channel,nick (channel and nicks are optional)
 
10
 
 
11
| irc | irc_is_channel | 1 if string is a valid IRC channel name for server | server,channel (server is optional)
 
12
 
 
13
| irc | irc_is_nick | 1 if string is a valid IRC nick name | nickname
 
14
 
 
15
| irc | irc_nick | get current nick on a server | server name
 
16
 
 
17
| irc | irc_nick_color | get nick color code | nickname
 
18
 
 
19
| irc | irc_nick_color_name | get nick color name | nickname
 
20
 
 
21
| irc | irc_nick_from_host | get nick from IRC host | IRC host (like `:nick!name@server.com`)
 
22
 
 
23
| irc | irc_server_isupport | 1 if server supports this feature (from IRC message 005) | server,feature
 
24
 
 
25
| irc | irc_server_isupport_value | value of feature, if supported by server (from IRC message 005) | server,feature
 
26
 
 
27
| python | python2_bin | path to python 2.x interpreter | -
 
28
 
 
29
| relay | relay_client_count | number of clients for relay | status name (optional): connecting, waiting_auth, connected, auth_failed, disconnected
 
30
 
 
31
| weechat | charset_internal | WeeChat internal charset | -
 
32
 
 
33
| weechat | charset_terminal | terminal charset | -
 
34
 
 
35
| weechat | color_ansi_regex | POSIX extended regular expression to search ANSI escape codes | -
 
36
 
 
37
| weechat | color_rgb2term | RGB color converted to terminal color (0-255) | rgb,limit (limit is optional and is set to 256 by default)
 
38
 
 
39
| weechat | color_term2rgb | terminal color (0-255) converted to RGB color | color (terminal color: 0-255)
 
40
 
 
41
| weechat | cursor_mode | 1 if cursor mode is enabled | -
 
42
 
 
43
| weechat | date | WeeChat compilation date | -
 
44
 
 
45
| weechat | dir_separator | directory separator | -
 
46
 
 
47
| weechat | filters_enabled | 1 if filters are enabled | -
 
48
 
 
49
| weechat | inactivity | keyboard inactivity (seconds) | -
 
50
 
 
51
| weechat | locale | locale used for translating messages | -
 
52
 
 
53
| weechat | term_height | height of terminal | -
 
54
 
 
55
| weechat | term_width | width of terminal | -
 
56
 
 
57
| weechat | version | WeeChat version | -
 
58
 
 
59
| weechat | version_git | WeeChat git version (output of command "git describe" for a development version only, empty for a stable release) | -
 
60
 
 
61
| weechat | version_number | WeeChat version (as number) | -
 
62
 
 
63
| weechat | weechat_dir | WeeChat directory | -
 
64
 
 
65
| weechat | weechat_libdir | WeeChat "lib" directory | -
 
66
 
 
67
| weechat | weechat_localedir | WeeChat "locale" directory | -
 
68
 
 
69
| weechat | weechat_sharedir | WeeChat "share" directory | -
 
70
 
 
71
| weechat | weechat_site | WeeChat site | -
 
72
 
 
73
| weechat | weechat_site_download | WeeChat site, download page | -
 
74
 
 
75
| weechat | weechat_upgrading | 1 if WeeChat is upgrading (command `/upgrade`) | -
 
76
 
 
77
|===