214 lines
13 KiB
Plaintext
214 lines
13 KiB
Plaintext
//
|
|
// 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_password]] *relay.network.auth_password*
|
|
** 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.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.hash_iterations]] *relay.network.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.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.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: `+""+`
|