README.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  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.2.6" />
  7. <style type="text/css">
  8. /* Debug borders */
  9. p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10. /*
  11. border: 1px solid red;
  12. */
  13. }
  14. body {
  15. margin: 1em 5% 1em 5%;
  16. }
  17. a {
  18. color: blue;
  19. text-decoration: underline;
  20. }
  21. a:visited {
  22. color: fuchsia;
  23. }
  24. em {
  25. font-style: italic;
  26. color: navy;
  27. }
  28. strong {
  29. font-weight: bold;
  30. color: #083194;
  31. }
  32. tt {
  33. color: navy;
  34. }
  35. h1, h2, h3, h4, h5, h6 {
  36. color: #527bbd;
  37. font-family: sans-serif;
  38. margin-top: 1.2em;
  39. margin-bottom: 0.5em;
  40. line-height: 1.3;
  41. }
  42. h1, h2, h3 {
  43. border-bottom: 2px solid silver;
  44. }
  45. h2 {
  46. padding-top: 0.5em;
  47. }
  48. h3 {
  49. float: left;
  50. }
  51. h3 + * {
  52. clear: left;
  53. }
  54. div.sectionbody {
  55. font-family: serif;
  56. margin-left: 0;
  57. }
  58. hr {
  59. border: 1px solid silver;
  60. }
  61. p {
  62. margin-top: 0.5em;
  63. margin-bottom: 0.5em;
  64. }
  65. ul, ol, li > p {
  66. margin-top: 0;
  67. }
  68. pre {
  69. padding: 0;
  70. margin: 0;
  71. }
  72. span#author {
  73. color: #527bbd;
  74. font-family: sans-serif;
  75. font-weight: bold;
  76. font-size: 1.1em;
  77. }
  78. span#email {
  79. }
  80. span#revision {
  81. font-family: sans-serif;
  82. }
  83. div#footer {
  84. font-family: sans-serif;
  85. font-size: small;
  86. border-top: 2px solid silver;
  87. padding-top: 0.5em;
  88. margin-top: 4.0em;
  89. }
  90. div#footer-text {
  91. float: left;
  92. padding-bottom: 0.5em;
  93. }
  94. div#footer-badges {
  95. float: right;
  96. padding-bottom: 0.5em;
  97. }
  98. div#preamble,
  99. div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
  100. div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
  101. div.admonitionblock {
  102. margin-right: 10%;
  103. margin-top: 1.5em;
  104. margin-bottom: 1.5em;
  105. }
  106. div.admonitionblock {
  107. margin-top: 2.5em;
  108. margin-bottom: 2.5em;
  109. }
  110. div.content { /* Block element content. */
  111. padding: 0;
  112. }
  113. /* Block element titles. */
  114. div.title, caption.title {
  115. color: #527bbd;
  116. font-family: sans-serif;
  117. font-weight: bold;
  118. text-align: left;
  119. margin-top: 1.0em;
  120. margin-bottom: 0.5em;
  121. }
  122. div.title + * {
  123. margin-top: 0;
  124. }
  125. td div.title:first-child {
  126. margin-top: 0.0em;
  127. }
  128. div.content div.title:first-child {
  129. margin-top: 0.0em;
  130. }
  131. div.content + div.title {
  132. margin-top: 0.0em;
  133. }
  134. div.sidebarblock > div.content {
  135. background: #ffffee;
  136. border: 1px solid silver;
  137. padding: 0.5em;
  138. }
  139. div.listingblock {
  140. margin-right: 0%;
  141. }
  142. div.listingblock > div.content {
  143. border: 1px solid silver;
  144. background: #f4f4f4;
  145. padding: 0.5em;
  146. }
  147. div.quoteblock > div.content {
  148. padding-left: 2.0em;
  149. }
  150. div.attribution {
  151. text-align: right;
  152. }
  153. div.verseblock + div.attribution {
  154. text-align: left;
  155. }
  156. div.admonitionblock .icon {
  157. vertical-align: top;
  158. font-size: 1.1em;
  159. font-weight: bold;
  160. text-decoration: underline;
  161. color: #527bbd;
  162. padding-right: 0.5em;
  163. }
  164. div.admonitionblock td.content {
  165. padding-left: 0.5em;
  166. border-left: 2px solid silver;
  167. }
  168. div.exampleblock > div.content {
  169. border-left: 2px solid silver;
  170. padding: 0.5em;
  171. }
  172. div.verseblock div.content {
  173. white-space: pre;
  174. }
  175. div.imageblock div.content { padding-left: 0; }
  176. div.imageblock img { border: 1px solid silver; }
  177. span.image img { border-style: none; }
  178. dl {
  179. margin-top: 0.8em;
  180. margin-bottom: 0.8em;
  181. }
  182. dt {
  183. margin-top: 0.5em;
  184. margin-bottom: 0;
  185. font-style: normal;
  186. }
  187. dd > *:first-child {
  188. margin-top: 0.1em;
  189. }
  190. ul, ol {
  191. list-style-position: outside;
  192. }
  193. div.olist > ol {
  194. list-style-type: decimal;
  195. }
  196. div.olist2 > ol {
  197. list-style-type: lower-alpha;
  198. }
  199. div.tableblock > table {
  200. border: 3px solid #527bbd;
  201. }
  202. thead {
  203. font-family: sans-serif;
  204. font-weight: bold;
  205. }
  206. tfoot {
  207. font-weight: bold;
  208. }
  209. div.hlist {
  210. margin-top: 0.8em;
  211. margin-bottom: 0.8em;
  212. }
  213. div.hlist td {
  214. padding-bottom: 15px;
  215. }
  216. td.hlist1 {
  217. vertical-align: top;
  218. font-style: normal;
  219. padding-right: 0.8em;
  220. }
  221. td.hlist2 {
  222. vertical-align: top;
  223. }
  224. @media print {
  225. div#footer-badges { display: none; }
  226. }
  227. div#toctitle {
  228. color: #527bbd;
  229. font-family: sans-serif;
  230. font-size: 1.1em;
  231. font-weight: bold;
  232. margin-top: 1.0em;
  233. margin-bottom: 0.1em;
  234. }
  235. div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  236. margin-top: 0;
  237. margin-bottom: 0;
  238. }
  239. div.toclevel2 {
  240. margin-left: 2em;
  241. font-size: 0.9em;
  242. }
  243. div.toclevel3 {
  244. margin-left: 4em;
  245. font-size: 0.9em;
  246. }
  247. div.toclevel4 {
  248. margin-left: 6em;
  249. font-size: 0.9em;
  250. }
  251. /* Workarounds for IE6's broken and incomplete CSS2. */
  252. div.sidebar-content {
  253. background: #ffffee;
  254. border: 1px solid silver;
  255. padding: 0.5em;
  256. }
  257. div.sidebar-title, div.image-title {
  258. color: #527bbd;
  259. font-family: sans-serif;
  260. font-weight: bold;
  261. margin-top: 0.0em;
  262. margin-bottom: 0.5em;
  263. }
  264. div.listingblock div.content {
  265. border: 1px solid silver;
  266. background: #f4f4f4;
  267. padding: 0.5em;
  268. }
  269. div.quoteblock-content {
  270. padding-left: 2.0em;
  271. }
  272. div.exampleblock-content {
  273. border-left: 2px solid silver;
  274. padding-left: 0.5em;
  275. }
  276. /* IE6 sets dynamically generated links as visited. */
  277. div#toc a:visited { color: blue; }
  278. /* Because IE6 child selector is broken. */
  279. div.olist2 ol {
  280. list-style-type: lower-alpha;
  281. }
  282. div.olist2 div.olist ol {
  283. list-style-type: decimal;
  284. }
  285. </style>
  286. <title>aria2 - The ultra fast download utility</title>
  287. </head>
  288. <body>
  289. <div id="header">
  290. <h1>aria2 - The ultra fast download utility</h1>
  291. <span id="author">Tatsuhiro Tsujikawa</span><br />
  292. <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 />
  293. </div>
  294. <h2 id="_disclaimer">1. Disclaimer</h2>
  295. <div class="sectionbody">
  296. <div class="para"><p>This program comes with no warranty.
  297. You must use this program at your own risk.</p></div>
  298. </div>
  299. <h2 id="_introduction">2. Introduction</h2>
  300. <div class="sectionbody">
  301. <div class="para"><p>aria2 is a utility for downloading files. The supported protocols are HTTP(S),
  302. FTP, BitTorrent, and Metalink.
  303. It can download a file from multiple sources/protocols and tries to utilize
  304. your maximum download bandwidth.
  305. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time,
  306. while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm.
  307. Using Metalink's chunk checksums, aria2 automatically validates chunks of data
  308. while downloading a file like BitTorrent.</p></div>
  309. <div class="para"><p>Here is a list of features.</p></div>
  310. <div class="ilist"><ul>
  311. <li>
  312. <p>
  313. Command-line interface
  314. </p>
  315. </li>
  316. <li>
  317. <p>
  318. Download files through HTTP(S)/FTP/BitTorrent
  319. </p>
  320. </li>
  321. <li>
  322. <p>
  323. Segmented downloading
  324. </p>
  325. </li>
  326. <li>
  327. <p>
  328. Metalink version 3.0 support(HTTP/FTP/BitTorrent)
  329. </p>
  330. </li>
  331. <li>
  332. <p>
  333. HTTP/1.1 implementation
  334. </p>
  335. </li>
  336. <li>
  337. <p>
  338. HTTP Proxy support
  339. </p>
  340. </li>
  341. <li>
  342. <p>
  343. HTTP BASIC authentication support
  344. </p>
  345. </li>
  346. <li>
  347. <p>
  348. HTTP Proxy authentication support
  349. </p>
  350. </li>
  351. <li>
  352. <p>
  353. HTTP gzip, deflate content encoding support
  354. </p>
  355. </li>
  356. <li>
  357. <p>
  358. Chunked transfer encoding support
  359. </p>
  360. </li>
  361. <li>
  362. <p>
  363. Load Cookies from file using the Mozilla/Firefox(1.x/2.x) and Netscape format
  364. </p>
  365. </li>
  366. <li>
  367. <p>
  368. Custom HTTP Header support
  369. </p>
  370. </li>
  371. <li>
  372. <p>
  373. Persistent Connections support
  374. </p>
  375. </li>
  376. <li>
  377. <p>
  378. FTP through HTTP Proxy
  379. </p>
  380. </li>
  381. <li>
  382. <p>
  383. Download/Upload speed throttling
  384. </p>
  385. </li>
  386. <li>
  387. <p>
  388. BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
  389. </p>
  390. </li>
  391. <li>
  392. <p>
  393. Run as a daemon process.
  394. </p>
  395. </li>
  396. <li>
  397. <p>
  398. Selective download in multi-file torrent/Metalink
  399. </p>
  400. </li>
  401. <li>
  402. <p>
  403. Chunk checksum validation in Metalink
  404. </p>
  405. </li>
  406. <li>
  407. <p>
  408. Can disable segmented downloading in Metalink
  409. </p>
  410. </li>
  411. <li>
  412. <p>
  413. Netrc support
  414. </p>
  415. </li>
  416. <li>
  417. <p>
  418. Configuration file support
  419. </p>
  420. </li>
  421. <li>
  422. <p>
  423. Download URIs found in a text file or stdin
  424. </p>
  425. </li>
  426. <li>
  427. <p>
  428. Parameterized URI support
  429. </p>
  430. </li>
  431. </ul></div>
  432. </div>
  433. <h2 id="_dependency">3. Dependency</h2>
  434. <div class="sectionbody">
  435. <div class="tableblock">
  436. <table rules="all"
  437. frame="border"
  438. cellspacing="0" cellpadding="4">
  439. <caption class="title">Table: External Library Dependency</caption>
  440. <col width="240" />
  441. <col width="320" />
  442. <thead>
  443. <tr>
  444. <th align="left">
  445. features
  446. </th>
  447. <th align="left">
  448. dependency
  449. </th>
  450. </tr>
  451. </thead>
  452. <tbody valign="top">
  453. <tr>
  454. <td align="left">
  455. HTTPS
  456. </td>
  457. <td align="left">
  458. GnuTLS or OpenSSL
  459. </td>
  460. </tr>
  461. <tr>
  462. <td align="left">
  463. BitTorrent
  464. </td>
  465. <td align="left">
  466. GnuTLS+Libgcrypt or OpenSSL
  467. </td>
  468. </tr>
  469. <tr>
  470. <td align="left">
  471. Metalink
  472. </td>
  473. <td align="left">
  474. libxml2 or Expat.
  475. </td>
  476. </tr>
  477. <tr>
  478. <td align="left">
  479. Checksum
  480. </td>
  481. <td align="left">
  482. GnuTLS+Libgcrypt or OpenSSL
  483. </td>
  484. </tr>
  485. <tr>
  486. <td align="left">
  487. gzip, deflate in HTTP
  488. </td>
  489. <td align="left">
  490. zlib
  491. </td>
  492. </tr>
  493. </tbody>
  494. </table>
  495. </div>
  496. <div class="vlist"><dl>
  497. <dt>
  498. Note
  499. </dt>
  500. <dd>
  501. <p>
  502. GNU TLS has precedence over OpenSSL if both libraries are installed.
  503. If you prefer OpenSSL, run configure with "&#8212;without-gnutls".
  504. </p>
  505. </dd>
  506. <dt>
  507. Note
  508. </dt>
  509. <dd>
  510. <p>
  511. libxml2 has precedence over Expat if both libraries are installed.
  512. If you prefer Expat, run configure with "&#8212;without-libxml2".
  513. </p>
  514. </dd>
  515. </dl></div>
  516. <div class="para"><p>You can disable BitTorrent, Metalink support by providing &#8212;disable-bittorrent,
  517. &#8212;disable-metalink respectively to configure script.</p></div>
  518. <div class="para"><p>In order to enable async DNS support, you need c-ares or ares.</p></div>
  519. <div class="ilist"><ul>
  520. <li>
  521. <p>
  522. c-ares: http://daniel.haxx.se/projects/c-ares/
  523. </p>
  524. </li>
  525. <li>
  526. <p>
  527. ares: ftp://athena-dist.mit.edu/pub/ATHENA/ares
  528. </p>
  529. </li>
  530. </ul></div>
  531. </div>
  532. <h2 id="_how_to_build">4. How to build</h2>
  533. <div class="sectionbody">
  534. <div class="para"><p>In order to build aria2 from the source package, you need following development
  535. packages(package name may vary depending on the distribution you use):</p></div>
  536. <div class="ilist"><ul>
  537. <li>
  538. <p>
  539. libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
  540. </p>
  541. </li>
  542. <li>
  543. <p>
  544. libgpg-error-dev (Required for BitTorrent, Checksum support)
  545. </p>
  546. </li>
  547. <li>
  548. <p>
  549. libgcrypt-dev (Required for BitTorrent, Checksum support)
  550. </p>
  551. </li>
  552. <li>
  553. <p>
  554. libares-dev (Required for async DNS support)
  555. </p>
  556. </li>
  557. <li>
  558. <p>
  559. libxml2-dev (Required for Metalink support)
  560. </p>
  561. </li>
  562. <li>
  563. <p>
  564. libz1g-dev (Required for gzip, deflate decoding support in HTTP)
  565. </p>
  566. </li>
  567. </ul></div>
  568. <div class="para"><p>You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
  569. <div class="ilist"><ul>
  570. <li>
  571. <p>
  572. libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
  573. </p>
  574. </li>
  575. </ul></div>
  576. <div class="para"><p>You can use libexpat1-dev instead of libxml2-dev:</p></div>
  577. <div class="ilist"><ul>
  578. <li>
  579. <p>
  580. libexpat1-dev (Required for Metalink support)
  581. </p>
  582. </li>
  583. </ul></div>
  584. <div class="para"><p>The build process is fairly standard way for *nix programs:</p></div>
  585. <div class="listingblock">
  586. <div class="content">
  587. <pre><tt>$ ./configure
  588. $ make</tt></pre>
  589. </div></div>
  590. <div class="para"><p>The executable is aria2c in src directory.</p></div>
  591. <div class="para"><p>aria2 uses CppUnit for automated unit testing. To run run the unit test:</p></div>
  592. <div class="listingblock">
  593. <div class="content">
  594. <pre><tt>$ make check</tt></pre>
  595. </div></div>
  596. </div>
  597. <h2 id="_bittorrrent">5. BitTorrrent</h2>
  598. <div class="sectionbody">
  599. <h3 id="_about_filename">5.1. About filename</h3><div style="clear:left"></div>
  600. <div class="para"><p>The filename of the downloaded file is determined as follows:</p></div>
  601. <div class="vlist"><dl>
  602. <dt>
  603. single-file mode
  604. </dt>
  605. <dd>
  606. <p>
  607. If "name" key is present in .torrent file, filename is the value of "name"
  608. key. Otherwise, filename is the basename of .torrent file appended by
  609. ".file". For example, .torrent file is "test.torrrent", then filename is
  610. "test.torrent.file".
  611. The directory to store the downloaded file can be specified by -d option.
  612. </p>
  613. </dd>
  614. <dt>
  615. multi-file mode
  616. </dt>
  617. <dd>
  618. <p>
  619. The complete directory/file structure mentioned in .torrent file is
  620. created.
  621. The directory to store the top directory of downloaded files can be
  622. specified by -d option.
  623. </p>
  624. </dd>
  625. </dl></div>
  626. <div class="para"><p>In the default behavior, before download starts, complete directory structure
  627. is created if needed. By default, aria2 opens at most 100 files mentioned in
  628. .torrent file, directly writes to and reads from these files. The number of
  629. files to open can be controlled by "&#8212;bt-max-open-files" option.</p></div>
  630. <div class="para"><p>If "&#8212;direct-file-mapping" option set to be false, aria2 creates temporary
  631. file in the store directory. The length of this file is the sum of length of
  632. the files in .torrent file, so at least 2 times more disk space than the file
  633. size itself is required. Writing and reading is done against this file.
  634. After download completes, aria2 creates complete directory structure if needed,
  635. and copies whole file or a part of it to the destination.</p></div>
  636. <h3 id="_dht">5.2. DHT</h3><div style="clear:left"></div>
  637. <div class="para"><p>As of release 0.13.0, aria2 supports DHT. The routing table is saved to $HOME/.aria2/dht.dat.</p></div>
  638. <div class="vlist"><dl>
  639. <dt>
  640. Note
  641. </dt>
  642. <dd>
  643. <div class="ilist"><ul>
  644. <li>
  645. <p>
  646. -o option is used to change the filename of .torrent file itself, not a
  647. filename of a file in .torrent file.
  648. </p>
  649. </li>
  650. <li>
  651. <p>
  652. The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP.
  653. </p>
  654. </li>
  655. <li>
  656. <p>
  657. aria2 doesn't configure port-forwarding automatically. Please configure your
  658. router or firewall manually.
  659. </p>
  660. </li>
  661. <li>
  662. <p>
  663. The maximum number of peers is 55. This limit may be exceeded when download
  664. rate is low.
  665. </p>
  666. </li>
  667. <li>
  668. <p>
  669. As of release 0.10.0, aria2 stops sending request message after selective
  670. download completes,
  671. </p>
  672. </li>
  673. </ul></div>
  674. </dd>
  675. </dl></div>
  676. </div>
  677. <h2 id="_metalink">6. Metalink</h2>
  678. <div class="sectionbody">
  679. <div class="para"><p>The current implementation supports HTTP/FTP/BitTorrent.
  680. The other P2P protocols are ignored.</p></div>
  681. <div class="para"><p>For checksum checking, MD5, SHA1, SHA256 are supported. If multiple hash
  682. algorithms are provided, aria2 uses SHA1. If checksum checking is failed, aria2
  683. doesn't retry the download and just exits with non-zero return code.</p></div>
  684. <div class="para"><p>The supported user preferences are version, language, location, protocol and
  685. os.</p></div>
  686. <div class="para"><p>If chunk checksums are provided in Metalink file, aria2 automatically validate
  687. a chunk of file while downloading it. This behavior can be turned off by
  688. a command-line option.</p></div>
  689. <div class="para"><p>If signature is included in a Metalink file, aria2 saves it as a file after the
  690. download completed.
  691. The filename is download filename + ".sig". If same file already exists, the
  692. signature file is not saved.</p></div>
  693. </div>
  694. <h2 id="_netrc">7. netrc</h2>
  695. <div class="sectionbody">
  696. <div class="para"><p>netrc support is enabled by default in ftp.
  697. To disable netrc support, specify -n command-line option.
  698. Your .netrc file should have correct permissions(600).</p></div>
  699. </div>
  700. <h2 id="_configuration_file">8. Configuration file</h2>
  701. <div class="sectionbody">
  702. <div class="para"><p>Configuration file must be placed under $HOME/.aria2 and must be named as
  703. aria2.conf.
  704. In each line, there is 1 parameter whose syntax is name=value pair,
  705. where name is the long command-line option name without <em>&#8212;</em> prefix.
  706. The lines beginning <em>#</em> are treated as comments.</p></div>
  707. <div class="para"><p>Example:</p></div>
  708. <div class="listingblock">
  709. <div class="content">
  710. <pre><tt># sample configuration file for aria2c
  711. file-allocation=prealloc
  712. listen-port=60000
  713. seed-ratio=1.0
  714. max-upload-limit=40K
  715. ftp-pasv=true</tt></pre>
  716. </div></div>
  717. </div>
  718. <div id="footer">
  719. <div id="footer-text">
  720. Last updated 2008-07-23 21:36:33 JST
  721. </div>
  722. </div>
  723. </body>
  724. </html>