diff options
Diffstat (limited to 'doc/en/autogen/user')
46 files changed, 0 insertions, 6972 deletions
diff --git a/doc/en/autogen/user/alias_commands.adoc b/doc/en/autogen/user/alias_commands.adoc deleted file mode 100644 index 2e723c832..000000000 --- a/doc/en/autogen/user/alias_commands.adoc +++ /dev/null @@ -1,40 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_alias_alias]] -* `+alias+`: list, add or remove command aliases - ----- -/alias list [<alias>] - add <alias> [<command>[;<command>...]] - addcompletion <completion> <alias> [<command>[;<command>...]] - del <alias> [<alias>...] - - list: list aliases (without argument, this list is displayed) - add: add an alias -addcompletion: add an alias with a custom completion - del: delete an alias - completion: completion for alias: by default completion is done with target command - note: you can use %%command to use completion of an existing command - alias: name of alias - command: command name with arguments (many commands can be separated by semicolons) - -Note: in command, special variables are replaced: - $n: argument 'n' (between 1 and 9) - $-m: arguments from 1 to 'm' - $n-: arguments from 'n' to last - $n-m: arguments from 'n' to 'm' - $*: all arguments - $~: last argument - $var: where "var" is a local variable of buffer (see /buffer localvar) - examples: $nick, $channel, $server, $plugin, $name - -Examples: - alias /split to split window horizontally: - /alias add split /window splith - alias /hello to say "hello" on all channels but not on #weechat: - /alias add hello /allchan -exclude=#weechat msg * hello - alias /forcejoin to send IRC command "forcejoin" with completion of /sajoin: - /alias addcompletion %%sajoin forcejoin /quote forcejoin ----- diff --git a/doc/en/autogen/user/alias_default_aliases.adoc b/doc/en/autogen/user/alias_default_aliases.adoc deleted file mode 100644 index d185018f7..000000000 --- a/doc/en/autogen/user/alias_default_aliases.adoc +++ /dev/null @@ -1,41 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[width="100%",cols="2m,5m,5",options="header"] -|=== -| Alias | Command | Completion - -| /AAWAY | /allserv /away | - -| /ANICK | /allserv /nick | - -| /BEEP | /print -beep | - -| /BYE | /quit | - -| /C | /buffer clear | - -| /CL | /buffer clear | - -| /CLOSE | /buffer close | - -| /CHAT | /dcc chat | - -| /EXIT | /quit | - -| /IG | /ignore | - -| /J | /join | - -| /K | /kick | - -| /KB | /kickban | - -| /LEAVE | /part | - -| /M | /msg | - -| /MUB | /unban * | - -| /MSGBUF | /command -buffer $1 * /input send $2- | %(buffers_plugins_names) -| /N | /names | - -| /Q | /query | - -| /REDRAW | /window refresh | - -| /SAY | /msg * | - -| /SIGNOFF | /quit | - -| /T | /topic | - -| /UB | /unban | - -| /UMODE | /mode $nick | - -| /V | /command core version | - -| /W | /who | - -| /WC | /window close | - -| /WI | /whois | - -| /WII | /whois $1 $1 | - -| /WM | /window merge | - -| /WW | /whowas | - -|=== diff --git a/doc/en/autogen/user/buflist_commands.adoc b/doc/en/autogen/user/buflist_commands.adoc deleted file mode 100644 index 1061eebfe..000000000 --- a/doc/en/autogen/user/buflist_commands.adoc +++ /dev/null @@ -1,57 +0,0 @@ -// -// 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 enable|disable|toggle - bar - refresh - - enable: enable buflist -disable: disable buflist - toggle: toggle buflist - 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 these options: - - bar item data (see hdata "bar_item" in API doc for a complete list), for example: - - ${bar_item.name} - - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example: - - ${window.number} - - ${window.buffer.full_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) ----- diff --git a/doc/en/autogen/user/buflist_options.adoc b/doc/en/autogen/user/buflist_options.adoc deleted file mode 100644 index ce4f8c0d4..000000000 --- a/doc/en/autogen/user/buflist_options.adoc +++ /dev/null @@ -1,153 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_buflist.format.buffer]] *buflist.format.buffer* -** description: pass:none[format of each line with a buffer (note: content is evaluated, see /help buflist); example: standard format for bar item "buflist" and only the buffer number between square brackets for other bar items ("buflist2" and "buflist3"): "${if:${bar_item.name}==buflist?${format_number}${indent}${format_nick_prefix}${color_hotlist}${format_name}:[${number}\]}"] -** type: string -** values: any string -** default value: `+"${format_number}${indent}${format_nick_prefix}${color_hotlist}${format_name}"+` - -* [[option_buflist.format.buffer_current]] *buflist.format.buffer_current* -** 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:,blue}${format_buffer}"+` - -* [[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" (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" (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" (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 (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" (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.indent]] *buflist.format.indent* -** description: pass:none[string displayed to indent channel and private buffers (note: content is evaluated, see /help buflist)] -** type: string -** values: any string -** default value: `+" "+` - -* [[option_buflist.format.lag]] *buflist.format.lag* -** 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}]"+` - -* [[option_buflist.format.name]] *buflist.format.name* -** description: pass:none[format for buffer name (note: content is evaluated, see /help buflist)] -** type: string -** values: any string -** default value: `+"${name}"+` - -* [[option_buflist.format.nick_prefix]] *buflist.format.nick_prefix* -** description: pass:none[format for nick prefix on a channel (note: content is evaluated, see /help buflist)] -** type: string -** values: any string -** default value: `+"${color_nick_prefix}${nick_prefix}"+` - -* [[option_buflist.format.number]] *buflist.format.number* -** description: pass:none[format for buffer number, ${number} is the indented number (note: content is evaluated, see /help buflist)] -** type: string -** values: any string -** default value: `+"${color:green}${number}${if:${number_displayed}?.: }"+` - -* [[option_buflist.look.add_newline]] *buflist.look.add_newline* -** description: pass:none[add newline between the buffers displayed, so each buffer is displayed on a separate line (recommended); if disabled, newlines must be manually added in the formats with "${\n}", and the mouse actions are not possible any more] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_buflist.look.auto_scroll]] *buflist.look.auto_scroll* -** description: pass:none[automatically scroll the buflist bar to always see the current buffer (this works only with a bar on the left/right position with a "vertical" filling); this value is the percent number of lines displayed before the current buffer when scrolling (-1 = disable scroll); for example 50 means that after a scroll, the current buffer is at the middle of bar, 0 means on top of bar, 100 means at bottom of bar] -** type: integer -** values: -1 .. 100 -** default value: `+50+` - -* [[option_buflist.look.display_conditions]] *buflist.look.display_conditions* -** description: pass:none[conditions to display a buffer (note: content is evaluated, see /help buflist); for example to hide server buffers if they are merged with core buffer: "${buffer.hidden}==0 && ((${type}!=server && ${buffer.full_name}!=core.weechat) || ${buffer.active}==1)"] -** type: string -** values: any string -** default value: `+"${buffer.hidden}==0"+` - -* [[option_buflist.look.enabled]] *buflist.look.enabled* -** description: pass:none[enable buflist] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_buflist.look.mouse_jump_visited_buffer]] *buflist.look.mouse_jump_visited_buffer* -** description: pass:none[if enabled, clicks with left/right buttons on the line with current buffer jump to previous/next visited buffer] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_buflist.look.mouse_move_buffer]] *buflist.look.mouse_move_buffer* -** description: pass:none[if enabled, mouse gestures (drag & drop) move buffers in list] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_buflist.look.mouse_wheel]] *buflist.look.mouse_wheel* -** description: pass:none[if enabled, mouse wheel up/down actions jump to previous/next buffer in list] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_buflist.look.nick_prefix]] *buflist.look.nick_prefix* -** description: pass:none[get the nick prefix and its color from nicklist so that ${nick_prefix} can be used in format; this can be slow on buffers with lot of nicks in nicklist, so this option is disabled by default] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_buflist.look.nick_prefix_empty]] *buflist.look.nick_prefix_empty* -** description: pass:none[when the nick prefix is enabled, display a space instead if there is no nick prefix on the buffer] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_buflist.look.signals_refresh]] *buflist.look.signals_refresh* -** description: pass:none[comma-separated list of extra signals that are hooked and trigger the refresh of buffers list; this can be useful if some custom variables are used in formats and need specific refresh] -** type: string -** values: any string -** default value: `+""+` - -* [[option_buflist.look.sort]] *buflist.look.sort* -** description: pass:none[comma-separated list of fields to sort buffers; each field is a hdata variable of buffer ("var"), a hdata variable of IRC server ("irc_server.var") or a hdata variable of IRC channel ("irc_channel.var"); char "-" can be used before field to reverse order, char "~" can be used to do a case insensitive comparison; example: "-~short_name" for case insensitive and reverse sort on buffer short name (note: content is evaluated, only the pointer to bar_item can be used, for example "bar_item.name")] -** type: string -** values: any string -** default value: `+"number,-active"+` diff --git a/doc/en/autogen/user/charset_commands.adoc b/doc/en/autogen/user/charset_commands.adoc deleted file mode 100644 index 883f29385..000000000 --- a/doc/en/autogen/user/charset_commands.adoc +++ /dev/null @@ -1,16 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_charset_charset]] -* `+charset+`: change charset for current buffer - ----- -/charset decode|encode <charset> - reset - - decode: change decoding charset - encode: change encoding charset -charset: new charset for current buffer - reset: reset charsets for current buffer ----- diff --git a/doc/en/autogen/user/charset_options.adoc b/doc/en/autogen/user/charset_options.adoc deleted file mode 100644 index 6fa2030aa..000000000 --- a/doc/en/autogen/user/charset_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_charset.default.decode]] *charset.default.decode* -** description: pass:none[global decoding charset: charset used to decode incoming messages when they are not UTF-8 valid] -** type: string -** values: any string -** default value: `+"iso-8859-1"+` - -* [[option_charset.default.encode]] *charset.default.encode* -** description: pass:none[global encoding charset: charset used to encode outgoing messages (if empty, default is UTF-8 because it is the WeeChat internal charset)] -** type: string -** values: any string -** default value: `+""+` diff --git a/doc/en/autogen/user/exec_commands.adoc b/doc/en/autogen/user/exec_commands.adoc deleted file mode 100644 index d36def7eb..000000000 --- a/doc/en/autogen/user/exec_commands.adoc +++ /dev/null @@ -1,76 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_exec_exec]] -* `+exec+`: execute external commands - ----- -/exec -list - [-sh|-nosh] [-bg|-nobg] [-stdin|-nostdin] [-buffer <name>] [-l|-o|-n|-nf] [-cl|-nocl] [-sw|-nosw] [-ln|-noln] [-flush|-noflush] [-color ansi|auto|irc|weechat|strip] [-rc|-norc] [-timeout <timeout>] [-name <name>] [-pipe <command>] [-hsignal <name>] <command> - -in <id> <text> - -inclose <id> [<text>] - -signal <id> <signal> - -kill <id> - -killall - -set <id> <property> <value> - -del <id>|-all [<id>...] - - -list: list commands - -sh: use the shell to execute the command, many commands can be piped (WARNING: use this option ONLY if all arguments are safe, see option -nosh) - -nosh: do not use the shell to execute the command (required if the command has some unsafe data, for example the content of a message from another user) (default) - -bg: run process in background: do not display process output neither return code (not compatible with options -o/-oc/-n/-nf/-pipe/-hsignal) - -nobg: catch process output and display return code (default) - -stdin: create a pipe for sending data to the process (with /exec -in/-inclose) --nostdin: do not create a pipe for stdin (default) - -buffer: display/send output of command on this buffer (if the buffer is not found, a new buffer with name "exec.exec.xxx" is created) - -l: display locally output of command on buffer (default) - -o: send output of command to the buffer without executing commands (not compatible with options -bg/-pipe/-hsignal) - -oc: send output of command to the buffer and execute commands (lines starting with "/" or another custom command char) (not compatible with options -bg/-pipe/-hsignal) - -n: display output of command in a new buffer (not compatible with options -bg/-pipe/-hsignal) - -nf: display output of command in a new buffer with free content (no word-wrap, no limit on number of lines) (not compatible with options -bg/-pipe/-hsignal) - -cl: clear the new buffer before displaying output - -nocl: append to the new buffer without clear (default) - -sw: switch to the output buffer (default) - -nosw: don't switch to the output buffer - -ln: display line numbers (default in new buffer only) - -noln: don't display line numbers - -flush: display output of command in real time (default) --noflush: display output of command after its end - -color: action on ANSI colors in output: - ansi: keep ANSI codes as-is - auto: convert ANSI colors to WeeChat/IRC (default) - irc: convert ANSI colors to IRC colors - weechat: convert ANSI colors to WeeChat colors - strip: remove ANSI colors - -rc: display return code (default) - -norc: don't display return code --timeout: set a timeout for the command (in seconds) - -name: set a name for the command (to name it later with /exec) - -pipe: send the output to a WeeChat/plugin command (line by line); if there are spaces in command/arguments, enclose them with double quotes; variable $line is replaced by the line (by default the line is added after the command, separated by a space) (not compatible with options -bg/-o/-oc/-n/-nf) --hsignal: send the output as a hsignal (to be used for example in a trigger) (not compatible with options -bg/-o/-oc/-n/-nf) - command: the command to execute; if beginning with "url:", the shell is disabled and the content of URL is downloaded and sent as output - id: command identifier: either its number or name (if set with "-name xxx") - -in: send text on standard input of process --inclose: same as -in, but stdin is closed after (and text is optional: without text, the stdin is just closed) - -signal: send a signal to the process; the signal can be an integer or one of these names: hup, int, quit, kill, term, usr1, usr2 - -kill: alias of "-signal <id> kill" --killall: kill all running processes - -set: set a hook property (see function hook_set in plugin API reference) -property: hook property - value: new value for hook property - -del: delete a terminated command - -all: delete all terminated commands - -Default options can be set in the option exec.command.default_options. - -Examples: - /exec -n ls -l /tmp - /exec -sh -n ps xu | grep weechat - /exec -n -norc url:https://pastebin.com/raw.php?i=xxxxxxxx - /exec -nf -noln links -dump https://weechat.org/files/doc/devel/weechat_user.en.html - /exec -o uptime - /exec -pipe "/print Machine uptime:" uptime - /exec -n tail -f /var/log/messages - /exec -kill 0 ----- diff --git a/doc/en/autogen/user/exec_options.adoc b/doc/en/autogen/user/exec_options.adoc deleted file mode 100644 index ad43c5423..000000000 --- a/doc/en/autogen/user/exec_options.adoc +++ /dev/null @@ -1,33 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_exec.color.flag_finished]] *exec.color.flag_finished* -** description: pass:none[text color for a finished command flag in list of commands] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_exec.color.flag_running]] *exec.color.flag_running* -** description: pass:none[text color for a running command flag in list of commands] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_exec.command.default_options]] *exec.command.default_options* -** description: pass:none[default options for command /exec (see /help exec); example: "-nosh -bg" to run all commands in background (no output), and without using the shell] -** type: string -** values: any string -** default value: `+""+` - -* [[option_exec.command.purge_delay]] *exec.command.purge_delay* -** description: pass:none[delay for purging finished commands (in seconds, 0 = purge commands immediately, -1 = never purge)] -** type: integer -** values: -1 .. 25920000 -** default value: `+0+` - -* [[option_exec.command.shell]] *exec.command.shell* -** description: pass:none[shell to use with command "/exec -sh"; it can be just the name of shell if it is in PATH (for example "bash") or the absolute path to the shell (for example "/bin/bash"); if value is empty, "sh" is used (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+"${env:SHELL}"+` diff --git a/doc/en/autogen/user/fifo_commands.adoc b/doc/en/autogen/user/fifo_commands.adoc deleted file mode 100644 index eee8b2526..000000000 --- a/doc/en/autogen/user/fifo_commands.adoc +++ /dev/null @@ -1,29 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_fifo_fifo]] -* `+fifo+`: fifo plugin configuration - ----- -/fifo enable|disable|toggle - - enable: enable FIFO pipe -disable: disable FIFO pipe - toggle: toggle FIFO pipe - -FIFO pipe is used as remote control of WeeChat: you can send commands or text to the FIFO pipe from your shell. -By default the FIFO pipe is in ~/.weechat/weechat_fifo - -The expected format is one of: - plugin.buffer *text or command here - *text or command here - -For example to change your freenode nick: - echo 'irc.server.freenode */nick newnick' >~/.weechat/weechat_fifo - -Please read the user's guide for more info and examples. - -Examples: - /fifo toggle ----- diff --git a/doc/en/autogen/user/fifo_options.adoc b/doc/en/autogen/user/fifo_options.adoc deleted file mode 100644 index e30939fa5..000000000 --- a/doc/en/autogen/user/fifo_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_fifo.file.enabled]] *fifo.file.enabled* -** description: pass:none[enable FIFO pipe] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_fifo.file.path]] *fifo.file.path* -** description: pass:none[path for FIFO file; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default); WeeChat PID can be used in path with ${info:pid} (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+"%h/weechat_fifo"+` diff --git a/doc/en/autogen/user/fset_commands.adoc b/doc/en/autogen/user/fset_commands.adoc deleted file mode 100644 index 2d5a89257..000000000 --- a/doc/en/autogen/user/fset_commands.adoc +++ /dev/null @@ -1,160 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_fset_fset]] -* `+fset+`: fast set WeeChat and plugins options - ----- -/fset -bar - -refresh - -up|-down [<number>] - -left|-right [<percent>] - -go <line>|end - -toggle - -add [<value>] - -reset - -unset - -set - -setnew - -append - -mark - -format - -export [-help|-nohelp] <filename> - <filter> - - -bar: add the help bar - -refresh: refresh list of options, then whole screen (command: /window refresh) - -up: move the selected line up by "number" lines - -down: move the selected line down by "number" lines - -left: scroll the fset buffer by "percent" of width on the left - -right: scroll the fset buffer by "percent" of width on the right - -go: select a line by number, first line number is 0 ("end" to select the last line) - -toggle: toggle the boolean value - -add: add "value" (which can be a negative number) for integers and colors, set/append to value for other types (set for a negative value, append for a positive value) - -reset: reset the value of option - -unset: unset the option - -set: add the /set command in input to edit the value of option (move the cursor at the beginning of value) - -setnew: add the /set command in input to edit a new value for the option - -append: add the /set command to append something in the value of option (move the cursor at the end of value) - -mark: toggle mark - -format: switch to the next available format - -export: export the options and values displayed in a file (each line has format: "/set name value" or "/unset name") - -help: force writing of help on options in exported file (see /help fset.look.export_help_default) - -nohelp: do not write help on options in exported file (see /help fset.look.export_help_default) - filter: set a new filter to see only matching options (this filter can be used as input in fset buffer as well); allowed formats are: - * show all options (no filter) - xxx show only options with "xxx" in name - f:xxx show only configuration file "xxx" - t:xxx show only type "xxx" (bool/int/str/col) - d show only changed options - d:xxx show only changed options with "xxx" in name - d=xxx show only changed options with "xxx" in value - d==xxx show only changed options with exact value "xxx" - h=xxx show only options with "xxx" in description (translated) - he=xxx show only options with "xxx" in description (in English) - =xxx show only options with "xxx" in value - ==xxx show only options with exact value "xxx" - c:xxx show only options matching the evaluated condition "xxx", using following variables: file, section, option, name, parent_name, type, type_en, type_short (bool/int/str/col), type_tiny (b/i/s/c), default_value, default_value_undef, value, quoted_value, value_undef, value_changed, parent_value, min, max, description, description2, description_en, description_en2, string_values - -The lines with options are displayed using string evaluation (see /help eval for the format), with these options: - - fset.format.option1: first format for an option - - fset.format.option2: second format for an option - -The following variables can be used in these options: - - option data, with color and padded by spaces on the right: - - ${file}: configuration file (for example "weechat" or "irc") - - ${section}: section - - ${option}: option name - - ${name}: full option name (file.section.option) - - ${parent_name}: parent option name - - ${type}: option type (translated) - - ${type_en}: option type (in English) - - ${type_short}: short option type (bool/int/str/col) - - ${type_tiny}: tiny option type (b/i/s/c) - - ${default_value}: option default value - - ${default_value_undef}: "1" if default value is null, otherwise "0" - - ${value}: option value - - ${value_undef}: "1" if value is null, otherwise "0" - - ${value_changed}: "1" if value is different from default value, otherwise "0" - - ${value2}: option value, with inherited value if null - - ${parent_value}: parent option value - - ${min}: min value - - ${max}: max value - - ${description}: option description (translated) - - ${description2}: option description (translated), "(no description)" (translated) if there's no description - - ${description_en}: option description (in English) - - ${description_en2}: option description (in English), "(no description)" if there's no description - - ${string_values}: string values allowed for set of an integer option using strings - - ${marked}: "1" if option is marked, otherwise "0" - - ${index}: index of option in list - - option data, with color but no spaces: - - same names prefixed by underscore, for example: ${_name}, ${_type}, ... - - option data, raw format (no colors/spaces): - - same names prefixed by two underscores, for example: ${__name}, ${__type}, ... - - option data, only spaces: - - same names prefixed with "empty_", for example: ${empty_name}, ${empty_type} - - other data: - - ${selected_line}: "1" if the line is selected, otherwise "0" - - ${newline}: insert a new line at point, so the option is displayed on multiple lines - -Keys and input to move in on fset buffer: - up move one line up - down move one line down - pgup move one page up - pgdn move one page down - alt-home << move to first line - alt-end >> move to last line - F11 < scroll horizontally on the left - F12 > scroll horizontally on the right - -Keys and input to set options on fset buffer: - alt+space t toggle boolean value - alt+'-' - subtract 1 from value for integer/color, set value for other types - alt+'+' + add 1 to value for integer/color, append to value for other types - alt+f, alt+r r reset value - alt+f, alt+u u unset value - alt+enter s set value - alt+f, alt+n n set new value - alt+f, alt+a a append to value - alt+',' , mark/unmark option - shift+up move one line up and mark/unmark option - shift+down mark/unmark option and move one line down - m:xxx mark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see filters above) - u:xxx unmark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see filters above) - -Other keys and input on fset buffer: - ctrl+L refresh options and whole screen (command: /fset -refresh) - $ refresh options (keep marked options) - $$ refresh options (unmark all options) - alt+p p toggle plugin description options (plugins.desc.*) - alt+v v toggle help bar - s:x,y sort options by fields x,y (see /help fset.look.sort) - s: reset sort to its default value (see /help fset.look.sort) - w:xxx export options in file "xxx" - w-:xxx export options in file "xxx" without help - w+:xxx export options in file "xxx" with help - ctrl+X x switch the format used to display options - q close fset buffer - -Mouse actions on fset buffer: - wheel up/down move line up/down - left button move line here - right button toggle boolean (on/off) or edit the option value - right button + drag left/right increase/decrease value for integer/color, set/append to value for other types - right button + drag up/down mark/unmark multiple options - -Note: if input has one or more leading spaces, the following text is interpreted as a filter, without the spaces. For example " q" searches all options with "q" inside name while "q" closes the fset buffer. - -Examples: - show IRC options changed: - /fset d:irc.* - show all options with "nicklist" in name: - /fset nicklist - show all values which contain "red": - /fset =red - show all values which are exactly "red": - /fset ==red - show all integer options in irc plugin: - /fset c:${file} == irc && ${type_en} == integer ----- diff --git a/doc/en/autogen/user/fset_options.adoc b/doc/en/autogen/user/fset_options.adoc deleted file mode 100644 index 14ef801ac..000000000 --- a/doc/en/autogen/user/fset_options.adoc +++ /dev/null @@ -1,477 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_fset.color.default_value]] *fset.color.default_value* -** description: pass:none[color for default value] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.default_value_selected]] *fset.color.default_value_selected* -** description: pass:none[color for default value on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.description]] *fset.color.description* -** description: pass:none[color for description] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.description_selected]] *fset.color.description_selected* -** description: pass:none[color for description on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.file]] *fset.color.file* -** description: pass:none[color for file] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.file_changed]] *fset.color.file_changed* -** description: pass:none[color for file if value is changed] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_fset.color.file_changed_selected]] *fset.color.file_changed_selected* -** description: pass:none[color for file if value is changed on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.file_selected]] *fset.color.file_selected* -** description: pass:none[color for file on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.help_default_value]] *fset.color.help_default_value* -** description: pass:none[color for default value in help bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.help_description]] *fset.color.help_description* -** description: pass:none[color for description in help bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.help_name]] *fset.color.help_name* -** description: pass:none[color for name in help bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.help_quotes]] *fset.color.help_quotes* -** description: pass:none[color for quotes around string values] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+darkgray+` - -* [[option_fset.color.help_values]] *fset.color.help_values* -** description: pass:none[color for allowed values] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.index]] *fset.color.index* -** description: pass:none[color for index of option] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_fset.color.index_selected]] *fset.color.index_selected* -** description: pass:none[color for index of option on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_fset.color.line_marked_bg1]] *fset.color.line_marked_bg1* -** description: pass:none[background color for a marked line (used with the first format, see option fset.format.option1)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.line_marked_bg2]] *fset.color.line_marked_bg2* -** description: pass:none[background color for a marked line (used with the second format, see option fset.format.option2)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.line_selected_bg1]] *fset.color.line_selected_bg1* -** description: pass:none[background color for the selected line (used with the first format, see option fset.format.option1)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+blue+` - -* [[option_fset.color.line_selected_bg2]] *fset.color.line_selected_bg2* -** description: pass:none[background color for the selected line (used with the second format, see option fset.format.option2)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_fset.color.marked]] *fset.color.marked* -** description: pass:none[color for mark indicator] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_fset.color.marked_selected]] *fset.color.marked_selected* -** description: pass:none[color for mark indicator on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.max]] *fset.color.max* -** description: pass:none[color for max value] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.max_selected]] *fset.color.max_selected* -** description: pass:none[color for max value on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.min]] *fset.color.min* -** description: pass:none[color for min value] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.min_selected]] *fset.color.min_selected* -** description: pass:none[color for min value on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.name]] *fset.color.name* -** description: pass:none[color for name] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.name_changed]] *fset.color.name_changed* -** description: pass:none[color for name if value is changed] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_fset.color.name_changed_selected]] *fset.color.name_changed_selected* -** description: pass:none[color for name if value is changed on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.name_selected]] *fset.color.name_selected* -** description: pass:none[color for name on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.option]] *fset.color.option* -** description: pass:none[color for option] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.option_changed]] *fset.color.option_changed* -** description: pass:none[color for option if value is changed] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_fset.color.option_changed_selected]] *fset.color.option_changed_selected* -** description: pass:none[color for option if value is changed on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.option_selected]] *fset.color.option_selected* -** description: pass:none[color for option on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.parent_name]] *fset.color.parent_name* -** description: pass:none[color for name of parent option] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.parent_name_selected]] *fset.color.parent_name_selected* -** description: pass:none[color for name of parent option on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.parent_value]] *fset.color.parent_value* -** description: pass:none[color for value of parent option] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_fset.color.parent_value_selected]] *fset.color.parent_value_selected* -** description: pass:none[color for value of parent option on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_fset.color.quotes]] *fset.color.quotes* -** description: pass:none[color for quotes around string values] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+darkgray+` - -* [[option_fset.color.quotes_changed]] *fset.color.quotes_changed* -** description: pass:none[color for quotes around string values which are changed] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.quotes_changed_selected]] *fset.color.quotes_changed_selected* -** description: pass:none[color for quotes around string values which are changed on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.quotes_selected]] *fset.color.quotes_selected* -** description: pass:none[color for quotes around string values on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.section]] *fset.color.section* -** description: pass:none[color for section] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.section_changed]] *fset.color.section_changed* -** description: pass:none[color for section if value is changed] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_fset.color.section_changed_selected]] *fset.color.section_changed_selected* -** description: pass:none[color for section if value is changed on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.section_selected]] *fset.color.section_selected* -** description: pass:none[color for section on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.string_values]] *fset.color.string_values* -** description: pass:none[color for string values] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.string_values_selected]] *fset.color.string_values_selected* -** description: pass:none[color for string values on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.title_count_options]] *fset.color.title_count_options* -** description: pass:none[color for the count of options found with the current filter in title of buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_fset.color.title_current_option]] *fset.color.title_current_option* -** description: pass:none[color for current option number in title of buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_fset.color.title_filter]] *fset.color.title_filter* -** description: pass:none[color for filter in title of buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.title_marked_options]] *fset.color.title_marked_options* -** description: pass:none[color for number of marked options in title of buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_fset.color.title_sort]] *fset.color.title_sort* -** description: pass:none[color for sort in title of buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.type]] *fset.color.type* -** description: pass:none[color for type] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_fset.color.type_selected]] *fset.color.type_selected* -** description: pass:none[color for type on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_fset.color.unmarked]] *fset.color.unmarked* -** description: pass:none[color for mark indicator when the option is not marked] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_fset.color.unmarked_selected]] *fset.color.unmarked_selected* -** description: pass:none[color for mark indicator when the option is not marked on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_fset.color.value]] *fset.color.value* -** description: pass:none[color for value] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_fset.color.value_changed]] *fset.color.value_changed* -** description: pass:none[color for value changed (different from default)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_fset.color.value_changed_selected]] *fset.color.value_changed_selected* -** description: pass:none[color for value changed (different from default) on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_fset.color.value_selected]] *fset.color.value_selected* -** description: pass:none[color for value on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_fset.color.value_undef]] *fset.color.value_undef* -** description: pass:none[color for undefined value] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_fset.color.value_undef_selected]] *fset.color.value_undef_selected* -** description: pass:none[color for undefined value on the selected line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_fset.format.export_help]] *fset.format.export_help* -** description: pass:none[format of help line written before each option exported in a file (note: content is evaluated, see /help fset)] -** type: string -** values: any string -** default value: `+"# ${description2}"+` - -* [[option_fset.format.export_option]] *fset.format.export_option* -** description: pass:none[format of each option exported in a file (note: content is evaluated, see /help fset)] -** type: string -** values: any string -** default value: `+"/set ${name} ${quoted_value}"+` - -* [[option_fset.format.export_option_null]] *fset.format.export_option_null* -** description: pass:none[format of each option with "null" value exported in a file (note: content is evaluated, see /help fset)] -** type: string -** values: any string -** default value: `+"/unset ${name}"+` - -* [[option_fset.format.option1]] *fset.format.option1* -** description: pass:none[first format of each line, used when option fset.look.format_number is set to 1 (note: content is evaluated, see /help fset); an empty string uses the default format ("${marked} ${name} ${type} ${value2}"), which is without evaluation of string and then much faster; formats can be switched with key ctrl+X] -** type: string -** values: any string -** default value: `+""+` - -* [[option_fset.format.option2]] *fset.format.option2* -** description: pass:none[second format of each line, used when option fset.look.format_number is set to 2 (note: content is evaluated, see /help fset); an empty string uses the default format ("${marked} ${name} ${type} ${value2}"), which is without evaluation of string and then much faster; formats can be switched with key ctrl+X] -** type: string -** values: any string -** default value: `+"${marked} ${name} ${type} ${value2}${newline} ${empty_name} ${_default_value}${color:darkgray} -- ${min}..${max}${newline} ${empty_name} ${description}"+` - -* [[option_fset.look.auto_unmark]] *fset.look.auto_unmark* -** description: pass:none[automatically unmark all options after an action on marked options or after a refresh] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_fset.look.condition_catch_set]] *fset.look.condition_catch_set* -** description: pass:none[condition to catch /set command and display results in the fset buffer; following variables can be used: ${name} (name of option given for the /set command), ${count} (number of options found with the /set argument); an empty string disables the catch of /set command; with value "1", the fset buffer is always used with /set command] -** type: string -** values: any string -** default value: `+"${count} >= 1"+` - -* [[option_fset.look.export_help_default]] *fset.look.export_help_default* -** description: pass:none[write help for each option exported by default (this can be overridden with arguments "-help" and "-nohelp" for command /fset -export)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_fset.look.format_number]] *fset.look.format_number* -** description: pass:none[number of format used to display options; this is dynamically changed by the key ctrl-X on the fset buffer] -** type: integer -** values: 1 .. 2 -** default value: `+1+` - -* [[option_fset.look.marked_string]] *fset.look.marked_string* -** description: pass:none[string displayed when an option is marked (to do an action on multiple options)] -** type: string -** values: any string -** default value: `+"*"+` - -* [[option_fset.look.scroll_horizontal]] *fset.look.scroll_horizontal* -** description: pass:none[left/right scroll in fset buffer (percent of width)] -** type: integer -** values: 1 .. 100 -** default value: `+10+` - -* [[option_fset.look.show_plugins_desc]] *fset.look.show_plugins_desc* -** description: pass:none[show the plugin description options (plugins.desc.*)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_fset.look.sort]] *fset.look.sort* -** description: pass:none[comma-separated list of fields to sort options (see /help fset for a list of fields); char "-" can be used before field to reverse order, char "~" can be used to do a case insensitive comparison; example: "-~name" for case insensitive and reverse sort on option name] -** type: string -** values: any string -** default value: `+"~name"+` - -* [[option_fset.look.unmarked_string]] *fset.look.unmarked_string* -** description: pass:none[string displayed when an option is not marked] -** type: string -** values: any string -** default value: `+" "+` - -* [[option_fset.look.use_color_value]] *fset.look.use_color_value* -** description: pass:none[use the color to display value of color options] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_fset.look.use_keys]] *fset.look.use_keys* -** description: pass:none[use keys alt+X in fset buffer to do actions on options; if disabled, only the input is allowed] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_fset.look.use_mute]] *fset.look.use_mute* -** description: pass:none[use /mute command to set options] -** type: boolean -** values: on, off -** default value: `+off+` diff --git a/doc/en/autogen/user/guile_commands.adoc b/doc/en/autogen/user/guile_commands.adoc deleted file mode 100644 index 81e7934ec..000000000 --- a/doc/en/autogen/user/guile_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_guile_guile]] -* `+guile+`: list/load/unload scripts - ----- -/guile list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/guile_options.adoc b/doc/en/autogen/user/guile_options.adoc deleted file mode 100644 index 7637dbc11..000000000 --- a/doc/en/autogen/user/guile_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_guile.look.check_license]] *guile.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_guile.look.eval_keep_context]] *guile.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/irc_colors.adoc b/doc/en/autogen/user/irc_colors.adoc deleted file mode 100644 index 4213842e5..000000000 --- a/doc/en/autogen/user/irc_colors.adoc +++ /dev/null @@ -1,109 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[width="50%",cols="^2m,3",options="header"] -|=== -| IRC color | WeeChat color - -| 00 | white -| 01 | black -| 02 | blue -| 03 | green -| 04 | lightred -| 05 | red -| 06 | magenta -| 07 | brown -| 08 | yellow -| 09 | lightgreen -| 10 | cyan -| 11 | lightcyan -| 12 | lightblue -| 13 | lightmagenta -| 14 | darkgray -| 15 | gray -| 16 | 52 -| 17 | 94 -| 18 | 100 -| 19 | 58 -| 20 | 22 -| 21 | 29 -| 22 | 23 -| 23 | 24 -| 24 | 17 -| 25 | 54 -| 26 | 53 -| 27 | 89 -| 28 | 88 -| 29 | 130 -| 30 | 142 -| 31 | 64 -| 32 | 28 -| 33 | 35 -| 34 | 30 -| 35 | 25 -| 36 | 18 -| 37 | 91 -| 38 | 90 -| 39 | 125 -| 40 | 124 -| 41 | 166 -| 42 | 184 -| 43 | 106 -| 44 | 34 -| 45 | 49 -| 46 | 37 -| 47 | 33 -| 48 | 19 -| 49 | 129 -| 50 | 127 -| 51 | 161 -| 52 | 196 -| 53 | 208 -| 54 | 226 -| 55 | 154 -| 56 | 46 -| 57 | 86 -| 58 | 51 -| 59 | 75 -| 60 | 21 -| 61 | 171 -| 62 | 201 -| 63 | 198 -| 64 | 203 -| 65 | 215 -| 66 | 227 -| 67 | 191 -| 68 | 83 -| 69 | 122 -| 70 | 87 -| 71 | 111 -| 72 | 63 -| 73 | 177 -| 74 | 207 -| 75 | 205 -| 76 | 217 -| 77 | 223 -| 78 | 229 -| 79 | 193 -| 80 | 157 -| 81 | 158 -| 82 | 159 -| 83 | 153 -| 84 | 147 -| 85 | 183 -| 86 | 219 -| 87 | 212 -| 88 | 16 -| 89 | 233 -| 90 | 235 -| 91 | 237 -| 92 | 239 -| 93 | 241 -| 94 | 244 -| 95 | 247 -| 96 | 250 -| 97 | 254 -| 98 | 231 -| 99 | default -|=== diff --git a/doc/en/autogen/user/irc_commands.adoc b/doc/en/autogen/user/irc_commands.adoc deleted file mode 100644 index 4417455c3..000000000 --- a/doc/en/autogen/user/irc_commands.adoc +++ /dev/null @@ -1,976 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_irc_admin]] -* `+admin+`: find information about the administrator of the server - ----- -/admin [<target>] - -target: server name ----- - -[[command_irc_allchan]] -* `+allchan+`: execute a command on all channels of all connected servers - ----- -/allchan [-current] [-exclude=<channel>[,<channel>...]] <command> [<arguments>] - [-current] -include=<channel>[,<channel>...] <command> [<arguments>] - - -current: execute command for channels of current server only - -exclude: exclude some channels (wildcard "*" is allowed) - -include: include only some channels (wildcard "*" is allowed) - command: command to execute -arguments: arguments for command (special variables $nick, $channel and $server are replaced by their value) - -Examples: - execute '/me is testing' on all channels: - /allchan me is testing - say 'hello' everywhere but not on #weechat: - /allchan -exclude=#weechat msg * hello - say 'hello' everywhere but not on #weechat and channels beginning with #linux: - /allchan -exclude=#weechat,#linux* msg * hello - say 'hello' on all channels beginning with #linux: - /allchan -include=#linux* msg * hello ----- - -[[command_irc_allpv]] -* `+allpv+`: execute a command on all private buffers of all connected servers - ----- -/allpv [-current] [-exclude=<nick>[,<nick>...]] <command> [<arguments>] - [-current] -include=<nick>[,<nick>...] <command> [<arguments>] - - -current: execute command for private buffers of current server only - -exclude: exclude some nicks (wildcard "*" is allowed) - -include: include only some nicks (wildcard "*" is allowed) - command: command to execute -arguments: arguments for command (special variables $nick, $channel and $server are replaced by their value) - -Examples: - execute '/me is testing' on all private buffers: - /allpv me is testing - say 'hello' everywhere but not for nick foo: - /allpv -exclude=foo msg * hello - say 'hello' everywhere but not for nick foo and nicks beginning with bar: - /allpv -exclude=foo,bar* msg * hello - say 'hello' for all nicks beginning with bar: - /allpv -include=bar* msg * hello - close all private buffers: - /allpv close ----- - -[[command_irc_allserv]] -* `+allserv+`: execute a command on all connected servers - ----- -/allserv [-exclude=<server>[,<server>...]] <command> [<arguments>] - -include=<server>[,<server>...] <command> [<arguments>] - - -exclude: exclude some servers (wildcard "*" is allowed) - -include: include only some servers (wildcard "*" is allowed) - command: command to execute -arguments: arguments for command (special variables $nick, $channel and $server are replaced by their value) - -Examples: - change nick on all servers: - /allserv nick newnick - set away on all servers: - /allserv away I'm away - do a whois on my nick on all servers: - /allserv whois $nick ----- - -[[command_irc_ban]] -* `+ban+`: ban nicks or hosts - ----- -/ban [<channel>] [<nick> [<nick>...]] - -channel: channel name - nick: nick or host - -Without argument, this command displays the ban list for current channel. ----- - -[[command_irc_cap]] -* `+cap+`: client capability negotiation - ----- -/cap ls - list - req|ack [<capability> [<capability>...]] - end - - ls: list the capabilities supported by the server - list: list the capabilities currently enabled - req: request a capability - ack: acknowledge capabilities which require client-side acknowledgement - end: end the capability negotiation - -Without argument, "ls" and "list" are sent. - -Capabilities supported by WeeChat are: account-notify, away-notify, cap-notify, chghost, extended-join, invite-notify, multi-prefix, server-time, userhost-in-names. - -The capabilities to automatically enable on servers can be set in option irc.server_default.capabilities (or by server in option irc.server.xxx.capabilities). - -Examples: - /cap - /cap req multi-prefix away-notify ----- - -[[command_irc_connect]] -* `+connect+`: connect to IRC server(s) - ----- -/connect [<server> [<server>...]] [-<option>[=<value>]] [-no<option>] [-nojoin] [-switch] - -all|-auto|-open [-nojoin] [-switch] - - server: server name, which can be: - - internal server name (added by /server add, recommended usage) - - hostname/port or IP/port, port is 6667 by default - - URL with format: irc[6][s]://[nickname[:password]@]irc.example.org[:port][/#channel1][,#channel2[...]] - Note: for an address/IP/URL, a temporary server is added (NOT SAVED), see /help irc.look.temporary_servers - option: set option for server (for boolean option, value can be omitted) - nooption: set boolean option to 'off' (for example: -nossl) - -all: connect to all servers defined in configuration - -auto: connect to servers with autoconnect enabled - -open: connect to all opened servers that are not currently connected - -nojoin: do not join any channel (even if autojoin is enabled on server) - -switch: switch to next server address - -To disconnect from a server or stop any connection attempt, use command /disconnect. - -Examples: - /connect freenode - /connect irc.oftc.net/6667 - /connect irc6.oftc.net/6667 -ipv6 - /connect irc6.oftc.net/6697 -ipv6 -ssl - /connect my.server.org/6697 -ssl -password=test - /connect irc://nick@irc.oftc.net/#channel - /connect -switch ----- - -[[command_irc_ctcp]] -* `+ctcp+`: send a CTCP message (Client-To-Client Protocol) - ----- -/ctcp [-server <server>] <target>[,<target>...] <type> [<arguments>] - - server: send to this server (internal name) - target: nick or channel ('*' = current channel) - type: CTCP type (examples: "version", "ping", etc.) -arguments: arguments for CTCP - -Examples: - /ctcp toto time - /ctcp toto version - /ctcp * version ----- - -[[command_irc_cycle]] -* `+cycle+`: leave and rejoin a channel - ----- -/cycle [<channel>[,<channel>...]] [<message>] - -channel: channel name -message: part message (displayed to other users) ----- - -[[command_irc_dcc]] -* `+dcc+`: start a DCC (file transfer or direct chat) - ----- -/dcc chat <nick> - send <nick> <file> - -nick: nick -file: filename (on local host) - -Examples: - chat with nick "toto": - /dcc chat toto - send file "/home/foo/bar.txt" to nick "toto": - /dcc send toto /home/foo/bar.txt ----- - -[[command_irc_dehalfop]] -* `+dehalfop+`: remove channel half-operator status from nick(s) - ----- -/dehalfop <nick> [<nick>...] - -nick: nick or mask (wildcard "*" is allowed) - *: remove channel half-operator status from everybody on channel except yourself ----- - -[[command_irc_deop]] -* `+deop+`: remove channel operator status from nick(s) - ----- -/deop <nick> [<nick>...] - * -yes - -nick: nick or mask (wildcard "*" is allowed) - *: remove channel operator status from everybody on channel except yourself ----- - -[[command_irc_devoice]] -* `+devoice+`: remove voice from nick(s) - ----- -/devoice <nick> [<nick>...] - * -yes - -nick: nick or mask (wildcard "*" is allowed) - *: remove voice from everybody on channel ----- - -[[command_irc_die]] -* `+die+`: shutdown the server - ----- -/die [<target>] - -target: server name ----- - -[[command_irc_disconnect]] -* `+disconnect+`: disconnect from one or all IRC servers - ----- -/disconnect [<server>|-all|-pending [<reason>]] - - server: internal server name - -all: disconnect from all servers --pending: cancel auto-reconnection on servers currently reconnecting - reason: reason for the "quit" ----- - -[[command_irc_halfop]] -* `+halfop+`: give channel half-operator status to nick(s) - ----- -/halfop <nick> [<nick>...] - * -yes - -nick: nick or mask (wildcard "*" is allowed) - *: give channel half-operator status to everybody on channel ----- - -[[command_irc_ignore]] -* `+ignore+`: ignore nicks/hosts from servers or channels - ----- -/ignore list - add [re:]<nick> [<server> [<channel>]] - del <number>|-all - - list: list all ignores - add: add an ignore - nick: nick or hostname (can be a POSIX extended regular expression if "re:" is given or a mask using "*" to replace zero or more chars) - del: delete an ignore - number: number of ignore to delete (look at list to find it) - -all: delete all ignores - server: internal server name where ignore is working - channel: channel name where ignore is working - -Note: the regular expression can start with "(?-i)" to become case sensitive. - -Examples: - ignore nick "toto" everywhere: - /ignore add toto - ignore host "toto@domain.com" on freenode server: - /ignore add toto@domain.com freenode - ignore host "toto*@*.domain.com" on freenode/#weechat: - /ignore add toto*@*.domain.com freenode #weechat ----- - -[[command_irc_info]] -* `+info+`: get information describing the server - ----- -/info [<target>] - -target: server name ----- - -[[command_irc_invite]] -* `+invite+`: invite a nick on a channel - ----- -/invite <nick> [<nick>...] [<channel>] - - nick: nick -channel: channel name ----- - -[[command_irc_ison]] -* `+ison+`: check if a nick is currently on IRC - ----- -/ison <nick> [<nick>...] - -nick: nick ----- - -[[command_irc_join]] -* `+join+`: join a channel - ----- -/join [-noswitch] [-server <server>] [<channel1>[,<channel2>...]] [<key1>[,<key2>...]] - --noswitch: do not switch to new buffer - server: send to this server (internal name) - channel: channel name to join - key: key to join the channel (channels with a key must be the first in list) - -Examples: - /join #weechat - /join #protectedchan,#weechat key - /join -server freenode #weechat - /join -noswitch #weechat ----- - -[[command_irc_kick]] -* `+kick+`: kick a user out of a channel - ----- -/kick [<channel>] <nick> [<reason>] - -channel: channel name - nick: nick - reason: reason (special variables $nick, $channel and $server are replaced by their value) ----- - -[[command_irc_kickban]] -* `+kickban+`: kick a user out of a channel and ban the host - ----- -/kickban [<channel>] <nick> [<reason>] - -channel: channel name - nick: nick - reason: reason (special variables $nick, $channel and $server are replaced by their value) - -It is possible to kick/ban with a mask, nick will be extracted from mask and replaced by "*". - -Example: - ban "*!*@host.com" and then kick "toto": - /kickban toto!*@host.com ----- - -[[command_irc_kill]] -* `+kill+`: close client-server connection - ----- -/kill <nick> [<reason>] - - nick: nick -reason: reason ----- - -[[command_irc_links]] -* `+links+`: list all server names which are known by the server answering the query - ----- -/links [[<target>] <server_mask>] - - target: this remote server should answer the query -server_mask: list of servers must match this mask ----- - -[[command_irc_list]] -* `+list+`: list channels and their topic - ----- -/list [-server <server>] [-re <regex>] [<channel>[,<channel>...]] [<target>] - - server: send to this server (internal name) - regex: POSIX extended regular expression used to filter results (case insensitive, can start by "(?-i)" to become case sensitive) -channel: channel to list - target: server name - -Examples: - list all channels on server (can be very slow on large networks): - /list - list channel #weechat: - /list #weechat - list all channels beginning with "#weechat" (can be very slow on large networks): - /list -re #weechat.* ----- - -[[command_irc_lusers]] -* `+lusers+`: get statistics about the size of the IRC network - ----- -/lusers [<mask> [<target>]] - - mask: servers matching the mask only -target: server for forwarding request ----- - -[[command_irc_map]] -* `+map+`: show a graphical map of the IRC network - ----- ----- - -[[command_irc_me]] -* `+me+`: send a CTCP action to the current channel - ----- -/me <message> - -message: message to send ----- - -[[command_irc_mode]] -* `+mode+`: change channel or user mode - ----- -/mode [<channel>] [+|-]o|p|s|i|t|n|m|l|b|e|v|k [<arguments>] - <nick> [+|-]i|s|w|o - -channel modes: - channel: channel name to modify (default is current one) - o: give/take channel operator privileges - p: private channel flag - s: secret channel flag - i: invite-only channel flag - t: topic settable by channel operator only flag - n: no messages to channel from clients on the outside - m: moderated channel - l: set the user limit to channel - b: set a ban mask to keep users out - e: set exception mask - v: give/take the ability to speak on a moderated channel - k: set a channel key (password) -user modes: - nick: nick to modify - i: mark a user as invisible - s: mark a user for receive server notices - w: user receives wallops - o: operator flag - -List of modes is not comprehensive, you should read documentation about your server to see all possible modes. - -Examples: - protect topic on channel #weechat: - /mode #weechat +t - become invisible on server: - /mode nick +i ----- - -[[command_irc_motd]] -* `+motd+`: get the "Message Of The Day" - ----- -/motd [<target>] - -target: server name ----- - -[[command_irc_msg]] -* `+msg+`: send message to a nick or channel - ----- -/msg [-server <server>] <target>[,<target>...] <text> - -server: send to this server (internal name) -target: nick or channel (may be mask, '*' = current channel) - text: text to send ----- - -[[command_irc_names]] -* `+names+`: list nicks on channels - ----- -/names [<channel>[,<channel>...]] - -channel: channel name ----- - -[[command_irc_nick]] -* `+nick+`: change current nick - ----- -/nick [-all] <nick> - --all: set new nick for all connected servers -nick: new nick ----- - -[[command_irc_notice]] -* `+notice+`: send notice message to user - ----- -/notice [-server <server>] <target> <text> - -server: send to this server (internal name) -target: nick or channel name - text: text to send ----- - -[[command_irc_notify]] -* `+notify+`: add a notification for presence or away status of nicks on servers - ----- -/notify add <nick> [<server> [-away]] - del <nick>|-all [<server>] - - add: add a notification - nick: nick -server: internal server name (by default current server) - -away: notify when away message is changed (by doing whois on nick) - del: delete a notification - -all: delete all notifications - -Without argument, this command displays notifications for current server (or all servers if command is issued on core buffer). - -Examples: - notify when "toto" joins/quits current server: - /notify add toto - notify when "toto" joins/quits freenode server: - /notify add toto freenode - notify when "toto" is away or back on freenode server: - /notify add toto freenode -away ----- - -[[command_irc_op]] -* `+op+`: give channel operator status to nick(s) - ----- -/op <nick> [<nick>...] - * -yes - -nick: nick or mask (wildcard "*" is allowed) - *: give channel operator status to everybody on channel ----- - -[[command_irc_oper]] -* `+oper+`: get operator privileges - ----- -/oper <user> <password> - - user: user -password: password ----- - -[[command_irc_part]] -* `+part+`: leave a channel - ----- -/part [<channel>[,<channel>...]] [<message>] - -channel: channel name to leave -message: part message (displayed to other users) ----- - -[[command_irc_ping]] -* `+ping+`: send a ping to server - ----- -/ping <target1> [<target2>] - -target1: server -target2: forward ping to this server ----- - -[[command_irc_pong]] -* `+pong+`: answer to a ping message - ----- -/pong <daemon> [<daemon2>] - - daemon: daemon who has responded to Ping message -daemon2: forward message to this daemon ----- - -[[command_irc_query]] -* `+query+`: send a private message to a nick - ----- -/query [-noswitch] [-server <server>] <nick>[,<nick>...] [<text>] - --noswitch: do not switch to new buffer - server: send to this server (internal name) - nick: nick - text: text to send ----- - -[[command_irc_quiet]] -* `+quiet+`: quiet nicks or hosts - ----- -/quiet [<channel>] [<nick> [<nick>...]] - -channel: channel name - nick: nick or host - -Without argument, this command displays the quiet list for current channel. ----- - -[[command_irc_quote]] -* `+quote+`: send raw data to server without parsing - ----- -/quote [-server <server>] <data> - -server: send to this server (internal name) - data: raw data to send ----- - -[[command_irc_reconnect]] -* `+reconnect+`: reconnect to server(s) - ----- -/reconnect <server> [<server>...] [-nojoin] [-switch] - -all [-nojoin] [-switch] - - server: server to reconnect (internal name) - -all: reconnect to all servers --nojoin: do not join any channel (even if autojoin is enabled on server) --switch: switch to next server address ----- - -[[command_irc_rehash]] -* `+rehash+`: tell the server to reload its config file - ----- -/rehash [<option>] - -option: extra option, for some servers ----- - -[[command_irc_remove]] -* `+remove+`: force a user to leave a channel - ----- -/remove [<channel>] <nick> [<reason>] - -channel: channel name - nick: nick - reason: reason (special variables $nick, $channel and $server are replaced by their value) ----- - -[[command_irc_restart]] -* `+restart+`: tell the server to restart itself - ----- -/restart [<target>] - -target: server name ----- - -[[command_irc_sajoin]] -* `+sajoin+`: force a user to join channel(s) - ----- -/sajoin <nick> <channel>[,<channel>...] - - nick: nick -channel: channel name ----- - -[[command_irc_samode]] -* `+samode+`: change mode on channel, without having operator status - ----- -/samode [<channel>] <mode> - -channel: channel name - mode: mode for channel ----- - -[[command_irc_sanick]] -* `+sanick+`: force a user to use another nick - ----- -/sanick <nick> <new_nick> - - nick: nick -new_nick: new nick ----- - -[[command_irc_sapart]] -* `+sapart+`: force a user to leave channel(s) - ----- -/sapart <nick> <channel>[,<channel>...] - - nick: nick -channel: channel name ----- - -[[command_irc_saquit]] -* `+saquit+`: force a user to quit server with a reason - ----- -/saquit <nick> <reason> - - nick: nick -reason: reason ----- - -[[command_irc_server]] -* `+server+`: list, add or remove IRC servers - ----- -/server list|listfull [<name>] - add <name> <hostname>[/<port>] [-temp] [-<option>[=<value>]] [-no<option>] - copy|rename <name> <new_name> - reorder <name> [<name>...] - open <name>|-all [<name>...] - del|keep <name> - deloutq|jump - raw [<filter>] - - list: list servers (without argument, this list is displayed) -listfull: list servers with detailed info for each server - add: add a new server - name: server name, for internal and display use; this name is used to connect to the server (/connect name) and to set server options: irc.server.name.xxx -hostname: name or IP address of server, with optional port (default: 6667), many addresses can be separated by a comma - -temp: add a temporary server (not saved) - option: set option for server (for boolean option, value can be omitted) -nooption: set boolean option to 'off' (for example: -nossl) - copy: duplicate a server - rename: rename a server - reorder: reorder list of servers - open: open the server buffer without connecting - keep: keep server in config file (for temporary servers only) - del: delete a server - deloutq: delete messages out queue for all servers (all messages WeeChat is currently sending) - jump: jump to server buffer - raw: open buffer with raw IRC data - filter: set a new filter to see only matching messages (this filter can be used as input in raw IRC data buffer as well); allowed formats are: - * show all messages (no filter) - xxx show only messages containing "xxx" - s:xxx show only messages for server "xxx" - f:xxx show only messages with a flag: recv (message received), sent (message sent), modified (message modified by a modifier), redirected (message redirected) - m:xxx show only IRC command "xxx" - c:xxx show only messages matching the evaluated condition "xxx", using following variables: output of function irc_message_parse (like nick, command, channel, text, etc., see function info_get_hashtable in plugin API reference for the list of all variables), date (format: "yyyy-mm-dd hh:mm:ss"), server, recv, sent, modified, redirected - -Examples: - /server listfull - /server add freenode chat.freenode.net - /server add freenode chat.freenode.net/6697 -ssl -autoconnect - /server add chatspike irc.chatspike.net/6667,irc.duckspike.net/6667 - /server copy freenode freenode-test - /server rename freenode-test freenode2 - /server reorder freenode2 freenode - /server del freenode - /server deloutq - /server raw - /server raw s:freenode - /server raw c:${recv} && ${command}==PRIVMSG && ${nick}==foo ----- - -[[command_irc_service]] -* `+service+`: register a new service - ----- -/service <nick> <reserved> <distribution> <type> <reserved> <info> - -distribution: visibility of service - type: reserved for future usage ----- - -[[command_irc_servlist]] -* `+servlist+`: list services currently connected to the network - ----- -/servlist [<mask> [<type>]] - -mask: list only services matching this mask -type: list only services of this type ----- - -[[command_irc_squery]] -* `+squery+`: deliver a message to a service - ----- -/squery <service> <text> - -service: name of service - text: text to send ----- - -[[command_irc_squit]] -* `+squit+`: disconnect server links - ----- -/squit <target> <comment> - - target: server name -comment: comment ----- - -[[command_irc_stats]] -* `+stats+`: query statistics about server - ----- -/stats [<query> [<target>]] - - query: c/h/i/k/l/m/o/y/u (see RFC1459) -target: server name ----- - -[[command_irc_summon]] -* `+summon+`: give users who are on a host running an IRC server a message asking them to please join IRC - ----- -/summon <user> [<target> [<channel>]] - - user: username - target: server name -channel: channel name ----- - -[[command_irc_time]] -* `+time+`: query local time from server - ----- -/time [<target>] - -target: query time from specified server ----- - -[[command_irc_topic]] -* `+topic+`: get/set channel topic - ----- -/topic [<channel>] [<topic>|-delete] - -channel: channel name - topic: new topic --delete: delete channel topic ----- - -[[command_irc_trace]] -* `+trace+`: find the route to specific server - ----- -/trace [<target>] - -target: server name ----- - -[[command_irc_unban]] -* `+unban+`: unban nicks or hosts - ----- -/unban [<channel>] <nick>|<number> [<nick>|<number>...] - -channel: channel name - nick: nick or host - number: ban number (as displayed by command /ban) ----- - -[[command_irc_unquiet]] -* `+unquiet+`: unquiet nicks or hosts - ----- -/unquiet [<channel>] <nick>|<number> [<nick>|<number>...] - -channel: channel name - nick: nick or host - number: quiet number (as displayed by command /quiet) ----- - -[[command_irc_userhost]] -* `+userhost+`: return a list of information about nicks - ----- -/userhost <nick> [<nick>...] - -nick: nick ----- - -[[command_irc_users]] -* `+users+`: list of users logged into the server - ----- -/users [<target>] - -target: server name ----- - -[[command_irc_version]] -* `+version+`: give the version info of nick or server (current or specified) - ----- -/version [<target>|<nick>] - -target: server name - nick: nick ----- - -[[command_irc_voice]] -* `+voice+`: give voice to nick(s) - ----- -/voice <nick> [<nick>...] - -nick: nick or mask (wildcard "*" is allowed) - *: give voice to everybody on channel ----- - -[[command_irc_wallchops]] -* `+wallchops+`: send a notice to channel ops - ----- -/wallchops [<channel>] <text> - -channel: channel name - text: text to send ----- - -[[command_irc_wallops]] -* `+wallops+`: send a message to all currently connected users who have set the 'w' user mode for themselves - ----- -/wallops <text> - -text: text to send ----- - -[[command_irc_who]] -* `+who+`: generate a query which returns a list of information - ----- -/who [<mask> [o]] - -mask: only information which match this mask - o: only operators are returned according to the mask supplied ----- - -[[command_irc_whois]] -* `+whois+`: query information about user(s) - ----- -/whois [<target>] [<nick>[,<nick>...]] - -target: server name - nick: nick (may be a mask) - -Without argument, this command will do a whois on: -- your own nick if buffer is a server/channel -- remote nick if buffer is a private. - -If option irc.network.whois_double_nick is enabled, two nicks are sent (if only one nick is given), to get idle time in answer. ----- - -[[command_irc_whowas]] -* `+whowas+`: ask for information about a nick which no longer exists - ----- -/whowas <nick>[,<nick>...] [<count> [<target>]] - - nick: nick - count: number of replies to return (full search if negative number) -target: reply should match this mask ----- diff --git a/doc/en/autogen/user/irc_options.adoc b/doc/en/autogen/user/irc_options.adoc deleted file mode 100644 index 06250468d..000000000 --- a/doc/en/autogen/user/irc_options.adoc +++ /dev/null @@ -1,795 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_irc.color.input_nick]] *irc.color.input_nick* -** description: pass:none[color for nick in input bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_irc.color.item_channel_modes]] *irc.color.item_channel_modes* -** description: pass:none[color for channel modes, near channel name] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.color.item_lag_counting]] *irc.color.item_lag_counting* -** description: pass:none[color for lag indicator, when counting (pong not received from server, lag is increasing)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.color.item_lag_finished]] *irc.color.item_lag_finished* -** description: pass:none[color for lag indicator, when pong has been received from server] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_irc.color.item_nick_modes]] *irc.color.item_nick_modes* -** description: pass:none[color for nick modes in bar item "input_prompt"] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.color.message_chghost]] *irc.color.message_chghost* -** description: pass:none[color for text in chghost messages] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_irc.color.message_join]] *irc.color.message_join* -** description: pass:none[color for text in join messages] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_irc.color.message_kick]] *irc.color.message_kick* -** description: pass:none[color for text in kick/kill messages] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_irc.color.message_quit]] *irc.color.message_quit* -** description: pass:none[color for text in part/quit messages] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_irc.color.mirc_remap]] *irc.color.mirc_remap* -** description: pass:none[remap mirc colors in messages using a hashtable: keys are "fg,bg" as integers between -1 (not specified) and 15, values are WeeChat color names or numbers (format is: "1,-1:color1;2,7:color2"), example: "1,-1:darkgray;1,2:white,blue" to remap black to "darkgray" and black on blue to "white,blue"; default WeeChat colors for IRC codes: 0=white, 1=black, 2=blue, 3=green, 4=lightred, 5=red, 6=magenta, 7=brown, 8=yellow, 9=lightgreen, 10=cyan, 11=lightcyan, 12=lightblue, 13=lightmagenta, 14=darkgray, 15=gray] -** type: string -** values: any string -** default value: `+"1,-1:darkgray"+` - -* [[option_irc.color.nick_prefixes]] *irc.color.nick_prefixes* -** description: pass:none[color for nick prefixes using mode char (o=op, h=halfop, v=voice, ..), format is: "o:color1;h:color2;v:color3" (if a mode is not found, WeeChat will try with next modes received from server ("PREFIX"); a special mode "*" can be used as default color if no mode has been found in list)] -** type: string -** values: any string -** default value: `+"y:lightred;q:lightred;a:lightcyan;o:lightgreen;h:lightmagenta;v:yellow;*:lightblue"+` - -* [[option_irc.color.notice]] *irc.color.notice* -** description: pass:none[color for text "Notice" in notices] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_irc.color.reason_kick]] *irc.color.reason_kick* -** description: pass:none[color for reason in kick/kill messages] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.color.reason_quit]] *irc.color.reason_quit* -** description: pass:none[color for reason in part/quit messages] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.color.topic_current]] *irc.color.topic_current* -** description: pass:none[color for current channel topic (when joining a channel or using /topic)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.color.topic_new]] *irc.color.topic_new* -** description: pass:none[color for new channel topic (when topic is changed)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_irc.color.topic_old]] *irc.color.topic_old* -** description: pass:none[color for old channel topic (when topic is changed)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_irc.look.buffer_open_before_autojoin]] *irc.look.buffer_open_before_autojoin* -** description: pass:none[open channel buffer before the JOIN is received from server when it is auto joined (with server option "autojoin"); this is useful to open channels with always the same buffer numbers on startup] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.buffer_open_before_join]] *irc.look.buffer_open_before_join* -** description: pass:none[open channel buffer before the JOIN is received from server when it is manually joined (with /join command)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.buffer_switch_autojoin]] *irc.look.buffer_switch_autojoin* -** description: pass:none[auto switch to channel buffer when it is auto joined (with server option "autojoin")] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.buffer_switch_join]] *irc.look.buffer_switch_join* -** description: pass:none[auto switch to channel buffer when it is manually joined (with /join command)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.color_nicks_in_names]] *irc.look.color_nicks_in_names* -** description: pass:none[use nick color in output of /names (or list of nicks displayed when joining a channel)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.color_nicks_in_nicklist]] *irc.look.color_nicks_in_nicklist* -** description: pass:none[use nick color in nicklist] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.color_nicks_in_server_messages]] *irc.look.color_nicks_in_server_messages* -** description: pass:none[use nick color in messages from server] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.color_pv_nick_like_channel]] *irc.look.color_pv_nick_like_channel* -** description: pass:none[use same nick color for channel and private] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.ctcp_time_format]] *irc.look.ctcp_time_format* -** description: pass:none[time format used in answer to message CTCP TIME (see man strftime for date/time specifiers)] -** type: string -** values: any string -** default value: `+"%a, %d %b %Y %T %z"+` - -* [[option_irc.look.display_away]] *irc.look.display_away* -** description: pass:none[display message when (un)marking as away (off: do not display/send anything, local: display locally, channel: send action to channels)] -** type: integer -** values: off, local, channel -** default value: `+local+` - -* [[option_irc.look.display_ctcp_blocked]] *irc.look.display_ctcp_blocked* -** description: pass:none[display CTCP message even if it is blocked] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_ctcp_reply]] *irc.look.display_ctcp_reply* -** description: pass:none[display CTCP reply sent by WeeChat] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_ctcp_unknown]] *irc.look.display_ctcp_unknown* -** description: pass:none[display CTCP message even if it is unknown CTCP] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_host_join]] *irc.look.display_host_join* -** description: pass:none[display host in join messages] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_host_join_local]] *irc.look.display_host_join_local* -** description: pass:none[display host in join messages from local client] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_host_quit]] *irc.look.display_host_quit* -** description: pass:none[display host in part/quit messages] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_join_message]] *irc.look.display_join_message* -** description: pass:none[comma-separated list of messages to display after joining a channel: 324 = channel modes, 329 = channel creation date, 332 = topic, 333 = nick/date for topic, 353 = names on channel, 366 = names count] -** type: string -** values: any string -** default value: `+"329,332,333,366"+` - -* [[option_irc.look.display_old_topic]] *irc.look.display_old_topic* -** description: pass:none[display old topic when channel topic is changed] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_pv_away_once]] *irc.look.display_pv_away_once* -** description: pass:none[display remote away message only once in private] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_pv_back]] *irc.look.display_pv_back* -** description: pass:none[display a message in private when user is back (after quit on server)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.display_pv_warning_address]] *irc.look.display_pv_warning_address* -** description: pass:none[display a warning in private buffer if the address of remote nick has changed; this option is disabled by default because servers like bitlbee are causing this warning to be displayed when it is not expected (the address of remote nick changes multiple times on login)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.highlight_channel]] *irc.look.highlight_channel* -** description: pass:none[comma separated list of words to highlight in channel buffers (case insensitive, use "(?-i)" at beginning of words to make them case sensitive; special variables $nick, $channel and $server are replaced by their value), these words are added to buffer property "highlight_words" only when buffer is created (it does not affect current buffers), an empty string disables default highlight on nick, examples: "$nick", "(?-i)$nick"] -** type: string -** values: any string -** default value: `+"$nick"+` - -* [[option_irc.look.highlight_pv]] *irc.look.highlight_pv* -** description: pass:none[comma separated list of words to highlight in private buffers (case insensitive, use "(?-i)" at beginning of words to make them case sensitive; special variables $nick, $channel and $server are replaced by their value), these words are added to buffer property "highlight_words" only when buffer is created (it does not affect current buffers), an empty string disables default highlight on nick, examples: "$nick", "(?-i)$nick"] -** type: string -** values: any string -** default value: `+"$nick"+` - -* [[option_irc.look.highlight_server]] *irc.look.highlight_server* -** description: pass:none[comma separated list of words to highlight in server buffers (case insensitive, use "(?-i)" at beginning of words to make them case sensitive; special variables $nick, $channel and $server are replaced by their value), these words are added to buffer property "highlight_words" only when buffer is created (it does not affect current buffers), an empty string disables default highlight on nick, examples: "$nick", "(?-i)$nick"] -** type: string -** values: any string -** default value: `+"$nick"+` - -* [[option_irc.look.highlight_tags_restrict]] *irc.look.highlight_tags_restrict* -** description: pass:none[restrict highlights to these tags on irc buffers (to have highlight on user messages but not server messages); tags must be separated by a comma and "+" can be used to make a logical "and" between tags; wildcard "*" is allowed in tags; an empty value allows highlight on any tag] -** type: string -** values: any string -** default value: `+"irc_privmsg,irc_notice"+` - -* [[option_irc.look.item_channel_modes_hide_args]] *irc.look.item_channel_modes_hide_args* -** description: pass:none[hide channel modes arguments if at least one of these modes is in channel modes ("*" to always hide all arguments, empty value to never hide arguments); example: "kf" to hide arguments if "k" or "f" are in channel modes] -** type: string -** values: any string -** default value: `+"k"+` - -* [[option_irc.look.item_display_server]] *irc.look.item_display_server* -** description: pass:none[name of bar item where IRC server is displayed (for status bar)] -** type: integer -** values: buffer_plugin, buffer_name -** default value: `+buffer_plugin+` - -* [[option_irc.look.item_nick_modes]] *irc.look.item_nick_modes* -** description: pass:none[display nick modes in bar item "input_prompt"] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.item_nick_prefix]] *irc.look.item_nick_prefix* -** description: pass:none[display nick prefix in bar item "input_prompt"] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.join_auto_add_chantype]] *irc.look.join_auto_add_chantype* -** description: pass:none[automatically add channel type in front of channel name on command /join if the channel name does not start with a valid channel type for the server; for example: "/join weechat" will in fact send: "/join #weechat"] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.msgbuffer_fallback]] *irc.look.msgbuffer_fallback* -** description: pass:none[default target buffer for msgbuffer options when target is private and that private buffer is not found] -** type: integer -** values: current, server -** default value: `+current+` - -* [[option_irc.look.new_channel_position]] *irc.look.new_channel_position* -** description: pass:none[force position of new channel in list of buffers (none = default position (should be last buffer), next = current buffer + 1, near_server = after last channel/pv of server)] -** type: integer -** values: none, next, near_server -** default value: `+none+` - -* [[option_irc.look.new_pv_position]] *irc.look.new_pv_position* -** description: pass:none[force position of new private in list of buffers (none = default position (should be last buffer), next = current buffer + 1, near_server = after last channel/pv of server)] -** type: integer -** values: none, next, near_server -** default value: `+none+` - -* [[option_irc.look.nick_completion_smart]] *irc.look.nick_completion_smart* -** description: pass:none[smart completion for nicks (completes first with last speakers): speakers = all speakers (including highlights), speakers_highlights = only speakers with highlight] -** type: integer -** values: off, speakers, speakers_highlights -** default value: `+speakers+` - -* [[option_irc.look.nick_mode]] *irc.look.nick_mode* -** description: pass:none[display nick mode (op, voice, ...) before nick (none = never, prefix = in prefix only (default), action = in action messages only, both = prefix + action messages)] -** type: integer -** values: none, prefix, action, both -** default value: `+prefix+` - -* [[option_irc.look.nick_mode_empty]] *irc.look.nick_mode_empty* -** description: pass:none[display a space if nick mode is enabled but nick has no mode (not op, voice, ...)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.nicks_hide_password]] *irc.look.nicks_hide_password* -** description: pass:none[comma separated list of nicks for which passwords will be hidden when a message is sent, for example to hide password in message displayed by "/msg nickserv identify password", example: "nickserv,nickbot"] -** type: string -** values: any string -** default value: `+"nickserv"+` - -* [[option_irc.look.notice_as_pv]] *irc.look.notice_as_pv* -** description: pass:none[display notices as private messages (if auto, use private buffer if found)] -** type: integer -** values: auto, never, always -** default value: `+auto+` - -* [[option_irc.look.notice_welcome_redirect]] *irc.look.notice_welcome_redirect* -** description: pass:none[automatically redirect channel welcome notices to the channel buffer; such notices have the nick as target but a channel name in beginning of notice message, for example the ENTRYMSG notices sent by Atheme IRC Services which look like: "[#channel\] Welcome to this channel..."] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.notice_welcome_tags]] *irc.look.notice_welcome_tags* -** description: pass:none[comma separated list of tags used in a welcome notices redirected to a channel, for example: "notify_private"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.look.notify_tags_ison]] *irc.look.notify_tags_ison* -** description: pass:none[comma separated list of tags used in messages displayed by notify when a nick joins or quits server (result of command ison or monitor), for example: "notify_message", "notify_private" or "notify_highlight"] -** type: string -** values: any string -** default value: `+"notify_message"+` - -* [[option_irc.look.notify_tags_whois]] *irc.look.notify_tags_whois* -** description: pass:none[comma separated list of tags used in messages displayed by notify when a nick away status changes (result of command whois), for example: "notify_message", "notify_private" or "notify_highlight"] -** type: string -** values: any string -** default value: `+"notify_message"+` - -* [[option_irc.look.part_closes_buffer]] *irc.look.part_closes_buffer* -** description: pass:none[close buffer when /part is issued on a channel] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.pv_buffer]] *irc.look.pv_buffer* -** description: pass:none[merge private buffers] -** type: integer -** values: independent, merge_by_server, merge_all -** default value: `+independent+` - -* [[option_irc.look.pv_tags]] *irc.look.pv_tags* -** description: pass:none[comma separated list of tags used in private messages, for example: "notify_message", "notify_private" or "notify_highlight"] -** type: string -** values: any string -** default value: `+"notify_private"+` - -* [[option_irc.look.raw_messages]] *irc.look.raw_messages* -** description: pass:none[number of raw messages to save in memory when raw data buffer is closed (messages will be displayed when opening raw data buffer)] -** type: integer -** values: 0 .. 65535 -** default value: `+256+` - -* [[option_irc.look.server_buffer]] *irc.look.server_buffer* -** description: pass:none[merge server buffers; this option has no effect if a layout is saved and is conflicting with this value (see /help layout)] -** type: integer -** values: merge_with_core, merge_without_core, independent -** default value: `+merge_with_core+` - -* [[option_irc.look.smart_filter]] *irc.look.smart_filter* -** description: pass:none[filter join/part/quit/nick messages for a nick if not speaking for some minutes on channel (you must create a filter on tag "irc_smart_filter", see /help filter)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.smart_filter_chghost]] *irc.look.smart_filter_chghost* -** description: pass:none[enable smart filter for "chghost" messages] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.smart_filter_delay]] *irc.look.smart_filter_delay* -** description: pass:none[delay for filtering join/part/quit messages (in minutes): if the nick did not speak during the last N minutes, the join/part/quit is filtered] -** type: integer -** values: 1 .. 10080 -** default value: `+5+` - -* [[option_irc.look.smart_filter_join]] *irc.look.smart_filter_join* -** description: pass:none[enable smart filter for "join" messages] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.smart_filter_join_unmask]] *irc.look.smart_filter_join_unmask* -** description: pass:none[delay for unmasking a join message that was filtered with tag "irc_smart_filter" (in minutes): if a nick has joined max N minutes ago and then says something on channel (message, notice or update on topic), the join is unmasked, as well as nick changes after this join (0 = disable: never unmask a join)] -** type: integer -** values: 0 .. 10080 -** default value: `+30+` - -* [[option_irc.look.smart_filter_mode]] *irc.look.smart_filter_mode* -** description: pass:none[enable smart filter for "mode" messages: "*" to filter all modes, "+" to filter all modes in server prefixes (for example "ovh"), "xyz" to filter only modes x/y/z, "-xyz" to filter all modes but not x/y/z; examples: "ovh": filter modes o/v/h, "-bkl": filter all modes but not b/k/l] -** type: string -** values: any string -** default value: `+"+"+` - -* [[option_irc.look.smart_filter_nick]] *irc.look.smart_filter_nick* -** description: pass:none[enable smart filter for "nick" messages (nick changes)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.smart_filter_quit]] *irc.look.smart_filter_quit* -** description: pass:none[enable smart filter for "part" and "quit" messages] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.look.temporary_servers]] *irc.look.temporary_servers* -** description: pass:none[enable automatic addition of temporary servers with command /connect] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.look.topic_strip_colors]] *irc.look.topic_strip_colors* -** description: pass:none[strip colors in topic (used only when displaying buffer title)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.network.autoreconnect_delay_growing]] *irc.network.autoreconnect_delay_growing* -** description: pass:none[growing factor for autoreconnect delay to server (1 = always same delay, 2 = delay*2 for each retry, etc.)] -** type: integer -** values: 1 .. 100 -** default value: `+2+` - -* [[option_irc.network.autoreconnect_delay_max]] *irc.network.autoreconnect_delay_max* -** description: pass:none[maximum autoreconnect delay to server (in seconds, 0 = no maximum)] -** type: integer -** values: 0 .. 604800 -** default value: `+600+` - -* [[option_irc.network.ban_mask_default]] *irc.network.ban_mask_default* -** description: pass:none[default ban mask for commands /ban, /unban and /kickban; variables $nick, $user, $ident and $host are replaced by their values (extracted from "nick!user@host"); $ident is the same as $user if $user does not start with "~", otherwise it is set to "*"; this default mask is used only if WeeChat knows the host for the nick] -** type: string -** values: any string -** default value: `+"*!$ident@$host"+` - -* [[option_irc.network.colors_receive]] *irc.network.colors_receive* -** description: pass:none[when off, colors codes are ignored in incoming messages] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.network.colors_send]] *irc.network.colors_send* -** description: pass:none[allow user to send colors with special codes (ctrl-c + a code and optional color: b=bold, cxx=color, cxx,yy=color+background, i=italic, o=disable color/attributes, r=reverse, u=underline)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.network.lag_check]] *irc.network.lag_check* -** description: pass:none[interval between two checks for lag (in seconds, 0 = never check)] -** type: integer -** values: 0 .. 604800 -** default value: `+60+` - -* [[option_irc.network.lag_max]] *irc.network.lag_max* -** description: pass:none[maximum lag (in seconds): if this lag is reached, WeeChat will consider that the answer from server (pong) will never be received and will give up counting the lag (0 = never give up)] -** type: integer -** values: 0 .. 604800 -** default value: `+1800+` - -* [[option_irc.network.lag_min_show]] *irc.network.lag_min_show* -** description: pass:none[minimum lag to show (in milliseconds)] -** type: integer -** values: 0 .. 86400000 -** default value: `+500+` - -* [[option_irc.network.lag_reconnect]] *irc.network.lag_reconnect* -** description: pass:none[reconnect to server if lag is greater than or equal to this value (in seconds, 0 = never reconnect); this value must be less than or equal to irc.network.lag_max] -** type: integer -** values: 0 .. 604800 -** default value: `+300+` - -* [[option_irc.network.lag_refresh_interval]] *irc.network.lag_refresh_interval* -** description: pass:none[interval between two refreshes of lag item, when lag is increasing (in seconds)] -** type: integer -** values: 1 .. 3600 -** default value: `+1+` - -* [[option_irc.network.notify_check_ison]] *irc.network.notify_check_ison* -** description: pass:none[interval between two checks for notify with IRC command "ison" (in minutes)] -** type: integer -** values: 1 .. 10080 -** default value: `+1+` - -* [[option_irc.network.notify_check_whois]] *irc.network.notify_check_whois* -** description: pass:none[interval between two checks for notify with IRC command "whois" (in minutes)] -** type: integer -** values: 1 .. 10080 -** default value: `+5+` - -* [[option_irc.network.sasl_fail_unavailable]] *irc.network.sasl_fail_unavailable* -** description: pass:none[cause SASL authentication failure when SASL is requested but unavailable on the server; when this option is enabled, it has effect only if option "sasl_fail" is set to "reconnect" or "disconnect" in the server] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.network.send_unknown_commands]] *irc.network.send_unknown_commands* -** description: pass:none[send unknown commands to server] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.network.whois_double_nick]] *irc.network.whois_double_nick* -** description: pass:none[double the nick in /whois command (if only one nick is given), to get idle time in answer; for example: "/whois nick" will send "whois nick nick"] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.server_default.addresses]] *irc.server_default.addresses* -** description: pass:none[list of hostname/port or IP/port for server (separated by comma) (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.anti_flood_prio_high]] *irc.server_default.anti_flood_prio_high* -** description: pass:none[anti-flood for high priority queue: number of seconds between two user messages or commands sent to IRC server (0 = no anti-flood)] -** type: integer -** values: 0 .. 60 -** default value: `+2+` - -* [[option_irc.server_default.anti_flood_prio_low]] *irc.server_default.anti_flood_prio_low* -** description: pass:none[anti-flood for low priority queue: number of seconds between two messages sent to IRC server (messages like automatic CTCP replies) (0 = no anti-flood)] -** type: integer -** values: 0 .. 60 -** default value: `+2+` - -* [[option_irc.server_default.autoconnect]] *irc.server_default.autoconnect* -** description: pass:none[automatically connect to server when WeeChat is starting] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.server_default.autojoin]] *irc.server_default.autojoin* -** description: pass:none[comma separated list of channels to join after connection to server (and after executing command + delay if they are set); the channels that require a key must be at beginning of the list, and all the keys must be given after the channels (separated by a space) (example: "#channel1,#channel2,#channel3 key1,key2" where #channel1 and #channel2 are protected by key1 and key2) (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.autoreconnect]] *irc.server_default.autoreconnect* -** description: pass:none[automatically reconnect to server when disconnected] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.server_default.autoreconnect_delay]] *irc.server_default.autoreconnect_delay* -** description: pass:none[delay (in seconds) before trying again to reconnect to server] -** type: integer -** values: 1 .. 65535 -** default value: `+10+` - -* [[option_irc.server_default.autorejoin]] *irc.server_default.autorejoin* -** description: pass:none[automatically rejoin channels after kick; you can define a buffer local variable on a channel to override this value (name of variable: "autorejoin", value: "on" or "off")] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.server_default.autorejoin_delay]] *irc.server_default.autorejoin_delay* -** description: pass:none[delay (in seconds) before autorejoin (after kick)] -** type: integer -** values: 0 .. 86400 -** default value: `+30+` - -* [[option_irc.server_default.away_check]] *irc.server_default.away_check* -** description: pass:none[interval between two checks for away (in minutes, 0 = never check)] -** type: integer -** values: 0 .. 10080 -** default value: `+0+` - -* [[option_irc.server_default.away_check_max_nicks]] *irc.server_default.away_check_max_nicks* -** description: pass:none[do not check away nicks on channels with high number of nicks (0 = unlimited)] -** type: integer -** values: 0 .. 1000000 -** default value: `+25+` - -* [[option_irc.server_default.capabilities]] *irc.server_default.capabilities* -** description: pass:none[comma-separated list of client capabilities to enable for server if they are available (see /help cap for a list of capabilities supported by WeeChat) (example: "away-notify,multi-prefix")] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.charset_message]] *irc.server_default.charset_message* -** description: pass:none[part of the IRC message (received or sent) which is decoded/encoded to the target charset; message = the whole IRC message (default), channel = starting from the channel name only (if found, with fallback on text), text = starting from the text only (you should try this value if you have issues with the channel name encoding)] -** type: integer -** values: message, channel, text -** default value: `+message+` - -* [[option_irc.server_default.command]] *irc.server_default.command* -** description: pass:none[command(s) to run after connection to server and before auto-join of channels (many commands can be separated by ";", use "\;" for a semicolon, special variables $nick, $channel and $server are replaced by their value) (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.command_delay]] *irc.server_default.command_delay* -** description: pass:none[delay (in seconds) after execution of command and before auto-join of channels (example: give some time for authentication before joining channels)] -** type: integer -** values: 0 .. 3600 -** default value: `+0+` - -* [[option_irc.server_default.connection_timeout]] *irc.server_default.connection_timeout* -** description: pass:none[timeout (in seconds) between TCP connection to server and message 001 received, if this timeout is reached before 001 message is received, WeeChat will disconnect from server] -** type: integer -** values: 1 .. 3600 -** default value: `+60+` - -* [[option_irc.server_default.ipv6]] *irc.server_default.ipv6* -** description: pass:none[use IPv6 protocol for server communication (try IPv6 then fallback to IPv4); if disabled, only IPv4 is used] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.server_default.local_hostname]] *irc.server_default.local_hostname* -** description: pass:none[custom local hostname/IP for server (optional, if empty local hostname is used)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.msg_kick]] *irc.server_default.msg_kick* -** description: pass:none[default kick message used by commands "/kick" and "/kickban" (note: content is evaluated, see /help eval; special variables ${nick}, ${channel} and ${server} are replaced by their value)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.msg_part]] *irc.server_default.msg_part* -** description: pass:none[default part message (leaving channel) (note: content is evaluated, see /help eval; special variables ${nick}, ${channel} and ${server} are replaced by their value; "%v" is replaced by WeeChat version if there is no ${...} in string)] -** type: string -** values: any string -** default value: `+"WeeChat ${info:version}"+` - -* [[option_irc.server_default.msg_quit]] *irc.server_default.msg_quit* -** description: pass:none[default quit message (disconnecting from server) (note: content is evaluated, see /help eval; special variables ${nick}, ${channel} and ${server} are replaced by their value; "%v" is replaced by WeeChat version if there is no ${...} in string)] -** type: string -** values: any string -** default value: `+"WeeChat ${info:version}"+` - -* [[option_irc.server_default.nicks]] *irc.server_default.nicks* -** description: pass:none[nicknames to use on server (separated by comma) (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.nicks_alternate]] *irc.server_default.nicks_alternate* -** description: pass:none[get an alternate nick when all the declared nicks are already used on server: add some "_" until the nick has a length of 9, and then replace last char (or the two last chars) by a number from 1 to 99, until we find a nick not used on server] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.server_default.notify]] *irc.server_default.notify* -** description: pass:none[notify list for server (you should not change this option but use /notify command instead)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.password]] *irc.server_default.password* -** description: pass:none[password for server (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.proxy]] *irc.server_default.proxy* -** description: pass:none[name of proxy used for this server (optional, proxy must be defined with command /proxy)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.realname]] *irc.server_default.realname* -** description: pass:none[real name to use on server (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.sasl_fail]] *irc.server_default.sasl_fail* -** description: pass:none[action to perform if SASL authentication fails: "continue" to ignore the authentication problem, "reconnect" to schedule a reconnection to the server, "disconnect" to disconnect from server (see also option irc.network.sasl_fail_unavailable)] -** type: integer -** values: continue, reconnect, disconnect -** default value: `+continue+` - -* [[option_irc.server_default.sasl_key]] *irc.server_default.sasl_key* -** description: pass:none[file with ECC private key for mechanism "ecdsa-nist256p-challenge" ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.sasl_mechanism]] *irc.server_default.sasl_mechanism* -** description: pass:none[mechanism for SASL authentication: "plain" for plain text password, "ecdsa-nist256p-challenge" for key-based challenge authentication, "external" for authentication using client side SSL cert, "dh-blowfish" for blowfish crypted password (insecure, not recommended), "dh-aes" for AES crypted password (insecure, not recommended)] -** type: integer -** values: plain, ecdsa-nist256p-challenge, external, dh-blowfish, dh-aes -** default value: `+plain+` - -* [[option_irc.server_default.sasl_password]] *irc.server_default.sasl_password* -** description: pass:none[password for SASL authentication; this option is not used for mechanisms "ecdsa-nist256p-challenge" and "external" (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.sasl_timeout]] *irc.server_default.sasl_timeout* -** description: pass:none[timeout (in seconds) before giving up SASL authentication] -** type: integer -** values: 1 .. 3600 -** default value: `+15+` - -* [[option_irc.server_default.sasl_username]] *irc.server_default.sasl_username* -** description: pass:none[username for SASL authentication; this option is not used for mechanism "external" (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.split_msg_max_length]] *irc.server_default.split_msg_max_length* -** description: pass:none[split outgoing IRC messages to fit in this number of chars; the default value is 512, this is a safe and recommended value; value 0 disables the split (not recommended, unless you know what you do); allowed values are 0 or any integer between 128 and 4096; this option should be changed only on non-standard IRC servers, for example gateways like bitlbee] -** type: integer -** values: 0 .. 4096 -** default value: `+512+` - -* [[option_irc.server_default.ssl]] *irc.server_default.ssl* -** description: pass:none[use SSL for server communication] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_irc.server_default.ssl_cert]] *irc.server_default.ssl_cert* -** description: pass:none[SSL certificate file used to automatically identify your nick ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.ssl_dhkey_size]] *irc.server_default.ssl_dhkey_size* -** description: pass:none[size of the key used during the Diffie-Hellman Key Exchange] -** type: integer -** values: 0 .. 2147483647 -** default value: `+2048+` - -* [[option_irc.server_default.ssl_fingerprint]] *irc.server_default.ssl_fingerprint* -** description: pass:none[fingerprint of certificate which is trusted and accepted for the server; only hexadecimal digits are allowed (0-9, a-f): 128 chars for SHA-512, 64 chars for SHA-256, 40 chars for SHA-1 (insecure, not recommended); many fingerprints can be separated by commas; if this option is set, the other checks on certificates are NOT performed (option "ssl_verify") (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.ssl_password]] *irc.server_default.ssl_password* -** description: pass:none[password for SSL certificate's private key; only used with gnutls version >= 3.1.0 (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.ssl_priorities]] *irc.server_default.ssl_priorities* -** description: pass:none[string with priorities for gnutls (for syntax, see documentation of function gnutls_priority_init in gnutls manual, common strings are: "PERFORMANCE", "NORMAL", "SECURE128", "SECURE256", "EXPORT", "NONE")] -** type: string -** values: any string -** default value: `+"NORMAL:-VERS-SSL3.0"+` - -* [[option_irc.server_default.ssl_verify]] *irc.server_default.ssl_verify* -** description: pass:none[check that the SSL connection is fully trusted] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_irc.server_default.usermode]] *irc.server_default.usermode* -** description: pass:none[user mode(s) to set after connection to server and before executing command and the auto-join of channels; examples: "+R" (to set mode "R"), "+R-i" (to set mode "R" and remove "i"); see /help mode for the complete mode syntax (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_irc.server_default.username]] *irc.server_default.username* -** description: pass:none[user name to use on server (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)] -** type: string -** values: any string -** default value: `+""+` diff --git a/doc/en/autogen/user/javascript_commands.adoc b/doc/en/autogen/user/javascript_commands.adoc deleted file mode 100644 index 235154919..000000000 --- a/doc/en/autogen/user/javascript_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_javascript_javascript]] -* `+javascript+`: list/load/unload scripts - ----- -/javascript list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/javascript_options.adoc b/doc/en/autogen/user/javascript_options.adoc deleted file mode 100644 index 62225e25d..000000000 --- a/doc/en/autogen/user/javascript_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_javascript.look.check_license]] *javascript.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_javascript.look.eval_keep_context]] *javascript.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/logger_commands.adoc b/doc/en/autogen/user/logger_commands.adoc deleted file mode 100644 index 602cfd47d..000000000 --- a/doc/en/autogen/user/logger_commands.adoc +++ /dev/null @@ -1,40 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_logger_logger]] -* `+logger+`: logger plugin configuration - ----- -/logger list - set <level> - flush - disable - - list: show logging status for opened buffers - set: set logging level on current buffer - level: level for messages to be logged (0 = logging disabled, 1 = a few messages (most important) .. 9 = all messages) - flush: write all log files now -disable: disable logging on current buffer (set level to 0) - -Options "logger.level.*" and "logger.mask.*" can be used to set level or mask for a buffer, or buffers beginning with name. - -Log levels used by IRC plugin: - 1: user message (channel and private), notice (server and channel) - 2: nick change - 3: server message - 4: join/part/quit - 9: all other messages - -Examples: - set level to 5 for current buffer: - /logger set 5 - disable logging for current buffer: - /logger disable - set level to 3 for all IRC buffers: - /set logger.level.irc 3 - disable logging for main WeeChat buffer: - /set logger.level.core.weechat 0 - use a directory per IRC server and a file per channel inside: - /set logger.mask.irc "$server/$channel.weechatlog" ----- diff --git a/doc/en/autogen/user/logger_options.adoc b/doc/en/autogen/user/logger_options.adoc deleted file mode 100644 index 420dd1811..000000000 --- a/doc/en/autogen/user/logger_options.adoc +++ /dev/null @@ -1,99 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_logger.color.backlog_end]] *logger.color.backlog_end* -** description: pass:none[color for line ending the backlog] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_logger.color.backlog_line]] *logger.color.backlog_line* -** description: pass:none[color for backlog lines, used only if the option logger.file.color_lines is off] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_logger.file.auto_log]] *logger.file.auto_log* -** description: pass:none[automatically save content of buffers to files (unless a buffer disables log)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_logger.file.color_lines]] *logger.file.color_lines* -** description: pass:none[use ANSI color codes in lines written in log files and display backlog lines with these colors] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_logger.file.flush_delay]] *logger.file.flush_delay* -** description: pass:none[number of seconds between flush of log files (0 = write in log files immediately for each line printed)] -** type: integer -** values: 0 .. 3600 -** default value: `+120+` - -* [[option_logger.file.fsync]] *logger.file.fsync* -** description: pass:none[use fsync to synchronize the log file with the storage device after the flush (see man fsync); this is slower but should prevent any data loss in case of power failure during the save of log file] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_logger.file.info_lines]] *logger.file.info_lines* -** description: pass:none[write information line in log file when log starts or ends for a buffer] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_logger.file.mask]] *logger.file.mask* -** description: pass:none[default file name mask for log files (format is "directory/to/file" or "file", without first "/" because "path" option is used to build complete path to file); local buffer variables are permitted (you should use only variables that are defined on all buffers, so for example you should NOT use $server nor $channel); date specifiers are permitted (see man strftime)] -** type: string -** values: any string -** default value: `+"$plugin.$name.weechatlog"+` - -* [[option_logger.file.name_lower_case]] *logger.file.name_lower_case* -** description: pass:none[use only lower case for log filenames] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_logger.file.nick_prefix]] *logger.file.nick_prefix* -** description: pass:none[text to write before nick in prefix of message, example: "<"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_logger.file.nick_suffix]] *logger.file.nick_suffix* -** description: pass:none[text to write after nick in prefix of message, example: ">"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_logger.file.path]] *logger.file.path* -** description: pass:none[path for WeeChat log files; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default); date specifiers are permitted (see man strftime) (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+"%h/logs/"+` - -* [[option_logger.file.replacement_char]] *logger.file.replacement_char* -** description: pass:none[replacement char for special chars in filename built with mask (like directory delimiter)] -** type: string -** values: any string -** default value: `+"_"+` - -* [[option_logger.file.time_format]] *logger.file.time_format* -** description: pass:none[timestamp used in log files (see man strftime for date/time specifiers)] -** type: string -** values: any string -** default value: `+"%Y-%m-%d %H:%M:%S"+` - -* [[option_logger.look.backlog]] *logger.look.backlog* -** description: pass:none[maximum number of lines to display from log file when creating new buffer (0 = no backlog)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+20+` - -* [[option_logger.look.backlog_conditions]] *logger.look.backlog_conditions* -** description: pass:none[conditions to display the backlog (note: content is evaluated, see /help eval); empty value displays the backlog on all buffers; for example to display backlog on private buffers only: "${type} == private"] -** type: string -** values: any string -** default value: `+""+` diff --git a/doc/en/autogen/user/lua_commands.adoc b/doc/en/autogen/user/lua_commands.adoc deleted file mode 100644 index 109a348bf..000000000 --- a/doc/en/autogen/user/lua_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_lua_lua]] -* `+lua+`: list/load/unload scripts - ----- -/lua list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/lua_options.adoc b/doc/en/autogen/user/lua_options.adoc deleted file mode 100644 index 4851fc6f4..000000000 --- a/doc/en/autogen/user/lua_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_lua.look.check_license]] *lua.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_lua.look.eval_keep_context]] *lua.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/perl_commands.adoc b/doc/en/autogen/user/perl_commands.adoc deleted file mode 100644 index 44fbd52a5..000000000 --- a/doc/en/autogen/user/perl_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_perl_perl]] -* `+perl+`: list/load/unload scripts - ----- -/perl list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/perl_options.adoc b/doc/en/autogen/user/perl_options.adoc deleted file mode 100644 index 45f024250..000000000 --- a/doc/en/autogen/user/perl_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_perl.look.check_license]] *perl.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_perl.look.eval_keep_context]] *perl.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/php_commands.adoc b/doc/en/autogen/user/php_commands.adoc deleted file mode 100644 index 447d3c1f6..000000000 --- a/doc/en/autogen/user/php_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_php_php]] -* `+php+`: list/load/unload scripts - ----- -/php list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/php_options.adoc b/doc/en/autogen/user/php_options.adoc deleted file mode 100644 index 99309df45..000000000 --- a/doc/en/autogen/user/php_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_php.look.check_license]] *php.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_php.look.eval_keep_context]] *php.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/python_commands.adoc b/doc/en/autogen/user/python_commands.adoc deleted file mode 100644 index a6d678094..000000000 --- a/doc/en/autogen/user/python_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_python_python]] -* `+python+`: list/load/unload scripts - ----- -/python list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/python_options.adoc b/doc/en/autogen/user/python_options.adoc deleted file mode 100644 index 383143e53..000000000 --- a/doc/en/autogen/user/python_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_python.look.check_license]] *python.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_python.look.eval_keep_context]] *python.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/relay_commands.adoc b/doc/en/autogen/user/relay_commands.adoc deleted file mode 100644 index bf7a1ca50..000000000 --- a/doc/en/autogen/user/relay_commands.adoc +++ /dev/null @@ -1,62 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_relay_relay]] -* `+relay+`: relay control - ----- -/relay list|listfull|listrelay - add <name> <port>|<path> - del|start|restart|stop <name> - raw - sslcertkey - - list: list relay clients (only active relays) - listfull: list relay clients (verbose, all relays) - listrelay: list relays (name and port) - add: add a relay (listen on a port/path) - del: remove a relay (clients remain connected) - start: listen on port - restart: close the server socket and listen again on port (clients remain connected) - stop: close the server socket (clients remain connected) - name: relay name (see format below) - port: port used for relay - path: path used for relay (for UNIX domain socket only); "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default), content is evaluated (see /help eval) - raw: open buffer with raw Relay data - sslcertkey: set SSL certificate/key using path in option relay.network.ssl_cert_key - -Relay name is: [ipv4.][ipv6.][ssl.]<protocol.name> or unix.[ssl.]<protocol.name> - ipv4: force use of IPv4 - ipv6: force use of IPv6 - ssl: enable SSL - unix: use UNIX domain socket -protocol.name: protocol and name to relay: - - protocol "irc": name is the server to share (optional, if not given, the server name must be sent by client in command "PASS", with format: "PASS server:password") - - protocol "weechat" (name is not used) - -The "irc" protocol allows any IRC client (including WeeChat itself) to connect on the port. -The "weechat" protocol allows a remote interface to connect on the port, see the list here: https://weechat.org/about/interfaces - -Without argument, this command opens buffer with list of relay clients. - -Examples: - irc proxy, for server "freenode": - /relay add irc.freenode 8000 - irc proxy, for server "freenode", with SSL: - /relay add ssl.irc.freenode 8001 - irc proxy, for all servers (client will choose), with SSL: - /relay add ssl.irc 8002 - weechat protocol: - /relay add weechat 9000 - weechat protocol with SSL: - /relay add ssl.weechat 9001 - weechat protocol with SSL, using only IPv4: - /relay add ipv4.ssl.weechat 9001 - weechat protocol with SSL, using only IPv6: - /relay add ipv6.ssl.weechat 9001 - weechat protocol with SSL, using IPv4 + IPv6: - /relay add ipv4.ipv6.ssl.weechat 9001 - weechat protocol over UNIX domain socket: - /relay add unix.weechat %h/relay_socket ----- diff --git a/doc/en/autogen/user/relay_options.adoc b/doc/en/autogen/user/relay_options.adoc deleted file mode 100644 index e9ade8563..000000000 --- a/doc/en/autogen/user/relay_options.adoc +++ /dev/null @@ -1,213 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_relay.color.client]] *relay.color.client* -** description: pass:none[text color for client description] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_relay.color.status_active]] *relay.color.status_active* -** description: pass:none[text color for "connected" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_relay.color.status_auth_failed]] *relay.color.status_auth_failed* -** description: pass:none[text color for "authentication failed" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_relay.color.status_connecting]] *relay.color.status_connecting* -** description: pass:none[text color for "connecting" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_relay.color.status_disconnected]] *relay.color.status_disconnected* -** description: pass:none[text color for "disconnected" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_relay.color.status_waiting_auth]] *relay.color.status_waiting_auth* -** description: pass:none[text color for "waiting authentication" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_relay.color.text]] *relay.color.text* -** description: pass:none[text color in relay buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_relay.color.text_bg]] *relay.color.text_bg* -** description: pass:none[background color in relay buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_relay.color.text_selected]] *relay.color.text_selected* -** description: pass:none[text color of selected line in relay buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_relay.irc.backlog_max_minutes]] *relay.irc.backlog_max_minutes* -** description: pass:none[maximum number of minutes in backlog per IRC channel (0 = unlimited, examples: 1440 = one day, 10080 = one week, 43200 = one month, 525600 = one year)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+1440+` - -* [[option_relay.irc.backlog_max_number]] *relay.irc.backlog_max_number* -** description: pass:none[maximum number of lines in backlog per IRC channel (0 = unlimited)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+256+` - -* [[option_relay.irc.backlog_since_last_disconnect]] *relay.irc.backlog_since_last_disconnect* -** description: pass:none[display backlog starting from last client disconnect] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_relay.irc.backlog_since_last_message]] *relay.irc.backlog_since_last_message* -** description: pass:none[display backlog starting from your last message] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_relay.irc.backlog_tags]] *relay.irc.backlog_tags* -** description: pass:none[comma-separated list of messages tags which are displayed in backlog per IRC channel (supported tags: "irc_join", "irc_part", "irc_quit", "irc_nick", "irc_privmsg"), "*" = all supported tags] -** type: string -** values: any string -** default value: `+"irc_privmsg"+` - -* [[option_relay.irc.backlog_time_format]] *relay.irc.backlog_time_format* -** description: pass:none[format for time in backlog messages (see man strftime for format) (not used if server capability "server-time" was enabled by client, because time is sent as irc tag); empty string = disable time in backlog messages] -** type: string -** values: any string -** default value: `+"[%H:%M] "+` - -* [[option_relay.look.auto_open_buffer]] *relay.look.auto_open_buffer* -** description: pass:none[auto open relay buffer when a new client is connecting] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_relay.look.raw_messages]] *relay.look.raw_messages* -** description: pass:none[number of raw messages to save in memory when raw data buffer is closed (messages will be displayed when opening raw data buffer)] -** type: integer -** values: 0 .. 65535 -** default value: `+256+` - -* [[option_relay.network.allow_empty_password]] *relay.network.allow_empty_password* -** description: pass:none[allow empty password in relay (it should be enabled only for tests or local network)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_relay.network.allowed_ips]] *relay.network.allowed_ips* -** description: pass:none[POSIX extended regular expression with IPs allowed to use relay (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^(123\.45\.67\.89|192\.160\..*)$"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_relay.network.auth_timeout]] *relay.network.auth_timeout* -** description: pass:none[timeout (in seconds) for client authentication: connection is closed if the client is still not authenticated after this delay and the client status is set to "authentication failed" (0 = wait forever)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+60+` - -* [[option_relay.network.bind_address]] *relay.network.bind_address* -** description: pass:none[address for bind (if empty, connection is possible on all interfaces, use "127.0.0.1" to allow connections from local machine only)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_relay.network.clients_purge_delay]] *relay.network.clients_purge_delay* -** description: pass:none[delay for purging disconnected clients (in minutes, 0 = purge clients immediately, -1 = never purge)] -** type: integer -** values: -1 .. 43200 -** default value: `+0+` - -* [[option_relay.network.compression_level]] *relay.network.compression_level* -** description: pass:none[compression level for packets sent to client with WeeChat protocol (0 = disable compression, 1 = low compression ... 9 = best compression)] -** type: integer -** values: 0 .. 9 -** default value: `+6+` - -* [[option_relay.network.ipv6]] *relay.network.ipv6* -** description: pass:none[listen on IPv6 socket by default (in addition to IPv4 which is default); protocols IPv4 and IPv6 can be forced (individually or together) in the protocol name (see /help relay)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_relay.network.max_clients]] *relay.network.max_clients* -** description: pass:none[maximum number of clients connecting to a port (0 = no limit)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+5+` - -* [[option_relay.network.nonce_size]] *relay.network.nonce_size* -** description: pass:none[size of nonce (in bytes), generated when a client connects; the client must use this nonce, concatenated to the client nonce and the password when hashing the password in the "init" command of the weechat protocol] -** type: integer -** values: 8 .. 128 -** default value: `+16+` - -* [[option_relay.network.password]] *relay.network.password* -** description: pass:none[password required by clients to access this relay (empty value means no password required, see option relay.network.allow_empty_password) (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_relay.network.password_hash_algo]] *relay.network.password_hash_algo* -** description: pass:none[comma separated list of hash algorithms used for password authentication in weechat protocol, among these values: "plain" (password in plain text, not hashed), "sha256", "sha512", "pbkdf2+sha256", "pbkdf2+sha512"), "*" means all algorithms, a name beginning with "!" is a negative value to prevent an algorithm from being used, wildcard "*" is allowed in names (examples: "*", "pbkdf2*", "*,!plain")] -** type: string -** values: any string -** default value: `+"*"+` - -* [[option_relay.network.password_hash_iterations]] *relay.network.password_hash_iterations* -** description: pass:none[number of iterations asked to the client in weechat protocol when a hashed password with algorithm PBKDF2 is used for authentication; more iterations is better in term of security but is slower to compute; this number should not be too high if your CPU is slow] -** type: integer -** values: 1 .. 1000000 -** default value: `+100000+` - -* [[option_relay.network.ssl_cert_key]] *relay.network.ssl_cert_key* -** description: pass:none[file with SSL certificate and private key (for serving clients with SSL)] -** type: string -** values: any string -** default value: `+"%h/ssl/relay.pem"+` - -* [[option_relay.network.ssl_priorities]] *relay.network.ssl_priorities* -** description: pass:none[string with priorities for gnutls (for syntax, see documentation of function gnutls_priority_init in gnutls manual, common strings are: "PERFORMANCE", "NORMAL", "SECURE128", "SECURE256", "EXPORT", "NONE")] -** type: string -** values: any string -** default value: `+"NORMAL:-VERS-SSL3.0"+` - -* [[option_relay.network.totp_secret]] *relay.network.totp_secret* -** description: pass:none[secret for the generation of the Time-based One-Time Password (TOTP), encoded in base32 (only letters and digits from 2 to 7); it is used as second factor in weechat protocol, in addition to the password, which must not be empty (empty value means no TOTP is required) (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_relay.network.totp_window]] *relay.network.totp_window* -** description: pass:none[number of Time-based One-Time Passwords to accept before and after the current one: 0 = accept only the current password, 1 = accept one password before, the current, and one after, 2 = accept two passwords before, the current, and two after, ...; a high number reduces the security level (0 or 1 are recommended values)] -** type: integer -** values: 0 .. 256 -** default value: `+0+` - -* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins* -** description: pass:none[POSIX extended regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^https?://(www\.)?example\.(com|org)"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_relay.weechat.commands]] *relay.weechat.commands* -** description: pass:none[comma-separated list of commands allowed/denied when input data (text or command) is received from a client; "*" means any command, a name beginning with "!" is a negative value to prevent a command from being executed, wildcard "*" is allowed in names; this option should be set if the relay client is not safe (someone could use it to run commands); for example "*,!exec,!quit" allows any command except /exec and /quit] -** type: string -** values: any string -** default value: `+""+` diff --git a/doc/en/autogen/user/ruby_commands.adoc b/doc/en/autogen/user/ruby_commands.adoc deleted file mode 100644 index 152e35d93..000000000 --- a/doc/en/autogen/user/ruby_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_ruby_ruby]] -* `+ruby+`: list/load/unload scripts - ----- -/ruby list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/ruby_options.adoc b/doc/en/autogen/user/ruby_options.adoc deleted file mode 100644 index 4282168a3..000000000 --- a/doc/en/autogen/user/ruby_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_ruby.look.check_license]] *ruby.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_ruby.look.eval_keep_context]] *ruby.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/script_commands.adoc b/doc/en/autogen/user/script_commands.adoc deleted file mode 100644 index 943ebed25..000000000 --- a/doc/en/autogen/user/script_commands.adoc +++ /dev/null @@ -1,82 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_script_script]] -* `+script+`: WeeChat script manager - ----- -/script list [-o|-ol|-i|-il] - search <text> - show <script> - load|unload|reload <script> [<script>...] - autoload|noautoload|toggleautoload <script> [<script>...] - install|remove|installremove|hold [-q] <script> [<script>...] - upgrade - update - - list: list loaded scripts (all languages) - -o: send list of loaded scripts to buffer (string in English) - -ol: send list of loaded scripts to buffer (translated string) - -i: copy list of loaded scripts in command line (for sending to buffer) (string in English) - -il: copy list of loaded scripts in command line (for sending to buffer) (translated string) - search: search scripts by tags, language (python, perl, ...), filename extension (py, pl, ...) or text; result is displayed on scripts buffer - show: show detailed info about a script - load: load script(s) - unload: unload script(s) - reload: reload script(s) - autoload: autoload the script - noautoload: do not autoload the script -toggleautoload: toggle autoload - install: install/upgrade script(s) - remove: remove script(s) - installremove: install or remove script(s), depending on current state - hold: hold/unhold script(s) (a script held will not be upgraded any more and cannot be removed) - -q: quiet mode: do not display messages - upgrade: upgrade all installed scripts which are obsolete (new version available) - update: update local scripts cache - -Without argument, this command opens a buffer with list of scripts. - -On script buffer, the possible status for each script are: - * i a H r N - | | | | | | - | | | | | obsolete (new version available) - | | | | running (loaded) - | | | held - | | autoloaded - | installed - popular script - -Keys on script buffer: - alt+i install script - alt+r remove script - alt+l load script - alt+L reload script - alt+u unload script - alt+A autoload script - alt+h (un)hold script - alt+v view script - -Input allowed on script buffer: - i/r/l/L/u/A/h/v action on script (same as keys above) - q close buffer - $ refresh buffer - s:x,y sort buffer using keys x and y (see /help script.look.sort) - s: reset sort (use default sort) - word(s) filter scripts: search word(s) in scripts (description, tags, ...) - * remove filter - -Mouse actions on script buffer: - wheel scroll list - left button select script - right button install/remove script - -Examples: - /script search url - /script install go.py urlserver.py - /script remove go.py - /script hold urlserver.py - /script reload urlserver - /script upgrade ----- diff --git a/doc/en/autogen/user/script_options.adoc b/doc/en/autogen/user/script_options.adoc deleted file mode 100644 index 140e740e4..000000000 --- a/doc/en/autogen/user/script_options.adoc +++ /dev/null @@ -1,243 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_script.color.status_autoloaded]] *script.color.status_autoloaded* -** description: pass:none[color for status "autoloaded" ("a")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_script.color.status_held]] *script.color.status_held* -** description: pass:none[color for status "held" ("H")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_script.color.status_installed]] *script.color.status_installed* -** description: pass:none[color for status "installed" ("i")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_script.color.status_obsolete]] *script.color.status_obsolete* -** description: pass:none[color for status "obsolete" ("N")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_script.color.status_popular]] *script.color.status_popular* -** description: pass:none[color for status "popular" ("*")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_script.color.status_running]] *script.color.status_running* -** description: pass:none[color for status "running" ("r")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_script.color.status_unknown]] *script.color.status_unknown* -** description: pass:none[color for status "unknown" ("?")] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_script.color.text]] *script.color.text* -** description: pass:none[text color in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_bg]] *script.color.text_bg* -** description: pass:none[background color in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_bg_selected]] *script.color.text_bg_selected* -** description: pass:none[background color for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_script.color.text_date]] *script.color.text_date* -** description: pass:none[text color of dates in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_date_selected]] *script.color.text_date_selected* -** description: pass:none[text color of dates for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_script.color.text_delimiters]] *script.color.text_delimiters* -** description: pass:none[text color of delimiters in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_description]] *script.color.text_description* -** description: pass:none[text color of description in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_description_selected]] *script.color.text_description_selected* -** description: pass:none[text color of description for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_script.color.text_extension]] *script.color.text_extension* -** description: pass:none[text color of extension in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_extension_selected]] *script.color.text_extension_selected* -** description: pass:none[text color of extension for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_script.color.text_name]] *script.color.text_name* -** description: pass:none[text color of script name in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_script.color.text_name_selected]] *script.color.text_name_selected* -** description: pass:none[text color of script name for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_script.color.text_selected]] *script.color.text_selected* -** description: pass:none[text color for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_script.color.text_tags]] *script.color.text_tags* -** description: pass:none[text color of tags in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_script.color.text_tags_selected]] *script.color.text_tags_selected* -** description: pass:none[text color of tags for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_script.color.text_version]] *script.color.text_version* -** description: pass:none[text color of version in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_script.color.text_version_loaded]] *script.color.text_version_loaded* -** description: pass:none[text color of version loaded in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_script.color.text_version_loaded_selected]] *script.color.text_version_loaded_selected* -** description: pass:none[text color of version loaded for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_script.color.text_version_selected]] *script.color.text_version_selected* -** description: pass:none[text color of version for selected line in script buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_script.look.columns]] *script.look.columns* -** description: pass:none[format of columns displayed in script buffer: following column identifiers are replaced by their value: %a=author, %d=description, %D=date added, %e=extension, %l=language, %L=license, %n=name with extension, %N=name, %r=requirements, %s=status, %t=tags, %u=date updated, %v=version, %V=version loaded, %w=min_weechat, %W=max_weechat)] -** type: string -** values: any string -** default value: `+"%s %n %V %v %u | %d | %t"+` - -* [[option_script.look.diff_color]] *script.look.diff_color* -** description: pass:none[colorize output of diff] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_script.look.diff_command]] *script.look.diff_command* -** description: pass:none[command used to show differences between script installed and the new version in repository ("auto" = auto detect diff command (git or diff), empty value = disable diff, other string = name of command, for example "diff")] -** type: string -** values: any string -** default value: `+"auto"+` - -* [[option_script.look.display_source]] *script.look.display_source* -** description: pass:none[display source code of script on buffer with detail on a script (script is downloaded in a temporary file when detail on script is displayed)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_script.look.quiet_actions]] *script.look.quiet_actions* -** description: pass:none[quiet actions on script buffer: do not display messages on core buffer when scripts are installed/removed/loaded/unloaded (only errors are displayed)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_script.look.sort]] *script.look.sort* -** description: pass:none[default sort keys for scripts: comma-separated list of identifiers: a=author, A=autoloaded, d=date added, e=extension, i=installed, l=language, n=name, o=obsolete, p=popularity, r=running, u=date updated; char "-" can be used before identifier to reverse order; example: "i,u": installed scripts first, sorted by update date] -** type: string -** values: any string -** default value: `+"i,p,n"+` - -* [[option_script.look.translate_description]] *script.look.translate_description* -** description: pass:none[translate description of scripts (if translation is available in your language, otherwise English version is used)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_script.look.use_keys]] *script.look.use_keys* -** description: pass:none[use keys alt+X in script buffer to do actions on scripts (alt+i = install, alt+r = remove, ...); if disabled, only the input is allowed: i, r, ...] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_script.scripts.autoload]] *script.scripts.autoload* -** description: pass:none[autoload scripts installed (make a link in "autoload" directory to script in parent directory)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_script.scripts.cache_expire]] *script.scripts.cache_expire* -** description: pass:none[local cache expiration time, in minutes (-1 = never expires, 0 = always expire)] -** type: integer -** values: -1 .. 525600 -** default value: `+1440+` - -* [[option_script.scripts.download_timeout]] *script.scripts.download_timeout* -** description: pass:none[timeout (in seconds) for download of scripts and list of scripts] -** type: integer -** values: 1 .. 3600 -** default value: `+30+` - -* [[option_script.scripts.hold]] *script.scripts.hold* -** description: pass:none[scripts to "hold": comma-separated list of scripts which will never been upgraded and can not be removed, for example: "go.py,urlserver.py"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_script.scripts.path]] *script.scripts.path* -** description: pass:none[local cache directory for scripts; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+"%h/script"+` - -* [[option_script.scripts.url]] *script.scripts.url* -** description: pass:none[URL for file with list of scripts] -** type: string -** values: any string -** default value: `+"https://weechat.org/files/plugins.xml.gz"+` diff --git a/doc/en/autogen/user/sec_options.adoc b/doc/en/autogen/user/sec_options.adoc deleted file mode 100644 index 823272b9f..000000000 --- a/doc/en/autogen/user/sec_options.adoc +++ /dev/null @@ -1,27 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_sec.crypt.cipher]] *sec.crypt.cipher* -** description: pass:none[cipher used to crypt data (the number after algorithm is the size of the key in bits)] -** type: integer -** values: aes128, aes192, aes256 -** default value: `+aes256+` - -* [[option_sec.crypt.hash_algo]] *sec.crypt.hash_algo* -** description: pass:none[hash algorithm used to check the decrypted data] -** type: integer -** values: sha224, sha256, sha384, sha512 -** default value: `+sha256+` - -* [[option_sec.crypt.passphrase_file]] *sec.crypt.passphrase_file* -** description: pass:none[path to a file containing the passphrase to encrypt/decrypt secured data; this option is used only when reading file sec.conf; only first line of file is used; this file is used only if the environment variable "WEECHAT_PASSPHRASE" is not set (the environment variable has higher priority); security note: it is recommended to keep this file readable only by you and store it outside WeeChat home (for example in your home); example: "~/.weechat-passphrase"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_sec.crypt.salt]] *sec.crypt.salt* -** description: pass:none[use salt when generating key used in encryption (recommended for maximum security); when enabled, the content of crypted data in file sec.conf will be different on each write of the file; if you put the file sec.conf in a version control system, then you can turn off this option to have always same content in file] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/spell_commands.adoc b/doc/en/autogen/user/spell_commands.adoc deleted file mode 100644 index 02d003fc1..000000000 --- a/doc/en/autogen/user/spell_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_spell_spell]] -* `+spell+`: spell plugin configuration - ----- -/spell enable|disable|toggle - listdict - setdict <dict>[,<dict>...] - deldict - addword [<dict>] <word> - - enable: enable spell checker - disable: disable spell checker - toggle: toggle spell checker -listdict: show installed dictionaries - setdict: set dictionary for current buffer (multiple dictionaries can be separated by a comma) - deldict: delete dictionary used on current buffer - addword: add a word in personal dictionary - -Input line beginning with a '/' is not checked, except for some commands (see /set spell.check.commands). - -To enable spell checker on all buffers, use option "default_dict", then enable spell checker, for example: - /set spell.check.default_dict "en" - /spell enable - -To display a list of suggestions in a bar, use item "spell_suggest". - -Default key to toggle spell checker is alt-s. ----- diff --git a/doc/en/autogen/user/spell_options.adoc b/doc/en/autogen/user/spell_options.adoc deleted file mode 100644 index 7e70e897b..000000000 --- a/doc/en/autogen/user/spell_options.adoc +++ /dev/null @@ -1,81 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_spell.check.commands]] *spell.check.commands* -** description: pass:none[comma separated list of commands for which spell checking is enabled (spell checking is disabled for all other commands)] -** type: string -** values: any string -** default value: `+"away,command,cycle,kick,kickban,me,msg,notice,part,query,quit,topic"+` - -* [[option_spell.check.default_dict]] *spell.check.default_dict* -** description: pass:none[default dictionary (or comma separated list of dictionaries) to use when buffer has no dictionary defined (leave blank to disable spell checker on buffers for which you didn't explicitly enabled it)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_spell.check.during_search]] *spell.check.during_search* -** description: pass:none[check words during text search in buffer] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_spell.check.enabled]] *spell.check.enabled* -** description: pass:none[enable spell checker for command line] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_spell.check.real_time]] *spell.check.real_time* -** description: pass:none[real-time spell checking of words (slower, disabled by default: words are checked only if there's delimiter after)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_spell.check.suggestions]] *spell.check.suggestions* -** description: pass:none[number of suggestions to display in bar item "spell_suggest" for each dictionary set in buffer (-1 = disable suggestions, 0 = display all possible suggestions in all languages)] -** type: integer -** values: -1 .. 2147483647 -** default value: `+-1+` - -* [[option_spell.check.word_min_length]] *spell.check.word_min_length* -** description: pass:none[minimum length for a word to be spell checked (use 0 to check all words)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+2+` - -* [[option_spell.color.misspelled]] *spell.color.misspelled* -** description: pass:none[text color for misspelled words (input bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_spell.color.suggestion]] *spell.color.suggestion* -** description: pass:none[text color for suggestion on a misspelled word in bar item "spell_suggest"] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_spell.color.suggestion_delimiter_dict]] *spell.color.suggestion_delimiter_dict* -** description: pass:none[text color for delimiters displayed between two dictionaries in bar item "spell_suggest"] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_spell.color.suggestion_delimiter_word]] *spell.color.suggestion_delimiter_word* -** description: pass:none[text color for delimiters displayed between two words in bar item "spell_suggest"] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_spell.look.suggestion_delimiter_dict]] *spell.look.suggestion_delimiter_dict* -** description: pass:none[delimiter displayed between two dictionaries in bar item "spell_suggest"] -** type: string -** values: any string -** default value: `+" / "+` - -* [[option_spell.look.suggestion_delimiter_word]] *spell.look.suggestion_delimiter_word* -** description: pass:none[delimiter displayed between two words in bar item "spell_suggest"] -** type: string -** values: any string -** default value: `+","+` diff --git a/doc/en/autogen/user/tcl_commands.adoc b/doc/en/autogen/user/tcl_commands.adoc deleted file mode 100644 index db0d7b78d..000000000 --- a/doc/en/autogen/user/tcl_commands.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_tcl_tcl]] -* `+tcl+`: list/load/unload scripts - ----- -/tcl list|listfull [<name>] - load [-q] <filename> - autoload - reload|unload [-q] [<name>] - eval [-o|-oc] <code> - version - - list: list loaded scripts -listfull: list loaded scripts (verbose) - load: load a script -autoload: load all scripts in "autoload" directory - reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory) - unload: unload a script (if no name given, unload all scripts) -filename: script (file) to load - -q: quiet mode: do not display messages - name: a script name (name used in call to "register" function) - eval: evaluate source code and display result on current buffer - -o: send evaluation result to the buffer without executing commands - -oc: send evaluation result to the buffer and execute commands - code: source code to evaluate - version: display the version of interpreter used - -Without argument, this command lists all loaded scripts. ----- diff --git a/doc/en/autogen/user/tcl_options.adoc b/doc/en/autogen/user/tcl_options.adoc deleted file mode 100644 index abe7d4a14..000000000 --- a/doc/en/autogen/user/tcl_options.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_tcl.look.check_license]] *tcl.look.check_license* -** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_tcl.look.eval_keep_context]] *tcl.look.eval_keep_context* -** description: pass:none[keep context between two calls to the source code evaluation (option "eval" of script command or info "%s_eval"); a hidden script is used to eval script code; if this option is disabled, this hidden script is unloaded after each eval: this uses less memory, but is slower] -** type: boolean -** values: on, off -** default value: `+on+` diff --git a/doc/en/autogen/user/trigger_commands.adoc b/doc/en/autogen/user/trigger_commands.adoc deleted file mode 100644 index 2b6c772dc..000000000 --- a/doc/en/autogen/user/trigger_commands.adoc +++ /dev/null @@ -1,88 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_trigger_trigger]] -* `+trigger+`: manage triggers, the Swiss Army knife for WeeChat - ----- -/trigger list|listfull|listdefault - add|addoff|addreplace <name> <hook> ["<arguments>" ["<conditions>" ["<regex>" ["<command>" ["<return_code>" ["<post_action>"]]]]]] - addinput [<hook>] - input|output|recreate <name> - set <name> <option> <value> - rename|copy <name> <new_name> - enable|disable|toggle [<name>|-all [<name>...]] - restart <name>|-all [<name>...] - show <name> - del <name>|-all [<name>...] - restore <name> [<name>...] - default -yes - monitor [<filter>] - - list: list triggers (without argument, this list is displayed) - listfull: list triggers with detailed info for each trigger -listdefault: list default triggers - add: add a trigger - addoff: add a trigger (disabled) - addreplace: add or replace an existing trigger - name: name of trigger - hook: signal, hsignal, modifier, line, print, command, command_run, timer, config, focus, info, info_hashtable - arguments: arguments for the hook, depending on hook (separated by semicolons): - signal: name(s) of signal (required) - hsignal: name(s) of hsignal (required) - modifier: name(s) of modifier (required) - line: buffer type ("formatted", "free" or "*"), list of buffer masks, tags - print: buffer, tags, message, strip colors - command: command (required), description, arguments, description of arguments, completion (all arguments except command are evaluated, see /help eval) - command_run: command(s) (required) - timer: interval (required), align on second, max calls - config: name(s) of option (required) - focus: name(s) of area (required) - info: name(s) of info (required) - info_hashtable: name(s) of info (required) - conditions: evaluated conditions for the trigger - regex: one or more regular expressions to replace strings in variables - command: command to execute (many commands can be separated by ";") -return_code: return code in callback (ok (default), ok_eat, error) -post_action: action to take after execution (none (default), disable, delete) - addinput: set input with default arguments to create a trigger - input: set input with the command used to create the trigger - output: send the command to create the trigger on the buffer - recreate: same as "input", with option "addreplace" instead of "add" - set: set an option in a trigger - option: name of option: name, hook, arguments, conditions, regex, command, return_code - (for help on option, you can type: /help trigger.trigger.<name>.<option>) - value: new value for the option - rename: rename a trigger - copy: copy a trigger - enable: enable trigger(s) (without arguments: enable triggers globally) - disable: disable trigger(s) (without arguments: disable triggers globally) - toggle: toggle trigger(s) (without arguments: toggle triggers globally) - restart: restart trigger(s) (recreate the hooks) - show: show detailed info on a trigger (with some stats) - del: delete a trigger - -all: do action on all triggers - restore: restore trigger(s) with the default values (works only for default triggers) - default: delete all triggers and restore default ones - monitor: open the trigger monitor buffer, with optional filter: - filter: filter hooks/triggers to display (a hook must start with "@", for example "@signal"), many filters can be separated by commas; wildcard "*" is allowed in each trigger name - -When a trigger callback is called, following actions are performed, in this order: - 1. check conditions; if false, exit - 2. replace text using POSIX extended regular expression(s) (if defined in trigger) - 3. execute command(s) (if defined in trigger) - 4. exit with a return code (except for modifier, line, focus, info and info_hashtable) - 5. perform post action - -Examples (you can also look at default triggers with /trigger listdefault): - add text attributes *bold*, _underline_ and /italic/ (only in user messages): - /trigger add effects modifier weechat_print "${tg_tag_nick}" "==\*([^ ]+)\*==*${color:bold}${re:1}${color:-bold}*== ==_([^ ]+)_==_${color:underline}${re:1}${color:-underline}_== ==/([^ ]+)/==/${color:italic}${re:1}${color:-italic}/" - hide nicklist bar on small terminals: - /trigger add resize_small signal signal_sigwinch "${info:term_width} < 100" "" "/bar hide nicklist" - /trigger add resize_big signal signal_sigwinch "${info:term_width} >= 100" "" "/bar show nicklist" - silently save config each hour: - /trigger add cfgsave timer 3600000;0;0 "" "" "/mute /save" - open trigger monitor and show only modifiers and triggers whose name starts with "resize": - /trigger monitor @modifier,resize* ----- diff --git a/doc/en/autogen/user/trigger_options.adoc b/doc/en/autogen/user/trigger_options.adoc deleted file mode 100644 index 32291da2b..000000000 --- a/doc/en/autogen/user/trigger_options.adoc +++ /dev/null @@ -1,69 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_trigger.color.flag_command]] *trigger.color.flag_command* -** description: pass:none[text color for command flag (in /trigger list)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_trigger.color.flag_conditions]] *trigger.color.flag_conditions* -** description: pass:none[text color for conditions flag (in /trigger list)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_trigger.color.flag_post_action]] *trigger.color.flag_post_action* -** description: pass:none[text color for post action flag (in /trigger list)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightblue+` - -* [[option_trigger.color.flag_regex]] *trigger.color.flag_regex* -** description: pass:none[text color for regex flag (in /trigger list)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_trigger.color.flag_return_code]] *trigger.color.flag_return_code* -** description: pass:none[text color for return code flag (in /trigger list)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_trigger.color.regex]] *trigger.color.regex* -** description: pass:none[text color for regular expressions] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_trigger.color.replace]] *trigger.color.replace* -** description: pass:none[text color for replacement text (for regular expressions)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_trigger.color.trigger]] *trigger.color.trigger* -** description: pass:none[text color for trigger name] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_trigger.color.trigger_disabled]] *trigger.color.trigger_disabled* -** description: pass:none[text color for disabled trigger name] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_trigger.look.enabled]] *trigger.look.enabled* -** description: pass:none[enable trigger support] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_trigger.look.monitor_strip_colors]] *trigger.look.monitor_strip_colors* -** description: pass:none[strip colors in hashtable values displayed on monitor buffer] -** type: boolean -** values: on, off -** default value: `+off+` diff --git a/doc/en/autogen/user/weechat_commands.adoc b/doc/en/autogen/user/weechat_commands.adoc deleted file mode 100644 index c8dc105ec..000000000 --- a/doc/en/autogen/user/weechat_commands.adoc +++ /dev/null @@ -1,1056 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_weechat_away]] -* `+away+`: set or remove away status - ----- -/away [-all] [<message>] - - -all: set or remove away status on all connected servers -message: message for away (if no message is given, away status is removed) ----- - -[[command_weechat_bar]] -* `+bar+`: manage bars - ----- -/bar list|listfull|listitems - add <name> <type>[,<conditions>] <position> <size> <separator> <item1>[,<item2>...] - default [input|title|status|nicklist] - del <name>|-all - set <name> <option> <value> - hide|show|toggle <name> - scroll <name> <window> <scroll_value> - - list: list all bars - listfull: list all bars (verbose) - listitems: list all bar items - add: add a new bar - name: name of bar (must be unique) - type: root: outside windows, - window: inside windows, with optional conditions (see below) - conditions: the conditions to display the bar: - active: on active window - inactive: on inactive windows - nicklist: on windows with nicklist - other condition: see /help weechat.bar.xxx.conditions and /help eval - without conditions, the bar is always displayed - position: bottom, top, left or right - size: size of bar (in chars) - separator: 1 for using separator (line), 0 or nothing means no separator - item1,...: items for this bar (items can be separated by comma (space between items) or "+" (glued items)) - default: create a default bar (all default bars if no bar name is given) - del: delete a bar (or all bars with -all) - set: set a value for a bar property - option: option to change (for options list, look at /set weechat.bar.<barname>.*) - value: new value for option - hide: hide a bar - show: show an hidden bar - toggle: hide/show a bar - scroll: scroll bar - window: window number (use '*' for current window or for root bars) - scroll_value: value for scroll: 'x' or 'y' (optional), followed by '+', '-', 'b' (beginning) or 'e' (end), value (for +/-), and optional % (to scroll by % of width/height, otherwise value is number of chars) - -Examples: - create a bar with time, buffer number + name, and completion: - /bar add mybar root bottom 1 0 [time],buffer_number+:+buffer_name,completion - hide a bar: - /bar hide mybar - scroll nicklist 10 lines down on current buffer: - /bar scroll nicklist * y+10 - scroll to end of nicklist on current buffer: - /bar scroll nicklist * ye ----- - -[[command_weechat_buffer]] -* `+buffer+`: manage buffers - ----- -/buffer list - add [-free] [-switch] <name> - clear [<number>|<name>|-merged|-all [<number>|<name>...]] - move <number>|-|+ - swap <number1>|<name1> [<number2>|<name2>] - cycle <number>|<name> [<number>|<name>...] - merge <number>|<name> - unmerge [<number>|-all] - hide [<number>|<name>|-all [<number>|<name>...]] - unhide [<number>|<name>|-all [<number>|<name>...]] - renumber [<number1> [<number2> [<start>]]] - close [<n1>[-<n2>]|<name>...] - notify <level> - localvar [<number>|<name>] - set <property> [<value>] - get <property> - <number>|-|+|<name> - - list: list buffers (without argument, this list is displayed) - add: add a new buffer (it can be closed with "/buffer close" or input "q") - clear: clear buffer content (number for a buffer, -merged for merged buffers, -all for all buffers, or nothing for current buffer) - move: move buffer in the list (may be relative, for example -1); "-" = move to first buffer number, "+" = move to last buffer number + 1 - swap: swap two buffers (swap with current buffer if only one number/name given) - cycle: jump loop between a list of buffers - merge: merge current buffer to another buffer (chat area will be mix of both buffers) - (by default ctrl-x switches between merged buffers) - unmerge: unmerge buffer from other buffers which have same number - hide: hide the buffer - unhide: unhide the buffer -renumber: renumber buffers (works only if option weechat.look.buffer_auto_renumber is off) - close: close buffer (number/range or name is optional) - notify: set notify level for current buffer: this level determines whether buffer will be added to hotlist or not: - none: never - highlight: for highlights only - message: for messages from users + highlights - all: all messages - reset: reset to default value (all) -localvar: display local variables for the buffer - set: set a property for current buffer - get: display a property of current buffer - number: jump to buffer by number, possible prefix: - '+': relative jump, add number to current - '-': relative jump, sub number to current - '*': jump to number, using option "weechat.look.jump_current_to_previous_buffer" - -: jump to first buffer number - +: jump to last buffer number - name: jump to buffer by (partial) name - -Examples: - clear current buffer: - /buffer clear - move buffer to number 5: - /buffer move 5 - swap buffer 1 with 3: - /buffer swap 1 3 - swap buffer #weechat with current buffer: - /buffer swap #weechat - jump on #chan1, #chan2, #chan3 and loop: - /buffer cycle #chan1 #chan2 #chan3 - merge with core buffer: - /buffer merge 1 - merge with #weechat buffer: - /buffer merge #weechat - unmerge buffer: - /buffer unmerge - close current buffer: - /buffer close - close buffers 5 to 7: - /buffer close 5-7 - jump to #weechat: - /buffer #weechat - jump to next buffer: - /buffer +1 - jump to last buffer number: - /buffer + ----- - -[[command_weechat_color]] -* `+color+`: define color aliases and display palette of colors - ----- -/color alias <color> <name> - unalias <color> - reset - term2rgb <color> - rgb2term <rgb> [<limit>] - -o - - alias: add an alias for a color - unalias: delete an alias - color: color number (greater than or equal to 0, max depends on terminal, commonly 63 or 255) - name: alias name for color (for example: "orange") - reset: reset all color pairs (required when no more color pairs are available if automatic reset is disabled, see option "weechat.look.color_pairs_auto_reset") -term2rgb: convert a terminal color (0-255) to RGB color -rgb2term: convert a RGB color to terminal color (0-255) - limit: number of colors to use in terminal table (starting from 0); default is 256 - -o: send terminal/colors info to current buffer as input - -Without argument, this command displays colors in a new buffer. - -Examples: - add alias "orange" for color 214: - /color alias 214 orange - delete color 214: - /color unalias 214 ----- - -[[command_weechat_command]] -* `+command+`: launch explicit WeeChat or plugin command - ----- -/command [-buffer <name>] <plugin> <command> - --buffer: execute the command on this buffer - plugin: execute the command from this plugin; 'core' for a WeeChat command, '*' for automatic plugin (it depends on the buffer where the command is executed) -command: command to execute (a '/' is automatically added if not found at beginning of command) ----- - -[[command_weechat_cursor]] -* `+cursor+`: free movement of cursor on screen to execute actions on specific areas of screen - ----- -/cursor go chat|<bar>|<x>,<y> - move up|down|left|right|area_up|area_down|area_left|area_right - stop - - go: move cursor to chat area, a bar (using bar name) or coordinates "x,y" -move: move cursor with direction -stop: stop cursor mode - -Without argument, this command toggles cursor mode. - -When mouse is enabled (see /help mouse), by default a middle click will start cursor mode at this point. - -Default keys in cursor mode on chat messages: - m quote message - q quote prefix + message - Q quote time + prefix + message - -Default keys in cursor mode on nicklist: - b ban nick (/ban) - k kick nick (/kick) - K kick and ban nick (/kickban) - q open query with nick (/query) - w query information about user (/whois) - -Other default keys in cursor mode: - arrow move cursor - alt+arrow move cursor to the next area - enter exit cursor mode - -Examples: - go to nicklist: - /cursor go nicklist - go to coordinates x=10, y=5: - /cursor go 10,5 ----- - -[[command_weechat_debug]] -* `+debug+`: debug functions - ----- -/debug list - set <plugin> <level> - dump [<plugin>] - buffer|color|infolists|memory|tags|term|windows - mouse|cursor [verbose] - hdata [free] - time <command> - - list: list plugins with debug levels - set: set debug level for plugin - plugin: name of plugin ("core" for WeeChat core) - level: debug level for plugin (0 = disable debug) - dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes) - buffer: dump buffer content with hexadecimal values in log file - color: display infos about current color pairs - cursor: toggle debug for cursor mode - dirs: display directories - hdata: display infos about hdata (with free: remove all hdata in memory) - hooks: display infos about hooks -infolists: display infos about infolists - libs: display infos about external libraries used - memory: display infos about memory usage - mouse: toggle debug for mouse - tags: display tags for lines - term: display infos about terminal - windows: display windows tree - time: measure time to execute a command or to send text to the current buffer ----- - -[[command_weechat_eval]] -* `+eval+`: evaluate expression - ----- -/eval [-n|-s] [-d] <expression> - [-n] [-d] -c <expression1> <operator> <expression2> - - -n: display result without sending it to buffer (debug mode) - -s: split expression before evaluating it (many commands can be separated by semicolons) - -d: display debug output after evaluation - -c: evaluate as condition: use operators and parentheses, return a boolean value ("0" or "1") -expression: expression to evaluate, variables with format ${variable} are replaced (see below); many commands can be separated by semicolons - operator: a logical or comparison operator: - - logical operators: - && boolean "and" - || boolean "or" - - comparison operators: - == equal - != not equal - <= less or equal - < less - >= greater or equal - > greater - =~ is matching POSIX extended regex - !~ is NOT matching POSIX extended regex - =* is matching mask (wildcard "*" is allowed) - !* is NOT matching mask (wildcard "*" is allowed) - -An expression is considered as "true" if it is not NULL, not empty, and different from "0". -The comparison is made using floating point numbers if the two expressions are valid numbers, with one of the following formats: - - integer (examples: 5, -7) - - floating point number (examples: 5.2, -7.5, 2.83e-2) - - hexadecimal number (examples: 0xA3, -0xA3) -To force a string comparison, you can add double quotes around each expression, for example: - 50 > 100 ==> 0 - "50" > "100" ==> 1 - -Some variables are replaced in expression, using the format ${variable}, variable can be, by order of priority: - 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 string with max chars (format: "cut:max,suffix,string" or "cut:+max,suffix,string") - or max chars displayed on screen (format: "cutscr:max,suffix,string" or "cutscr:+max,suffix,string") - 5. a reversed string (format: "rev:xxx" or "revscr:xxx") - 6. a repeated string (format: "repeat:count,string") - 7. length of a string (format: "length:xxx" or "lengthscr:xxx") - 8. a color (format: "color:xxx", see "Plugin API reference", function "color") - 9. a modifier (format: "modifier:name,data,string") - 10. an info (format: "info:name,arguments", arguments are optional) - 11. current date/time (format: "date" or "date:format") - 12. an environment variable (format: "env:XXX") - 13. a ternary operator (format: "if:condition?value_if_true:value_if_false") - 14. result of an expression with parentheses and operators + - * / // % ** (format: "calc:xxx") - 15. an option (format: "file.section.option") - 16. a local variable in buffer - 17. 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: - ${buffer[gui_buffers].full_name}: full name of first buffer in linked list of buffers - ${plugin[weechat_plugins].name}: name of first plugin in linked list of plugins - hdata[pointer].var1.var2...: start with a hdata using a pointer, for example: - ${buffer[0x1234abcd].full_name}: full name of the buffer with this pointer (can be used in triggers) -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 ${sec.data.freenode_password} ==> secret - /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:3,+,test} ==> tes+ - /eval -n ${cut:+3,+,test} ==> te+ - /eval -n ${date:%H:%M:%S} ==> 07:46:40 - /eval -n ${if:${info:term_width}>80?big:small} ==> big - /eval -n ${rev:Hello} ==> olleH - /eval -n ${repeat:5,-} ==> ----- - /eval -n ${length:test} ==> 4 - /eval -n ${calc:(5+2)*3} ==> 21 - -Examples (conditions): - /eval -n -c ${window.buffer.number} > 2 ==> 0 - /eval -n -c ${window.win_width} > 100 ==> 1 - /eval -n -c (8 > 12) || (5 > 2) ==> 1 - /eval -n -c (8 > 12) && (5 > 2) ==> 0 - /eval -n -c abcd =~ ^ABC ==> 1 - /eval -n -c abcd =~ (?-i)^ABC ==> 0 - /eval -n -c abcd =~ (?-i)^abc ==> 1 - /eval -n -c abcd !~ abc ==> 0 - /eval -n -c abcd =* a*d ==> 1 ----- - -[[command_weechat_filter]] -* `+filter+`: filter messages in buffers, to hide/show them according to tags or regex - ----- -/filter list - enable|disable|toggle [<name>|@] - add|addreplace <name> <buffer>[,<buffer>...] <tags> <regex> - rename <name> <new_name> - del <name>|-all - - list: list all filters - enable: enable filters (filters are enabled by default) - disable: disable filters - toggle: toggle filters - name: filter name ("@" = enable/disable all filters in current buffer) - add: add a filter -addreplace: add or replace an existing filter - rename: rename a filter - del: delete a filter - -all: delete all filters - buffer: comma separated list of buffers where filter is active: - - this is full name including plugin (example: "irc.freenode.#weechat" or "irc.server.freenode") - - "*" means all buffers - - a name starting with '!' is excluded - - wildcard "*" is allowed - tags: comma separated list of tags, for example "irc_join,irc_part,irc_quit" - - logical "and": use "+" between tags (for example: "nick_toto+irc_action") - - wildcard "*" is allowed - - if tag starts with '!', then it is excluded and must NOT be in message - regex: POSIX extended regular expression to search in line - - use '\t' to separate prefix from message, special chars like '|' must be escaped: '\|' - - if regex starts with '!', then matching result is reversed (use '\!' to start with '!') - - two regular expressions are created: one for prefix and one for message - - regex are case insensitive, they can start by "(?-i)" to become case sensitive - -The default key alt+'=' toggles filtering on/off globally and alt+'-' toggles filtering on/off in the current buffer. - -Tags most commonly used: - no_filter, no_highlight, no_log, log0..log9 (log level), - notify_none, notify_message, notify_private, notify_highlight, - self_msg, nick_xxx (xxx is nick in message), prefix_nick_ccc (ccc is color of nick), - host_xxx (xxx is username + host in message), - irc_xxx (xxx is command name or number, see /server raw or /debug tags), - irc_numeric, irc_error, irc_action, irc_ctcp, irc_ctcp_reply, irc_smart_filter, away_info. -To see tags for lines in buffers: /debug tags - -Examples: - use IRC smart filter on all buffers: - /filter add irc_smart * irc_smart_filter * - use IRC smart filter on all buffers except those with "#weechat" in name: - /filter add irc_smart *,!*#weechat* irc_smart_filter * - filter all IRC join/part/quit messages: - /filter add joinquit * irc_join,irc_part,irc_quit * - filter nicks displayed when joining channels or with /names: - /filter add nicks * irc_366 * - filter nick "toto" on IRC channel #weechat: - /filter add toto irc.freenode.#weechat nick_toto * - filter IRC join/action messages from nick "toto": - /filter add toto * nick_toto+irc_join,nick_toto+irc_action * - filter lines containing "weechat sucks" on IRC channel #weechat: - /filter add sucks irc.freenode.#weechat * weechat sucks - filter lines that are strictly equal to "WeeChat sucks" on all buffers: - /filter add sucks2 * * (?-i)^WeeChat sucks$ ----- - -[[command_weechat_help]] -* `+help+`: display help about commands and options - ----- -/help -list|-listfull [<plugin> [<plugin>...]] - <command> - <option> - - -list: list commands, by plugin (without argument, this list is displayed) --listfull: list commands with description, by plugin - plugin: list commands for this plugin - command: a command name - option: an option name (use /set to see list) ----- - -[[command_weechat_history]] -* `+history+`: show buffer command history - ----- -/history clear - <value> - -clear: clear history -value: number of history entries to show ----- - -[[command_weechat_input]] -* `+input+`: functions for command line - ----- -/input <action> [<arguments>] - -list of actions: - return: simulate key "enter" - complete_next: complete word with next completion - complete_previous: complete word with previous completion - search_text_here: search text in buffer at current position - search_text: search text in buffer - search_switch_case: switch exact case for search - search_switch_regex: switch search type: string/regular expression - search_switch_where: switch search in messages/prefixes - search_previous: search previous line - search_next: search next line - search_stop_here: stop search at current position - search_stop: stop search - delete_previous_char: delete previous char - delete_next_char: delete next char - delete_previous_word: delete previous word - delete_next_word: delete next word - delete_beginning_of_line: delete from beginning of line until cursor - delete_end_of_line: delete from cursor until end of line - delete_line: delete entire line - clipboard_paste: paste from the internal clipboard - transpose_chars: transpose two chars - undo: undo last command line action - redo: redo last command line action - move_beginning_of_line: move cursor to beginning of line - move_end_of_line: move cursor to end of line - move_previous_char: move cursor to previous char - move_next_char: move cursor to next char - move_previous_word: move cursor to previous word - move_next_word: move cursor to next word - history_previous: recall previous command in current buffer history - history_next: recall next command in current buffer history - history_global_previous: recall previous command in global history - history_global_next: recall next command in global history - jump_smart: jump to next buffer with activity - jump_last_buffer_displayed: jump to last buffer displayed (before last jump to a buffer) - jump_previously_visited_buffer: jump to previously visited buffer - jump_next_visited_buffer: jump to next visited buffer - hotlist_clear: clear hotlist (optional argument: "lowest" to clear only lowest level in hotlist, "highest" to clear only highest level in hotlist, or level mask: integer which is a combination of 1=join/part, 2=message, 4=private, 8=highlight) - grab_key: grab a key (optional argument: delay for end of grab, default is 500 milliseconds) - grab_key_command: grab a key with its associated command (optional argument: delay for end of grab, default is 500 milliseconds) - grab_mouse: grab mouse event code - grab_mouse_area: grab mouse event code with area - set_unread: set unread marker for all buffers - set_unread_current_buffer: set unread marker for current buffer - switch_active_buffer: switch to next merged buffer - switch_active_buffer_previous: switch to previous merged buffer - zoom_merged_buffer: zoom on merged buffer - insert: insert text in command line (escaped chars are allowed, see /help print) - send: send text to the buffer - paste_start: start paste (bracketed paste mode) - paste_stop: stop paste (bracketed paste mode) - -This command is used by key bindings or plugins. ----- - -[[command_weechat_key]] -* `+key+`: bind/unbind keys - ----- -/key list|listdefault|listdiff [<context>] - bind <key> [<command> [<args>]] - bindctxt <context> <key> [<command> [<args>]] - unbind <key> - unbindctxt <context> <key> - reset <key> - resetctxt <context> <key> - resetall -yes [<context>] - missing [<context>] - - list: list all current keys (without argument, this list is displayed) -listdefault: list default keys - listdiff: list differences between current and default keys (keys added, redefined or deleted) - context: name of context ("default" or "search") - bind: bind a command to a key or display command bound to key (for context "default") - bindctxt: bind a command to a key or display command bound to key, for given context - command: command (many commands can be separated by semicolons) - unbind: remove a key binding (for context "default") - unbindctxt: remove a key binding for given context - reset: reset a key to default binding (for context "default") - resetctxt: reset a key to default binding, for given context - resetall: restore bindings to the default values and delete ALL personal bindings (use carefully!) - missing: add missing keys (using default bindings), useful after installing new WeeChat version - -When binding a command to a key, it is recommended to use key alt+k (or Esc then k), and then press the key to bind: this will insert key code in command line. - -For context "mouse" (possible in context "cursor" too), key has format: "@area:key" or "@area1>area2:key" where area can be: - *: any area on screen - chat: chat area (any buffer) - chat(xxx): chat area for buffer with name "xxx" (full name including plugin) - bar(*): any bar - bar(xxx): bar "xxx" - item(*): any bar item - item(xxx): bar item "xxx" -Wildcard "*" is allowed in key to match many mouse events. -A special value for command with format "hsignal:name" can be used for context mouse, this will send the hsignal "name" with the focus hashtable as argument. -Another special value "-" can be used to disable key (it will be ignored when looking for keys). - -Examples: - key alt-t to toggle nicklist bar: - /key bind meta-t /bar toggle nicklist - key alt-r to jump to #weechat IRC channel: - /key bind meta-r /buffer #weechat - restore default binding for key alt-r: - /key reset meta-r - key "tab" to stop search in buffer: - /key bindctxt search ctrl-I /input search_stop - middle button of mouse on a nick to retrieve info on nick: - /key bindctxt mouse @item(buffer_nicklist):button3 /msg nickserv info ${nick} ----- - -[[command_weechat_layout]] -* `+layout+`: manage buffers/windows layouts - ----- -/layout store [<name>] [buffers|windows] - apply [<name>] [buffers|windows] - leave - del [<name>] [buffers|windows] - rename <name> <new_name> - - store: store current buffers/windows in a layout - apply: apply stored layout - leave: leave current layout (does not update any layout) - del: delete buffers and/or windows in a stored layout - (if neither "buffers" nor "windows" is given after the name, the layout is deleted) - rename: rename a layout - name: name for stored layout (default is "default") -buffers: store/apply only buffers (order of buffers) -windows: store/apply only windows (buffer displayed by each window) - -Without argument, this command displays stored layouts. - -The current layout can be saved on /quit command with the option "weechat.look.save_layout_on_exit". ----- - -[[command_weechat_mouse]] -* `+mouse+`: mouse control - ----- -/mouse enable|disable|toggle [<delay>] - - enable: enable mouse -disable: disable mouse - toggle: toggle mouse - delay: delay (in seconds) after which initial mouse state is restored (useful to temporarily disable mouse) - -The mouse state is saved in option "weechat.look.mouse". - -Examples: - enable mouse: - /mouse enable - toggle mouse for 5 seconds: - /mouse toggle 5 ----- - -[[command_weechat_mute]] -* `+mute+`: execute a command silently - ----- -/mute [-core | -current | -buffer <name>] <command> - - -core: no output on WeeChat core buffer --current: no output on current buffer - -buffer: no output on specified buffer - name: full buffer name (examples: "irc.server.freenode", "irc.freenode.#weechat") - command: command to execute silently (a '/' is automatically added if not found at beginning of command) - -If no target is specified (-core, -current or -buffer), then default is to mute all buffers. - -Examples: - config save: - /mute save - message to current IRC channel: - /mute -current msg * hi! - message to #weechat channel: - /mute -buffer irc.freenode.#weechat msg #weechat hi! ----- - -[[command_weechat_plugin]] -* `+plugin+`: list/load/unload plugins - ----- -/plugin list|listfull [<name>] - load <filename> [<arguments>] - autoload [<arguments>] - reload [<name>|* [<arguments>]] - unload [<name>] - - list: list loaded plugins - listfull: list loaded plugins (verbose) - load: load a plugin - autoload: autoload plugins in system or user directory - reload: reload a plugin (if no name given, unload all plugins, then autoload plugins) - unload: unload a plugin (if no name given, unload all plugins) - filename: plugin (file) to load - name: a plugin name -arguments: arguments given to plugin on load - -Without argument, this command lists loaded plugins. ----- - -[[command_weechat_print]] -* `+print+`: display text on a buffer - ----- -/print [-buffer <number>|<name>] [-newbuffer <name>] [-free] [-switch] [-core|-current] [-y <line>] [-escape] [-date <date>] [-tags <tags>] [-action|-error|-join|-network|-quit] [<text>] - -stdout|-stderr [<text>] - -beep - - -buffer: display text in this buffer (default: buffer where command is executed) --newbuffer: create a new buffer and display text in this buffer - -free: create a buffer with free content (with -newbuffer only) - -switch: switch to the buffer - -core: alias of "-buffer core.weechat" - -current: display text on current buffer - -y: display on a custom line (for buffer with free content only) - line: line number for buffer with free content (first line is 0, a negative number displays after last line: -1 = after last line, -2 = two lines after last line, etc.) - -escape: interpret escaped chars (for example \a, \07, \x07) - -date: message date, format can be: - -n: 'n' seconds before now - +n: 'n' seconds in the future - n: 'n' seconds since the Epoch (see man time) - date/time (ISO 8601): yyyy-mm-ddThh:mm:ss, example: 2014-01-19T04:32:55 - time: hh:mm:ss (example: 04:32:55) - -tags: comma-separated list of tags (see /help filter for a list of tags most commonly used) - text: text to display (prefix and message must be separated by "\t", if text starts with "-", then add a "\" before) - -stdout: display text on stdout (escaped chars are interpreted) - -stderr: display text on stderr (escaped chars are interpreted) - -beep: alias of "-stderr \a" - -The options -action ... -quit use the prefix defined in options "weechat.look.prefix_*". - -Following escaped chars are supported: - \" \\ \a \b \e \f \n \r \t \v \0ooo \xhh \uhhhh \Uhhhhhhhh - -Examples: - display a reminder on core buffer with a highlight: - /print -core -tags notify_highlight Reminder: buy milk - display an error on core buffer: - /print -core -error Some error here - display message on core buffer with prefix "abc": - /print -core abc\tThe message - display a message on channel #weechat: - /print -buffer irc.freenode.#weechat Message on #weechat - display a snowman (U+2603): - /print -escape \u2603 - send alert (BEL): - /print -beep ----- - -[[command_weechat_proxy]] -* `+proxy+`: manage proxies - ----- -/proxy list - add <name> <type> <address> <port> [<username> [<password>]] - del <name>|-all - set <name> <option> <value> - - list: list all proxies - add: add a new proxy - name: name of proxy (must be unique) - type: http, socks4 or socks5 - address: IP or hostname - port: port -username: username (optional) -password: password (optional) - del: delete a proxy (or all proxies with -all) - set: set a value for a proxy property - option: option to change (for options list, look at /set weechat.proxy.<proxyname>.*) - value: new value for option - -Examples: - add a http proxy, running on local host, port 8888: - /proxy add local http 127.0.0.1 8888 - add a http proxy using IPv6 protocol: - /proxy add local http ::1 8888 - /proxy set local ipv6 on - add a socks5 proxy with username/password: - /proxy add myproxy socks5 sample.host.org 3128 myuser mypass - delete a proxy: - /proxy del myproxy ----- - -[[command_weechat_quit]] -* `+quit+`: quit WeeChat - ----- -/quit [-yes] [<arguments>] - - -yes: required if option "weechat.look.confirm_quit" is enabled -arguments: text sent with signal "quit" - (for example irc plugin uses this text to send quit message to server) - -By default when quitting the configuration files are saved (see option "weechat.look.save_config_on_exit") and the current layout can be saved (see option "weechat.look.save_layout_on_exit"). ----- - -[[command_weechat_reload]] -* `+reload+`: reload configuration files from disk - ----- -/reload [<file> [<file>...]] - -file: configuration file to reload (without extension ".conf") - -Without argument, all files (WeeChat and plugins) are reloaded. ----- - -[[command_weechat_repeat]] -* `+repeat+`: execute a command several times - ----- -/repeat [-interval <delay>[<unit>]] <count> <command> - - delay: delay between execution of commands - unit: optional, values are: - ms: milliseconds - s: seconds (default) - m: minutes - h: hours - count: number of times to execute command -command: command to execute (or text to send to buffer if command does not start with '/') - -Note: the command is executed on buffer where /repeat was executed (if the buffer does not exist any more, the command is not executed). - -Example: - scroll 2 pages up: - /repeat 2 /window page_up ----- - -[[command_weechat_save]] -* `+save+`: save configuration files to disk - ----- -/save [<file> [<file>...]] - -file: configuration file to save (without extension ".conf") - -Without argument, all files (WeeChat and plugins) are saved. - -By default all configuration files are saved to disk on /quit command (see option "weechat.look.save_config_on_exit"). ----- - -[[command_weechat_secure]] -* `+secure+`: manage secured data (passwords or private data encrypted in file sec.conf) - ----- -/secure passphrase <passphrase>|-delete - decrypt <passphrase>|-discard - set <name> <value> - del <name> - -passphrase: change the passphrase (without passphrase, data is stored as plain text in file sec.conf) - -delete: delete passphrase - decrypt: decrypt data still encrypted (it happens only if passphrase was not given on startup) - -discard: discard all data still encrypted - set: add or change secured data - del: delete secured data - -Without argument, this command displays secured data in a new buffer. - -Keys on secure buffer: - alt+v toggle values - -When a passphrase is used (data encrypted), it is asked by WeeChat on startup. -It is possible to set environment variable "WEECHAT_PASSPHRASE" to prevent the prompt (this same variable is used by WeeChat on /upgrade), or to set option sec.crypt.passphrase_file to read the passphrase from a file (see /help sec.crypt.passphrase_file). - -Secured data with format ${sec.data.xxx} can be used in: - - command /eval - - command line argument "--run-command" - - options weechat.startup.command_{before|after}_plugins - - other options that may contain a password or sensitive data (for example proxy, irc server and relay); see /help on the options to check if they are evaluated. - -Examples: - set a passphrase: - /secure passphrase this is my passphrase - encrypt freenode SASL password: - /secure set freenode mypassword - /set irc.server.freenode.sasl_password "${sec.data.freenode}" - encrypt oftc password for nickserv: - /secure set oftc mypassword - /set irc.server.oftc.command "/msg nickserv identify ${sec.data.oftc}" - alias to ghost the nick "mynick": - /alias add ghost /eval /msg -server freenode nickserv ghost mynick ${sec.data.freenode} ----- - -[[command_weechat_set]] -* `+set+`: set config options and environment variables - ----- -/set [<option> [<value>]] - diff [<option> [<option>...]] - env [<variable> [<value>]] - -option: name of an option (wildcard "*" is allowed to list options, if no value is specified) - value: new value for option, according to type: - boolean: on, off or toggle - integer: number, ++number or --number - string: any string ("" for empty string) - color: color name, ++number or --number - Note: for all types, you can use null to remove option value (undefined value). This works only for some special plugin variables. - diff: display only changed options - env: display or set an environment variable (use value "" to unset a variable) - -Examples: - display options about highlight: - /set *highlight* - add a word to highlight: - /set weechat.look.highlight "word" - display changed options: - /set diff - display changed options in irc plugin: - /set diff irc.* - display value of environment variable LANG: - /set env LANG - set environment variable LANG and use it: - /set env LANG fr_FR.UTF-8 - /upgrade - unset environment variable ABC: - /set env ABC "" ----- - -[[command_weechat_unset]] -* `+unset+`: unset/reset config options - ----- -/unset <option> - -mask <option> - -option: name of an option - -mask: use a mask in option (wildcard "*" is allowed to mass-reset options, use carefully!) - -According to option, it's reset (for standard options) or removed (for optional settings, like server values). - -Examples: - reset one option: - /unset weechat.look.item_time_format - reset all color options: - /unset -mask weechat.color.* ----- - -[[command_weechat_upgrade]] -* `+upgrade+`: reload the WeeChat binary without disconnecting from servers - ----- -/upgrade [-yes] [<path_to_binary>|-quit] - - -yes: required if option "weechat.look.confirm_upgrade" is enabled -path_to_binary: path to WeeChat binary (default is current binary) - -dummy: do nothing (option used to prevent accidental completion with "-quit") - -quit: close *ALL* connections, save session and quit WeeChat, which makes possible a delayed restoration (see below) - -This command upgrades and reloads a running WeeChat session. The new WeeChat binary must have been compiled or installed with a package manager before running this command. - -Note: SSL connections are lost during upgrade, because reload of SSL sessions is currently not possible with GnuTLS. There is automatic reconnection after upgrade. - -Upgrade process has 4 steps: - 1. save session into files for core and plugins (buffers, history, ..) - 2. unload all plugins (configuration files (*.conf) are written on disk) - 3. save WeeChat configuration (weechat.conf) - 4. execute new WeeChat binary and reload session. - -With option "-quit", the process is slightly different: - 1. close *ALL* connections (irc, xfer, relay, ...) - 2. save session into files (*.upgrade) - 3. unload all plugins - 4. save WeeChat configuration - 5. quit WeeChat -Then later you can restore session with command: weechat --upgrade -IMPORTANT: you must restore the session with exactly same configuration (files *.conf). -It is possible to restore WeeChat session on another machine if you copy the content of directory "~/.weechat". ----- - -[[command_weechat_uptime]] -* `+uptime+`: show WeeChat uptime - ----- -/uptime [-o|-ol] - - -o: send uptime to current buffer as input (English string) --ol: send uptime to current buffer as input (translated string) ----- - -[[command_weechat_version]] -* `+version+`: show WeeChat version and compilation date - ----- -/version [-o|-ol] - - -o: send version to current buffer as input (English string) --ol: send version to current buffer as input (translated string) - -The default alias /v can be used to execute this command on all buffers (otherwise the irc command /version is used on irc buffers). ----- - -[[command_weechat_wait]] -* `+wait+`: schedule a command execution in future - ----- -/wait <number>[<unit>] <command> - - number: amount of time to wait (integer number) - unit: optional, values are: - ms: milliseconds - s: seconds (default) - m: minutes - h: hours -command: command to execute (or text to send to buffer if command does not start with '/') - -Note: the command is executed on buffer where /wait was executed (if the buffer does not exist any more, the command is not executed). - -Examples: - join channel in 10 seconds: - /wait 10 /join #test - set away in 15 minutes: - /wait 15m /away -all I'm away - say 'hello' in 2 minutes: - /wait 2m hello ----- - -[[command_weechat_window]] -* `+window+`: manage windows - ----- -/window list - -1|+1|b#|up|down|left|right [-window <number>] - <number> - splith|splitv [-window <number>] [<pct>] - resize [-window <number>] [h|v][+|-]<pct> - balance - merge [-window <number>] [all] - close [-window <number>] - page_up|page_down [-window <number>] - refresh - scroll [-window <number>] [+|-]<value>[s|m|h|d|M|y] - scroll_horiz [-window <number>] [+|-]<value>[%] - scroll_up|scroll_down|scroll_top|scroll_bottom|scroll_beyond_end|scroll_previous_highlight|scroll_next_highlight|scroll_unread [-window <number>] - swap [-window <number>] [up|down|left|right] - zoom [-window <number>] - bare [<delay>] - - list: list opened windows (without argument, this list is displayed) - -1: jump to previous window - +1: jump to next window - b#: jump to next window displaying buffer number # - up: switch to window above current one - down: switch to window below current one - left: switch to window on the left - right: switch to window on the right - number: window number (see /window list) - splith: split current window horizontally (to undo: /window merge) - splitv: split current window vertically (to undo: /window merge) - resize: resize window size, new size is <pct> percentage of parent window - if "h" or "v" is specified, the resize affects the nearest parent window with a split of this type (horizontal/vertical) - balance: balance the sizes of all windows - merge: merge window with another (all = keep only one window) - close: close window - page_up: scroll one page up - page_down: scroll one page down - refresh: refresh screen - scroll: scroll a number of lines (+/-N) or with time: s=seconds, m=minutes, h=hours, d=days, M=months, y=years - scroll_horiz: scroll horizontally a number of columns (+/-N) or percentage of window size (this scrolling is possible only on buffers with free content) - scroll_up: scroll a few lines up - scroll_down: scroll a few lines down - scroll_top: scroll to top of buffer -scroll_bottom: scroll to bottom of buffer -scroll_beyond_end: scroll beyond the end of buffer -scroll_previous_highlight: scroll to previous highlight -scroll_next_highlight: scroll to next highlight -scroll_unread: scroll to unread marker - swap: swap buffers of two windows (with optional direction for target window) - zoom: zoom on window - bare: toggle bare display (with optional delay in seconds for automatic return to standard display mode) - -For splith and splitv, pct is a percentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4 - -Examples: - jump to window displaying buffer #1: - /window b1 - scroll 2 lines up: - /window scroll -2 - scroll 2 days up: - /window scroll -2d - scroll to beginning of current day: - /window scroll -d - zoom on window #2: - /window zoom -window 2 - split window horizontally using 30% of space for the window on top: - /window splith 30 - resize window to 75% of the parent window size: - /window resize 75 - resize vertical split, add 10% in size: - /window resize v+10 - remove the split, keep the current window: - /window merge - close the current window: - /window close - enable bare display for 2 seconds: - /window bare 2 ----- diff --git a/doc/en/autogen/user/weechat_options.adoc b/doc/en/autogen/user/weechat_options.adoc deleted file mode 100644 index 84a1dd545..000000000 --- a/doc/en/autogen/user/weechat_options.adoc +++ /dev/null @@ -1,1299 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_weechat.color.bar_more]] *weechat.color.bar_more* -** description: pass:none[text color for "+" when scrolling bars] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_weechat.color.chat]] *weechat.color.chat* -** description: pass:none[text color for chat] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_bg]] *weechat.color.chat_bg* -** description: pass:none[background color for chat] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_buffer]] *weechat.color.chat_buffer* -** description: pass:none[text color for buffer names] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_weechat.color.chat_channel]] *weechat.color.chat_channel* -** description: pass:none[text color for channel names] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_weechat.color.chat_day_change]] *weechat.color.chat_day_change* -** description: pass:none[text color for message displayed when the day has changed] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_weechat.color.chat_delimiters]] *weechat.color.chat_delimiters* -** description: pass:none[text color for delimiters] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.chat_highlight]] *weechat.color.chat_highlight* -** description: pass:none[text color for highlighted prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.chat_highlight_bg]] *weechat.color.chat_highlight_bg* -** description: pass:none[background color for highlighted prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_weechat.color.chat_host]] *weechat.color.chat_host* -** description: pass:none[text color for hostnames] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_weechat.color.chat_inactive_buffer]] *weechat.color.chat_inactive_buffer* -** description: pass:none[text color for chat when line is inactive (buffer is merged with other buffers and is not selected)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_inactive_window]] *weechat.color.chat_inactive_window* -** description: pass:none[text color for chat when window is inactive (not current selected window)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_nick]] *weechat.color.chat_nick* -** description: pass:none[text color for nicks in chat window: used in some server messages and as fallback when a nick color is not found; most of times nick color comes from option weechat.color.chat_nick_colors] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_weechat.color.chat_nick_colors]] *weechat.color.chat_nick_colors* -** description: pass:none[text color for nicks (comma separated list of colors, background is allowed with format: "fg:bg", for example: "lightred:blue")] -** type: string -** values: any string -** default value: `+"cyan,magenta,green,brown,lightblue,default,lightcyan,lightmagenta,lightgreen,blue"+` - -* [[option_weechat.color.chat_nick_offline]] *weechat.color.chat_nick_offline* -** description: pass:none[text color for offline nick (not in nicklist any more); this color is used only if option weechat.look.color_nick_offline is enabled] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_nick_offline_highlight]] *weechat.color.chat_nick_offline_highlight* -** description: pass:none[text color for offline nick with highlight; this color is used only if option weechat.look.color_nick_offline is enabled] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_nick_offline_highlight_bg]] *weechat.color.chat_nick_offline_highlight_bg* -** description: pass:none[background color for offline nick with highlight; this color is used only if option weechat.look.color_nick_offline is enabled] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+blue+` - -* [[option_weechat.color.chat_nick_other]] *weechat.color.chat_nick_other* -** description: pass:none[text color for other nick in private buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_weechat.color.chat_nick_prefix]] *weechat.color.chat_nick_prefix* -** description: pass:none[color for nick prefix (string displayed before nick in prefix)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.chat_nick_self]] *weechat.color.chat_nick_self* -** description: pass:none[text color for local nick in chat window] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_weechat.color.chat_nick_suffix]] *weechat.color.chat_nick_suffix* -** description: pass:none[color for nick suffix (string displayed after nick in prefix)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.chat_prefix_action]] *weechat.color.chat_prefix_action* -** description: pass:none[text color for action prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_weechat.color.chat_prefix_buffer]] *weechat.color.chat_prefix_buffer* -** description: pass:none[text color for buffer name (before prefix, when many buffers are merged with same number)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_weechat.color.chat_prefix_buffer_inactive_buffer]] *weechat.color.chat_prefix_buffer_inactive_buffer* -** description: pass:none[text color for inactive buffer name (before prefix, when many buffers are merged with same number and if buffer is not selected)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_prefix_error]] *weechat.color.chat_prefix_error* -** description: pass:none[text color for error prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.chat_prefix_join]] *weechat.color.chat_prefix_join* -** description: pass:none[text color for join prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_weechat.color.chat_prefix_more]] *weechat.color.chat_prefix_more* -** description: pass:none[text color for "+" when prefix is too long] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_weechat.color.chat_prefix_network]] *weechat.color.chat_prefix_network* -** description: pass:none[text color for network prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_weechat.color.chat_prefix_quit]] *weechat.color.chat_prefix_quit* -** description: pass:none[text color for quit prefix] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_weechat.color.chat_prefix_suffix]] *weechat.color.chat_prefix_suffix* -** description: pass:none[text color for suffix (after prefix)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.chat_read_marker]] *weechat.color.chat_read_marker* -** description: pass:none[text color for unread data marker] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_weechat.color.chat_read_marker_bg]] *weechat.color.chat_read_marker_bg* -** description: pass:none[background color for unread data marker] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_server]] *weechat.color.chat_server* -** description: pass:none[text color for server names] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_weechat.color.chat_tags]] *weechat.color.chat_tags* -** description: pass:none[text color for tags after messages (displayed with command /debug tags)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_weechat.color.chat_text_found]] *weechat.color.chat_text_found* -** description: pass:none[text color for marker on lines where text sought is found] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.chat_text_found_bg]] *weechat.color.chat_text_found_bg* -** description: pass:none[background color for marker on lines where text sought is found] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_weechat.color.chat_time]] *weechat.color.chat_time* -** description: pass:none[text color for time in chat window] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.chat_time_delimiters]] *weechat.color.chat_time_delimiters* -** description: pass:none[text color for time delimiters] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_weechat.color.chat_value]] *weechat.color.chat_value* -** description: pass:none[text color for values] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_weechat.color.chat_value_null]] *weechat.color.chat_value_null* -** description: pass:none[text color for null values (undefined)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+blue+` - -* [[option_weechat.color.emphasized]] *weechat.color.emphasized* -** description: pass:none[text color for emphasized text (for example when searching text); this option is used only if option weechat.look.emphasized_attributes is an empty string (default value)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.emphasized_bg]] *weechat.color.emphasized_bg* -** description: pass:none[background color for emphasized text (for example when searching text); used only if option weechat.look.emphasized_attributes is an empty string (default value)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_weechat.color.input_actions]] *weechat.color.input_actions* -** description: pass:none[text color for actions in input line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_weechat.color.input_text_not_found]] *weechat.color.input_text_not_found* -** description: pass:none[text color for unsuccessful text search in input line] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+red+` - -* [[option_weechat.color.item_away]] *weechat.color.item_away* -** description: pass:none[text color for away item] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.nicklist_away]] *weechat.color.nicklist_away* -** description: pass:none[text color for away nicknames] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+cyan+` - -* [[option_weechat.color.nicklist_group]] *weechat.color.nicklist_group* -** description: pass:none[text color for groups in nicklist] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.separator]] *weechat.color.separator* -** description: pass:none[color for window separators (when split) and separators beside bars (like nicklist)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+blue+` - -* [[option_weechat.color.status_count_highlight]] *weechat.color.status_count_highlight* -** description: pass:none[text color for count of highlight messages in hotlist (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+magenta+` - -* [[option_weechat.color.status_count_msg]] *weechat.color.status_count_msg* -** description: pass:none[text color for count of messages in hotlist (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+brown+` - -* [[option_weechat.color.status_count_other]] *weechat.color.status_count_other* -** description: pass:none[text color for count of other messages in hotlist (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.status_count_private]] *weechat.color.status_count_private* -** description: pass:none[text color for count of private messages in hotlist (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.status_data_highlight]] *weechat.color.status_data_highlight* -** description: pass:none[text color for buffer with highlight (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightmagenta+` - -* [[option_weechat.color.status_data_msg]] *weechat.color.status_data_msg* -** description: pass:none[text color for buffer with new messages (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.status_data_other]] *weechat.color.status_data_other* -** description: pass:none[text color for buffer with new data (not messages) (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.status_data_private]] *weechat.color.status_data_private* -** description: pass:none[text color for buffer with private message (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_weechat.color.status_filter]] *weechat.color.status_filter* -** description: pass:none[text color for filter indicator in status bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.status_more]] *weechat.color.status_more* -** description: pass:none[text color for buffer with new data (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.status_mouse]] *weechat.color.status_mouse* -** description: pass:none[text color for mouse indicator in status bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+green+` - -* [[option_weechat.color.status_name]] *weechat.color.status_name* -** description: pass:none[text color for current buffer name in status bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_weechat.color.status_name_ssl]] *weechat.color.status_name_ssl* -** description: pass:none[text color for current buffer name in status bar, if data are secured with a protocol like SSL] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_weechat.color.status_nicklist_count]] *weechat.color.status_nicklist_count* -** description: pass:none[text color for number of nicks in nicklist (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.color.status_number]] *weechat.color.status_number* -** description: pass:none[text color for current buffer number in status bar] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_weechat.color.status_time]] *weechat.color.status_time* -** description: pass:none[text color for time (status bar)] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_weechat.completion.base_word_until_cursor]] *weechat.completion.base_word_until_cursor* -** description: pass:none[if enabled, the base word to complete ends at char before cursor; otherwise the base word ends at first space after cursor] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.completion.command_inline]] *weechat.completion.command_inline* -** description: pass:none[if enabled, the commands inside command line are completed (the command at beginning of line has higher priority and is used first); note: when this option is enabled, there is no more automatic completion of paths beginning with "/" (outside commands arguments)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.completion.default_template]] *weechat.completion.default_template* -** description: pass:none[default completion template (please see documentation for template codes and values: plugin API reference, function "weechat_hook_command")] -** type: string -** values: any string -** default value: `+"%(nicks)|%(irc_channels)"+` - -* [[option_weechat.completion.nick_add_space]] *weechat.completion.nick_add_space* -** description: pass:none[add space after nick completion (when nick is not first word on command line)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.completion.nick_case_sensitive]] *weechat.completion.nick_case_sensitive* -** description: pass:none[case sensitive completion for nicks] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.completion.nick_completer]] *weechat.completion.nick_completer* -** description: pass:none[string inserted after nick completion (when nick is first word on command line)] -** type: string -** values: any string -** default value: `+": "+` - -* [[option_weechat.completion.nick_first_only]] *weechat.completion.nick_first_only* -** description: pass:none[complete only with first nick found] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.completion.nick_ignore_chars]] *weechat.completion.nick_ignore_chars* -** description: pass:none[chars ignored for nick completion] -** type: string -** values: any string -** default value: `+"[]`_-^"+` - -* [[option_weechat.completion.partial_completion_alert]] *weechat.completion.partial_completion_alert* -** description: pass:none[send alert (BEL) when a partial completion occurs] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.completion.partial_completion_command]] *weechat.completion.partial_completion_command* -** description: pass:none[partially complete command names (stop when many commands found begin with same letters)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.completion.partial_completion_command_arg]] *weechat.completion.partial_completion_command_arg* -** description: pass:none[partially complete command arguments (stop when many arguments found begin with same prefix)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.completion.partial_completion_count]] *weechat.completion.partial_completion_count* -** description: pass:none[display count for each partial completion in bar item] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.completion.partial_completion_other]] *weechat.completion.partial_completion_other* -** description: pass:none[partially complete outside commands (stop when many words found begin with same letters)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.completion.partial_completion_templates]] *weechat.completion.partial_completion_templates* -** description: pass:none[comma-separated list of templates for which partial completion is enabled by default (with Tab key instead of shift-Tab); the list of templates is in documentation: plugin API reference, function "weechat_hook_command"] -** type: string -** values: any string -** default value: `+"config_options"+` - -* [[option_weechat.history.display_default]] *weechat.history.display_default* -** description: pass:none[maximum number of commands to display by default in history listing (0 = unlimited)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+5+` - -* [[option_weechat.history.max_buffer_lines_minutes]] *weechat.history.max_buffer_lines_minutes* -** description: pass:none[maximum number of minutes in history per buffer (0 = unlimited); examples: 1440 = one day, 10080 = one week, 43200 = one month, 525600 = one year; use 0 ONLY if option weechat.history.max_buffer_lines_number is NOT set to 0] -** type: integer -** values: 0 .. 2147483647 -** default value: `+0+` - -* [[option_weechat.history.max_buffer_lines_number]] *weechat.history.max_buffer_lines_number* -** description: pass:none[maximum number of lines in history per buffer (0 = unlimited); use 0 ONLY if option weechat.history.max_buffer_lines_minutes is NOT set to 0] -** type: integer -** values: 0 .. 2147483647 -** default value: `+4096+` - -* [[option_weechat.history.max_commands]] *weechat.history.max_commands* -** description: pass:none[maximum number of user commands in history (0 = unlimited, NOT RECOMMENDED: no limit in memory usage)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+100+` - -* [[option_weechat.history.max_visited_buffers]] *weechat.history.max_visited_buffers* -** description: pass:none[maximum number of visited buffers to keep in memory] -** type: integer -** values: 0 .. 1000 -** default value: `+50+` - -* [[option_weechat.look.align_end_of_lines]] *weechat.look.align_end_of_lines* -** description: pass:none[alignment for end of lines (all lines after the first): they are starting under this data (time, buffer, prefix, suffix, message (default))] -** type: integer -** values: time, buffer, prefix, suffix, message -** default value: `+message+` - -* [[option_weechat.look.align_multiline_words]] *weechat.look.align_multiline_words* -** description: pass:none[alignment for multiline words according to option weechat.look.align_end_of_lines; if disabled, the multiline words will not be aligned, which can be useful to not break long URLs] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.bar_more_down]] *weechat.look.bar_more_down* -** description: pass:none[string displayed when bar can be scrolled down (for bars with filling different from "horizontal")] -** type: string -** values: any string -** default value: `+"++"+` - -* [[option_weechat.look.bar_more_left]] *weechat.look.bar_more_left* -** description: pass:none[string displayed when bar can be scrolled to the left (for bars with filling "horizontal")] -** type: string -** values: any string -** default value: `+"<<"+` - -* [[option_weechat.look.bar_more_right]] *weechat.look.bar_more_right* -** description: pass:none[string displayed when bar can be scrolled to the right (for bars with filling "horizontal")] -** type: string -** values: any string -** default value: `+">>"+` - -* [[option_weechat.look.bar_more_up]] *weechat.look.bar_more_up* -** description: pass:none[string displayed when bar can be scrolled up (for bars with filling different from "horizontal")] -** type: string -** values: any string -** default value: `+"--"+` - -* [[option_weechat.look.bare_display_exit_on_input]] *weechat.look.bare_display_exit_on_input* -** description: pass:none[exit the bare display mode on any changes in input] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.bare_display_time_format]] *weechat.look.bare_display_time_format* -** description: pass:none[time format in bare display mode (see man strftime for date/time specifiers)] -** type: string -** values: any string -** default value: `+"%H:%M"+` - -* [[option_weechat.look.buffer_auto_renumber]] *weechat.look.buffer_auto_renumber* -** description: pass:none[automatically renumber buffers to have only consecutive numbers and start with number 1; if disabled, gaps between buffer numbers are allowed and the first buffer can have a number greater than 1] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.buffer_notify_default]] *weechat.look.buffer_notify_default* -** description: pass:none[default notify level for buffers (used to tell WeeChat if buffer must be displayed in hotlist or not, according to importance of message): all=all messages (default), message=messages+highlights, highlight=highlights only, none=never display in hotlist] -** type: integer -** values: none, highlight, message, all -** default value: `+all+` - -* [[option_weechat.look.buffer_position]] *weechat.look.buffer_position* -** description: pass:none[position of a new buffer: end = after the end of list (number = last number + 1) (default), first_gap = at first available number in the list (after the end of list if no number is available); this option is used only if the buffer has no layout number] -** type: integer -** values: end, first_gap -** default value: `+end+` - -* [[option_weechat.look.buffer_search_case_sensitive]] *weechat.look.buffer_search_case_sensitive* -** description: pass:none[default text search in buffer: case sensitive or not] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.buffer_search_force_default]] *weechat.look.buffer_search_force_default* -** description: pass:none[force default values for text search in buffer (instead of using values from last search in buffer)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.buffer_search_regex]] *weechat.look.buffer_search_regex* -** description: pass:none[default text search in buffer: if enabled, search POSIX extended regular expression, otherwise search simple string] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.buffer_search_where]] *weechat.look.buffer_search_where* -** description: pass:none[default text search in buffer: in message, prefix, prefix and message] -** type: integer -** values: prefix, message, prefix_message -** default value: `+prefix_message+` - -* [[option_weechat.look.buffer_time_format]] *weechat.look.buffer_time_format* -** description: pass:none[time format for each line displayed in buffers (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval); for example time using grayscale (requires support of 256 colors): "${color:252}%H${color:245}%M${color:240}%S"] -** type: string -** values: any string -** default value: `+"%H:%M:%S"+` - -* [[option_weechat.look.buffer_time_same]] *weechat.look.buffer_time_same* -** description: pass:none[time displayed for a message with same time as previous message: use a space " " to hide time, another string to display this string instead of time, or an empty string to disable feature (display time) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.color_basic_force_bold]] *weechat.look.color_basic_force_bold* -** description: pass:none[force "bold" attribute for light colors and "darkgray" in basic colors (this option is disabled by default: bold is used only if terminal has less than 16 colors)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.color_inactive_buffer]] *weechat.look.color_inactive_buffer* -** description: pass:none[use a different color for lines in inactive buffer (when line is from a merged buffer not selected)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.color_inactive_message]] *weechat.look.color_inactive_message* -** description: pass:none[use a different color for inactive message (when window is not current window, or if line is from a merged buffer not selected)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.color_inactive_prefix]] *weechat.look.color_inactive_prefix* -** description: pass:none[use a different color for inactive prefix (when window is not current window, or if line is from a merged buffer not selected)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.color_inactive_prefix_buffer]] *weechat.look.color_inactive_prefix_buffer* -** description: pass:none[use a different color for inactive buffer name in prefix (when window is not current window, or if line is from a merged buffer not selected)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.color_inactive_time]] *weechat.look.color_inactive_time* -** description: pass:none[use a different color for inactive time (when window is not current window, or if line is from a merged buffer not selected)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.color_inactive_window]] *weechat.look.color_inactive_window* -** description: pass:none[use a different color for lines in inactive window (when window is not current window)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.color_nick_offline]] *weechat.look.color_nick_offline* -** description: pass:none[use a different color for offline nicks (not in nicklist any more)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.color_pairs_auto_reset]] *weechat.look.color_pairs_auto_reset* -** description: pass:none[automatically reset table of color pairs when number of available pairs is lower or equal to this number (-1 = disable automatic reset, and then a manual "/color reset" is needed when table is full)] -** type: integer -** values: -1 .. 256 -** default value: `+5+` - -* [[option_weechat.look.color_real_white]] *weechat.look.color_real_white* -** description: pass:none[if set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.command_chars]] *weechat.look.command_chars* -** description: pass:none[chars used to determine if input string is a command or not: input must start with one of these chars; the slash ("/") is always considered as command prefix (example: ".$")] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.command_incomplete]] *weechat.look.command_incomplete* -** description: pass:none[if set, incomplete and unambiguous commands are allowed, for example /he for /help] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.confirm_quit]] *weechat.look.confirm_quit* -** description: pass:none[if set, /quit command must be confirmed with extra argument "-yes" (see /help quit)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.confirm_upgrade]] *weechat.look.confirm_upgrade* -** description: pass:none[if set, /upgrade command must be confirmed with extra argument "-yes" (see /help upgrade)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.day_change]] *weechat.look.day_change* -** description: pass:none[display special message when day changes] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.day_change_message_1date]] *weechat.look.day_change_message_1date* -** description: pass:none[message displayed when the day has changed, with one date displayed (for example at beginning of buffer) (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"-- %a, %d %b %Y --"+` - -* [[option_weechat.look.day_change_message_2dates]] *weechat.look.day_change_message_2dates* -** description: pass:none[message displayed when the day has changed, with two dates displayed (between two messages); the second date specifiers must start with two "%" because strftime is called two times on this string (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"-- %%a, %%d %%b %%Y (%a, %d %b %Y) --"+` - -* [[option_weechat.look.eat_newline_glitch]] *weechat.look.eat_newline_glitch* -** description: pass:none[if set, the eat_newline_glitch will be set to 0; this is used to not add new line char at end of each line, and then not break text when you copy/paste text from WeeChat to another application (this option is disabled by default because it can cause serious display bugs)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.emphasized_attributes]] *weechat.look.emphasized_attributes* -** description: pass:none[attributes for emphasized text: one or more attribute chars ("*" for bold, "!" for reverse, "/" for italic, "_" for underline); if the string is empty, the colors weechat.color.emphasized* are used] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.highlight]] *weechat.look.highlight* -** description: pass:none[comma separated list of words to highlight; case insensitive comparison (use "(?-i)" at beginning of words to make them case sensitive), words may begin or end with "*" for partial match; example: "test,(?-i)*toto*,flash*"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.highlight_regex]] *weechat.look.highlight_regex* -** description: pass:none[POSIX extended regular expression used to check if a message has highlight or not, at least one match in string must be surrounded by delimiters (chars different from: alphanumeric, "-", "_" and "|"), regular expression is case insensitive (use "(?-i)" at beginning to make it case sensitive), examples: "flashcode|flashy", "(?-i)FlashCode|flashy"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.highlight_tags]] *weechat.look.highlight_tags* -** description: pass:none[comma separated list of tags to highlight; case insensitive comparison; wildcard "*" is allowed in each tag; many tags can be separated by "+" to make a logical "and" between tags; examples: "nick_flashcode" for messages from nick "FlashCode", "irc_notice+nick_toto*" for notices from a nick starting with "toto"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.hotlist_add_conditions]] *weechat.look.hotlist_add_conditions* -** description: pass:none[conditions to add a buffer in hotlist (if notify level is OK for the buffer); you can use in these conditions: "window" (current window pointer), "buffer" (buffer pointer to add in hotlist), "priority" (0 = low, 1 = message, 2 = private, 3 = highlight); by default a buffer is added to hotlist if you are away, or if the buffer is not visible on screen (not displayed in any window), or if at least one relay client is connected via the weechat protocol] -** type: string -** values: any string -** default value: `+"${away} || ${buffer.num_displayed} == 0 || ${info:relay_client_count,weechat,connected} > 0"+` - -* [[option_weechat.look.hotlist_buffer_separator]] *weechat.look.hotlist_buffer_separator* -** description: pass:none[string displayed between buffers in hotlist] -** type: string -** values: any string -** default value: `+", "+` - -* [[option_weechat.look.hotlist_count_max]] *weechat.look.hotlist_count_max* -** description: pass:none[max number of messages count to display in hotlist for a buffer: 0 = never display messages count, other number = display max N messages count (from the highest to lowest priority)] -** type: integer -** values: 0 .. 4 -** default value: `+2+` - -* [[option_weechat.look.hotlist_count_min_msg]] *weechat.look.hotlist_count_min_msg* -** description: pass:none[display messages count if number of messages is greater or equal to this value] -** type: integer -** values: 1 .. 100 -** default value: `+2+` - -* [[option_weechat.look.hotlist_names_count]] *weechat.look.hotlist_names_count* -** description: pass:none[max number of names in hotlist (0 = no name displayed, only buffer numbers)] -** type: integer -** values: 0 .. 10000 -** default value: `+3+` - -* [[option_weechat.look.hotlist_names_length]] *weechat.look.hotlist_names_length* -** description: pass:none[max length of names in hotlist (0 = no limit)] -** type: integer -** values: 0 .. 32 -** default value: `+0+` - -* [[option_weechat.look.hotlist_names_level]] *weechat.look.hotlist_names_level* -** description: pass:none[level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)] -** type: integer -** values: 1 .. 15 -** default value: `+12+` - -* [[option_weechat.look.hotlist_names_merged_buffers]] *weechat.look.hotlist_names_merged_buffers* -** description: pass:none[if set, force display of names in hotlist for merged buffers] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.hotlist_prefix]] *weechat.look.hotlist_prefix* -** description: pass:none[text displayed at the beginning of the hotlist] -** type: string -** values: any string -** default value: `+"H: "+` - -* [[option_weechat.look.hotlist_remove]] *weechat.look.hotlist_remove* -** description: pass:none[remove buffers in hotlist: buffer = remove buffer by buffer, merged = remove all visible merged buffers at once] -** type: integer -** values: buffer, merged -** default value: `+merged+` - -* [[option_weechat.look.hotlist_short_names]] *weechat.look.hotlist_short_names* -** description: pass:none[if set, uses short names to display buffer names in hotlist (start after first "." in name)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.hotlist_sort]] *weechat.look.hotlist_sort* -** description: pass:none[sort of hotlist: group_time_*: group by notify level (highlights first) then sort by time, group_number_*: group by notify level (highlights first) then sort by number, number_*: sort by number; asc = ascending sort, desc = descending sort] -** type: integer -** values: group_time_asc, group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc -** default value: `+group_time_asc+` - -* [[option_weechat.look.hotlist_suffix]] *weechat.look.hotlist_suffix* -** description: pass:none[text displayed at the end of the hotlist] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.hotlist_unique_numbers]] *weechat.look.hotlist_unique_numbers* -** description: pass:none[keep only unique numbers in hotlist (this applies only on hotlist items where name is NOT displayed after number)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.input_cursor_scroll]] *weechat.look.input_cursor_scroll* -** description: pass:none[number of chars displayed after end of input line when scrolling to display end of line] -** type: integer -** values: 0 .. 100 -** default value: `+20+` - -* [[option_weechat.look.input_share]] *weechat.look.input_share* -** description: pass:none[share commands, text, or both in input for all buffers (there is still local history for each buffer)] -** type: integer -** values: none, commands, text, all -** default value: `+none+` - -* [[option_weechat.look.input_share_overwrite]] *weechat.look.input_share_overwrite* -** description: pass:none[if set and input is shared, always overwrite input in target buffer] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.input_undo_max]] *weechat.look.input_undo_max* -** description: pass:none[max number of "undo" for command line, by buffer (0 = undo disabled)] -** type: integer -** values: 0 .. 65535 -** default value: `+32+` - -* [[option_weechat.look.item_away_message]] *weechat.look.item_away_message* -** description: pass:none[display server away message in away bar item] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.item_buffer_filter]] *weechat.look.item_buffer_filter* -** description: pass:none[string used to show that some lines are filtered in current buffer (bar item "buffer_filter")] -** type: string -** values: any string -** default value: `+"*"+` - -* [[option_weechat.look.item_buffer_zoom]] *weechat.look.item_buffer_zoom* -** description: pass:none[string used to show zoom on merged buffer (bar item "buffer_zoom")] -** type: string -** values: any string -** default value: `+"!"+` - -* [[option_weechat.look.item_mouse_status]] *weechat.look.item_mouse_status* -** description: pass:none[string used to show if mouse is enabled (bar item "mouse_status")] -** type: string -** values: any string -** default value: `+"M"+` - -* [[option_weechat.look.item_time_format]] *weechat.look.item_time_format* -** description: pass:none[time format for "time" bar item (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"%H:%M"+` - -* [[option_weechat.look.jump_current_to_previous_buffer]] *weechat.look.jump_current_to_previous_buffer* -** description: pass:none[jump to previous buffer displayed when jumping to current buffer number with /buffer *N (where N is a buffer number), to easily switch to another buffer, then come back to current buffer] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.jump_previous_buffer_when_closing]] *weechat.look.jump_previous_buffer_when_closing* -** description: pass:none[jump to previously visited buffer when closing a buffer (if disabled, then jump to buffer number - 1)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.jump_smart_back_to_buffer]] *weechat.look.jump_smart_back_to_buffer* -** description: pass:none[jump back to initial buffer after reaching end of hotlist] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.key_bind_safe]] *weechat.look.key_bind_safe* -** description: pass:none[allow only binding of "safe" keys (beginning with a ctrl or meta code)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.key_grab_delay]] *weechat.look.key_grab_delay* -** description: pass:none[default delay (in milliseconds) to grab a key (using default key alt-k); this delay can be overridden in the /input command (see /help input)] -** type: integer -** values: 1 .. 10000 -** default value: `+800+` - -* [[option_weechat.look.mouse]] *weechat.look.mouse* -** description: pass:none[enable mouse support] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.mouse_timer_delay]] *weechat.look.mouse_timer_delay* -** description: pass:none[delay (in milliseconds) to grab a mouse event: WeeChat will wait this delay before processing event] -** type: integer -** values: 1 .. 10000 -** default value: `+100+` - -* [[option_weechat.look.nick_color_force]] *weechat.look.nick_color_force* -** description: pass:none[force color for some nicks: hash computed with nickname to find color will not be used for these nicks (format is: "nick1:color1;nick2:color2"); look up for nicks is with exact case then lower case, so it's possible to use only lower case for nicks in this option; color can include background with the format "text,background", for example "yellow,red"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.nick_color_hash]] *weechat.look.nick_color_hash* -** description: pass:none[hash algorithm used to find the color for a nick: djb2 = variant of djb2 (position of letters matters: anagrams of a nick have different color), djb2_32 = variant of djb2 using 32-bit instead of 64-bit integer, sum = sum of letters, sum_32 = sum of letters using 32-bit instead of 64-bit integer] -** type: integer -** values: djb2, sum, djb2_32, sum_32 -** default value: `+djb2+` - -* [[option_weechat.look.nick_color_hash_salt]] *weechat.look.nick_color_hash_salt* -** description: pass:none[salt for the hash algorithm used to find nick colors (the nickname is appended to this salt and the hash algorithm operates on this string); modifying this shuffles nick colors] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.nick_color_stop_chars]] *weechat.look.nick_color_stop_chars* -** description: pass:none[chars used to stop in nick when computing color with letters of nick (at least one char outside this list must be in string before stopping) (example: nick "|nick|away" with "|" in chars will return color of nick "|nick"); this option has an impact on option weechat.look.nick_color_force, so the nick for the forced color must not contain the chars ignored by this option] -** type: string -** values: any string -** default value: `+"_|["+` - -* [[option_weechat.look.nick_prefix]] *weechat.look.nick_prefix* -** description: pass:none[text to display before nick in prefix of message, example: "<"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.nick_suffix]] *weechat.look.nick_suffix* -** description: pass:none[text to display after nick in prefix of message, example: ">"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.paste_auto_add_newline]] *weechat.look.paste_auto_add_newline* -** description: pass:none[automatically add a newline at the end of pasted text if there are at least two lines and if a confirmation is asked] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.paste_bracketed]] *weechat.look.paste_bracketed* -** description: pass:none[enable terminal "bracketed paste mode" (not supported in all terminals/multiplexers): in this mode, pasted text is bracketed with control sequences so that WeeChat can differentiate pasted text from typed-in text ("ESC[200~", followed by the pasted text, followed by "ESC[201~")] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.paste_bracketed_timer_delay]] *weechat.look.paste_bracketed_timer_delay* -** description: pass:none[force end of bracketed paste after this delay (in seconds) if the control sequence for end of bracketed paste ("ESC[201~") was not received in time] -** type: integer -** values: 1 .. 60 -** default value: `+10+` - -* [[option_weechat.look.paste_max_lines]] *weechat.look.paste_max_lines* -** description: pass:none[max number of lines for paste without asking user (-1 = disable this feature); this option is used only if the bar item "input_paste" is used in at least one bar (by default it is used in "input" bar)] -** type: integer -** values: -1 .. 2147483647 -** default value: `+1+` - -* [[option_weechat.look.prefix_action]] *weechat.look.prefix_action* -** description: pass:none[prefix for action messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+" *"+` - -* [[option_weechat.look.prefix_align]] *weechat.look.prefix_align* -** description: pass:none[prefix alignment (none, left, right (default))] -** type: integer -** values: none, left, right -** default value: `+right+` - -* [[option_weechat.look.prefix_align_max]] *weechat.look.prefix_align_max* -** description: pass:none[max size for prefix (0 = no max size)] -** type: integer -** values: 0 .. 128 -** default value: `+0+` - -* [[option_weechat.look.prefix_align_min]] *weechat.look.prefix_align_min* -** description: pass:none[min size for prefix] -** type: integer -** values: 0 .. 128 -** default value: `+0+` - -* [[option_weechat.look.prefix_align_more]] *weechat.look.prefix_align_more* -** description: pass:none[char to display if prefix is truncated (must be exactly one char on screen)] -** type: string -** values: any string -** default value: `+"+"+` - -* [[option_weechat.look.prefix_align_more_after]] *weechat.look.prefix_align_more_after* -** description: pass:none[display the truncature char (by default "+") after the text (by replacing the space that should be displayed here); if disabled, the truncature char replaces last char of text] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.prefix_buffer_align]] *weechat.look.prefix_buffer_align* -** description: pass:none[prefix alignment for buffer name, when many buffers are merged with same number (none, left, right (default))] -** type: integer -** values: none, left, right -** default value: `+right+` - -* [[option_weechat.look.prefix_buffer_align_max]] *weechat.look.prefix_buffer_align_max* -** description: pass:none[max size for buffer name, when many buffers are merged with same number (0 = no max size)] -** type: integer -** values: 0 .. 128 -** default value: `+0+` - -* [[option_weechat.look.prefix_buffer_align_more]] *weechat.look.prefix_buffer_align_more* -** description: pass:none[char to display if buffer name is truncated (when many buffers are merged with same number) (must be exactly one char on screen)] -** type: string -** values: any string -** default value: `+"+"+` - -* [[option_weechat.look.prefix_buffer_align_more_after]] *weechat.look.prefix_buffer_align_more_after* -** description: pass:none[display the truncature char (by default "+") after the text (by replacing the space that should be displayed here); if disabled, the truncature char replaces last char of text] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.prefix_error]] *weechat.look.prefix_error* -** description: pass:none[prefix for error messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"=!="+` - -* [[option_weechat.look.prefix_join]] *weechat.look.prefix_join* -** description: pass:none[prefix for join messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"-->"+` - -* [[option_weechat.look.prefix_network]] *weechat.look.prefix_network* -** description: pass:none[prefix for network messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"--"+` - -* [[option_weechat.look.prefix_quit]] *weechat.look.prefix_quit* -** description: pass:none[prefix for quit messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)] -** type: string -** values: any string -** default value: `+"<--"+` - -* [[option_weechat.look.prefix_same_nick]] *weechat.look.prefix_same_nick* -** description: pass:none[prefix displayed for a message with same nick as previous but not next message: use a space " " to hide prefix, another string to display this string instead of prefix, or an empty string to disable feature (display prefix)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.prefix_same_nick_middle]] *weechat.look.prefix_same_nick_middle* -** description: pass:none[prefix displayed for a message with same nick as previous and next message: use a space " " to hide prefix, another string to display this string instead of prefix, or an empty string to disable feature (display prefix)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.prefix_suffix]] *weechat.look.prefix_suffix* -** description: pass:none[string displayed after prefix] -** type: string -** values: any string -** default value: `+"|"+` - -* [[option_weechat.look.quote_nick_prefix]] *weechat.look.quote_nick_prefix* -** description: pass:none[text to display before nick when quoting a message (see /help cursor)] -** type: string -** values: any string -** default value: `+"<"+` - -* [[option_weechat.look.quote_nick_suffix]] *weechat.look.quote_nick_suffix* -** description: pass:none[text to display after nick when quoting a message (see /help cursor)] -** type: string -** values: any string -** default value: `+">"+` - -* [[option_weechat.look.quote_time_format]] *weechat.look.quote_time_format* -** description: pass:none[time format when quoting a message (see /help cursor)] -** type: string -** values: any string -** default value: `+"%H:%M:%S"+` - -* [[option_weechat.look.read_marker]] *weechat.look.read_marker* -** description: pass:none[use a marker (line or char) on buffers to show first unread line] -** type: integer -** values: none, line, char -** default value: `+line+` - -* [[option_weechat.look.read_marker_always_show]] *weechat.look.read_marker_always_show* -** description: pass:none[always show read marker, even if it is after last buffer line] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.read_marker_string]] *weechat.look.read_marker_string* -** description: pass:none[string used to draw read marker line (string is repeated until end of line)] -** type: string -** values: any string -** default value: `+"- "+` - -* [[option_weechat.look.save_config_on_exit]] *weechat.look.save_config_on_exit* -** description: pass:none[save configuration file on exit] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.save_config_with_fsync]] *weechat.look.save_config_with_fsync* -** description: pass:none[use fsync to synchronize the configuration file with the storage device (see man fsync); this is slower but should prevent any data loss in case of power failure during the save of configuration file] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.save_layout_on_exit]] *weechat.look.save_layout_on_exit* -** description: pass:none[save layout on exit (buffers, windows, or both)] -** type: integer -** values: none, buffers, windows, all -** default value: `+none+` - -* [[option_weechat.look.scroll_amount]] *weechat.look.scroll_amount* -** description: pass:none[how many lines to scroll by with scroll_up and scroll_down] -** type: integer -** values: 1 .. 2147483647 -** default value: `+3+` - -* [[option_weechat.look.scroll_bottom_after_switch]] *weechat.look.scroll_bottom_after_switch* -** description: pass:none[scroll to bottom of window after switch to another buffer (do not remember scroll position in windows); the scroll is done only for buffers with formatted content (not free content)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.scroll_page_percent]] *weechat.look.scroll_page_percent* -** description: pass:none[percent of screen to scroll when scrolling one page up or down (for example 100 means one page, 50 half-page)] -** type: integer -** values: 1 .. 100 -** default value: `+100+` - -* [[option_weechat.look.search_text_not_found_alert]] *weechat.look.search_text_not_found_alert* -** description: pass:none[alert user when text sought is not found in buffer] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.separator_horizontal]] *weechat.look.separator_horizontal* -** description: pass:none[char used to draw horizontal separators around bars and windows (empty value will draw a real line with ncurses, but may cause bugs with URL selection under some terminals); width on screen must be exactly one char] -** type: string -** values: any string -** default value: `+"-"+` - -* [[option_weechat.look.separator_vertical]] *weechat.look.separator_vertical* -** description: pass:none[char used to draw vertical separators around bars and windows (empty value will draw a real line with ncurses); width on screen must be exactly one char] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.tab_width]] *weechat.look.tab_width* -** description: pass:none[number of spaces used to display tabs in messages] -** type: integer -** values: 1 .. 64 -** default value: `+1+` - -* [[option_weechat.look.time_format]] *weechat.look.time_format* -** description: pass:none[time format for dates converted to strings and displayed in messages (see man strftime for date/time specifiers)] -** type: string -** values: any string -** default value: `+"%a, %d %b %Y %T"+` - -* [[option_weechat.look.window_auto_zoom]] *weechat.look.window_auto_zoom* -** description: pass:none[automatically zoom on current window if the terminal becomes too small to display all windows (use alt-z to unzoom windows when the terminal is big enough)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.look.window_separator_horizontal]] *weechat.look.window_separator_horizontal* -** description: pass:none[display an horizontal separator between windows] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.window_separator_vertical]] *weechat.look.window_separator_vertical* -** description: pass:none[display a vertical separator between windows] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.look.window_title]] *weechat.look.window_title* -** description: pass:none[title for window (terminal for Curses GUI), set on startup; an empty string will keep title unchanged (note: content is evaluated, see /help eval); example: "WeeChat ${info:version}"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.look.word_chars_highlight]] *weechat.look.word_chars_highlight* -** description: pass:none[comma-separated list of chars (or range of chars) that are considered part of words for highlights; each item can be a single char, a range of chars (format: a-z), a class of wide character (for example "alnum", see man wctype); a "!" before the item makes it negative (ie the char is NOT considered part of words); the value "*" matches any char; unicode chars are allowed with the format \u1234, for example \u00A0 for unbreakable space (see /help print for supported formats)] -** type: string -** values: any string -** default value: `+"!\u00A0,-,_,|,alnum"+` - -* [[option_weechat.look.word_chars_input]] *weechat.look.word_chars_input* -** description: pass:none[comma-separated list of chars (or range of chars) that are considered part of words for command line; each item can be a single char, a range of chars (format: a-z), a class of wide character (for example "alnum", see man wctype); a "!" before the item makes it negative (ie the char is NOT considered part of words); the value "*" matches any char; unicode chars are allowed with the format \u1234, for example \u00A0 for unbreakable space (see /help print for supported formats)] -** type: string -** values: any string -** default value: `+"!\u00A0,-,_,|,alnum"+` - -* [[option_weechat.network.connection_timeout]] *weechat.network.connection_timeout* -** description: pass:none[timeout (in seconds) for connection to a remote host (made in a child process)] -** type: integer -** values: 1 .. 2147483647 -** default value: `+60+` - -* [[option_weechat.network.gnutls_ca_file]] *weechat.network.gnutls_ca_file* -** description: pass:none[file containing the certificate authorities ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] -** type: string -** values: any string -** default value: `+"/etc/ssl/certs/ca-certificates.crt"+` - -* [[option_weechat.network.gnutls_handshake_timeout]] *weechat.network.gnutls_handshake_timeout* -** description: pass:none[timeout (in seconds) for gnutls handshake] -** type: integer -** values: 1 .. 2147483647 -** default value: `+30+` - -* [[option_weechat.network.proxy_curl]] *weechat.network.proxy_curl* -** description: pass:none[name of proxy used for download of URLs with Curl (used to download list of scripts and in scripts calling function hook_process); the proxy must be defined with command /proxy] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.plugin.autoload]] *weechat.plugin.autoload* -** description: pass:none[comma separated list of plugins to load automatically at startup, "*" means all plugins found, a name beginning with "!" is a negative value to prevent a plugin from being loaded, wildcard "*" is allowed in names (examples: "*" or "*,!lua,!tcl")] -** type: string -** values: any string -** default value: `+"*"+` - -* [[option_weechat.plugin.debug]] *weechat.plugin.debug* -** description: pass:none[enable debug messages by default in all plugins (option disabled by default, which is highly recommended)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_weechat.plugin.extension]] *weechat.plugin.extension* -** description: pass:none[comma separated list of file name extensions for plugins] -** type: string -** values: any string -** default value: `+".so,.dll"+` - -* [[option_weechat.plugin.path]] *weechat.plugin.path* -** description: pass:none[path for searching plugins ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] -** type: string -** values: any string -** default value: `+"%h/plugins"+` - -* [[option_weechat.plugin.save_config_on_unload]] *weechat.plugin.save_config_on_unload* -** description: pass:none[save configuration files when unloading plugins] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.startup.command_after_plugins]] *weechat.startup.command_after_plugins* -** description: pass:none[command executed when WeeChat starts, after loading plugins (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.startup.command_before_plugins]] *weechat.startup.command_before_plugins* -** description: pass:none[command executed when WeeChat starts, before loading plugins (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_weechat.startup.display_logo]] *weechat.startup.display_logo* -** description: pass:none[display WeeChat logo at startup] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.startup.display_version]] *weechat.startup.display_version* -** description: pass:none[display WeeChat version at startup] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_weechat.startup.sys_rlimit]] *weechat.startup.sys_rlimit* -** description: pass:none[set resource limits for WeeChat process, format is: "res1:limit1,res2:limit2"; resource name is the end of constant (RLIMIT_XXX) in lower case (see man setrlimit for values); limit -1 means "unlimited"; example: set unlimited size for core file and max 1GB of virtual memory: "core:-1,as:1000000000"] -** type: string -** values: any string -** default value: `+""+` diff --git a/doc/en/autogen/user/xfer_commands.adoc b/doc/en/autogen/user/xfer_commands.adoc deleted file mode 100644 index 4507b98d3..000000000 --- a/doc/en/autogen/user/xfer_commands.adoc +++ /dev/null @@ -1,24 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -[[command_xfer_me]] -* `+me+`: send a CTCP action to remote host - ----- -/me <message> - -message: message to send ----- - -[[command_xfer_xfer]] -* `+xfer+`: xfer control - ----- -/xfer [list|listfull] - - list: list xfer -listfull: list xfer (verbose) - -Without argument, this command opens buffer with xfer list. ----- diff --git a/doc/en/autogen/user/xfer_options.adoc b/doc/en/autogen/user/xfer_options.adoc deleted file mode 100644 index e32581273..000000000 --- a/doc/en/autogen/user/xfer_options.adoc +++ /dev/null @@ -1,189 +0,0 @@ -// -// This file is auto-generated by script docgen.py. -// DO NOT EDIT BY HAND! -// -* [[option_xfer.color.status_aborted]] *xfer.color.status_aborted* -** description: pass:none[text color for "aborted" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_xfer.color.status_active]] *xfer.color.status_active* -** description: pass:none[text color for "active" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightblue+` - -* [[option_xfer.color.status_connecting]] *xfer.color.status_connecting* -** description: pass:none[text color for "connecting" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+yellow+` - -* [[option_xfer.color.status_done]] *xfer.color.status_done* -** description: pass:none[text color for "done" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightgreen+` - -* [[option_xfer.color.status_failed]] *xfer.color.status_failed* -** description: pass:none[text color for "failed" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightred+` - -* [[option_xfer.color.status_waiting]] *xfer.color.status_waiting* -** description: pass:none[text color for "waiting" status] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+lightcyan+` - -* [[option_xfer.color.text]] *xfer.color.text* -** description: pass:none[text color in xfer buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_xfer.color.text_bg]] *xfer.color.text_bg* -** description: pass:none[background color in xfer buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+default+` - -* [[option_xfer.color.text_selected]] *xfer.color.text_selected* -** description: pass:none[text color of selected line in xfer buffer] -** type: color -** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline -** default value: `+white+` - -* [[option_xfer.file.auto_accept_chats]] *xfer.file.auto_accept_chats* -** description: pass:none[automatically accept chat requests (use carefully!)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_xfer.file.auto_accept_files]] *xfer.file.auto_accept_files* -** description: pass:none[automatically accept incoming files (use carefully!)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_xfer.file.auto_accept_nicks]] *xfer.file.auto_accept_nicks* -** description: pass:none[comma-separated list of nicks for which the incoming files and chats are automatically accepted; format is "server.nick" (for a specific server) or "nick" (for all servers); example: "freenode.FlashCode,andrew"] -** type: string -** values: any string -** default value: `+""+` - -* [[option_xfer.file.auto_check_crc32]] *xfer.file.auto_check_crc32* -** description: pass:none[automatically check CRC32 file checksum if it is found in the filename (8 hexadecimal chars)] -** type: boolean -** values: on, off -** default value: `+off+` - -* [[option_xfer.file.auto_rename]] *xfer.file.auto_rename* -** description: pass:none[rename incoming files if already exists (add ".1", ".2", ...)] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.file.auto_resume]] *xfer.file.auto_resume* -** description: pass:none[automatically resume file transfer if connection with remote host is lost] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.file.convert_spaces]] *xfer.file.convert_spaces* -** description: pass:none[convert spaces to underscores when sending and receiving files] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.file.download_path]] *xfer.file.download_path* -** description: pass:none[path for writing incoming files: "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+"%h/xfer"+` - -* [[option_xfer.file.download_temporary_suffix]] *xfer.file.download_temporary_suffix* -** description: pass:none[temporary filename suffix used during the transfer for a file received, it is removed after successful transfer; if empty string, no filename suffix is used during the transfer] -** type: string -** values: any string -** default value: `+".part"+` - -* [[option_xfer.file.upload_path]] *xfer.file.upload_path* -** description: pass:none[path for reading files when sending (when no path is specified by user): "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)] -** type: string -** values: any string -** default value: `+"~"+` - -* [[option_xfer.file.use_nick_in_filename]] *xfer.file.use_nick_in_filename* -** description: pass:none[use remote nick as prefix in local filename when receiving a file] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.look.auto_open_buffer]] *xfer.look.auto_open_buffer* -** description: pass:none[auto open xfer buffer when a new xfer is added to list] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.look.progress_bar_size]] *xfer.look.progress_bar_size* -** description: pass:none[size of progress bar, in chars (if 0, progress bar is disabled)] -** type: integer -** values: 0 .. 256 -** default value: `+20+` - -* [[option_xfer.look.pv_tags]] *xfer.look.pv_tags* -** description: pass:none[comma separated list of tags used in private messages, for example: "notify_message", "notify_private" or "notify_highlight"] -** type: string -** values: any string -** default value: `+"notify_private"+` - -* [[option_xfer.network.blocksize]] *xfer.network.blocksize* -** description: pass:none[block size for sending packets, in bytes] -** type: integer -** values: 1024 .. 102400 -** default value: `+65536+` - -* [[option_xfer.network.fast_send]] *xfer.network.fast_send* -** description: pass:none[does not wait for ACK when sending file] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.network.own_ip]] *xfer.network.own_ip* -** description: pass:none[IP or DNS address used for sending files/chats (if empty, local interface IP is used)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_xfer.network.port_range]] *xfer.network.port_range* -** description: pass:none[restricts outgoing files/chats to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port, it's recommended to use ports greater than 1024, because only root can use ports below 1024)] -** type: string -** values: any string -** default value: `+""+` - -* [[option_xfer.network.send_ack]] *xfer.network.send_ack* -** description: pass:none[send acks when receiving files; if disabled, the transfer may freeze if the sender is waiting for acks (for example a WeeChat sending a file with option xfer.network.fast_send set to off); on the other hand, disabling send of acks may prevent a freeze if the acks are not sent immediately to the sender] -** type: boolean -** values: on, off -** default value: `+on+` - -* [[option_xfer.network.speed_limit_recv]] *xfer.network.speed_limit_recv* -** description: pass:none[speed limit for receiving files, in kilo-bytes by second (0 means no limit)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+0+` - -* [[option_xfer.network.speed_limit_send]] *xfer.network.speed_limit_send* -** description: pass:none[speed limit for sending files, in kilo-bytes by second (0 means no limit)] -** type: integer -** values: 0 .. 2147483647 -** default value: `+0+` - -* [[option_xfer.network.timeout]] *xfer.network.timeout* -** description: pass:none[timeout for xfer request (in seconds)] -** type: integer -** values: 5 .. 2147483647 -** default value: `+300+` |