forked from aria2/aria2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.html
678 lines (641 loc) · 14.1 KB
/
README.html
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>aria2 - The ultra fast download utility</title>
</head>
<body>
<div id="header">
<h1>aria2 - The ultra fast download utility</h1>
<span id="author">Tatsuhiro Tsujikawa</span><br />
<span id="email"><tt><<a href="mailto:tujikawa_at_users_dot_sourceforge_dot_net">tujikawa_at_users_dot_sourceforge_dot_net</a>></tt></span><br />
</div>
<h2>1. Disclaimer</h2>
<div class="sectionbody">
<p>This program comes with no warranty.
You must use this program at your own risk.</p>
</div>
<h2>2. Introduction</h2>
<div class="sectionbody">
<p>aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.</p>
<p>Here is a list of features.</p>
<ul>
<li>
<p>
HTTP Proxy support
</p>
</li>
<li>
<p>
HTTP BASIC authentication support
</p>
</li>
<li>
<p>
HTTP Proxy authentication support
</p>
</li>
<li>
<p>
FTP support(active, passive mode)
</p>
</li>
<li>
<p>
FTP through HTTP proxy(GET command or tunneling)
</p>
</li>
<li>
<p>
Multi-source/segmented downloading ability
</p>
</li>
<li>
<p>
Cookie support
</p>
</li>
<li>
<p>
It can load cookies from file whose format is used by Netscape and Mozilla.
</p>
</li>
<li>
<p>
It can run as a daemon process.
</p>
</li>
<li>
<p>
BitTorrent protocol support with fast extension, DHT, encryption, PEX enabled.
</p>
</li>
<li>
<p>
Selective download in multi-file torrent/metalink.
</p>
</li>
<li>
<p>
Metalink version 3.0 support(HTTP/FTP/BitTorrent).
</p>
</li>
<li>
<p>
Limits download/upload speed.
</p>
</li>
<li>
<p>
Chunk checksum validation in Metalink.
</p>
</li>
<li>
<p>
netrc support.
</p>
</li>
<li>
<p>
Configuration file support.
</p>
</li>
<li>
<p>
Downloads URIs found in a text file or stdin.
</p>
</li>
<li>
<p>
Integrates HTTP/FTP/BitTorrent downloads; downloading a file from several
different sources.
</p>
</li>
</ul>
</div>
<h2>3. Dependency</h2>
<div class="sectionbody">
<div class="tableblock">
<table rules="all"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Table: External Library Dependency</caption>
<col width="114" />
<col width="320" />
<thead>
<tr>
<th align="left">
features
</th>
<th align="left">
dependency
</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td align="left">
HTTPS
</td>
<td align="left">
GnuTLS or OpenSSL
</td>
</tr>
<tr>
<td align="left">
BitTorrent
</td>
<td align="left">
GnuTLS+Libgcrypt or OpenSSL
</td>
</tr>
<tr>
<td align="left">
Metalink
</td>
<td align="left">
libxml2 or Expat.
</td>
</tr>
<tr>
<td align="left">
Checksum
</td>
<td align="left">
GnuTLS+Libgcrypt or OpenSSL
</td>
</tr>
</tbody>
</table>
</div>
<dl>
<dt>
Note
</dt>
<dd>
<p>
GNU TLS has precedence over OpenSSL if both libraries are installed.
If you prefer OpenSSL, run configure with "—without-gnutls".
</p>
</dd>
<dt>
Note
</dt>
<dd>
<p>
libxml2 has precedence over Expat if both libraries are installed.
If you prefer Expat, run configure with "—without-libxml2".
</p>
</dd>
</dl>
<p>You can disable BitTorrent, Metalink support by providing —disable-bittorrent,
—disable-metalink respectively to configure script.</p>
<p>In order to enable async DNS support, you need c-ares or ares.</p>
<ul>
<li>
<p>
c-ares: http://daniel.haxx.se/projects/c-ares/
</p>
</li>
<li>
<p>
ares: ftp://athena-dist.mit.edu/pub/ATHENA/ares
</p>
</li>
</ul>
</div>
<h2>4. How to build</h2>
<div class="sectionbody">
<p>In order to build aria2 from the source package, you need following development
packages(package name may vary depending on the distribution you use):</p>
<ul>
<li>
<p>
libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
</p>
</li>
<li>
<p>
libgpg-error-dev (Required for BitTorrent, Checksum support)
</p>
</li>
<li>
<p>
libgcrypt-dev (Required for BitTorrent, Checksum support)
</p>
</li>
<li>
<p>
libares-dev (Required for async DNS support)
</p>
</li>
<li>
<p>
libxml2-dev (Required for Metalink support)
</p>
</li>
</ul>
<p>You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p>
<ul>
<li>
<p>
libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
</p>
</li>
</ul>
<p>You can use libexpat1-dev instead of libxml2-dev:</p>
<ul>
<li>
<p>
libexpat1-dev (Required for Metalink support)
</p>
</li>
</ul>
<p>The build process is fairly standard way for *nix programs:</p>
<div class="listingblock">
<div class="content">
<pre><tt>$ ./configure
$ make</tt></pre>
</div></div>
<p>The executable is aria2c in src directory.</p>
</div>
<h2>5. BitTorrrent</h2>
<div class="sectionbody">
<h3>5.1. About filename</h3>
<p>The filename of the downloaded file is determined as follows:</p>
<dl>
<dt>
single-file mode
</dt>
<dd>
<p>
If "name" key is present in .torrent file, filename is the value of "name"
key. Otherwise, filename is the basename of .torrent file appended by
".file". For example, .torrent file is "test.torrrent", then filename is
"test.torrent.file".
The directory to store the downloaded file can be specified by -d option.
</p>
</dd>
<dt>
multi-file mode
</dt>
<dd>
<p>
The complete directory/file structure mentioned in .torrent file is
created.
The directory to store the top directory of downloaded files can be
specified by -d option.
</p>
</dd>
</dl>
<p>In the default behavior, before download starts, complete directory structure
is created if needed. Then aria2 opens all files mentioned in .torrent file,
directly writes to and reads from these files.
NOTE: Even in selective download, all files are opened.</p>
<p>If "—direct-file-mapping" option set to be false, aria2 creates temporary
file in the store directory. The length of this file is the sum of length of
the files in .torrent file, so at least 2 times more disk space than the file
size itself is required. Writing and reading is done against this file.
After download completes, aria2 creates complete directory structure if needed,
and copies whole file or a part of it to the destination.</p>
<h3>5.2. DHT</h3>
<p>As of release 0.13.0, aria2 supports DHT. The routing table is saved to $HOME/.aria2/dht.dat.</p>
<dl>
<dt>
Note
</dt>
<dd>
<ul>
<li>
<p>
-o option is used to change the filename of .torrent file itself, not a filename of a file in .torrent file.
</p>
</li>
<li>
<p>
The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP.
</p>
</li>
<li>
<p>
aria2 doesn't configure port-forwarding automatically. Please configure your router or firewall manually.
</p>
</li>
<li>
<p>
The maximum number of peers is 55. This limit may be exceeded when download
rate is low.
</p>
</li>
<li>
<p>
As of release 0.10.0, aria2 stops sending request message after selective
download completes,
</p>
</li>
</ul>
</dd>
</dl>
</div>
<h2>6. Metalink</h2>
<div class="sectionbody">
<p>The current implementation supports HTTP/FTP/BitTorrent.
The other P2P protocols are ignored.</p>
<p>For checksum checking, MD5, SHA1, SHA256 are supported. If multiple hash
algorithms are provided, aria2 uses SHA1. If checksum checking is failed, aria2
doesn't retry the download and just exits with non-zero return code.</p>
<p>The supported user preferences are version, language, location, protocol and
os.</p>
<p>If chunk checksums are provided in Metalink file, aria2 automatically validate
a chunk of file while downloading it. This behavior can be turned off by
a command-line option.</p>
</div>
<h2>7. netrc</h2>
<div class="sectionbody">
<p>netrc support is enabled by default in ftp.
To disable netrc support, specify -n command-line option.
Your .netrc file should have correct permissions(600).</p>
</div>
<h2>8. Configuration file</h2>
<div class="sectionbody">
<p>Configuration file must be placed under $HOME/.aria2 and must be named as aria2.conf.
In each line, there is 1 parameter whose syntax is name=value pair,
where name is the long command-line option name without <em>—</em> prefix.
The lines beginning <em>#</em> are treated as comments.</p>
<p>Example:</p>
<div class="listingblock">
<div class="content">
<pre><tt># sample configuration file for aria2c
file-allocation=prealloc
listen-port=60000
seed-ratio=1.0
max-upload-limit=40K
ftp-pasv=true</tt></pre>
</div></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 26-Feb-2008 21:34:01 JST
</div>
</div>
</body>
</html>