summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/xfer_options.txt
blob: c92550512fea476f2e936774c11c3afb56dc4d49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
* [[option_xfer.color.status_aborted]] *xfer.color.status_aborted*
** description: `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 underline (default value: `lightred`)

* [[option_xfer.color.status_active]] *xfer.color.status_active*
** description: `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 underline (default value: `lightblue`)

* [[option_xfer.color.status_connecting]] *xfer.color.status_connecting*
** description: `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 underline (default value: `yellow`)

* [[option_xfer.color.status_done]] *xfer.color.status_done*
** description: `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 underline (default value: `lightgreen`)

* [[option_xfer.color.status_failed]] *xfer.color.status_failed*
** description: `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 underline (default value: `lightred`)

* [[option_xfer.color.status_waiting]] *xfer.color.status_waiting*
** description: `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 underline (default value: `lightcyan`)

* [[option_xfer.color.text]] *xfer.color.text*
** description: `text color`
** 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 underline (default value: `default`)

* [[option_xfer.color.text_bg]] *xfer.color.text_bg*
** description: `background color`
** 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 underline (default value: `default`)

* [[option_xfer.color.text_selected]] *xfer.color.text_selected*
** description: `text color of selected xfer 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 underline (default value: `white`)

* [[option_xfer.file.auto_accept_chats]] *xfer.file.auto_accept_chats*
** description: `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: `automatically accept incoming files (use carefully!)`
** type: boolean
** 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", ...)`
** type: boolean
** 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`
** type: boolean
** values: on, off (default value: `on`)

* [[option_xfer.file.convert_spaces]] *xfer.file.convert_spaces*
** description: `convert spaces to underscores when sending files`
** type: boolean
** values: on, off (default value: `on`)

* [[option_xfer.file.download_path]] *xfer.file.download_path*
** description: `path for writing incoming files ("%h" will be replaced by WeeChat home, "~/.weechat" by default)`
** type: string
** 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" will be replaced by WeeChat home, "~/.weechat" by default)`
** type: string
** 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`
** type: boolean
** 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`
** type: boolean
** 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)`
** type: integer
** values: 0 .. 256 (default value: `20`)

* [[option_xfer.network.blocksize]] *xfer.network.blocksize*
** description: `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: `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: `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: `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.speed_limit]] *xfer.network.speed_limit*
** description: `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: `timeout for xfer request (in seconds)`
** type: integer
** values: 5 .. 2147483647 (default value: `300`)