README.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867
  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.4.4" />
  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#revision {
  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.5em;
  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. div.imageblock img { border: 1px solid silver; }
  188. span.image img { border-style: none; }
  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. @media print {
  281. div#footer-badges { display: none; }
  282. }
  283. div#toctitle {
  284. color: #527bbd;
  285. font-family: sans-serif;
  286. font-size: 1.1em;
  287. font-weight: bold;
  288. margin-top: 1.0em;
  289. margin-bottom: 0.1em;
  290. }
  291. div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  292. margin-top: 0;
  293. margin-bottom: 0;
  294. }
  295. div.toclevel2 {
  296. margin-left: 2em;
  297. font-size: 0.9em;
  298. }
  299. div.toclevel3 {
  300. margin-left: 4em;
  301. font-size: 0.9em;
  302. }
  303. div.toclevel4 {
  304. margin-left: 6em;
  305. font-size: 0.9em;
  306. }
  307. /* Workarounds for IE6's broken and incomplete CSS2. */
  308. div.sidebar-content {
  309. background: #ffffee;
  310. border: 1px solid silver;
  311. padding: 0.5em;
  312. }
  313. div.sidebar-title, div.image-title {
  314. color: #527bbd;
  315. font-family: sans-serif;
  316. font-weight: bold;
  317. margin-top: 0.0em;
  318. margin-bottom: 0.5em;
  319. }
  320. div.listingblock div.content {
  321. border: 1px solid silver;
  322. background: #f4f4f4;
  323. padding: 0.5em;
  324. }
  325. div.quoteblock-attribution {
  326. padding-top: 0.5em;
  327. text-align: right;
  328. }
  329. div.verseblock-content {
  330. white-space: pre;
  331. }
  332. div.verseblock-attribution {
  333. padding-top: 0.75em;
  334. text-align: left;
  335. }
  336. div.exampleblock-content {
  337. border-left: 2px solid silver;
  338. padding-left: 0.5em;
  339. }
  340. /* IE6 sets dynamically generated links as visited. */
  341. div#toc a:visited { color: blue; }
  342. </style>
  343. </head>
  344. <body>
  345. <div id="header">
  346. <h1>aria2 - The ultra fast download utility</h1>
  347. <span id="author">Tatsuhiro Tsujikawa</span><br />
  348. <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 />
  349. </div>
  350. <h2 id="_disclaimer">1. Disclaimer</h2>
  351. <div class="sectionbody">
  352. <div class="paragraph"><p>This program comes with no warranty.
  353. You must use this program at your own risk.</p></div>
  354. </div>
  355. <h2 id="_introduction">2. Introduction</h2>
  356. <div class="sectionbody">
  357. <div class="paragraph"><p>aria2 is a utility for downloading files. The supported protocols are
  358. HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
  359. multiple sources/protocols and tries to utilize your maximum download
  360. bandwidth. It supports downloading a file from HTTP(S)/FTP and
  361. BitTorrent at the same time, while the data downloaded from
  362. HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink&#8217;s
  363. chunk checksums, aria2 automatically validates chunks of data while
  364. downloading a file like BitTorrent.</p></div>
  365. <div class="paragraph"><p>Here is a list of features.</p></div>
  366. <div class="ulist"><ul>
  367. <li>
  368. <p>
  369. Command-line interface
  370. </p>
  371. </li>
  372. <li>
  373. <p>
  374. Download files through HTTP(S)/FTP/BitTorrent
  375. </p>
  376. </li>
  377. <li>
  378. <p>
  379. Segmented downloading
  380. </p>
  381. </li>
  382. <li>
  383. <p>
  384. Metalink version 3.0 support(HTTP/FTP/BitTorrent)
  385. </p>
  386. </li>
  387. <li>
  388. <p>
  389. HTTP/1.1 implementation
  390. </p>
  391. </li>
  392. <li>
  393. <p>
  394. HTTP Proxy support
  395. </p>
  396. </li>
  397. <li>
  398. <p>
  399. HTTP BASIC authentication support
  400. </p>
  401. </li>
  402. <li>
  403. <p>
  404. HTTP Proxy authentication support
  405. </p>
  406. </li>
  407. <li>
  408. <p>
  409. Well-known environment variables for proxy: http_proxy, https_proxy,
  410. ftp_proxy, all_proxy and no_proxy
  411. </p>
  412. </li>
  413. <li>
  414. <p>
  415. HTTP gzip, deflate content encoding support
  416. </p>
  417. </li>
  418. <li>
  419. <p>
  420. Verify peer using given trusted CA certificate in HTTPS
  421. </p>
  422. </li>
  423. <li>
  424. <p>
  425. Client certificate authentication in HTTPS
  426. </p>
  427. </li>
  428. <li>
  429. <p>
  430. Chunked transfer encoding support
  431. </p>
  432. </li>
  433. <li>
  434. <p>
  435. Load Cookies from file using the Firefox3 format and the Mozilla/Firefox
  436. (1.x/2.x)/Netscape format.
  437. </p>
  438. </li>
  439. <li>
  440. <p>
  441. Save Cookies in the Mozilla/Firefox (1.x/2.x)/Netscape format.
  442. </p>
  443. </li>
  444. <li>
  445. <p>
  446. Custom HTTP Header support
  447. </p>
  448. </li>
  449. <li>
  450. <p>
  451. Persistent Connections support
  452. </p>
  453. </li>
  454. <li>
  455. <p>
  456. FTP through HTTP Proxy
  457. </p>
  458. </li>
  459. <li>
  460. <p>
  461. Download/Upload speed throttling
  462. </p>
  463. </li>
  464. <li>
  465. <p>
  466. BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
  467. </p>
  468. </li>
  469. <li>
  470. <p>
  471. BitTorrent <a href="http://getright.com/seedtorrent.html">WEB-Seeding</a>
  472. (single-file torrent only)
  473. </p>
  474. </li>
  475. <li>
  476. <p>
  477. Rename/change the directory structure of BitTorrent downloads
  478. completely
  479. </p>
  480. </li>
  481. <li>
  482. <p>
  483. XML-RPC interface
  484. </p>
  485. </li>
  486. <li>
  487. <p>
  488. Run as a daemon process
  489. </p>
  490. </li>
  491. <li>
  492. <p>
  493. Selective download in multi-file torrent/Metalink
  494. </p>
  495. </li>
  496. <li>
  497. <p>
  498. Chunk checksum validation in Metalink
  499. </p>
  500. </li>
  501. <li>
  502. <p>
  503. Can disable segmented downloading in Metalink
  504. </p>
  505. </li>
  506. <li>
  507. <p>
  508. Netrc support
  509. </p>
  510. </li>
  511. <li>
  512. <p>
  513. Configuration file support
  514. </p>
  515. </li>
  516. <li>
  517. <p>
  518. Download URIs found in a text file or stdin and the destination directory and
  519. output filename can be specified optionally
  520. </p>
  521. </li>
  522. <li>
  523. <p>
  524. Parameterized URI support
  525. </p>
  526. </li>
  527. </ul></div>
  528. </div>
  529. <h2 id="_dependency">3. Dependency</h2>
  530. <div class="sectionbody">
  531. <div class="tableblock">
  532. <table rules="all"
  533. width="100%"
  534. frame="border"
  535. cellspacing="0" cellpadding="4">
  536. <caption class="title">External Library Dependency</caption>
  537. <col width="50%" />
  538. <col width="50%" />
  539. <thead>
  540. <tr>
  541. <th align="left" valign="top">features </th>
  542. <th align="left" valign="top">dependency</th>
  543. </tr>
  544. </thead>
  545. <tbody>
  546. <tr>
  547. <td align="left" valign="top"><p class="table">HTTPS</p></td>
  548. <td align="left" valign="top"><p class="table">GnuTLS or OpenSSL</p></td>
  549. </tr>
  550. <tr>
  551. <td align="left" valign="top"><p class="table">BitTorrent</p></td>
  552. <td align="left" valign="top"><p class="table">GnuTLS+Libgcrypt or OpenSSL</p></td>
  553. </tr>
  554. <tr>
  555. <td align="left" valign="top"><p class="table">Metalink</p></td>
  556. <td align="left" valign="top"><p class="table">libxml2 or Expat.</p></td>
  557. </tr>
  558. <tr>
  559. <td align="left" valign="top"><p class="table">Checksum</p></td>
  560. <td align="left" valign="top"><p class="table">GnuTLS+Libgcrypt or OpenSSL</p></td>
  561. </tr>
  562. <tr>
  563. <td align="left" valign="top"><p class="table">gzip, deflate in HTTP</p></td>
  564. <td align="left" valign="top"><p class="table">zlib</p></td>
  565. </tr>
  566. <tr>
  567. <td align="left" valign="top"><p class="table">Async DNS</p></td>
  568. <td align="left" valign="top"><p class="table">C-Ares</p></td>
  569. </tr>
  570. <tr>
  571. <td align="left" valign="top"><p class="table">Firefox3 cookie</p></td>
  572. <td align="left" valign="top"><p class="table">libsqlite3</p></td>
  573. </tr>
  574. <tr>
  575. <td align="left" valign="top"><p class="table">XML-RPC</p></td>
  576. <td align="left" valign="top"><p class="table">libxml2 or Expat.</p></td>
  577. </tr>
  578. </tbody>
  579. </table>
  580. </div>
  581. <div class="dlist"><dl>
  582. <dt class="hdlist1">
  583. Note
  584. </dt>
  585. <dd>
  586. <p>
  587. GNU TLS has precedence over OpenSSL if both libraries are installed.
  588. If you prefer OpenSSL, run configure with --without-gnutls.
  589. </p>
  590. </dd>
  591. <dt class="hdlist1">
  592. Note
  593. </dt>
  594. <dd>
  595. <p>
  596. libxml2 has precedence over Expat if both libraries are installed.
  597. If you prefer Expat, run configure with --without-libxml2.
  598. </p>
  599. </dd>
  600. </dl></div>
  601. <div class="paragraph"><p>You can disable BitTorrent, Metalink support by providing
  602. --disable-bittorrent, --disable-metalink respectively to configure
  603. script.</p></div>
  604. <div class="paragraph"><p>In order to enable async DNS support, you need c-ares.</p></div>
  605. <div class="ulist"><ul>
  606. <li>
  607. <p>
  608. c-ares: <a href="http://daniel.haxx.se/projects/c-ares/">http://daniel.haxx.se/projects/c-ares/</a>
  609. </p>
  610. </li>
  611. </ul></div>
  612. </div>
  613. <h2 id="_how_to_build">4. How to build</h2>
  614. <div class="sectionbody">
  615. <div class="paragraph"><p>In order to build aria2 from the source package, you need following
  616. development packages(package name may vary depending on the
  617. distribution you use):</p></div>
  618. <div class="ulist"><ul>
  619. <li>
  620. <p>
  621. libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
  622. </p>
  623. </li>
  624. <li>
  625. <p>
  626. libgpg-error-dev (Required for BitTorrent, Checksum support)
  627. </p>
  628. </li>
  629. <li>
  630. <p>
  631. libgcrypt-dev (Required for BitTorrent, Checksum support)
  632. </p>
  633. </li>
  634. <li>
  635. <p>
  636. libc-ares-dev (Required for async DNS support)
  637. </p>
  638. </li>
  639. <li>
  640. <p>
  641. libxml2-dev (Required for Metalink support)
  642. </p>
  643. </li>
  644. <li>
  645. <p>
  646. libz1g-dev (Required for gzip, deflate decoding support in HTTP)
  647. </p>
  648. </li>
  649. <li>
  650. <p>
  651. libsqlite3-dev (Required for Firefox3 cookie support)
  652. </p>
  653. </li>
  654. </ul></div>
  655. <div class="paragraph"><p>You can use libssl-dev instead of
  656. libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
  657. <div class="ulist"><ul>
  658. <li>
  659. <p>
  660. libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
  661. </p>
  662. </li>
  663. </ul></div>
  664. <div class="paragraph"><p>You can use libexpat1-dev instead of libxml2-dev:</p></div>
  665. <div class="ulist"><ul>
  666. <li>
  667. <p>
  668. libexpat1-dev (Required for Metalink support)
  669. </p>
  670. </li>
  671. </ul></div>
  672. <div class="paragraph"><p>The quickest way to build aria2 is just type following commands:</p></div>
  673. <div class="listingblock">
  674. <div class="content">
  675. <pre><tt>$ ./configure
  676. $ make</tt></pre>
  677. </div></div>
  678. <div class="paragraph"><p>The configure script checks available libraries and enables the features
  679. as much as possible because all the features are enabled by default.</p></div>
  680. <div class="paragraph"><p>Since 1.1.0, aria2 checks the certificate of HTTPS servers by default.
  681. If you build with HTTPS support, I recommend to supply the path to the
  682. CA bundle file. For example, in Debian the path to CA bundle file is
  683. <em>/etc/ssl/certs/ca-certificates.crt</em> (in ca-certificates package). This
  684. may vary depending on your distribution. You can give it to
  685. configure script using --with-ca-bundle option:</p></div>
  686. <div class="listingblock">
  687. <div class="content">
  688. <pre><tt>$ ./configure --with-ca-bundle='/etc/ssl/certs/ca-certificates.crt'
  689. $ make</tt></pre>
  690. </div></div>
  691. <div class="paragraph"><p>Without --with-ca-bundle option, you will encounter the error when
  692. accessing HTTPS servers because the certificate cannot be verified
  693. without CA bundle. In such case, you can specify the CA bundle file
  694. using aria2&#8217;s --ca-certificate option. If you don&#8217;t have CA bundle
  695. file installed, then the last resort is disable the certificate
  696. validation using --check-certificate=false.</p></div>
  697. <div class="paragraph"><p>The executable is <em>aria2c</em> in src directory.</p></div>
  698. <div class="paragraph"><p>aria2 uses CppUnit for automated unit testing. To run the unit test:</p></div>
  699. <div class="listingblock">
  700. <div class="content">
  701. <pre><tt>$ make check</tt></pre>
  702. </div></div>
  703. </div>
  704. <h2 id="_bittorrrent">5. BitTorrrent</h2>
  705. <div class="sectionbody">
  706. <h3 id="_about_filename">5.1. About filename</h3><div style="clear:left"></div>
  707. <div class="paragraph"><p>The filename of the downloaded file is determined as follows:</p></div>
  708. <div class="dlist"><dl>
  709. <dt class="hdlist1">
  710. single-file mode
  711. </dt>
  712. <dd>
  713. <p>
  714. If "name" key is present in .torrent file, filename is the value
  715. of "name" key. Otherwise, filename is the basename of .torrent
  716. file appended by ".file". For example, .torrent file is
  717. "test.torrrent", then filename is "test.torrent.file". The
  718. directory to store the downloaded file can be specified by -d
  719. option.
  720. </p>
  721. </dd>
  722. <dt class="hdlist1">
  723. multi-file mode
  724. </dt>
  725. <dd>
  726. <p>
  727. The complete directory/file structure mentioned in .torrent file
  728. is created. The directory to store the top directory of
  729. downloaded files can be specified by -d option.
  730. </p>
  731. </dd>
  732. </dl></div>
  733. <div class="paragraph"><p>Before download starts, a complete directory structure is created if
  734. needed. By default, aria2 opens at most 100 files mentioned in
  735. .torrent file, and directly writes to and reads from these files.
  736. The number of files to open simultaneously can be controlled by
  737. --bt-max-open-files option.</p></div>
  738. <h3 id="_dht">5.2. DHT</h3><div style="clear:left"></div>
  739. <div class="paragraph"><p>As of release 0.13.0, aria2 supports DHT. By default, the routing
  740. table is saved to $HOME/.aria2/dht.dat.</p></div>
  741. <h3 id="_other_things_should_be_noted">5.3. Other things should be noted</h3><div style="clear:left"></div>
  742. <div class="ulist"><ul>
  743. <li>
  744. <p>
  745. -o option is used to change the filename of .torrent file itself,
  746. not a filename of a file in .torrent file.
  747. </p>
  748. </li>
  749. <li>
  750. <p>
  751. The port numbers that aria2 uses by default are 6881-6999 for TCP
  752. and UDP.
  753. </p>
  754. </li>
  755. <li>
  756. <p>
  757. aria2 doesn&#8217;t configure port-forwarding automatically. Please
  758. configure your router or firewall manually.
  759. </p>
  760. </li>
  761. <li>
  762. <p>
  763. The maximum number of peers is 55. This limit may be exceeded when
  764. download rate is low. This download rate can be adjusted using
  765. --bt-request-peer-speed-limit option.
  766. </p>
  767. </li>
  768. <li>
  769. <p>
  770. As of release 0.10.0, aria2 stops sending request message after
  771. selective download completes.
  772. </p>
  773. </li>
  774. </ul></div>
  775. </div>
  776. <h2 id="_metalink">6. Metalink</h2>
  777. <div class="sectionbody">
  778. <div class="paragraph"><p>The current implementation supports HTTP(S)/FTP/BitTorrent. The other
  779. P2P protocols are ignored.</p></div>
  780. <div class="paragraph"><p>For checksum verification, MD5, SHA1, and SHA256 are supported. If
  781. multiple hash algorithms are provided, aria2 uses SHA1. If whole file
  782. checksum verification fails, aria2 doesn&#8217;t retry the download and just
  783. exits with non-zero return code.</p></div>
  784. <div class="paragraph"><p>The supported user preferences are version, language, location,
  785. protocol and os.</p></div>
  786. <div class="paragraph"><p>If chunk checksums are provided in Metalink file, aria2 automatically
  787. validates chunks of data during download. This behavior can be turned
  788. off by a command-line option.</p></div>
  789. <div class="paragraph"><p>If signature is included in a Metalink file, aria2 saves it as a file
  790. after the completion of the download. The filename is download
  791. filename + ".sig". If same file already exists, the signature file is
  792. not saved.</p></div>
  793. </div>
  794. <h2 id="_netrc">7. netrc</h2>
  795. <div class="sectionbody">
  796. <div class="paragraph"><p>netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
  797. support, specify -n command-line option. Your .netrc file should have
  798. correct permissions(600).</p></div>
  799. </div>
  800. <h2 id="_references">8. References</h2>
  801. <div class="sectionbody">
  802. <div class="ulist"><ul>
  803. <li>
  804. <p>
  805. man aria2c
  806. </p>
  807. </li>
  808. <li>
  809. <p>
  810. <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a>
  811. </p>
  812. </li>
  813. <li>
  814. <p>
  815. <a href="http://apps.sourceforge.net/trac/aria2/wiki">http://apps.sourceforge.net/trac/aria2/wiki</a>
  816. </p>
  817. </li>
  818. </ul></div>
  819. </div>
  820. <div id="footer">
  821. <div id="footer-text">
  822. Last updated 2009-05-27 00:49:50 JST
  823. </div>
  824. </div>
  825. </body>
  826. </html>