summaryrefslogtreecommitdiff
path: root/doc/en/autogen/xfer_options.xml
blob: f09e4cfae3157a7e7ab44998770161aa0d062e36 (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
<?xml version="1.0" encoding="UTF-8"?>
<!--
     ********* WARNING! *********

     This file is autogenerated with docgen.pl script. *** DO NOT EDIT! ***
     docgen.pl builds XML doc files to include in many languages
-->

<command>xfer.color.status_aborted</command>
<itemizedlist>
  <listitem>
    <para>description: text color for "aborted" status</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: lightred</para>
  </listitem>
</itemizedlist>

<command>xfer.color.status_active</command>
<itemizedlist>
  <listitem>
    <para>description: text color for "active" status</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: lightblue</para>
  </listitem>
</itemizedlist>

<command>xfer.color.status_connecting</command>
<itemizedlist>
  <listitem>
    <para>description: text color for "connecting" status</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: yellow</para>
  </listitem>
</itemizedlist>

<command>xfer.color.status_done</command>
<itemizedlist>
  <listitem>
    <para>description: text color for "done" status</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: lightgreen</para>
  </listitem>
</itemizedlist>

<command>xfer.color.status_failed</command>
<itemizedlist>
  <listitem>
    <para>description: text color for "failed" status</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: lightred</para>
  </listitem>
</itemizedlist>

<command>xfer.color.status_waiting</command>
<itemizedlist>
  <listitem>
    <para>description: text color for "waiting" status</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: lightcyan</para>
  </listitem>
</itemizedlist>

<command>xfer.color.text</command>
<itemizedlist>
  <listitem>
    <para>description: text color</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: default</para>
  </listitem>
</itemizedlist>

<command>xfer.color.text_bg</command>
<itemizedlist>
  <listitem>
    <para>description: background color</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: default</para>
  </listitem>
</itemizedlist>

<command>xfer.color.text_selected</command>
<itemizedlist>
  <listitem>
    <para>description: text color of selected xfer line</para>
  </listitem>
  <listitem>
    <para>type: color</para>
  </listitem>
  <listitem>
    <para>values: a color name</para>
  </listitem>
  <listitem>
    <para>default value: white</para>
  </listitem>
</itemizedlist>

<command>xfer.file.auto_accept_chats</command>
<itemizedlist>
  <listitem>
    <para>description: automatically accept chat requests (use carefully!)</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: off</para>
  </listitem>
</itemizedlist>

<command>xfer.file.auto_accept_files</command>
<itemizedlist>
  <listitem>
    <para>description: automatically accept incoming files (use carefully!)</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: off</para>
  </listitem>
</itemizedlist>

<command>xfer.file.auto_rename</command>
<itemizedlist>
  <listitem>
    <para>description: rename incoming files if already exists (add '.1', '.2', ...)</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: on</para>
  </listitem>
</itemizedlist>

<command>xfer.file.auto_resume</command>
<itemizedlist>
  <listitem>
    <para>description: automatically resume file transfer if connection with remote host is lost</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: on</para>
  </listitem>
</itemizedlist>

<command>xfer.file.convert_spaces</command>
<itemizedlist>
  <listitem>
    <para>description: convert spaces to underscores when sending files</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: on</para>
  </listitem>
</itemizedlist>

<command>xfer.file.download_path</command>
<itemizedlist>
  <listitem>
    <para>description: path for writing incoming files</para>
  </listitem>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string</para>
  </listitem>
  <listitem>
    <para>default value: '%h/xfer'</para>
  </listitem>
</itemizedlist>

<command>xfer.file.upload_path</command>
<itemizedlist>
  <listitem>
    <para>description: path for reading files when sending (when no path is specified by user)</para>
  </listitem>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string</para>
  </listitem>
  <listitem>
    <para>default value: '~'</para>
  </listitem>
</itemizedlist>

<command>xfer.file.use_nick_in_filename</command>
<itemizedlist>
  <listitem>
    <para>description: use remote nick as prefix in local filename when receiving a file</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: on</para>
  </listitem>
</itemizedlist>

<command>xfer.look.auto_open_buffer</command>
<itemizedlist>
  <listitem>
    <para>description: auto open xfer buffer when a new xfer is added to list</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: on</para>
  </listitem>
</itemizedlist>

<command>xfer.look.progress_bar_size</command>
<itemizedlist>
  <listitem>
    <para>description: size of progress bar, in chars (if 0, progress bar is disabled)</para>
  </listitem>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 256</para>
  </listitem>
  <listitem>
    <para>default value: 20</para>
  </listitem>
</itemizedlist>

<command>xfer.network.blocksize</command>
<itemizedlist>
  <listitem>
    <para>description: block size for sending packets, in bytes</para>
  </listitem>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 1024 .. 102400</para>
  </listitem>
  <listitem>
    <para>default value: 65536</para>
  </listitem>
</itemizedlist>

<command>xfer.network.fast_send</command>
<itemizedlist>
  <listitem>
    <para>description: does not wait for ACK when sending file</para>
  </listitem>
  <listitem>
    <para>type: boolean</para>
  </listitem>
  <listitem>
    <para>values: on, off</para>
  </listitem>
  <listitem>
    <para>default value: on</para>
  </listitem>
</itemizedlist>

<command>xfer.network.own_ip</command>
<itemizedlist>
  <listitem>
    <para>description: IP or DNS address used for sending files/chats (if empty, local interface IP is used)</para>
  </listitem>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string</para>
  </listitem>
  <listitem>
    <para>default value: ''</para>
  </listitem>
</itemizedlist>

<command>xfer.network.port_range</command>
<itemizedlist>
  <listitem>
    <para>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)</para>
  </listitem>
  <listitem>
    <para>type: string</para>
  </listitem>
  <listitem>
    <para>values: any string</para>
  </listitem>
  <listitem>
    <para>default value: ''</para>
  </listitem>
</itemizedlist>

<command>xfer.network.speed_limit</command>
<itemizedlist>
  <listitem>
    <para>description: speed limit for sending files, in kilo-bytes by second (0 means no limit)</para>
  </listitem>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 0 .. 2147483647</para>
  </listitem>
  <listitem>
    <para>default value: 0</para>
  </listitem>
</itemizedlist>

<command>xfer.network.timeout</command>
<itemizedlist>
  <listitem>
    <para>description: timeout for xfer request (in seconds)</para>
  </listitem>
  <listitem>
    <para>type: integer</para>
  </listitem>
  <listitem>
    <para>values: 5 .. 2147483647</para>
  </listitem>
  <listitem>
    <para>default value: 300</para>
  </listitem>
</itemizedlist>