aria2c.1.txt 25 KB

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