aria2c.1.txt 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. ARIA2C(1)
  2. =========
  3. Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
  4. NAME
  5. ----
  6. aria2c - The ultra fast download utility
  7. SYNOPSIS
  8. --------
  9. aria2c ['OPTIONS'] ['URL' | 'TORRENT_FILE' | 'METALINK_FILE']...
  10. DESCRIPTION
  11. -----------
  12. aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.
  13. OPTIONS
  14. -------
  15. Basic Options
  16. ~~~~~~~~~~~~~
  17. *-d*, *--dir*=DIR::
  18. The directory to store the downloaded file.
  19. *-i*, *--input-file*=FILE::
  20. Downloads URIs found in FILE. You can specify multiple URIs for a single
  21. entity: separate URIs on a single line using the TAB character.
  22. Reads input from stdin when '-' is specified.
  23. *-l*, *--log*=LOG::
  24. The file name of the log file. If '-' is specified, log is written to
  25. stdout.
  26. *-j*, *--max-concurrent-downloads*=N::
  27. Set maximum number of parallel downloads for every static (HTTP/FTP) URL,
  28. torrent and metalink.
  29. Default: '5'
  30. *--check-integrity*='true'|'false'::
  31. Check file integrity by validating piece hash.
  32. This option only affects in BitTorrent downloads and Metalink downloads with
  33. chunk checksums.
  34. Use this option to re-download a damaged portion of a file.
  35. Default: 'false'
  36. *-c*, *--continue*::
  37. Continue downloading a partially downloaded file.
  38. Use this option to resume a download started by a web browser or another
  39. program which downloads files sequentially from the beginning.
  40. Currently this option is only applicable to HTTP(S)/FTP downloads.
  41. *-h*, *--help*[=CATEGORY]::
  42. Print usage and exit.
  43. The help messages are classified in several categories.
  44. For example, type "*--help*=http" for detailed explanation for the options
  45. related to HTTP. If no matching category is found, search option name using
  46. a given word in forward match and print the result.
  47. Available Values: 'basic', 'advanced', 'http', 'ftp', 'metalink',
  48. 'bittorrent', 'all'
  49. Default: 'basic'
  50. HTTP/FTP Options
  51. ~~~~~~~~~~~~~~~~
  52. *--lowest-speed-limit*=SPEED::
  53. Close connection if download speed is lower than or equal to this
  54. value(bytes per sec).
  55. '0' means aria2 does not have a lowest speed limit.
  56. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  57. This option does not affect BitTorrent downloads.
  58. Default: '0'
  59. *-m*, *--max-tries*=N::
  60. Set number of tries. '0' means unlimited.
  61. Default: '5'
  62. *-o*, *--out*=FILE::
  63. The file name of the downloaded file.
  64. [NOTE]
  65. In Metalink, BitTorrent download you cannot specify file name.
  66. The file name specified here is only used when the URLs fed to aria2
  67. is done by command line without *-i*, *-Z* option, like this:
  68. aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip
  69. *--retry-wait*=SEC::
  70. Set the seconds to wait to retry after an error has occured.
  71. Specify a value between '0' and '60'.
  72. Default: '5'
  73. *-s*, *--split*=N::
  74. Download a file using N connections.
  75. If more than N URLs are given, first N URLs are used and remaining URLs are
  76. used for backup.
  77. If less than N URLs are given, those URLs are used more than once so that N
  78. connections total are made simultaneously.
  79. N must be between '1' and '16'. Please see *-j* option too.
  80. Default: '5'
  81. *-t*, *--timeout*=SEC::
  82. Set timeout in seconds.
  83. Default: '60'
  84. HTTP Specific Options
  85. ~~~~~~~~~~~~~~~~~~~~~
  86. *--http-auth-scheme*=SCHEME::
  87. Set HTTP authentication scheme.
  88. Currently, 'basic' is the only supported scheme.
  89. Default: 'basic'
  90. *--http-user*=USER::
  91. Set HTTP user. This affects all URLs.
  92. *--http-passwd*=PASSWD::
  93. Set HTTP password. This affects all URLs.
  94. *--http-proxy*=HOST:PORT::
  95. Use HTTP proxy server. This affects all URLs.
  96. *--http-proxy-user*=USER::
  97. Set HTTP proxy user. This affects all URLs.
  98. *--http-proxy-passwd*=PASSWD::
  99. Set HTTP proxy password. This affects all URLs.
  100. *--http-proxy-method*=METHOD::
  101. Set the method to use in proxy request.
  102. 'METHOD' is either 'get' or 'tunnel'.
  103. Default: 'tunnel'
  104. *--referer*=REFERER::
  105. Set Referer. This affects all URLs.
  106. *--enable-http-keep-alive*[='true'|'false']::
  107. Enable HTTP/1.1 persistent connection.
  108. Default: 'true'
  109. *--enable-http-pipelining*[='true'|'false']::
  110. Enable HTTP/1.1 pipelining.
  111. Default: 'false'
  112. *--header*=HEADER::
  113. Append HEADER to HTTP request header.
  114. You can use this option repeatedly to specify more than one header:
  115. aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" http://host/file
  116. *--load-cookies*=FILE::
  117. Load Cookies from FILE using the Mozilla/Firefox(1.x/2.x) and Netscape format.
  118. *-U*, *--user-agent*=USER_AGENT::
  119. Set user agent for HTTP(S) downloads.
  120. FTP Specific Options
  121. ~~~~~~~~~~~~~~~~~~~~
  122. *--ftp-user*=USER::
  123. Set FTP user. This affects all URLs.
  124. Default: 'anonymous'
  125. *--ftp-passwd*=PASSWD::
  126. Set FTP password. This affects all URLs.
  127. Default: 'ARIA2USER@'
  128. *-p*, *--ftp-pasv*::
  129. Use passive mode in FTP.
  130. *--ftp-type*=TYPE::
  131. Set FTP transfer type. TYPE is either 'binary' or 'ascii'.
  132. Default: 'binary'
  133. *--ftp-reuse-connection*[='true'|'false']::
  134. Reuse connection in FTP.
  135. Default: 'true'
  136. *--ftp-via-http-proxy*=METHOD::
  137. Use HTTP proxy in FTP. METHOD is either 'get' or 'tunnel'.
  138. Default: 'tunnel'
  139. *-n*, *--no-netrc*::
  140. Disables netrc support. netrc support is enabled by default.
  141. BitTorrent/Metalink Options
  142. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  143. *--select-file*=INDEX...::
  144. Set file to download by specifing its index.
  145. You can find the file index using the *--show-files* option.
  146. Multiple indexes can be specified by using ",", for example: '3,6'.
  147. You can also use "-" to specify a range: '1-5'.
  148. "," and "-" can be used together: '1-5,8,9'.
  149. When used with the -M option, index may vary depending on the query
  150. (see *--metalink-** options).
  151. [NOTE]
  152. In multi file torrent, the adjacent files specified by this option may
  153. also be downloaded. This is by design, not a bug.
  154. A single piece may include several files or part of files, and aria2
  155. writes the piece to the appropriate files.
  156. *-S*, *--show-files*::
  157. Print file listing of .torrent or .metalink file and exit.
  158. In case of .torrent file, additional information
  159. (infohash, piece length, etc) is also printed.
  160. BitTorrent Specific Options
  161. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  162. *--bt-max-open-files*=NUM::
  163. Specify maximum number of files to open in each BitTorrent download.
  164. Default: '100'
  165. *--bt-min-crypto-level*='plain'|'arc4'::
  166. Set minimum level of encryption method.
  167. If several encryption methods are provided by a peer, aria2 chooses a lowest
  168. one which satisfies the given level.
  169. Default: 'plain'
  170. *--bt-require-crypto*='true'|'false'::
  171. If true is given, aria2 doesn't accept and establish connection with legacy
  172. BitTorrent handshake(\19BitTorrent protocol).
  173. Thus aria2 always uses Obfuscation handshake.
  174. Default: 'false'
  175. *--bt-request-peer-speed-limit*=SPEED::
  176. In BitTorrent downloads, if the download speed is lower than SPEED,
  177. aria2 initiates and accepts connections ignoring max peer cap.
  178. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  179. Default: '51200'
  180. *--bt-seed-unverified*[='true'|'false']::
  181. Seed previously downloaded files without verifying piece hashes.
  182. Default: 'false'
  183. *--dht-entry-point*=HOST:PORT::
  184. Set host and port as an entry point to DHT network.
  185. *--dht-listen-port*=PORT...::
  186. Set UDP listening port for DHT.
  187. Multiple ports can be specified by using ",", for example: '6881,6885'.
  188. You can also use "-" to specify a range: '6881-6999'. "," and "-" can be used
  189. together.
  190. Default: '6881-6999'
  191. *--direct-file-mapping*='true'|'false'::
  192. Directly read from and write to each file mentioned in .torrent file.
  193. Use this option if lots of files are listed in .torrent file and aria2
  194. complains it cannot open files anymore.
  195. Default: 'true'
  196. *--enable-dht*[='true'|'false']::
  197. Enable DHT functionality. If a private flag is set in a torrent, aria2
  198. doesn't use DHT for that download even if 'true' is given.
  199. Default: 'false'
  200. *--enable-peer-exchange*[='true'|'false']::
  201. Enable Peer Exchange extension. If a private flag is set in a torrent, this
  202. feature is disabled for that download even if 'true' is given.
  203. Default: 'true'
  204. *--follow-torrent*='true'|'false'|'mem'::
  205. If 'true' or 'mem' is specified, when a file whose suffix is ".torrent" or content
  206. type is "application/x-bittorrent" is downloaded, aria2 parses it as a torrent
  207. file and downloads files mentioned in it.
  208. If 'mem' is specified, a torrent file is not written to the disk, but is just
  209. kept in memory.
  210. If 'false' is specified, the action mentioned above is not taken.
  211. Default: 'true'
  212. *--listen-port*=PORT...::
  213. Set TCP port number for BitTorrent downloads.
  214. Multiple ports can be specified by using ",", for example: '6881,6885'.
  215. You can also use "-" to specify a range: '6881-6999'.
  216. "," and "-" can be used together: '6881-6889,6999'.
  217. Default: '6881-6999'
  218. [NOTE]
  219. Make sure that the specified ports are open for incoming TCP traffic.
  220. *--max-upload-limit*=SPEED::
  221. Set max upload speed in bytes per sec. '0' means unrestricted.
  222. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  223. Default: '0'
  224. *--peer-id-prefix*=PEERI_ID_PREFIX::
  225. Specify the prefix of peer ID. The peer ID in BitTorrent is 20 byte length.
  226. If more than 20 bytes are specified, only first 20 bytes are used.
  227. If less than 20 bytes are specified, the random alphabet characters are
  228. added to make it's length 20 bytes.
  229. Default: '-aria2-'
  230. *--seed-ratio*=RATIO::
  231. Specify share ratio. Seed completed torrents until share ratio reaches]
  232. RATIO.
  233. I strongly encourages you to specify equals or more than '1.0' here.
  234. Specify '0.0' if you intend to do seeding regardless of share ratio.
  235. If *--seed-time* option is specified along with this option, seeding ends when
  236. at least one of the conditions is satisfied.
  237. Default: '1.0'
  238. *--seed-time*=MINUTES::
  239. Specify seeding time in minutes. Also see the *--seed-ratio* option.
  240. *-T*, *--torrent-file*=TORRENT_FILE::
  241. The path to the .torrent file.
  242. You may not use this option because you can specify torrent file without -T.
  243. Metalink Specific Options
  244. ~~~~~~~~~~~~~~~~~~~~~~~~~
  245. *--follow-metalink*='true'|'false'|'mem'::
  246. If 'true' or 'mem' is specified, when a file whose suffix is ".metaink" or content
  247. type is "application/metalink+xml" is downloaded, aria2 parses it as a metalink
  248. file and downloads files mentioned in it.
  249. If 'mem' is specified, a metalink file is not written to the disk, but is just
  250. kept in memory.
  251. If 'false' is specified, the action mentioned above is not taken.
  252. Default: 'true'
  253. *-M*, *--metalink-file*=METALINK_FILE::
  254. The file path to .metalink file. You may not use this option because you can
  255. specify metalink file without -M.
  256. *-C*, *--metalink-servers*=NUM_SERVERS::
  257. The number of servers to connect to simultaneously.
  258. Some metalinks regulates the number of servers to connect.
  259. aria2 respects them.
  260. Default: '5'
  261. *--metalink-language*=LANGUAGE::
  262. The language of the file to download.
  263. *--metalink-location*=LOCATION[,...]::
  264. The location of the preferred server.
  265. A comma-deliminated list of locations is acceptable, for example, 'JP,US'.
  266. *--metalink-os*=OS::
  267. The operating system of the file to download.
  268. *--metalink-version*=VERSION::
  269. The version of the file to download.
  270. *--metalink-preferred-protocol*=PROTO::
  271. Specify preferred protocol.
  272. The possible values are 'http', 'https', 'ftp' and 'none'.
  273. Specifiy 'none' to disable this feature.
  274. Default: 'none'
  275. *--metalink-enable-unique-protocol*='true'|'false'::
  276. If 'true' is given and several protocols are available for a mirror in a
  277. metalink file, aria2 uses one of them.
  278. Use *--metalink-preferred-protocol* option to specify the preference of
  279. protocol.
  280. Default: 'true'
  281. Advanced Options
  282. ~~~~~~~~~~~~~~~~
  283. *--allow-overwrite*='true'|'false'::
  284. If 'false' is given, aria2 doesn't download a file which already exists but
  285. the corresponding .aria2 file doesn't exist.
  286. In HTTP(S)/FTP download, if *--auto-file-renaming*='true' then,
  287. file name will be renamed. See *--auto-file-renaming* for details.
  288. Default: 'false'
  289. *--allow-piece-length-change*='true'|'false'::
  290. If false is given, aria2 aborts download when a piece length is different
  291. from one in a control file.
  292. If true is given, you can proceed but some download progress will be lost.
  293. Default: 'false'
  294. *--async-dns*[='true'|'false']::
  295. Enable asynchronous DNS.
  296. Default: 'true'
  297. *--auto-file-renaming*[='true'|'false']::
  298. Rename file name if the same file already exists.
  299. This option works only in HTTP(S)/FTP download.
  300. The new file name has a dot and a number(1..9999) appended.
  301. Default: 'true'
  302. *--conf-path*=PATH::
  303. Change the configuration file path to PATH.
  304. Default: '$HOME/.aria2/aria2.conf'
  305. *-D*, *--daemon*::
  306. Run as daemon.
  307. *--enable-direct-io*[='true'|'false']::
  308. Enable directI/O, which lowers cpu usage while allocating/checking files.
  309. Turn off if you encounter any error.
  310. Default: 'false'
  311. *--file-allocation*=METHOD::
  312. Specify file allocation method. METHOD is either 'none' or 'prealloc'.
  313. 'none' doesn't pre-allocate file space. 'prealloc' pre-allocates file space
  314. before download begins. This may take some time depending on the size of the
  315. file.
  316. Default: 'prealloc'
  317. *--log-level*=LEVEL::
  318. Set log level to output.
  319. LEVEL is either 'debug', 'info', 'notice', 'warn' or 'error'.
  320. Default: 'debug'
  321. *--summary-interval*=SEC::
  322. Set interval in seconds to output download progress summary.
  323. Setting '0' suppresses the output.
  324. Default: '60'
  325. [NOTE]
  326. In multi file torrent, the files adjacent forward to the specified files
  327. are also allocated if they share a same piece.
  328. *-Z*, *--force-sequential*[='true'|'false']::
  329. Fetch URIs in the command-line sequentially and download each URI in a
  330. separate session, like the usual command-line download utilities.
  331. Default: 'false'
  332. *--max-download-limit*=SPEED::
  333. Set max download speed in bytes per sec. '0' means unrestricted.
  334. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  335. Default: '0'
  336. *--no-conf*::
  337. Disable loading aria2.conf file.
  338. *--no-file-allocation-limit*=SIZE::
  339. No file allocation is made for files whose size is smaller than SIZE.
  340. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  341. Default: '5M'
  342. *-P*, *--parameterized-uri*[='true'|'false']::
  343. Enable parameterized URI support.
  344. You can specify set of parts: 'http://{sv1,sv2,sv3}/foo.iso'.
  345. Also you can specify numeric sequences with step counter:
  346. '\\http://host/image[000-100:2].img'.
  347. A step counter can be omitted.
  348. If all URIs do not point to the same file, such as the second example above,
  349. -Z option is required.
  350. Default: 'false'
  351. *-q*, *--quiet*[='true'|'false']::
  352. Make aria2 quite (no console output).
  353. Default: 'false'
  354. *--realtime-chunk-checksum*='true'|'false'::
  355. Validate chunk of data by calculating checkusm while download a file if
  356. chunk checksums are provided. Currently Metalink is the only way to to
  357. provide chunk checksums.
  358. Default: 'true'
  359. *--stop*=SEC::
  360. Stop application after SEC seconds has passed.
  361. If '0' is given, this feature is disabled.
  362. Default: '0'
  363. *-v*, *--version*::
  364. Print the version number, copyright and the configuration information and
  365. exit.
  366. URL, TORRENT_FILE, METALINK_FILE
  367. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  368. You can specify multiple URLs in command-line.
  369. Unless you specify *-Z* option, all URLs must point to the same file or downloading will fail.
  370. You can also specify arbitrary number of torrent files and metalink files
  371. stored in a local drive. Please note that they are always treated as a
  372. separate download.
  373. You can specify both torrent file with -T option and URLs. By doing this,
  374. download a file from both torrent swarm and HTTP(S)/FTP server at the same time,
  375. while the data from HTTP(S)/FTP are uploaded to the torrent swarm. Note that
  376. only single file torrent can be integrated with HTTP(S)/FTP.
  377. [NOTE]
  378. Make sure that URL is quoted with single(\') or double(") quotation if it
  379. contains "&" or any characters that have special meaning in shell.
  380. EXAMPLES
  381. --------
  382. HTTP/FTP Segmented Download
  383. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  384. Download a file
  385. ^^^^^^^^^^^^^^^
  386. --------------------------------
  387. aria2c http://host/file.zip
  388. --------------------------------
  389. [NOTE]
  390. aria2 uses 5 connections to download 1 file by default.
  391. Download a file using 1 connection
  392. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  393. ----------------------------------
  394. aria2c -s1 http://host/file.zip
  395. ----------------------------------
  396. [NOTE]
  397. aria2 uses 5 connections to download 1 file by default.
  398. -s1 limtis the number of connections to just 1.
  399. [NOTE]
  400. To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument at the same directory. You can change URLs as long as they are pointing to the same file.
  401. Download a file from 2 different HTTP servers
  402. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  403. --------------------------------------------------
  404. aria2c http://host/file.zip http://mirror/file.zip
  405. --------------------------------------------------
  406. Download a file from HTTP and FTP servers
  407. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  408. -------------------------------------------------
  409. aria2c http://host1/file.zip ftp://host2/file.zip
  410. -------------------------------------------------
  411. Download files listed in a file concurrently
  412. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  413. ------------------------
  414. aria2c -ifiles.txt -j2
  415. ------------------------
  416. [NOTE]
  417. -j option specifies the number of parallel downloads.
  418. Metalink Download
  419. ~~~~~~~~~~~~~~~~~
  420. Download files with remote Metalink
  421. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  422. ------------------------------------------------------
  423. aria2c --follow-metalink=mem http://host/file.metalink
  424. ------------------------------------------------------
  425. Download using a local metalink file
  426. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  427. ----------------------------------------------------------
  428. aria2c -p --lowest-speed-limit=4000 file.metalink
  429. ----------------------------------------------------------
  430. [NOTE]
  431. To pause a download, press Ctrl-C.
  432. You can resume the transfer by running aria2c with the same argument at the same
  433. directory.
  434. Download several local metalink files
  435. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  436. ----------------------------------------
  437. aria2c -j2 file1.metalink file2.metalink
  438. ----------------------------------------
  439. Download only selected files using index
  440. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  441. -------------------------------------------
  442. aria2c --select-file=1-4,8 file.metalink
  443. -------------------------------------------
  444. [NOTE]
  445. The index is printed to the console using -S option.
  446. Download a file using a local .metalink file with user preference
  447. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  448. ------------------------------------------------------------------------------
  449. aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US file.metalink
  450. ------------------------------------------------------------------------------
  451. BitTorrent Download
  452. ~~~~~~~~~~~~~~~~~~~
  453. Download files from remote BitTorrent file
  454. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  455. -------------------------------------------------------
  456. aria2c --follow-torrent=mem http://host/file.torrent
  457. -------------------------------------------------------
  458. Download using a local torrent file
  459. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  460. ---------------------------------------------
  461. aria2c --max-upload-limit=40K file.torrent
  462. ---------------------------------------------
  463. [NOTE]
  464. --max-upload-limit specifies the max of upload rate.
  465. [NOTE]
  466. To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.
  467. Download 2 torrents
  468. ^^^^^^^^^^^^^^^^^^^
  469. --------------------------------------
  470. aria2c -j2 file1.torrent file2.torrent
  471. --------------------------------------
  472. Download a file using torrent and HTTP/FTP server
  473. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  474. -----------------------------------------------------------
  475. aria2c -Ttest.torrent http://host1/file ftp://host2/file
  476. -----------------------------------------------------------
  477. [NOTE]
  478. Downloading multi file torrent with HTTP/FTP is not supported.
  479. Download only selected files using index(usually called "selectable download")
  480. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  481. ---------------------------------------
  482. aria2c --select-file=1-4,8 file.torrent
  483. ---------------------------------------
  484. [NOTE]
  485. The index is printed to the console using -S option.
  486. Change the listening port for incoming peer
  487. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  488. ---------------------------------------------------
  489. aria2c --listen-port=7000-7001,8000 file.torrent
  490. ---------------------------------------------------
  491. [NOTE]
  492. Since aria2 doesn't configure firewall or router for port forwarding, it's up
  493. to you to do it manually.
  494. Specify the condition to stop program after torrent download finished
  495. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  496. -------------------------------------------------------
  497. aria2c --seed-time=120 --seed-ratio=1.0 file.torrent
  498. -------------------------------------------------------
  499. [NOTE]
  500. In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.
  501. Throttle upload speed
  502. ^^^^^^^^^^^^^^^^^^^^^
  503. ----------------------------------------------
  504. aria2c --max-upload-limit=100K file.torrent
  505. ----------------------------------------------
  506. Enable DHT
  507. ^^^^^^^^^^
  508. ---------------------------------------------------------
  509. aria2c --enable-dht --dht-listen-port=6881 file.torrent
  510. ---------------------------------------------------------
  511. [NOTE]
  512. DHT uses udp port. Since aria2 doesn't configure firewall or router for port
  513. forwarding, it's up to you to do it manually.
  514. More advanced HTTP features
  515. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  516. Load cookies
  517. ^^^^^^^^^^^^
  518. ------------------------------------------------------
  519. aria2c --load-cookies=cookies.txt http://host/file.zip
  520. ------------------------------------------------------
  521. [NOTE]
  522. You can use Firefox/Mozilla's cookie file without modification.
  523. Resume download started by web browsers or another programs
  524. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  525. ---------------------------------------------------
  526. aria2c -c -s2 http://host/partiallydownloadedfile.zip
  527. ---------------------------------------------------
  528. And more advanced features
  529. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  530. Throttle download speed
  531. ^^^^^^^^^^^^^^^^^^^^^^^
  532. -------------------------------------------------
  533. aria2c --max-download-limit=100K file.metalink
  534. -------------------------------------------------
  535. Repair a damaged download using --check-integrity option
  536. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  537. ----------------------------------------------
  538. aria2c --check-integrity=true file.metalink
  539. ----------------------------------------------
  540. [NOTE]
  541. This option is only available used with BitTorrent or metalink with chunk
  542. checksums.
  543. Drop connection if download speed is lower than specified value
  544. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  545. ------------------------------------------------
  546. aria2c --lowest-speed-limit=10K file.metalink
  547. ------------------------------------------------
  548. Parameterized URI support
  549. ^^^^^^^^^^^^^^^^^^^^^^^^^
  550. You can specify set of parts:
  551. ---------------------------------------------
  552. aria2c -P http://{host1,host2,host3}/file.iso
  553. ---------------------------------------------
  554. You can specify numeric sequence:
  555. -------------------------------------------
  556. aria2c -Z -P http://host/image[000-100].png
  557. -------------------------------------------
  558. [NOTE]
  559. -Z option is required if the all URIs don't point to the same file, such as the above example.
  560. You can specify step counter:
  561. -----------------------------------------
  562. aria2c -Z -P http://host/image[A-Z:2].png
  563. -----------------------------------------
  564. Parallel downloads of arbitrary number of URL,metalink,torrent
  565. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  566. ------------------------------------------------------------
  567. aria2c -j3 -Z http://host/file1 file2.torrent file3.metalink
  568. ------------------------------------------------------------
  569. BitTorrent Encryption
  570. ^^^^^^^^^^^^^^^^^^^^^
  571. Encrypt whole payload using ARC4:
  572. -------------------------------------------------------------------------
  573. aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent
  574. -------------------------------------------------------------------------
  575. RESUME DOWNLOAD
  576. ---------------
  577. Usually, you can resume transfer by just issuing same command(aria2c URL)
  578. if the previous transfer is made by aria2.
  579. If the previous transfer is made by a browser or wget like sequencial
  580. download manager, then use -c option to continue the transfer(aria2c -c URL).
  581. CONTROL FILE
  582. ------------
  583. aria2 uses a control file to keep track the progress of download.
  584. A control file is placed at the same directory of the dowloading file and
  585. its filename is the filename of downloading file with ".aria2" appended.
  586. For example, if you are downloading file.zip, then the control file should be
  587. file.zip.aria2.
  588. (There is a exception for this naming convention.
  589. If you are downloading a multi torrent, its control file is the "top directory"
  590. name of the torrent with ".aria2" appended.
  591. The "top directory" name is a value of "name" key in "info" directory in a torrent file.)
  592. Usually a control file is deleted once download completed.
  593. If aria2 decides that download cannot be resumed(for example, when downloading
  594. a file from a HTTP server which doesn't support resume), a control file is
  595. not created.
  596. Normally if you lose a control file, you cannot resume download.
  597. But if you have a torrent or metalink with chunk checksums for the file,
  598. you can resume the download without a control file by giving
  599. --check-integrity=true option to aria2c in command-line.
  600. SEEDING DOWNLOADED FILE IN BITTORRENT
  601. -------------------------------------
  602. You can seed downloaded file using --check-integrity=true option.
  603. ---------------------------------------------
  604. aria2c --check-integrity=true file.torrent
  605. ---------------------------------------------
  606. FILES
  607. -----
  608. aria2.conf
  609. ~~~~~~~~~~
  610. User configuration file.
  611. It must be placed under $HOME/.aria2 and must be named as aria2.conf.
  612. In each line, there is 1 parameter whose syntax is name=value pair,
  613. where name is the long command-line option name without '--' prefix.
  614. The lines beginning '#' are treated as comments.
  615. --------------------------------------
  616. # sample configuration file for aria2c
  617. listen-port=60000
  618. dht-listen-port=60000
  619. seed-ratio=1.0
  620. max-upload-limit=50K
  621. ftp-pasv=true
  622. --------------------------------------
  623. dht.dat
  624. ~~~~~~~~
  625. The routing table of DHT is saved to the path $HOME/.aria2/dht.dat.
  626. RESOURCES
  627. ---------
  628. Project web site: http://aria2.sourceforge.net/[]
  629. metalink: http://www.metalinker.org/[]
  630. REPORTING BUGS
  631. --------------
  632. Report bugs to Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
  633. AUTHOR
  634. ------
  635. Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
  636. COPYRIGHT
  637. ---------
  638. Copyright (C) 2006, 2008 Tatsuhiro Tsujikawa
  639. This program is free software; you can redistribute it and/or modify
  640. it under the terms of the GNU General Public License as published by
  641. the Free Software Foundation; either version 2 of the License, or
  642. (at your option) any later version.
  643. This program is distributed in the hope that it will be useful,
  644. but WITHOUT ANY WARRANTY; without even the implied warranty of
  645. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  646. GNU General Public License for more details.
  647. You should have received a copy of the GNU General Public License
  648. along with this program; if not, write to the Free Software
  649. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  650. In addition, as a special exception, the copyright holders give
  651. permission to link the code of portions of this program with the
  652. OpenSSL library under certain conditions as described in each
  653. individual source file, and distribute linked combinations
  654. including the two.
  655. You must obey the GNU General Public License in all respects
  656. for all of the code used other than OpenSSL. If you modify
  657. file(s) with this exception, you may extend this exception to your
  658. version of the file(s), but you are not obligated to do so. If you
  659. do not wish to do so, delete this exception statement from your
  660. version. If you delete this exception statement from all source
  661. files in the program, then also delete it here.