summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/xfer_options.adoc
blob: d6e5020553189c46a41297adfbe7f4ba40adadd9 (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
//
// 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.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+`