diff options
Diffstat (limited to 'doc/en/autogen/user/xfer_options.asciidoc')
| -rw-r--r-- | doc/en/autogen/user/xfer_options.asciidoc | 112 |
1 files changed, 56 insertions, 56 deletions
diff --git a/doc/en/autogen/user/xfer_options.asciidoc b/doc/en/autogen/user/xfer_options.asciidoc index e44ddd780..7b5701c22 100644 --- a/doc/en/autogen/user/xfer_options.asciidoc +++ b/doc/en/autogen/user/xfer_options.asciidoc @@ -3,141 +3,141 @@ // DO NOT EDIT BY HAND! // * [[option_xfer.color.status_aborted]] *xfer.color.status_aborted* -** description: `text color for "aborted" status` +** 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`) +** 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: `text color for "active" status` +** 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`) +** 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: `text color for "connecting" status` +** 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`) +** 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: `text color for "done" status` +** 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`) +** 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: `text color for "failed" status` +** 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`) +** 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: `text color for "waiting" status` +** 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`) +** 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: `text color in xfer buffer` +** 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`) +** 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: `background color in xfer buffer` +** 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`) +** 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: `text color of selected line in xfer buffer` +** 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`) +** 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: `automatically accept chat requests (use carefully!)` +** description: pass:none[automatically accept chat requests (use carefully!)] ** type: boolean -** values: on, off (default value: `off`) +** values: on, off (default value: `+off+`) * [[option_xfer.file.auto_accept_files]] *xfer.file.auto_accept_files* -** description: `automatically accept incoming files (use carefully!)` +** description: pass:none[automatically accept incoming files (use carefully!)] ** type: boolean -** values: on, off (default value: `off`) +** values: on, off (default value: `+off+`) * [[option_xfer.file.auto_accept_nicks]] *xfer.file.auto_accept_nicks* -** description: `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"` +** 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: `""`) +** values: any string (default value: `+""+`) * [[option_xfer.file.auto_check_crc32]] *xfer.file.auto_check_crc32* -** description: `automatically check CRC32 file checksum if it is found in the filename (8 hexadecimal chars)` +** 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`) +** values: on, off (default value: `+off+`) * [[option_xfer.file.auto_rename]] *xfer.file.auto_rename* -** description: `rename incoming files if already exists (add ".1", ".2", ...)` +** description: pass:none[rename incoming files if already exists (add ".1", ".2", ...)] ** type: boolean -** values: on, off (default value: `on`) +** values: on, off (default value: `+on+`) * [[option_xfer.file.auto_resume]] *xfer.file.auto_resume* -** description: `automatically resume file transfer if connection with remote host is lost` +** description: pass:none[automatically resume file transfer if connection with remote host is lost] ** type: boolean -** values: on, off (default value: `on`) +** values: on, off (default value: `+on+`) * [[option_xfer.file.convert_spaces]] *xfer.file.convert_spaces* -** description: `convert spaces to underscores when sending and receiving files` +** description: pass:none[convert spaces to underscores when sending and receiving files] ** type: boolean -** values: on, off (default value: `on`) +** values: on, off (default value: `+on+`) * [[option_xfer.file.download_path]] *xfer.file.download_path* -** description: `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)` +** 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"`) +** values: any string (default value: `+"%h/xfer"+`) * [[option_xfer.file.upload_path]] *xfer.file.upload_path* -** description: `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)` +** 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: `"~"`) +** values: any string (default value: `+"~"+`) * [[option_xfer.file.use_nick_in_filename]] *xfer.file.use_nick_in_filename* -** description: `use remote nick as prefix in local filename when receiving a file` +** description: pass:none[use remote nick as prefix in local filename when receiving a file] ** type: boolean -** values: on, off (default value: `on`) +** values: on, off (default value: `+on+`) * [[option_xfer.look.auto_open_buffer]] *xfer.look.auto_open_buffer* -** description: `auto open xfer buffer when a new xfer is added to list` +** description: pass:none[auto open xfer buffer when a new xfer is added to list] ** type: boolean -** values: on, off (default value: `on`) +** values: on, off (default value: `+on+`) * [[option_xfer.look.progress_bar_size]] *xfer.look.progress_bar_size* -** description: `size of progress bar, in chars (if 0, progress bar is disabled)` +** description: pass:none[size of progress bar, in chars (if 0, progress bar is disabled)] ** type: integer -** values: 0 .. 256 (default value: `20`) +** values: 0 .. 256 (default value: `+20+`) * [[option_xfer.look.pv_tags]] *xfer.look.pv_tags* -** description: `comma separated list of tags used in private messages, for example: "notify_message", "notify_private" or "notify_highlight"` +** 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"`) +** values: any string (default value: `+"notify_private"+`) * [[option_xfer.network.blocksize]] *xfer.network.blocksize* -** description: `block size for sending packets, in bytes` +** description: pass:none[block size for sending packets, in bytes] ** type: integer -** values: 1024 .. 102400 (default value: `65536`) +** values: 1024 .. 102400 (default value: `+65536+`) * [[option_xfer.network.fast_send]] *xfer.network.fast_send* -** description: `does not wait for ACK when sending file` +** description: pass:none[does not wait for ACK when sending file] ** type: boolean -** values: on, off (default value: `on`) +** values: on, off (default value: `+on+`) * [[option_xfer.network.own_ip]] *xfer.network.own_ip* -** description: `IP or DNS address used for sending files/chats (if empty, local interface IP is used)` +** 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: `""`) +** values: any string (default value: `+""+`) * [[option_xfer.network.port_range]] *xfer.network.port_range* -** description: `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)` +** 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: `""`) +** values: any string (default value: `+""+`) * [[option_xfer.network.speed_limit]] *xfer.network.speed_limit* -** description: `speed limit for sending files, in kilo-bytes by second (0 means no limit)` +** 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`) +** values: 0 .. 2147483647 (default value: `+0+`) * [[option_xfer.network.timeout]] *xfer.network.timeout* -** description: `timeout for xfer request (in seconds)` +** description: pass:none[timeout for xfer request (in seconds)] ** type: integer -** values: 5 .. 2147483647 (default value: `300`) +** values: 5 .. 2147483647 (default value: `+300+`) |