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
|
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_buflist_buflist]]
* `+buflist+`: bar item with list of buffers
----
/buflist bar
refresh
bar: add the "buflist" bar
refresh: force the refresh of the bar items (buflist, buflist2 and buflist3)
The lines with buffers are displayed using string evaluation (see /help eval for the format), with these options:
- buflist.look.display_conditions: conditions to display a buffer in the list
- buflist.format.buffer: format for a buffer which is not current buffer
- buflist.format.buffer_current: format for the current buffer
The following variables can be used in the option "buflist.look.display_conditions" (see below for the description):
- bar_item
- buffer
- irc_server
- irc_channel
The following variables can be used in the options "buflist.format.*":
- bar item data (see hdata "bar_item" in API doc for a complete list), for example:
- ${bar_item.name}
- buffer data (see hdata "buffer" in API doc for a complete list), for example:
- ${buffer.number}
- ${buffer.name}
- ${buffer.full_name}
- ${buffer.short_name}
- ${buffer.nicklist_nicks_count}
- irc_server: IRC server data, defined only on an IRC buffer (see hdata "irc_server" in API doc)
- irc_channel: IRC channel data, defined only on an IRC channel buffer (see hdata "irc_channel" in API doc)
- extra variables added by buflist for convenience:
- ${format_buffer}: the evaluated value of option buflist.format.buffer; this can be used in option buflist.format.buffer_current to just change the background color for example
- ${current_buffer}: a boolean ("0" or "1"), "1" if this is the current buffer; it can be used in a condition: ${if:${current_buffer}?...:...}
- ${merged}: a boolean ("0" or "1"), "1" if the buffer is merged with at least another buffer; it can be used in a condition: ${if:${merged}?...:...}
- ${format_number}: indented number with separator (evaluation of option buflist.format.number)
- ${number}: indented number, for example " 1" if there are between 10 and 99 buffers; for merged buffers, this variable is set with number for the first buffer and spaces for the next buffers with same number
- ${number2}: indented number, for example " 1" if there are between 10 and 99 buffers
- ${number_displayed}: "1" if the number is displayed, otherwise "0"
- ${indent}: indentation for name (channel and private buffers are indented) (evaluation of option buflist.format.indent)
- ${format_nick_prefix}: colored nick prefix for a channel (evaluation of option buflist.format.nick_prefix)
- ${color_nick_prefix}: color of nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
- ${nick_prefix}: nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
- ${format_name}: formatted name (evaluation of option buflist.format.name)
- ${name}: the short name (if set), with a fallback on the name
- ${color_hotlist}: the color depending on the highest hotlist level for the buffer (evaluation of option buflist.format.hotlist_xxx where xxx is the level)
- ${format_hotlist}: the formatted hotlist (evaluation of option buflist.format.hotlist)
- ${hotlist}: the raw hotlist
- ${hotlist_priority}: "none", "low", "message", "private" or "highlight"
- ${format_lag}: the lag for an IRC server buffer, empty if there's no lag (evaluation of option buflist.format.lag)
----
|
