README.html 24 KB

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