README.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  2. "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  6. <meta name="generator" content="AsciiDoc 8.5.2" />
  7. <title>aria2 - The ultra fast download utility</title>
  8. <style type="text/css">
  9. /* Debug borders */
  10. p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11. /*
  12. border: 1px solid red;
  13. */
  14. }
  15. body {
  16. margin: 1em 5% 1em 5%;
  17. }
  18. a {
  19. color: blue;
  20. text-decoration: underline;
  21. }
  22. a:visited {
  23. color: fuchsia;
  24. }
  25. em {
  26. font-style: italic;
  27. color: navy;
  28. }
  29. strong {
  30. font-weight: bold;
  31. color: #083194;
  32. }
  33. tt {
  34. color: navy;
  35. }
  36. h1, h2, h3, h4, h5, h6 {
  37. color: #527bbd;
  38. font-family: sans-serif;
  39. margin-top: 1.2em;
  40. margin-bottom: 0.5em;
  41. line-height: 1.3;
  42. }
  43. h1, h2, h3 {
  44. border-bottom: 2px solid silver;
  45. }
  46. h2 {
  47. padding-top: 0.5em;
  48. }
  49. h3 {
  50. float: left;
  51. }
  52. h3 + * {
  53. clear: left;
  54. }
  55. div.sectionbody {
  56. font-family: serif;
  57. margin-left: 0;
  58. }
  59. hr {
  60. border: 1px solid silver;
  61. }
  62. p {
  63. margin-top: 0.5em;
  64. margin-bottom: 0.5em;
  65. }
  66. ul, ol, li > p {
  67. margin-top: 0;
  68. }
  69. pre {
  70. padding: 0;
  71. margin: 0;
  72. }
  73. span#author {
  74. color: #527bbd;
  75. font-family: sans-serif;
  76. font-weight: bold;
  77. font-size: 1.1em;
  78. }
  79. span#email {
  80. }
  81. span#revnumber, span#revdate, span#revremark {
  82. font-family: sans-serif;
  83. }
  84. div#footer {
  85. font-family: sans-serif;
  86. font-size: small;
  87. border-top: 2px solid silver;
  88. padding-top: 0.5em;
  89. margin-top: 4.0em;
  90. }
  91. div#footer-text {
  92. float: left;
  93. padding-bottom: 0.5em;
  94. }
  95. div#footer-badges {
  96. float: right;
  97. padding-bottom: 0.5em;
  98. }
  99. div#preamble {
  100. margin-top: 1.5em;
  101. margin-bottom: 1.5em;
  102. }
  103. div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
  104. div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
  105. div.admonitionblock {
  106. margin-top: 1.0em;
  107. margin-bottom: 1.5em;
  108. }
  109. div.admonitionblock {
  110. margin-top: 2.0em;
  111. margin-bottom: 2.0em;
  112. margin-right: 10%;
  113. color: #606060;
  114. }
  115. div.content { /* Block element content. */
  116. padding: 0;
  117. }
  118. /* Block element titles. */
  119. div.title, caption.title {
  120. color: #527bbd;
  121. font-family: sans-serif;
  122. font-weight: bold;
  123. text-align: left;
  124. margin-top: 1.0em;
  125. margin-bottom: 0.5em;
  126. }
  127. div.title + * {
  128. margin-top: 0;
  129. }
  130. td div.title:first-child {
  131. margin-top: 0.0em;
  132. }
  133. div.content div.title:first-child {
  134. margin-top: 0.0em;
  135. }
  136. div.content + div.title {
  137. margin-top: 0.0em;
  138. }
  139. div.sidebarblock > div.content {
  140. background: #ffffee;
  141. border: 1px solid silver;
  142. padding: 0.5em;
  143. }
  144. div.listingblock > div.content {
  145. border: 1px solid silver;
  146. background: #f4f4f4;
  147. padding: 0.5em;
  148. }
  149. div.quoteblock, div.verseblock {
  150. padding-left: 1.0em;
  151. margin-left: 1.0em;
  152. margin-right: 10%;
  153. border-left: 5px solid #dddddd;
  154. color: #777777;
  155. }
  156. div.quoteblock > div.attribution {
  157. padding-top: 0.5em;
  158. text-align: right;
  159. }
  160. div.verseblock > div.content {
  161. white-space: pre;
  162. }
  163. div.verseblock > div.attribution {
  164. padding-top: 0.75em;
  165. text-align: left;
  166. }
  167. /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
  168. div.verseblock + div.attribution {
  169. text-align: left;
  170. }
  171. div.admonitionblock .icon {
  172. vertical-align: top;
  173. font-size: 1.1em;
  174. font-weight: bold;
  175. text-decoration: underline;
  176. color: #527bbd;
  177. padding-right: 0.5em;
  178. }
  179. div.admonitionblock td.content {
  180. padding-left: 0.5em;
  181. border-left: 3px solid #dddddd;
  182. }
  183. div.exampleblock > div.content {
  184. border-left: 3px solid #dddddd;
  185. padding-left: 0.5em;
  186. }
  187. div.imageblock div.content { padding-left: 0; }
  188. span.image img { border-style: none; }
  189. a.image:visited { color: white; }
  190. dl {
  191. margin-top: 0.8em;
  192. margin-bottom: 0.8em;
  193. }
  194. dt {
  195. margin-top: 0.5em;
  196. margin-bottom: 0;
  197. font-style: normal;
  198. color: navy;
  199. }
  200. dd > *:first-child {
  201. margin-top: 0.1em;
  202. }
  203. ul, ol {
  204. list-style-position: outside;
  205. }
  206. ol.arabic {
  207. list-style-type: decimal;
  208. }
  209. ol.loweralpha {
  210. list-style-type: lower-alpha;
  211. }
  212. ol.upperalpha {
  213. list-style-type: upper-alpha;
  214. }
  215. ol.lowerroman {
  216. list-style-type: lower-roman;
  217. }
  218. ol.upperroman {
  219. list-style-type: upper-roman;
  220. }
  221. div.compact ul, div.compact ol,
  222. div.compact p, div.compact p,
  223. div.compact div, div.compact div {
  224. margin-top: 0.1em;
  225. margin-bottom: 0.1em;
  226. }
  227. div.tableblock > table {
  228. border: 3px solid #527bbd;
  229. }
  230. thead, p.table.header {
  231. font-family: sans-serif;
  232. font-weight: bold;
  233. }
  234. tfoot {
  235. font-weight: bold;
  236. }
  237. td > div.verse {
  238. white-space: pre;
  239. }
  240. p.table {
  241. margin-top: 0;
  242. }
  243. /* Because the table frame attribute is overriden by CSS in most browsers. */
  244. div.tableblock > table[frame="void"] {
  245. border-style: none;
  246. }
  247. div.tableblock > table[frame="hsides"] {
  248. border-left-style: none;
  249. border-right-style: none;
  250. }
  251. div.tableblock > table[frame="vsides"] {
  252. border-top-style: none;
  253. border-bottom-style: none;
  254. }
  255. div.hdlist {
  256. margin-top: 0.8em;
  257. margin-bottom: 0.8em;
  258. }
  259. div.hdlist tr {
  260. padding-bottom: 15px;
  261. }
  262. dt.hdlist1.strong, td.hdlist1.strong {
  263. font-weight: bold;
  264. }
  265. td.hdlist1 {
  266. vertical-align: top;
  267. font-style: normal;
  268. padding-right: 0.8em;
  269. color: navy;
  270. }
  271. td.hdlist2 {
  272. vertical-align: top;
  273. }
  274. div.hdlist.compact tr {
  275. margin: 0;
  276. padding-bottom: 0;
  277. }
  278. .comment {
  279. background: yellow;
  280. }
  281. .footnote, .footnoteref {
  282. font-size: 0.8em;
  283. }
  284. span.footnote, span.footnoteref {
  285. vertical-align: super;
  286. }
  287. #footnotes {
  288. margin: 20px 0 20px 0;
  289. padding: 7px 0 0 0;
  290. }
  291. #footnotes div.footnote {
  292. margin: 0 0 5px 0;
  293. }
  294. #footnotes hr {
  295. border: none;
  296. border-top: 1px solid silver;
  297. height: 1px;
  298. text-align: left;
  299. margin-left: 0;
  300. width: 20%;
  301. min-width: 100px;
  302. }
  303. @media print {
  304. div#footer-badges { display: none; }
  305. }
  306. div#toc {
  307. margin-bottom: 2.5em;
  308. }
  309. div#toctitle {
  310. color: #527bbd;
  311. font-family: sans-serif;
  312. font-size: 1.1em;
  313. font-weight: bold;
  314. margin-top: 1.0em;
  315. margin-bottom: 0.1em;
  316. }
  317. div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  318. margin-top: 0;
  319. margin-bottom: 0;
  320. }
  321. div.toclevel2 {
  322. margin-left: 2em;
  323. font-size: 0.9em;
  324. }
  325. div.toclevel3 {
  326. margin-left: 4em;
  327. font-size: 0.9em;
  328. }
  329. div.toclevel4 {
  330. margin-left: 6em;
  331. font-size: 0.9em;
  332. }
  333. /* Workarounds for IE6's broken and incomplete CSS2. */
  334. div.sidebar-content {
  335. background: #ffffee;
  336. border: 1px solid silver;
  337. padding: 0.5em;
  338. }
  339. div.sidebar-title, div.image-title {
  340. color: #527bbd;
  341. font-family: sans-serif;
  342. font-weight: bold;
  343. margin-top: 0.0em;
  344. margin-bottom: 0.5em;
  345. }
  346. div.listingblock div.content {
  347. border: 1px solid silver;
  348. background: #f4f4f4;
  349. padding: 0.5em;
  350. }
  351. div.quoteblock-attribution {
  352. padding-top: 0.5em;
  353. text-align: right;
  354. }
  355. div.verseblock-content {
  356. white-space: pre;
  357. }
  358. div.verseblock-attribution {
  359. padding-top: 0.75em;
  360. text-align: left;
  361. }
  362. div.exampleblock-content {
  363. border-left: 3px solid #dddddd;
  364. padding-left: 0.5em;
  365. }
  366. /* IE6 sets dynamically generated links as visited. */
  367. div#toc a:visited { color: blue; }
  368. </style>
  369. <script type="text/javascript">
  370. /*<![CDATA[*/
  371. window.onload = function(){asciidoc.footnotes();}
  372. var asciidoc = { // Namespace.
  373. /////////////////////////////////////////////////////////////////////
  374. // Table Of Contents generator
  375. /////////////////////////////////////////////////////////////////////
  376. /* Author: Mihai Bazon, September 2002
  377. * http://students.infoiasi.ro/~mishoo
  378. *
  379. * Table Of Content generator
  380. * Version: 0.4
  381. *
  382. * Feel free to use this script under the terms of the GNU General Public
  383. * License, as long as you do not remove or alter this notice.
  384. */
  385. /* modified by Troy D. Hanson, September 2006. License: GPL */
  386. /* modified by Stuart Rackham, 2006, 2009. License: GPL */
  387. // toclevels = 1..4.
  388. toc: function (toclevels) {
  389. function getText(el) {
  390. var text = "";
  391. for (var i = el.firstChild; i != null; i = i.nextSibling) {
  392. if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
  393. text += i.data;
  394. else if (i.firstChild != null)
  395. text += getText(i);
  396. }
  397. return text;
  398. }
  399. function TocEntry(el, text, toclevel) {
  400. this.element = el;
  401. this.text = text;
  402. this.toclevel = toclevel;
  403. }
  404. function tocEntries(el, toclevels) {
  405. var result = new Array;
  406. var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
  407. // Function that scans the DOM tree for header elements (the DOM2
  408. // nodeIterator API would be a better technique but not supported by all
  409. // browsers).
  410. var iterate = function (el) {
  411. for (var i = el.firstChild; i != null; i = i.nextSibling) {
  412. if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
  413. var mo = re.exec(i.tagName);
  414. if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
  415. result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
  416. }
  417. iterate(i);
  418. }
  419. }
  420. }
  421. iterate(el);
  422. return result;
  423. }
  424. var toc = document.getElementById("toc");
  425. var entries = tocEntries(document.getElementById("content"), toclevels);
  426. for (var i = 0; i < entries.length; ++i) {
  427. var entry = entries[i];
  428. if (entry.element.id == "")
  429. entry.element.id = "_toc_" + i;
  430. var a = document.createElement("a");
  431. a.href = "#" + entry.element.id;
  432. a.appendChild(document.createTextNode(entry.text));
  433. var div = document.createElement("div");
  434. div.appendChild(a);
  435. div.className = "toclevel" + entry.toclevel;
  436. toc.appendChild(div);
  437. }
  438. if (entries.length == 0)
  439. toc.parentNode.removeChild(toc);
  440. },
  441. /////////////////////////////////////////////////////////////////////
  442. // Footnotes generator
  443. /////////////////////////////////////////////////////////////////////
  444. /* Based on footnote generation code from:
  445. * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
  446. */
  447. footnotes: function () {
  448. var cont = document.getElementById("content");
  449. var noteholder = document.getElementById("footnotes");
  450. var spans = cont.getElementsByTagName("span");
  451. var refs = {};
  452. var n = 0;
  453. for (i=0; i<spans.length; i++) {
  454. if (spans[i].className == "footnote") {
  455. n++;
  456. // Use [\s\S] in place of . so multi-line matches work.
  457. // Because JavaScript has no s (dotall) regex flag.
  458. note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
  459. noteholder.innerHTML +=
  460. "<div class='footnote' id='_footnote_" + n + "'>" +
  461. "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
  462. n + "</a>. " + note + "</div>";
  463. spans[i].innerHTML =
  464. "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
  465. "' title='View footnote' class='footnote'>" + n + "</a>]";
  466. var id =spans[i].getAttribute("id");
  467. if (id != null) refs["#"+id] = n;
  468. }
  469. }
  470. if (n == 0)
  471. noteholder.parentNode.removeChild(noteholder);
  472. else {
  473. // Process footnoterefs.
  474. for (i=0; i<spans.length; i++) {
  475. if (spans[i].className == "footnoteref") {
  476. var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
  477. href = href.match(/#.*/)[0]; // Because IE return full URL.
  478. n = refs[href];
  479. spans[i].innerHTML =
  480. "[<a href='#_footnote_" + n +
  481. "' title='View footnote' class='footnote'>" + n + "</a>]";
  482. }
  483. }
  484. }
  485. }
  486. }
  487. /*]]>*/
  488. </script>
  489. </head>
  490. <body>
  491. <div id="header">
  492. <h1>aria2 - The ultra fast download utility</h1>
  493. <span id="author">Tatsuhiro Tsujikawa</span><br />
  494. <span id="email"><tt>&lt;<a href="mailto:tujikawa_at_users_dot_sourceforge_dot_net">tujikawa_at_users_dot_sourceforge_dot_net</a>&gt;</tt></span><br />
  495. </div>
  496. <div id="content">
  497. <h2 id="_disclaimer">1. Disclaimer</h2>
  498. <div class="sectionbody">
  499. <div class="paragraph"><p>This program comes with no warranty.
  500. You must use this program at your own risk.</p></div>
  501. </div>
  502. <h2 id="_introduction">2. Introduction</h2>
  503. <div class="sectionbody">
  504. <div class="paragraph"><p>aria2 is a utility for downloading files. The supported protocols are
  505. HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
  506. multiple sources/protocols and tries to utilize your maximum download
  507. bandwidth. It supports downloading a file from HTTP(S)/FTP and
  508. BitTorrent at the same time, while the data downloaded from
  509. HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink&#8217;s
  510. chunk checksums, aria2 automatically validates chunks of data while
  511. downloading a file like BitTorrent.</p></div>
  512. <div class="paragraph"><p>Here is a list of features.</p></div>
  513. <div class="ulist"><ul>
  514. <li>
  515. <p>
  516. Command-line interface
  517. </p>
  518. </li>
  519. <li>
  520. <p>
  521. Download files through HTTP(S)/FTP/BitTorrent
  522. </p>
  523. </li>
  524. <li>
  525. <p>
  526. Segmented downloading
  527. </p>
  528. </li>
  529. <li>
  530. <p>
  531. Metalink version 4 (RFC5854) support(HTTP/FTP/BitTorrent)
  532. </p>
  533. </li>
  534. <li>
  535. <p>
  536. Metalink version 3.0 support(HTTP/FTP/BitTorrent)
  537. </p>
  538. </li>
  539. <li>
  540. <p>
  541. HTTP/1.1 implementation
  542. </p>
  543. </li>
  544. <li>
  545. <p>
  546. HTTP Proxy support
  547. </p>
  548. </li>
  549. <li>
  550. <p>
  551. HTTP BASIC authentication support
  552. </p>
  553. </li>
  554. <li>
  555. <p>
  556. HTTP Proxy authentication support
  557. </p>
  558. </li>
  559. <li>
  560. <p>
  561. Well-known environment variables for proxy: http_proxy, https_proxy,
  562. ftp_proxy, all_proxy and no_proxy
  563. </p>
  564. </li>
  565. <li>
  566. <p>
  567. HTTP gzip, deflate content encoding support
  568. </p>
  569. </li>
  570. <li>
  571. <p>
  572. Verify peer using given trusted CA certificate in HTTPS
  573. </p>
  574. </li>
  575. <li>
  576. <p>
  577. Client certificate authentication in HTTPS
  578. </p>
  579. </li>
  580. <li>
  581. <p>
  582. Chunked transfer encoding support
  583. </p>
  584. </li>
  585. <li>
  586. <p>
  587. Load Cookies from file using the Firefox3 format, Chromium/Google Chrome
  588. and the Mozilla/Firefox
  589. (1.x/2.x)/Netscape format.
  590. </p>
  591. </li>
  592. <li>
  593. <p>
  594. Save Cookies in the Mozilla/Firefox (1.x/2.x)/Netscape format.
  595. </p>
  596. </li>
  597. <li>
  598. <p>
  599. Custom HTTP Header support
  600. </p>
  601. </li>
  602. <li>
  603. <p>
  604. Persistent Connections support
  605. </p>
  606. </li>
  607. <li>
  608. <p>
  609. FTP through HTTP Proxy
  610. </p>
  611. </li>
  612. <li>
  613. <p>
  614. Download/Upload speed throttling
  615. </p>
  616. </li>
  617. <li>
  618. <p>
  619. BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
  620. </p>
  621. </li>
  622. <li>
  623. <p>
  624. BitTorrent <a href="http://getright.com/seedtorrent.html">WEB-Seeding</a>. aria2
  625. requests chunks more than piece size to reduce the request
  626. overhead. It also supports pipelined requests with piece size.
  627. </p>
  628. </li>
  629. <li>
  630. <p>
  631. BitTorrent Local Peer Discovery
  632. </p>
  633. </li>
  634. <li>
  635. <p>
  636. Rename/change the directory structure of BitTorrent downloads
  637. completely
  638. </p>
  639. </li>
  640. <li>
  641. <p>
  642. XML-RPC interface
  643. </p>
  644. </li>
  645. <li>
  646. <p>
  647. Run as a daemon process
  648. </p>
  649. </li>
  650. <li>
  651. <p>
  652. Selective download in multi-file torrent/Metalink
  653. </p>
  654. </li>
  655. <li>
  656. <p>
  657. Chunk checksum validation in Metalink
  658. </p>
  659. </li>
  660. <li>
  661. <p>
  662. Can disable segmented downloading in Metalink
  663. </p>
  664. </li>
  665. <li>
  666. <p>
  667. Netrc support
  668. </p>
  669. </li>
  670. <li>
  671. <p>
  672. Configuration file support
  673. </p>
  674. </li>
  675. <li>
  676. <p>
  677. Download URIs found in a text file or stdin and the destination directory and
  678. output filename can be specified optionally
  679. </p>
  680. </li>
  681. <li>
  682. <p>
  683. Parameterized URI support
  684. </p>
  685. </li>
  686. <li>
  687. <p>
  688. IPv6 support
  689. </p>
  690. </li>
  691. </ul></div>
  692. </div>
  693. <h2 id="_dependency">3. Dependency</h2>
  694. <div class="sectionbody">
  695. <div class="tableblock">
  696. <table rules="all"
  697. width="100%"
  698. frame="border"
  699. cellspacing="0" cellpadding="4">
  700. <caption class="title">Table 1. External Library Dependency</caption>
  701. <col width="50%" />
  702. <col width="50%" />
  703. <thead>
  704. <tr>
  705. <th align="left" valign="top">features </th>
  706. <th align="left" valign="top">dependency</th>
  707. </tr>
  708. </thead>
  709. <tbody>
  710. <tr>
  711. <td align="left" valign="top"><p class="table">HTTPS</p></td>
  712. <td align="left" valign="top"><p class="table">GnuTLS or OpenSSL</p></td>
  713. </tr>
  714. <tr>
  715. <td align="left" valign="top"><p class="table">BitTorrent</p></td>
  716. <td align="left" valign="top"><p class="table">GnuTLS+Libgcrypt or OpenSSL</p></td>
  717. </tr>
  718. <tr>
  719. <td align="left" valign="top"><p class="table">Metalink</p></td>
  720. <td align="left" valign="top"><p class="table">libxml2 or Expat.</p></td>
  721. </tr>
  722. <tr>
  723. <td align="left" valign="top"><p class="table">Checksum</p></td>
  724. <td align="left" valign="top"><p class="table">GnuTLS+Libgcrypt or OpenSSL</p></td>
  725. </tr>
  726. <tr>
  727. <td align="left" valign="top"><p class="table">gzip, deflate in HTTP</p></td>
  728. <td align="left" valign="top"><p class="table">zlib</p></td>
  729. </tr>
  730. <tr>
  731. <td align="left" valign="top"><p class="table">Async DNS</p></td>
  732. <td align="left" valign="top"><p class="table">C-Ares</p></td>
  733. </tr>
  734. <tr>
  735. <td align="left" valign="top"><p class="table">Firefox3/Chromium cookie</p></td>
  736. <td align="left" valign="top"><p class="table">libsqlite3</p></td>
  737. </tr>
  738. <tr>
  739. <td align="left" valign="top"><p class="table">XML-RPC</p></td>
  740. <td align="left" valign="top"><p class="table">libxml2 or Expat.</p></td>
  741. </tr>
  742. </tbody>
  743. </table>
  744. </div>
  745. <div class="dlist"><dl>
  746. <dt class="hdlist1">
  747. Note
  748. </dt>
  749. <dd>
  750. <p>
  751. GNU TLS has precedence over OpenSSL if both libraries are installed.
  752. If you prefer OpenSSL, run configure with --without-gnutls.
  753. </p>
  754. </dd>
  755. <dt class="hdlist1">
  756. Note
  757. </dt>
  758. <dd>
  759. <p>
  760. libxml2 has precedence over Expat if both libraries are installed.
  761. If you prefer Expat, run configure with --without-libxml2.
  762. </p>
  763. </dd>
  764. </dl></div>
  765. <div class="paragraph"><p>You can disable BitTorrent, Metalink support by providing
  766. --disable-bittorrent, --disable-metalink respectively to configure
  767. script.</p></div>
  768. <div class="paragraph"><p>In order to enable async DNS support, you need c-ares.</p></div>
  769. <div class="ulist"><ul>
  770. <li>
  771. <p>
  772. c-ares: <a href="http://daniel.haxx.se/projects/c-ares/">http://daniel.haxx.se/projects/c-ares/</a>
  773. </p>
  774. </li>
  775. </ul></div>
  776. </div>
  777. <h2 id="_how_to_build">4. How to build</h2>
  778. <div class="sectionbody">
  779. <div class="paragraph"><p>In order to build aria2 from the source package, you need following
  780. development packages(package name may vary depending on the
  781. distribution you use):</p></div>
  782. <div class="ulist"><ul>
  783. <li>
  784. <p>
  785. libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
  786. </p>
  787. </li>
  788. <li>
  789. <p>
  790. libgpg-error-dev (Required for BitTorrent, Checksum support)
  791. </p>
  792. </li>
  793. <li>
  794. <p>
  795. libgcrypt-dev (Required for BitTorrent, Checksum support)
  796. </p>
  797. </li>
  798. <li>
  799. <p>
  800. libc-ares-dev (Required for async DNS support)
  801. </p>
  802. </li>
  803. <li>
  804. <p>
  805. libxml2-dev (Required for Metalink support)
  806. </p>
  807. </li>
  808. <li>
  809. <p>
  810. zlib1g-dev (Required for gzip, deflate decoding support in HTTP)
  811. </p>
  812. </li>
  813. <li>
  814. <p>
  815. libsqlite3-dev (Required for Firefox3/Chromium cookie support)
  816. </p>
  817. </li>
  818. </ul></div>
  819. <div class="paragraph"><p>You can use libssl-dev instead of
  820. libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
  821. <div class="ulist"><ul>
  822. <li>
  823. <p>
  824. libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
  825. </p>
  826. </li>
  827. </ul></div>
  828. <div class="paragraph"><p>You can use libexpat1-dev instead of libxml2-dev:</p></div>
  829. <div class="ulist"><ul>
  830. <li>
  831. <p>
  832. libexpat1-dev (Required for Metalink support)
  833. </p>
  834. </li>
  835. </ul></div>
  836. <div class="paragraph"><p>You may also need pkg-config to detect the above mentioned libraries.</p></div>
  837. <div class="paragraph"><p>The quickest way to build aria2 is just type following commands:</p></div>
  838. <div class="listingblock">
  839. <div class="content">
  840. <pre><tt>$ ./configure
  841. $ make</tt></pre>
  842. </div></div>
  843. <div class="paragraph"><p>The configure script checks available libraries and enables the features
  844. as much as possible because all the features are enabled by default.</p></div>
  845. <div class="paragraph"><p>Since 1.1.0, aria2 checks the certificate of HTTPS servers by default.
  846. If you build with HTTPS support, I recommend to supply the path to the
  847. CA bundle file. For example, in Debian the path to CA bundle file is
  848. <em>/etc/ssl/certs/ca-certificates.crt</em> (in ca-certificates package). This
  849. may vary depending on your distribution. You can give it to
  850. configure script using --with-ca-bundle option:</p></div>
  851. <div class="listingblock">
  852. <div class="content">
  853. <pre><tt>$ ./configure --with-ca-bundle='/etc/ssl/certs/ca-certificates.crt'
  854. $ make</tt></pre>
  855. </div></div>
  856. <div class="paragraph"><p>Without --with-ca-bundle option, you will encounter the error when
  857. accessing HTTPS servers because the certificate cannot be verified
  858. without CA bundle. In such case, you can specify the CA bundle file
  859. using aria2&#8217;s --ca-certificate option. If you don&#8217;t have CA bundle
  860. file installed, then the last resort is disable the certificate
  861. validation using --check-certificate=false.</p></div>
  862. <div class="paragraph"><p>The executable is <em>aria2c</em> in src directory.</p></div>
  863. <div class="paragraph"><p>aria2 uses CppUnit for automated unit testing. To run the unit test:</p></div>
  864. <div class="listingblock">
  865. <div class="content">
  866. <pre><tt>$ make check</tt></pre>
  867. </div></div>
  868. </div>
  869. <h2 id="_bittorrrent">5. BitTorrrent</h2>
  870. <div class="sectionbody">
  871. <h3 id="_about_filename">5.1. About filename</h3><div style="clear:left"></div>
  872. <div class="paragraph"><p>The filename of the downloaded file is determined as follows:</p></div>
  873. <div class="dlist"><dl>
  874. <dt class="hdlist1">
  875. single-file mode
  876. </dt>
  877. <dd>
  878. <p>
  879. If "name" key is present in .torrent file, filename is the value
  880. of "name" key. Otherwise, filename is the basename of .torrent
  881. file appended by ".file". For example, .torrent file is
  882. "test.torrrent", then filename is "test.torrent.file". The
  883. directory to store the downloaded file can be specified by -d
  884. option.
  885. </p>
  886. </dd>
  887. <dt class="hdlist1">
  888. multi-file mode
  889. </dt>
  890. <dd>
  891. <p>
  892. The complete directory/file structure mentioned in .torrent file
  893. is created. The directory to store the top directory of
  894. downloaded files can be specified by -d option.
  895. </p>
  896. </dd>
  897. </dl></div>
  898. <div class="paragraph"><p>Before download starts, a complete directory structure is created if
  899. needed. By default, aria2 opens at most 100 files mentioned in
  900. .torrent file, and directly writes to and reads from these files.
  901. The number of files to open simultaneously can be controlled by
  902. --bt-max-open-files option.</p></div>
  903. <h3 id="_dht">5.2. DHT</h3><div style="clear:left"></div>
  904. <div class="paragraph"><p>aria2 supports mainline compatible DHT. By default, the routing table
  905. for IPv4 DHT is saved to $HOME/.aria2/dht.dat and the routing table
  906. for IPv6 DHT is saved to $HOME/.aria2/dht6.dat. aria2 uses same port
  907. number to listen on for both IPv4 and IPv6 DHT.</p></div>
  908. <h3 id="_other_things_should_be_noted">5.3. Other things should be noted</h3><div style="clear:left"></div>
  909. <div class="ulist"><ul>
  910. <li>
  911. <p>
  912. -o option is used to change the filename of .torrent file itself,
  913. not a filename of a file in .torrent file. For this purpose, use
  914. --index-out option instead.
  915. </p>
  916. </li>
  917. <li>
  918. <p>
  919. The port numbers that aria2 uses by default are 6881-6999 for TCP
  920. and UDP.
  921. </p>
  922. </li>
  923. <li>
  924. <p>
  925. aria2 doesn&#8217;t configure port-forwarding automatically. Please
  926. configure your router or firewall manually.
  927. </p>
  928. </li>
  929. <li>
  930. <p>
  931. The maximum number of peers is 55. This limit may be exceeded when
  932. download rate is low. This download rate can be adjusted using
  933. --bt-request-peer-speed-limit option.
  934. </p>
  935. </li>
  936. <li>
  937. <p>
  938. As of release 0.10.0, aria2 stops sending request message after
  939. selective download completes.
  940. </p>
  941. </li>
  942. </ul></div>
  943. </div>
  944. <h2 id="_metalink">6. Metalink</h2>
  945. <div class="sectionbody">
  946. <div class="paragraph"><p>The current implementation supports HTTP(S)/FTP/BitTorrent. The other
  947. P2P protocols are ignored. Both Metalink4 and Metalink version 3.0
  948. documents are supported.</p></div>
  949. <div class="paragraph"><p>For checksum verification, MD5, SHA1, and SHA256 are supported. If
  950. multiple hash algorithms are provided, aria2 uses stronger one. If
  951. whole file checksum verification fails, aria2 doesn&#8217;t retry the
  952. download and just exits with non-zero return code.</p></div>
  953. <div class="paragraph"><p>The supported user preferences are version, language, location,
  954. protocol and os.</p></div>
  955. <div class="paragraph"><p>If chunk checksums are provided in Metalink file, aria2 automatically
  956. validates chunks of data during download. This behavior can be turned
  957. off by a command-line option.</p></div>
  958. <div class="paragraph"><p>If signature is included in a Metalink file, aria2 saves it as a file
  959. after the completion of the download. The filename is download
  960. filename + ".sig". If same file already exists, the signature file is
  961. not saved.</p></div>
  962. <div class="paragraph"><p>In Metalink4, multi-file torrent could appear in metalink:metaurl
  963. element. Since aria2 cannot download 2 same torrents at the same
  964. time, aria2 groups files in metalink:file element which has same
  965. BitTorrent metaurl and downloads them from a single BitTorrent swarm.
  966. This is basically multi-file torrent download with file selection, so
  967. the adjacent files which is not in Metalink document but shares same
  968. piece with selected file are also created.</p></div>
  969. </div>
  970. <h2 id="_netrc">7. netrc</h2>
  971. <div class="sectionbody">
  972. <div class="paragraph"><p>netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
  973. support, specify -n command-line option. Your .netrc file should have
  974. correct permissions(600).</p></div>
  975. </div>
  976. <h2 id="_references">8. References</h2>
  977. <div class="sectionbody">
  978. <div class="ulist"><ul>
  979. <li>
  980. <p>
  981. man aria2c
  982. </p>
  983. </li>
  984. <li>
  985. <p>
  986. <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a>
  987. </p>
  988. </li>
  989. <li>
  990. <p>
  991. <a href="http://sourceforge.net/apps/trac/aria2/wiki">http://sourceforge.net/apps/trac/aria2/wiki</a>
  992. </p>
  993. </li>
  994. <li>
  995. <p>
  996. <a href="http://tools.ietf.org/html/rfc5854">http://tools.ietf.org/html/rfc5854</a>
  997. </p>
  998. </li>
  999. </ul></div>
  1000. </div>
  1001. </div>
  1002. <div id="footnotes"><hr /></div>
  1003. <div id="footer">
  1004. <div id="footer-text">
  1005. Last updated 2010-08-22 20:35:26 JST
  1006. </div>
  1007. </div>
  1008. </body>
  1009. </html>