README.html 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102
  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>The project page is located at <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a>.</p></div>
  513. <div class="paragraph"><p>See <a href="http://aria2.sourceforge.net/aria2c.1.html">aria2 Online Manual</a>
  514. and <a href="http://sourceforge.net/apps/trac/aria2/wiki/UsageExample">the usage
  515. example</a> to learn how to use aria2.</p></div>
  516. </div>
  517. <h2 id="_features">3. Features</h2>
  518. <div class="sectionbody">
  519. <div class="paragraph"><p>Here is a list of features:</p></div>
  520. <div class="ulist"><ul>
  521. <li>
  522. <p>
  523. Command-line interface
  524. </p>
  525. </li>
  526. <li>
  527. <p>
  528. Download files through HTTP(S)/FTP/BitTorrent
  529. </p>
  530. </li>
  531. <li>
  532. <p>
  533. Segmented downloading
  534. </p>
  535. </li>
  536. <li>
  537. <p>
  538. Metalink version 4 (RFC5854) support(HTTP/FTP/BitTorrent)
  539. </p>
  540. </li>
  541. <li>
  542. <p>
  543. Metalink version 3.0 support(HTTP/FTP/BitTorrent)
  544. </p>
  545. </li>
  546. <li>
  547. <p>
  548. HTTP/1.1 implementation
  549. </p>
  550. </li>
  551. <li>
  552. <p>
  553. HTTP Proxy support
  554. </p>
  555. </li>
  556. <li>
  557. <p>
  558. HTTP BASIC authentication support
  559. </p>
  560. </li>
  561. <li>
  562. <p>
  563. HTTP Proxy authentication support
  564. </p>
  565. </li>
  566. <li>
  567. <p>
  568. Well-known environment variables for proxy: http_proxy, https_proxy,
  569. ftp_proxy, all_proxy and no_proxy
  570. </p>
  571. </li>
  572. <li>
  573. <p>
  574. HTTP gzip, deflate content encoding support
  575. </p>
  576. </li>
  577. <li>
  578. <p>
  579. Verify peer using given trusted CA certificate in HTTPS
  580. </p>
  581. </li>
  582. <li>
  583. <p>
  584. Client certificate authentication in HTTPS
  585. </p>
  586. </li>
  587. <li>
  588. <p>
  589. Chunked transfer encoding support
  590. </p>
  591. </li>
  592. <li>
  593. <p>
  594. Load Cookies from file using the Firefox3 format, Chromium/Google Chrome
  595. and the Mozilla/Firefox
  596. (1.x/2.x)/Netscape format.
  597. </p>
  598. </li>
  599. <li>
  600. <p>
  601. Save Cookies in the Mozilla/Firefox (1.x/2.x)/Netscape format.
  602. </p>
  603. </li>
  604. <li>
  605. <p>
  606. Custom HTTP Header support
  607. </p>
  608. </li>
  609. <li>
  610. <p>
  611. Persistent Connections support
  612. </p>
  613. </li>
  614. <li>
  615. <p>
  616. FTP through HTTP Proxy
  617. </p>
  618. </li>
  619. <li>
  620. <p>
  621. Download/Upload speed throttling
  622. </p>
  623. </li>
  624. <li>
  625. <p>
  626. BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
  627. </p>
  628. </li>
  629. <li>
  630. <p>
  631. BitTorrent <a href="http://getright.com/seedtorrent.html">WEB-Seeding</a>. aria2
  632. requests chunks more than piece size to reduce the request
  633. overhead. It also supports pipelined requests with piece size.
  634. </p>
  635. </li>
  636. <li>
  637. <p>
  638. BitTorrent Local Peer Discovery
  639. </p>
  640. </li>
  641. <li>
  642. <p>
  643. Rename/change the directory structure of BitTorrent downloads
  644. completely
  645. </p>
  646. </li>
  647. <li>
  648. <p>
  649. XML-RPC interface
  650. </p>
  651. </li>
  652. <li>
  653. <p>
  654. Run as a daemon process
  655. </p>
  656. </li>
  657. <li>
  658. <p>
  659. Selective download in multi-file torrent/Metalink
  660. </p>
  661. </li>
  662. <li>
  663. <p>
  664. Chunk checksum validation in Metalink
  665. </p>
  666. </li>
  667. <li>
  668. <p>
  669. Can disable segmented downloading in Metalink
  670. </p>
  671. </li>
  672. <li>
  673. <p>
  674. Netrc support
  675. </p>
  676. </li>
  677. <li>
  678. <p>
  679. Configuration file support
  680. </p>
  681. </li>
  682. <li>
  683. <p>
  684. Download URIs found in a text file or stdin and the destination directory and
  685. output filename can be specified optionally
  686. </p>
  687. </li>
  688. <li>
  689. <p>
  690. Parameterized URI support
  691. </p>
  692. </li>
  693. <li>
  694. <p>
  695. IPv6 support
  696. </p>
  697. </li>
  698. </ul></div>
  699. </div>
  700. <h2 id="_how_to_get_source_code">4. How to get source code</h2>
  701. <div class="sectionbody">
  702. <div class="paragraph"><p>We maintain the source code at Github:
  703. <a href="http://github.com/tatsuhiro-t/aria2">http://github.com/tatsuhiro-t/aria2</a></p></div>
  704. <div class="paragraph"><p>To download the latest source code, run following command:</p></div>
  705. <div class="listingblock">
  706. <div class="content">
  707. <pre><tt>git clone git://github.com/tatsuhiro-t/aria2.git</tt></pre>
  708. </div></div>
  709. <div class="paragraph"><p>This will create aria2 directory in your current directory and source
  710. files are stored there.</p></div>
  711. </div>
  712. <h2 id="_dependency">5. Dependency</h2>
  713. <div class="sectionbody">
  714. <div class="tableblock">
  715. <table rules="all"
  716. width="100%"
  717. frame="border"
  718. cellspacing="0" cellpadding="4">
  719. <caption class="title">Table 1. External Library Dependency</caption>
  720. <col width="50%" />
  721. <col width="50%" />
  722. <thead>
  723. <tr>
  724. <th align="left" valign="top">features </th>
  725. <th align="left" valign="top">dependency</th>
  726. </tr>
  727. </thead>
  728. <tbody>
  729. <tr>
  730. <td align="left" valign="top"><p class="table">HTTPS</p></td>
  731. <td align="left" valign="top"><p class="table">GnuTLS or OpenSSL</p></td>
  732. </tr>
  733. <tr>
  734. <td align="left" valign="top"><p class="table">BitTorrent</p></td>
  735. <td align="left" valign="top"><p class="table">GnuTLS+Libgcrypt or OpenSSL</p></td>
  736. </tr>
  737. <tr>
  738. <td align="left" valign="top"><p class="table">Metalink</p></td>
  739. <td align="left" valign="top"><p class="table">libxml2 or Expat.</p></td>
  740. </tr>
  741. <tr>
  742. <td align="left" valign="top"><p class="table">Checksum</p></td>
  743. <td align="left" valign="top"><p class="table">GnuTLS+Libgcrypt or OpenSSL</p></td>
  744. </tr>
  745. <tr>
  746. <td align="left" valign="top"><p class="table">gzip, deflate in HTTP</p></td>
  747. <td align="left" valign="top"><p class="table">zlib</p></td>
  748. </tr>
  749. <tr>
  750. <td align="left" valign="top"><p class="table">Async DNS</p></td>
  751. <td align="left" valign="top"><p class="table">C-Ares</p></td>
  752. </tr>
  753. <tr>
  754. <td align="left" valign="top"><p class="table">Firefox3/Chromium cookie</p></td>
  755. <td align="left" valign="top"><p class="table">libsqlite3</p></td>
  756. </tr>
  757. <tr>
  758. <td align="left" valign="top"><p class="table">XML-RPC</p></td>
  759. <td align="left" valign="top"><p class="table">libxml2 or Expat.</p></td>
  760. </tr>
  761. </tbody>
  762. </table>
  763. </div>
  764. <div class="dlist"><dl>
  765. <dt class="hdlist1">
  766. Note
  767. </dt>
  768. <dd>
  769. <p>
  770. GNU TLS has precedence over OpenSSL if both libraries are installed.
  771. If you prefer OpenSSL, run configure with --without-gnutls.
  772. </p>
  773. </dd>
  774. <dt class="hdlist1">
  775. Note
  776. </dt>
  777. <dd>
  778. <p>
  779. libxml2 has precedence over Expat if both libraries are installed.
  780. If you prefer Expat, run configure with --without-libxml2.
  781. </p>
  782. </dd>
  783. </dl></div>
  784. <div class="paragraph"><p>You can disable BitTorrent, Metalink support by providing
  785. --disable-bittorrent, --disable-metalink respectively to configure
  786. script.</p></div>
  787. <div class="paragraph"><p>In order to enable async DNS support, you need c-ares.</p></div>
  788. <div class="ulist"><ul>
  789. <li>
  790. <p>
  791. c-ares: <a href="http://daniel.haxx.se/projects/c-ares/">http://daniel.haxx.se/projects/c-ares/</a>
  792. </p>
  793. </li>
  794. </ul></div>
  795. </div>
  796. <h2 id="_how_to_build">6. How to build</h2>
  797. <div class="sectionbody">
  798. <div class="paragraph"><p>In order to build aria2 from the source package, you need following
  799. development packages(package name may vary depending on the
  800. distribution you use):</p></div>
  801. <div class="ulist"><ul>
  802. <li>
  803. <p>
  804. libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
  805. </p>
  806. </li>
  807. <li>
  808. <p>
  809. libgpg-error-dev (Required for BitTorrent, Checksum support)
  810. </p>
  811. </li>
  812. <li>
  813. <p>
  814. libgcrypt-dev (Required for BitTorrent, Checksum support)
  815. </p>
  816. </li>
  817. <li>
  818. <p>
  819. libc-ares-dev (Required for async DNS support)
  820. </p>
  821. </li>
  822. <li>
  823. <p>
  824. libxml2-dev (Required for Metalink support)
  825. </p>
  826. </li>
  827. <li>
  828. <p>
  829. zlib1g-dev (Required for gzip, deflate decoding support in HTTP)
  830. </p>
  831. </li>
  832. <li>
  833. <p>
  834. libsqlite3-dev (Required for Firefox3/Chromium cookie support)
  835. </p>
  836. </li>
  837. </ul></div>
  838. <div class="paragraph"><p>You can use libssl-dev instead of
  839. libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
  840. <div class="ulist"><ul>
  841. <li>
  842. <p>
  843. libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
  844. </p>
  845. </li>
  846. </ul></div>
  847. <div class="paragraph"><p>You can use libexpat1-dev instead of libxml2-dev:</p></div>
  848. <div class="ulist"><ul>
  849. <li>
  850. <p>
  851. libexpat1-dev (Required for Metalink support)
  852. </p>
  853. </li>
  854. </ul></div>
  855. <div class="paragraph"><p>You may also need pkg-config to detect the above mentioned libraries.</p></div>
  856. <div class="paragraph"><p>If you downloaded source code from git repository, you have to run
  857. following command to generate configure script and other files
  858. necessary to build the program:</p></div>
  859. <div class="listingblock">
  860. <div class="content">
  861. <pre><tt>$ autoreconf -i</tt></pre>
  862. </div></div>
  863. <div class="paragraph"><p>The quickest way to build aria2 is just type following commands:</p></div>
  864. <div class="listingblock">
  865. <div class="content">
  866. <pre><tt>$ ./configure
  867. $ make</tt></pre>
  868. </div></div>
  869. <div class="paragraph"><p>The configure script checks available libraries and enables the features
  870. as much as possible because all the features are enabled by default.</p></div>
  871. <div class="paragraph"><p>Since 1.1.0, aria2 checks the certificate of HTTPS servers by default.
  872. If you build with HTTPS support, I recommend to supply the path to the
  873. CA bundle file. For example, in Debian the path to CA bundle file is
  874. <em>/etc/ssl/certs/ca-certificates.crt</em> (in ca-certificates package). This
  875. may vary depending on your distribution. You can give it to
  876. configure script using --with-ca-bundle option:</p></div>
  877. <div class="listingblock">
  878. <div class="content">
  879. <pre><tt>$ ./configure --with-ca-bundle='/etc/ssl/certs/ca-certificates.crt'
  880. $ make</tt></pre>
  881. </div></div>
  882. <div class="paragraph"><p>Without --with-ca-bundle option, you will encounter the error when
  883. accessing HTTPS servers because the certificate cannot be verified
  884. without CA bundle. In such case, you can specify the CA bundle file
  885. using aria2&#8217;s --ca-certificate option. If you don&#8217;t have CA bundle
  886. file installed, then the last resort is disable the certificate
  887. validation using --check-certificate=false.</p></div>
  888. <div class="paragraph"><p>The executable is <em>aria2c</em> in src directory.</p></div>
  889. <div class="paragraph"><p>aria2 uses CppUnit for automated unit testing. To run the unit test:</p></div>
  890. <div class="listingblock">
  891. <div class="content">
  892. <pre><tt>$ make check</tt></pre>
  893. </div></div>
  894. </div>
  895. <h2 id="_bittorrrent">7. BitTorrrent</h2>
  896. <div class="sectionbody">
  897. <h3 id="_about_filename">7.1. About filename</h3><div style="clear:left"></div>
  898. <div class="paragraph"><p>The filename of the downloaded file is determined as follows:</p></div>
  899. <div class="dlist"><dl>
  900. <dt class="hdlist1">
  901. single-file mode
  902. </dt>
  903. <dd>
  904. <p>
  905. If "name" key is present in .torrent file, filename is the value
  906. of "name" key. Otherwise, filename is the basename of .torrent
  907. file appended by ".file". For example, .torrent file is
  908. "test.torrrent", then filename is "test.torrent.file". The
  909. directory to store the downloaded file can be specified by -d
  910. option.
  911. </p>
  912. </dd>
  913. <dt class="hdlist1">
  914. multi-file mode
  915. </dt>
  916. <dd>
  917. <p>
  918. The complete directory/file structure mentioned in .torrent file
  919. is created. The directory to store the top directory of
  920. downloaded files can be specified by -d option.
  921. </p>
  922. </dd>
  923. </dl></div>
  924. <div class="paragraph"><p>Before download starts, a complete directory structure is created if
  925. needed. By default, aria2 opens at most 100 files mentioned in
  926. .torrent file, and directly writes to and reads from these files.
  927. The number of files to open simultaneously can be controlled by
  928. --bt-max-open-files option.</p></div>
  929. <h3 id="_dht">7.2. DHT</h3><div style="clear:left"></div>
  930. <div class="paragraph"><p>aria2 supports mainline compatible DHT. By default, the routing table
  931. for IPv4 DHT is saved to $HOME/.aria2/dht.dat and the routing table
  932. for IPv6 DHT is saved to $HOME/.aria2/dht6.dat. aria2 uses same port
  933. number to listen on for both IPv4 and IPv6 DHT.</p></div>
  934. <h3 id="_other_things_should_be_noted">7.3. Other things should be noted</h3><div style="clear:left"></div>
  935. <div class="ulist"><ul>
  936. <li>
  937. <p>
  938. -o option is used to change the filename of .torrent file itself,
  939. not a filename of a file in .torrent file. For this purpose, use
  940. --index-out option instead.
  941. </p>
  942. </li>
  943. <li>
  944. <p>
  945. The port numbers that aria2 uses by default are 6881-6999 for TCP
  946. and UDP.
  947. </p>
  948. </li>
  949. <li>
  950. <p>
  951. aria2 doesn&#8217;t configure port-forwarding automatically. Please
  952. configure your router or firewall manually.
  953. </p>
  954. </li>
  955. <li>
  956. <p>
  957. The maximum number of peers is 55. This limit may be exceeded when
  958. download rate is low. This download rate can be adjusted using
  959. --bt-request-peer-speed-limit option.
  960. </p>
  961. </li>
  962. <li>
  963. <p>
  964. As of release 0.10.0, aria2 stops sending request message after
  965. selective download completes.
  966. </p>
  967. </li>
  968. </ul></div>
  969. </div>
  970. <h2 id="_metalink">8. Metalink</h2>
  971. <div class="sectionbody">
  972. <div class="paragraph"><p>The current implementation supports HTTP(S)/FTP/BitTorrent. The other
  973. P2P protocols are ignored. Both Metalink4 and Metalink version 3.0
  974. documents are supported.</p></div>
  975. <div class="paragraph"><p>For checksum verification, md5, sha-1, sha-224, sha-256, sha-384 and
  976. sha-512 are supported. If multiple hash algorithms are provided, aria2
  977. uses stronger one. If whole file checksum verification fails, aria2
  978. doesn&#8217;t retry the download and just exits with non-zero return code.</p></div>
  979. <div class="paragraph"><p>The supported user preferences are version, language, location,
  980. protocol and os.</p></div>
  981. <div class="paragraph"><p>If chunk checksums are provided in Metalink file, aria2 automatically
  982. validates chunks of data during download. This behavior can be turned
  983. off by a command-line option.</p></div>
  984. <div class="paragraph"><p>If signature is included in a Metalink file, aria2 saves it as a file
  985. after the completion of the download. The filename is download
  986. filename + ".sig". If same file already exists, the signature file is
  987. not saved.</p></div>
  988. <div class="paragraph"><p>In Metalink4, multi-file torrent could appear in metalink:metaurl
  989. element. Since aria2 cannot download 2 same torrents at the same
  990. time, aria2 groups files in metalink:file element which has same
  991. BitTorrent metaurl and downloads them from a single BitTorrent swarm.
  992. This is basically multi-file torrent download with file selection, so
  993. the adjacent files which is not in Metalink document but shares same
  994. piece with selected file are also created.</p></div>
  995. </div>
  996. <h2 id="_netrc">9. netrc</h2>
  997. <div class="sectionbody">
  998. <div class="paragraph"><p>netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
  999. support, specify -n command-line option. Your .netrc file should have
  1000. correct permissions(600).</p></div>
  1001. </div>
  1002. <h2 id="_references">10. References</h2>
  1003. <div class="sectionbody">
  1004. <div class="ulist"><ul>
  1005. <li>
  1006. <p>
  1007. <a href="http://aria2.sourceforge.net/aria2c.1.html">aria2 Online Manual</a>
  1008. </p>
  1009. </li>
  1010. <li>
  1011. <p>
  1012. <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a>
  1013. </p>
  1014. </li>
  1015. <li>
  1016. <p>
  1017. <a href="http://sourceforge.net/apps/trac/aria2/wiki">http://sourceforge.net/apps/trac/aria2/wiki</a>
  1018. </p>
  1019. </li>
  1020. <li>
  1021. <p>
  1022. <a href="http://github.com/tatsuhiro-t/aria2">http://github.com/tatsuhiro-t/aria2</a>
  1023. </p>
  1024. </li>
  1025. <li>
  1026. <p>
  1027. <a href="http://tools.ietf.org/html/rfc5854">http://tools.ietf.org/html/rfc5854</a>
  1028. </p>
  1029. </li>
  1030. </ul></div>
  1031. </div>
  1032. </div>
  1033. <div id="footnotes"><hr /></div>
  1034. <div id="footer">
  1035. <div id="footer-text">
  1036. Last updated 2010-11-28 01:13:54 JST
  1037. </div>
  1038. </div>
  1039. </body>
  1040. </html>