summaryrefslogtreecommitdiff
path: root/net/py-bittornado/files/btdownloadcurses.1
blob: 9df6e66ccf0cee2474e2a4fa16eb1a2b0ce2aa09 (plain) (blame)
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
.TH BTDOWNLOADCURSES "1" "August 2004" "btdownloadcurses (bittornado)" "User Commands"
.SH NAME
Btdownloadcurses \- curses bittornado download interface
.SH SYNOPSIS
.B btdownloadcurses
\fI<global options>\fR
.SH DESCRIPTION
Arguments are:
.PP
\fB\-\-max_uploads\fR <arg>
.IP
the maximum number of uploads to allow at once. (defaults to 7)
.PP
\fB\-\-keepalive_interval\fR <arg>
.IP
number of seconds to pause between sending keepalives (defaults to 120.0)
.PP
\fB\-\-download_slice_size\fR <arg>
.IP
How many bytes to query for per request. (defaults to 16384)
.PP
\fB\-\-upload_unit_size\fR <arg>
.IP
when limiting upload rate, how many bytes to send at a time (defaults to 1460)
.PP
\fB\-\-request_backlog\fR <arg>
.IP
maximum number of requests to keep in a single pipe at once. (defaults to 10)
.PP
\fB\-\-max_message_length\fR <arg>
.IP
maximum length prefix encoding you'll accept over the wire - larger values get the
connection dropped. (defaults to 8388608)
.PP
\fB\-\-ip\fR <arg>
.IP
ip to report you have to the tracker. (defaults to '')
.PP
\fB\-\-minport\fR <arg>
.IP
minimum port to listen on, counts up if unavailable (defaults to 10000)
.PP
\fB\-\-maxport\fR <arg>
.IP
maximum port to listen on (defaults to 60000)
.PP
\fB\-\-random_port\fR <arg>
.IP
whether to choose randomly inside the port range instead of counting up linearly
(defaults to 1)
.PP
\fB\-\-responsefile\fR <arg>
.IP
file the server response was stored in, alternative to url (defaults to '')
.PP
\fB\-\-url\fR <arg>
.IP
url to get file from, alternative to responsefile (defaults to '')
.PP
\fB\-\-selector_enabled\fR <arg>
.IP
whether to enable the file selector and fast resume function (defaults to 1)
.PP
\fB\-\-expire_cache_data\fR <arg>
.IP
the number of days after which you wish to expire old cache data (0 = disabled) (defaults
to 10)
.PP
\fB\-\-priority\fR <arg>
.IP
a list of file priorities separated by commas, must be one per file, 0 = highest, 1 =
normal, 2 = lowest, \fB\-1\fR = download disabled (defaults to '')
.PP
\fB\-\-saveas\fR <arg>
.IP
local file name to save the file as, null indicates query user (defaults to '')
.PP
\fB\-\-timeout\fR <arg>
.IP
time to wait between closing sockets which nothing has been received on (defaults to
300.0)
.PP
\fB\-\-timeout_check_interval\fR <arg>
.IP
time to wait between checking if any connections have timed out (defaults to 60.0)
.PP
\fB\-\-max_slice_length\fR <arg>
.IP
maximum length slice to send to peers, larger requests are ignored (defaults to 131072)
.PP
\fB\-\-max_rate_period\fR <arg>
.IP
maximum amount of time to guess the current rate estimate represents (defaults to 20.0)
.PP
\fB\-\-bind\fR <arg>
.IP
comma-separated list of ips/hostnames to bind to locally (defaults to '')
.PP
\fB\-\-ipv6_enabled\fR <arg>
.IP
allow the client to connect to peers via IPv6 (defaults to 0)
.PP
\fB\-\-ipv6_binds_v4\fR <arg>
.IP
set if an IPv6 server socket will also field IPv4 connections (defaults to 1)
.PP
\fB\-\-upnp_nat_access\fR <arg>
.IP
attempt to autoconfigure a UPnP router to forward a server port (0 = disabled, 1 = mode 1
[fast], 2 = mode 2 [slow]) (defaults to 1)
.PP
\fB\-\-upload_rate_fudge\fR <arg>
.IP
time equivalent of writing to kernel-level TCP buffer, for rate adjustment (defaults to
5.0)
.PP
\fB\-\-tcp_ack_fudge\fR <arg>
.IP
how much TCP ACK download overhead to add to upload rate calculations (0 = disabled)
(defaults to 0.029999999999999999)
.PP
\fB\-\-display_interval\fR <arg>
.IP
time between updates of displayed information (defaults to 0.5)
.PP
\fB\-\-rerequest_interval\fR <arg>
.IP
time to wait between requesting more peers (defaults to 300)
.PP
\fB\-\-min_peers\fR <arg>
.IP
minimum number of peers to not do rerequesting (defaults to 20)
.PP
\fB\-\-http_timeout\fR <arg>
.IP
number of seconds to wait before assuming that an http connection has timed out (defaults
to 60)
.PP
\fB\-\-max_initiate\fR <arg>
.IP
number of peers at which to stop initiating new connections (defaults to 40)
.PP
\fB\-\-check_hashes\fR <arg>
.IP
whether to check hashes on disk (defaults to 1)
.PP
\fB\-\-max_upload_rate\fR <arg>
.IP
maximum kB/s to upload at (0 = no limit, \fB\-1\fR = automatic) (defaults to 0)
.PP
\fB\-\-max_download_rate\fR <arg>
.IP
maximum kB/s to download at (0 = no limit) (defaults to 0)
.PP
\fB\-\-alloc_type\fR <arg>
.IP
allocation type (may be normal, background, pre-allocate or sparse) (defaults to
\&'normal')
.PP
\fB\-\-alloc_rate\fR <arg>
.IP
rate (in MiB/s) to allocate space at using background allocation (defaults to 2.0)
.PP
\fB\-\-buffer_reads\fR <arg>
.IP
whether to buffer disk reads (defaults to 1)
.PP
\fB\-\-write_buffer_size\fR <arg>
.IP
the maximum amount of space to use for buffering disk writes (in megabytes, 0 = disabled)
(defaults to 4)
.PP
\fB\-\-snub_time\fR <arg>
.IP
seconds to wait for data to come in over a connection before assuming it's
semi-permanently choked (defaults to 30.0)
.PP
\fB\-\-spew\fR <arg>
.IP
whether to display diagnostic info to stdout (defaults to 0)
.PP
\fB\-\-rarest_first_cutoff\fR <arg>
.IP
number of downloads at which to switch from random to rarest first (defaults to 2)
.PP
\fB\-\-rarest_first_priority_cutoff\fR <arg>
.IP
the number of peers which need to have a piece before other partials take priority over
rarest first (defaults to 5)
.PP
\fB\-\-min_uploads\fR <arg>
.IP
the number of uploads to fill out to with extra optimistic unchokes (defaults to 4)
.PP
\fB\-\-max_files_open\fR <arg>
.IP
the maximum number of files to keep open at a time, 0 means no limit (defaults to 50)
.PP
\fB\-\-round_robin_period\fR <arg>
.IP
the number of seconds between the client's switching upload targets (defaults to 30)
.PP
\fB\-\-super_seeder\fR <arg>
.IP
whether to use special upload-efficiency-maximizing routines (only for dedicated seeds)
(defaults to 0)
.PP
\fB\-\-security\fR <arg>
.IP
whether to enable extra security features intended to prevent abuse (defaults to 1)
.PP
\fB\-\-max_connections\fR <arg>
.IP
the absolute maximum number of peers to connect with (0 = no limit) (defaults to 0)
.PP
\fB\-\-auto_kick\fR <arg>
.IP
whether to allow the client to automatically kick/ban peers that send bad data (defaults
to 1)
.PP
\fB\-\-double_check\fR <arg>
.IP
whether to double-check data being written to the disk for errors (may increase CPU load)
(defaults to 1)
.PP
\fB\-\-triple_check\fR <arg>
.IP
whether to thoroughly check data being written to the disk (may slow disk access)
(defaults to 0)
.PP
\fB\-\-lock_files\fR <arg>
.IP
whether to lock files the client is working with (defaults to 1)
.PP
\fB\-\-lock_while_reading\fR <arg>
.IP
whether to lock access to files being read (defaults to 0)
.PP
\fB\-\-auto_flush\fR <arg>
.IP
minutes between automatic flushes to disk (0 = disabled) (defaults to 0)
.PP
Arguments are:
.PP
\fB\-\-max_uploads\fR <arg>
.IP
the maximum number of uploads to allow at once. (defaults to 7)
.PP
\fB\-\-keepalive_interval\fR <arg>
.IP
number of seconds to pause between sending keepalives (defaults to 120.0)
.PP
\fB\-\-download_slice_size\fR <arg>
.IP
How many bytes to query for per request. (defaults to 16384)
.PP
\fB\-\-upload_unit_size\fR <arg>
.IP
when limiting upload rate, how many bytes to send at a time (defaults to 1460)
.PP
\fB\-\-request_backlog\fR <arg>
.IP
maximum number of requests to keep in a single pipe at once. (defaults to 10)
.PP
\fB\-\-max_message_length\fR <arg>
.IP
maximum length prefix encoding you'll accept over the wire - larger values get the
connection dropped. (defaults to 8388608)
.PP
\fB\-\-ip\fR <arg>
.IP
ip to report you have to the tracker. (defaults to '')
.PP
\fB\-\-minport\fR <arg>
.IP
minimum port to listen on, counts up if unavailable (defaults to 10000)
.PP
\fB\-\-maxport\fR <arg>
.IP
maximum port to listen on (defaults to 60000)
.PP
\fB\-\-random_port\fR <arg>
.IP
whether to choose randomly inside the port range instead of counting up linearly
(defaults to 1)
.PP
\fB\-\-responsefile\fR <arg>
.IP
file the server response was stored in, alternative to url (defaults to '')
.PP
\fB\-\-url\fR <arg>
.IP
url to get file from, alternative to responsefile (defaults to '')
.PP
\fB\-\-selector_enabled\fR <arg>
.IP
whether to enable the file selector and fast resume function (defaults to 1)
.PP
\fB\-\-expire_cache_data\fR <arg>
.IP
the number of days after which you wish to expire old cache data (0 = disabled) (defaults
to 10)
.PP
\fB\-\-priority\fR <arg>
.IP
a list of file priorities separated by commas, must be one per file, 0 = highest, 1 =
normal, 2 = lowest, \fB\-1\fR = download disabled (defaults to '')
.PP
\fB\-\-saveas\fR <arg>
.IP
local file name to save the file as, null indicates query user (defaults to '')
.PP
\fB\-\-timeout\fR <arg>
.IP
time to wait between closing sockets which nothing has been received on (defaults to
300.0)
.PP
\fB\-\-timeout_check_interval\fR <arg>
.IP
time to wait between checking if any connections have timed out (defaults to 60.0)
.PP
\fB\-\-max_slice_length\fR <arg>
.IP
maximum length slice to send to peers, larger requests are ignored (defaults to 131072)
.PP
\fB\-\-max_rate_period\fR <arg>
.IP
maximum amount of time to guess the current rate estimate represents (defaults to 20.0)
.PP
\fB\-\-bind\fR <arg>
.IP
comma-separated list of ips/hostnames to bind to locally (defaults to '')
.PP
\fB\-\-ipv6_enabled\fR <arg>
.IP
allow the client to connect to peers via IPv6 (defaults to 0)
.PP
\fB\-\-ipv6_binds_v4\fR <arg>
.IP
set if an IPv6 server socket will also field IPv4 connections (defaults to 1)
.PP
\fB\-\-upnp_nat_access\fR <arg>
.IP
attempt to autoconfigure a UPnP router to forward a server port (0 = disabled, 1 = mode 1
[fast], 2 = mode 2 [slow]) (defaults to 1)
.PP
\fB\-\-upload_rate_fudge\fR <arg>
.IP
time equivalent of writing to kernel-level TCP buffer, for rate adjustment (defaults to
5.0)
.PP
\fB\-\-tcp_ack_fudge\fR <arg>
.IP
how much TCP ACK download overhead to add to upload rate calculations (0 = disabled)
(defaults to 0.029999999999999999)
.PP
\fB\-\-display_interval\fR <arg>
.IP
time between updates of displayed information (defaults to 0.5)
.PP
\fB\-\-rerequest_interval\fR <arg>
.IP
time to wait between requesting more peers (defaults to 300)
.PP
\fB\-\-min_peers\fR <arg>
.IP
minimum number of peers to not do rerequesting (defaults to 20)
.PP
\fB\-\-http_timeout\fR <arg>
.IP
number of seconds to wait before assuming that an http connection has timed out (defaults
to 60)
.PP
\fB\-\-max_initiate\fR <arg>
.IP
number of peers at which to stop initiating new connections (defaults to 40)
.PP
\fB\-\-check_hashes\fR <arg>
.IP
whether to check hashes on disk (defaults to 1)
.PP
\fB\-\-max_upload_rate\fR <arg>
.IP
maximum kB/s to upload at (0 = no limit, \fB\-1\fR = automatic) (defaults to 0)
.PP
\fB\-\-max_download_rate\fR <arg>
.IP
maximum kB/s to download at (0 = no limit) (defaults to 0)
.PP
\fB\-\-alloc_type\fR <arg>
.IP
allocation type (may be normal, background, pre-allocate or sparse) (defaults to
\&'normal')
.PP
\fB\-\-alloc_rate\fR <arg>
.IP
rate (in MiB/s) to allocate space at using background allocation (defaults to 2.0)
.PP
\fB\-\-buffer_reads\fR <arg>
.IP
whether to buffer disk reads (defaults to 1)
.PP
\fB\-\-write_buffer_size\fR <arg>
.IP
the maximum amount of space to use for buffering disk writes (in megabytes, 0 = disabled)
(defaults to 4)
.PP
\fB\-\-snub_time\fR <arg>
.IP
seconds to wait for data to come in over a connection before assuming it's
semi-permanently choked (defaults to 30.0)
.PP
\fB\-\-spew\fR <arg>
.IP
whether to display diagnostic info to stdout (defaults to 0)
.PP
\fB\-\-rarest_first_cutoff\fR <arg>
.IP
number of downloads at which to switch from random to rarest first (defaults to 2)
.PP
\fB\-\-rarest_first_priority_cutoff\fR <arg>
.IP
the number of peers which need to have a piece before other partials take priority over
rarest first (defaults to 5)
.PP
\fB\-\-min_uploads\fR <arg>
.IP
the number of uploads to fill out to with extra optimistic unchokes (defaults to 4)
.PP
\fB\-\-max_files_open\fR <arg>
.IP
the maximum number of files to keep open at a time, 0 means no limit (defaults to 50)
.PP
\fB\-\-round_robin_period\fR <arg>
.IP
the number of seconds between the client's switching upload targets (defaults to 30)
.PP
\fB\-\-super_seeder\fR <arg>
.IP
whether to use special upload-efficiency-maximizing routines (only for dedicated seeds)
(defaults to 0)
.PP
\fB\-\-security\fR <arg>
.IP
whether to enable extra security features intended to prevent abuse (defaults to 1)
.PP
\fB\-\-max_connections\fR <arg>
.IP
the absolute maximum number of peers to connect with (0 = no limit) (defaults to 0)
.PP
\fB\-\-auto_kick\fR <arg>
.IP
whether to allow the client to automatically kick/ban peers that send bad data (defaults
to 1)
.PP
\fB\-\-double_check\fR <arg>
.IP
whether to double-check data being written to the disk for errors (may increase CPU load)
(defaults to 1)
.PP
\fB\-\-triple_check\fR <arg>
.IP
whether to thoroughly check data being written to the disk (may slow disk access)
(defaults to 0)
.PP
\fB\-\-lock_files\fR <arg>
.IP
whether to lock files the client is working with (defaults to 1)
.PP
\fB\-\-lock_while_reading\fR <arg>
.IP
whether to lock access to files being read (defaults to 0)
.PP
\fB\-\-auto_flush\fR <arg>
.IP
minutes between automatic flushes to disk (0 = disabled) (defaults to 0)