diff options
Diffstat (limited to 'doc/en/autogen/user')
| -rw-r--r-- | doc/en/autogen/user/buflist_commands.adoc | 33 | ||||
| -rw-r--r-- | doc/en/autogen/user/buflist_options.adoc | 28 | ||||
| -rw-r--r-- | doc/en/autogen/user/weechat_commands.adoc | 38 |
3 files changed, 74 insertions, 25 deletions
diff --git a/doc/en/autogen/user/buflist_commands.adoc b/doc/en/autogen/user/buflist_commands.adoc new file mode 100644 index 000000000..c82246851 --- /dev/null +++ b/doc/en/autogen/user/buflist_commands.adoc @@ -0,0 +1,33 @@ +// +// 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 refresh + +refresh: force the refresh of the "buflist" bar item + +The lines with buffers are displayed using string evaluation (see /help eval for the format), with two main options: + - 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 these options: + - 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} + - 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 + - ${number}: indented number, for example " 1" if there are between 10 and 99 buffers + - ${indent}: indentation for name (channel and private buffers are indented) + - ${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 + - ${format_lag}: the lag for an IRC server buffer, empty if there's no lag (evaluation of option buflist.format.lag) +---- diff --git a/doc/en/autogen/user/buflist_options.adoc b/doc/en/autogen/user/buflist_options.adoc index 897265c23..e72baa172 100644 --- a/doc/en/autogen/user/buflist_options.adoc +++ b/doc/en/autogen/user/buflist_options.adoc @@ -3,49 +3,61 @@ // DO NOT EDIT BY HAND! // * [[option_buflist.format.buffer]] *buflist.format.buffer* -** description: pass:none[format of each line with a buffer] +** description: pass:none[format of each line with a buffer (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:green}${number}.${indent}${color_hotlist}${name}"+` * [[option_buflist.format.buffer_current]] *buflist.format.buffer_current* -** description: pass:none[format for the line with current buffer] +** description: pass:none[format for the line with current buffer (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:lightgreen,blue}${number}.${indent}${color_hotlist}${name}"+` +* [[option_buflist.format.hotlist]] *buflist.format.hotlist* +** description: pass:none[format for hotlist (note: content is evaluated, see /help buflist)] +** type: string +** values: any string +** default value: `+" ${color:green}(${hotlist}${color:green})"+` + * [[option_buflist.format.hotlist_highlight]] *buflist.format.hotlist_highlight* -** description: pass:none[format for a buffer with hotlist level "highlight"] +** description: pass:none[format for a buffer with hotlist level "highlight" (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:magenta}"+` * [[option_buflist.format.hotlist_low]] *buflist.format.hotlist_low* -** description: pass:none[format for a buffer with hotlist level "low"] +** description: pass:none[format for a buffer with hotlist level "low" (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:white}"+` * [[option_buflist.format.hotlist_message]] *buflist.format.hotlist_message* -** description: pass:none[format for a buffer with hotlist level "message"] +** description: pass:none[format for a buffer with hotlist level "message" (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:brown}"+` * [[option_buflist.format.hotlist_none]] *buflist.format.hotlist_none* -** description: pass:none[format for a buffer not in hotlist] +** description: pass:none[format for a buffer not in hotlist (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:default}"+` * [[option_buflist.format.hotlist_private]] *buflist.format.hotlist_private* -** description: pass:none[format for a buffer with hotlist level "private"] +** description: pass:none[format for a buffer with hotlist level "private" (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+"${color:green}"+` +* [[option_buflist.format.hotlist_separator]] *buflist.format.hotlist_separator* +** description: pass:none[separator for counts in hotlist (note: content is evaluated, see /help buflist)] +** type: string +** values: any string +** default value: `+"${color:default},"+` + * [[option_buflist.format.lag]] *buflist.format.lag* -** description: pass:none[format for lag on an irc server buffer] +** description: pass:none[format for lag on an IRC server buffer (note: content is evaluated, see /help buflist)] ** type: string ** values: any string ** default value: `+" ${color:green}[${color:brown}${lag}${color:green}]"+` diff --git a/doc/en/autogen/user/weechat_commands.adoc b/doc/en/autogen/user/weechat_commands.adoc index bddd0a053..c1d29443d 100644 --- a/doc/en/autogen/user/weechat_commands.adoc +++ b/doc/en/autogen/user/weechat_commands.adoc @@ -285,13 +285,15 @@ Some variables are replaced in expression, using the format ${variable}, variabl 1. an evaluated sub-string (format: "eval:xxx") 2. a string with escaped chars (format: "esc:xxx" or "\xxx") 3. a string with chars to hide (format: "hide:char,string") - 4. a color (format: "color:xxx") - 5. an info (format: "info:name,arguments", arguments are optional) - 6. current date/time (format: "date" or "date:format") - 7. an environment variable (format: "env:XXX") - 8. an option (format: "file.section.option") - 9. a local variable in buffer - 10. a hdata name/variable (the value is automatically converted to string), by default "window" and "buffer" point to current window/buffer. + 4. a string with max chars (format: "cut:max,suffix,string") + 5. a color (format: "color:xxx") + 6. an info (format: "info:name,arguments", arguments are optional) + 7. current date/time (format: "date" or "date:format") + 8. an environment variable (format: "env:XXX") + 9. a ternary operator (format: "if:condition?value_if_true:value_if_false") + 10. an option (format: "file.section.option") + 11. a local variable in buffer + 12. a hdata name/variable (the value is automatically converted to string), by default "window" and "buffer" point to current window/buffer. Format for hdata can be one of following: hdata.var1.var2...: start with a hdata (pointer must be known), and ask variables one after one (other hdata can be followed) hdata[list].var1.var2...: start with a hdata using a list, for example: @@ -302,16 +304,18 @@ Format for hdata can be one of following: For name of hdata and variables, please look at "Plugin API reference", function "weechat_hdata_get". Examples (simple strings): - /eval -n ${info:version} ==> 0.4.3 - /eval -n ${env:HOME} ==> /home/user - /eval -n ${weechat.look.scroll_amount} ==> 3 - /eval -n ${window} ==> 0x2549aa0 - /eval -n ${window.buffer} ==> 0x2549320 - /eval -n ${window.buffer.full_name} ==> core.weechat - /eval -n ${window.buffer.number} ==> 1 - /eval -n ${\t} ==> <tab> - /eval -n ${hide:-,${relay.network.password}} ==> -------- - /eval -n ${date:%H:%M:%S} ==> 07:46:40 + /eval -n ${info:version} ==> 0.4.3 + /eval -n ${env:HOME} ==> /home/user + /eval -n ${weechat.look.scroll_amount} ==> 3 + /eval -n ${window} ==> 0x2549aa0 + /eval -n ${window.buffer} ==> 0x2549320 + /eval -n ${window.buffer.full_name} ==> core.weechat + /eval -n ${window.buffer.number} ==> 1 + /eval -n ${\t} ==> <tab> + /eval -n ${hide:-,${relay.network.password}} ==> -------- + /eval -n ${cut:2,+,test} ==> te+ + /eval -n ${date:%H:%M:%S} ==> 07:46:40 + /eval -n ${if:${info:term_width}>80?big:small} ==> big Examples (conditions): /eval -n -c ${window.buffer.number} > 2 ==> 0 |