README 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. aria2 - The ultra fast download utility
  2. =======================================
  3. :Author: Tatsuhiro Tsujikawa
  4. :Email: tujikawa_at_users_dot_sourceforge_dot_net
  5. Disclaimer
  6. ----------
  7. This program comes with no warranty.
  8. You must use this program at your own risk.
  9. Introduction
  10. ------------
  11. aria2 is a utility for downloading files. The supported protocols are
  12. HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
  13. multiple sources/protocols and tries to utilize your maximum download
  14. bandwidth. It supports downloading a file from HTTP(S)/FTP and
  15. BitTorrent at the same time, while the data downloaded from
  16. HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's
  17. chunk checksums, aria2 automatically validates chunks of data while
  18. downloading a file like BitTorrent.
  19. Here is a list of features.
  20. * Command-line interface
  21. * Download files through HTTP(S)/FTP/BitTorrent
  22. * Segmented downloading
  23. * Metalink version 4 (RFC5854) support(HTTP/FTP/BitTorrent)
  24. * Metalink version 3.0 support(HTTP/FTP/BitTorrent)
  25. * HTTP/1.1 implementation
  26. * HTTP Proxy support
  27. * HTTP BASIC authentication support
  28. * HTTP Proxy authentication support
  29. * Well-known environment variables for proxy: http_proxy, https_proxy,
  30. ftp_proxy, all_proxy and no_proxy
  31. * HTTP gzip, deflate content encoding support
  32. * Verify peer using given trusted CA certificate in HTTPS
  33. * Client certificate authentication in HTTPS
  34. * Chunked transfer encoding support
  35. * Load Cookies from file using the Firefox3 format, Chromium/Google Chrome
  36. and the Mozilla/Firefox
  37. (1.x/2.x)/Netscape format.
  38. * Save Cookies in the Mozilla/Firefox (1.x/2.x)/Netscape format.
  39. * Custom HTTP Header support
  40. * Persistent Connections support
  41. * FTP through HTTP Proxy
  42. * Download/Upload speed throttling
  43. * BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
  44. * BitTorrent http://getright.com/seedtorrent.html[WEB-Seeding]. aria2
  45. requests chunks more than piece size to reduce the request
  46. overhead. It also supports pipelined requests with piece size.
  47. * BitTorrent Local Peer Discovery
  48. * Rename/change the directory structure of BitTorrent downloads
  49. completely
  50. * XML-RPC interface
  51. * Run as a daemon process
  52. * Selective download in multi-file torrent/Metalink
  53. * Chunk checksum validation in Metalink
  54. * Can disable segmented downloading in Metalink
  55. * Netrc support
  56. * Configuration file support
  57. * Download URIs found in a text file or stdin and the destination directory and
  58. output filename can be specified optionally
  59. * Parameterized URI support
  60. * IPv6 support
  61. Dependency
  62. ----------
  63. .External Library Dependency
  64. [options="header"]
  65. |====================================================
  66. |features |dependency
  67. |HTTPS |GnuTLS or OpenSSL
  68. |BitTorrent |GnuTLS+Libgcrypt or OpenSSL
  69. |Metalink |libxml2 or Expat.
  70. |Checksum |GnuTLS+Libgcrypt or OpenSSL
  71. |gzip, deflate in HTTP |zlib
  72. |Async DNS |C-Ares
  73. |Firefox3/Chromium cookie|libsqlite3
  74. |XML-RPC |libxml2 or Expat.
  75. |====================================================
  76. Note;;
  77. GNU TLS has precedence over OpenSSL if both libraries are installed.
  78. If you prefer OpenSSL, run configure with \--without-gnutls.
  79. Note;;
  80. libxml2 has precedence over Expat if both libraries are installed.
  81. If you prefer Expat, run configure with \--without-libxml2.
  82. You can disable BitTorrent, Metalink support by providing
  83. \--disable-bittorrent, \--disable-metalink respectively to configure
  84. script.
  85. In order to enable async DNS support, you need c-ares.
  86. * c-ares: http://daniel.haxx.se/projects/c-ares/
  87. How to build
  88. ------------
  89. In order to build aria2 from the source package, you need following
  90. development packages(package name may vary depending on the
  91. distribution you use):
  92. * libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
  93. * libgpg-error-dev (Required for BitTorrent, Checksum support)
  94. * libgcrypt-dev (Required for BitTorrent, Checksum support)
  95. * libc-ares-dev (Required for async DNS support)
  96. * libxml2-dev (Required for Metalink support)
  97. * zlib1g-dev (Required for gzip, deflate decoding support in HTTP)
  98. * libsqlite3-dev (Required for Firefox3/Chromium cookie support)
  99. You can use libssl-dev instead of
  100. libgnutls-dev,libgpg-error-dev,libgcrypt-dev:
  101. * libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
  102. You can use libexpat1-dev instead of libxml2-dev:
  103. * libexpat1-dev (Required for Metalink support)
  104. You may also need pkg-config to detect the above mentioned libraries.
  105. The quickest way to build aria2 is just type following commands:
  106. -------------
  107. $ ./configure
  108. $ make
  109. -------------
  110. The configure script checks available libraries and enables the features
  111. as much as possible because all the features are enabled by default.
  112. Since 1.1.0, aria2 checks the certificate of HTTPS servers by default.
  113. If you build with HTTPS support, I recommend to supply the path to the
  114. CA bundle file. For example, in Debian the path to CA bundle file is
  115. '/etc/ssl/certs/ca-certificates.crt' (in ca-certificates package). This
  116. may vary depending on your distribution. You can give it to
  117. configure script using \--with-ca-bundle option:
  118. -------------------------------------------------------------------
  119. $ ./configure --with-ca-bundle='/etc/ssl/certs/ca-certificates.crt'
  120. $ make
  121. -------------------------------------------------------------------
  122. Without \--with-ca-bundle option, you will encounter the error when
  123. accessing HTTPS servers because the certificate cannot be verified
  124. without CA bundle. In such case, you can specify the CA bundle file
  125. using aria2's \--ca-certificate option. If you don't have CA bundle
  126. file installed, then the last resort is disable the certificate
  127. validation using \--check-certificate=false.
  128. The executable is 'aria2c' in src directory.
  129. aria2 uses CppUnit for automated unit testing. To run the unit test:
  130. ------------
  131. $ make check
  132. ------------
  133. BitTorrrent
  134. -----------
  135. About filename
  136. ~~~~~~~~~~~~~~
  137. The filename of the downloaded file is determined as follows:
  138. single-file mode::
  139. If "name" key is present in .torrent file, filename is the value
  140. of "name" key. Otherwise, filename is the basename of .torrent
  141. file appended by ".file". For example, .torrent file is
  142. "test.torrrent", then filename is "test.torrent.file". The
  143. directory to store the downloaded file can be specified by -d
  144. option.
  145. multi-file mode::
  146. The complete directory/file structure mentioned in .torrent file
  147. is created. The directory to store the top directory of
  148. downloaded files can be specified by -d option.
  149. Before download starts, a complete directory structure is created if
  150. needed. By default, aria2 opens at most 100 files mentioned in
  151. .torrent file, and directly writes to and reads from these files.
  152. The number of files to open simultaneously can be controlled by
  153. \--bt-max-open-files option.
  154. DHT
  155. ~~~
  156. aria2 supports mainline compatible DHT. By default, the routing table
  157. for IPv4 DHT is saved to $HOME/.aria2/dht.dat and the routing table
  158. for IPv6 DHT is saved to $HOME/.aria2/dht6.dat. aria2 uses same port
  159. number to listen on for both IPv4 and IPv6 DHT.
  160. Other things should be noted
  161. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  162. * -o option is used to change the filename of .torrent file itself,
  163. not a filename of a file in .torrent file. For this purpose, use
  164. --index-out option instead.
  165. * The port numbers that aria2 uses by default are 6881-6999 for TCP
  166. and UDP.
  167. * aria2 doesn't configure port-forwarding automatically. Please
  168. configure your router or firewall manually.
  169. * The maximum number of peers is 55. This limit may be exceeded when
  170. download rate is low. This download rate can be adjusted using
  171. \--bt-request-peer-speed-limit option.
  172. * As of release 0.10.0, aria2 stops sending request message after
  173. selective download completes.
  174. Metalink
  175. --------
  176. The current implementation supports HTTP(S)/FTP/BitTorrent. The other
  177. P2P protocols are ignored. Both Metalink4 and Metalink version 3.0
  178. documents are supported.
  179. For checksum verification, MD5, SHA1, and SHA256 are supported. If
  180. multiple hash algorithms are provided, aria2 uses stronger one. If
  181. whole file checksum verification fails, aria2 doesn't retry the
  182. download and just exits with non-zero return code.
  183. The supported user preferences are version, language, location,
  184. protocol and os.
  185. If chunk checksums are provided in Metalink file, aria2 automatically
  186. validates chunks of data during download. This behavior can be turned
  187. off by a command-line option.
  188. If signature is included in a Metalink file, aria2 saves it as a file
  189. after the completion of the download. The filename is download
  190. filename + ".sig". If same file already exists, the signature file is
  191. not saved.
  192. In Metalink4, multi-file torrent could appear in metalink:metaurl
  193. element. Since aria2 cannot download 2 same torrents at the same
  194. time, aria2 groups files in metalink:file element which has same
  195. BitTorrent metaurl and downloads them from a single BitTorrent swarm.
  196. This is basically multi-file torrent download with file selection, so
  197. the adjacent files which is not in Metalink document but shares same
  198. piece with selected file are also created.
  199. netrc
  200. -----
  201. netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
  202. support, specify -n command-line option. Your .netrc file should have
  203. correct permissions(600).
  204. References
  205. ----------
  206. * man aria2c
  207. * http://aria2.sourceforge.net/
  208. * http://sourceforge.net/apps/trac/aria2/wiki
  209. * http://tools.ietf.org/html/rfc5854