aria2c.1.txt 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708
  1. ARIA2C(1)
  2. =========
  3. Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
  4. :man source: Aria2
  5. :man manual: Aria2 Manual
  6. NAME
  7. ----
  8. aria2c - The ultra fast download utility
  9. SYNOPSIS
  10. --------
  11. aria2c ['OPTIONS'] ['URL' | 'TORRENT_FILE' | 'METALINK_FILE']...
  12. DESCRIPTION
  13. -----------
  14. aria2 is a utility for downloading files. The supported protocols are
  15. HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
  16. multiple sources/protocols and tries to utilize your maximum download
  17. bandwidth. It supports downloading a file from HTTP(S)/FTP and
  18. BitTorrent at the same time, while the data downloaded from
  19. HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's
  20. chunk checksums, aria2 automatically validates chunks of data while
  21. downloading a file like BitTorrent.
  22. OPTIONS
  23. -------
  24. Basic Options
  25. ~~~~~~~~~~~~~
  26. *-d*, *--dir*=DIR::
  27. The directory to store the downloaded file.
  28. *-i*, *--input-file*=FILE::
  29. Downloads URIs found in FILE. You can specify multiple URIs for a single
  30. entity: separate URIs on a single line using the TAB character.
  31. Reads input from stdin when '-' is specified.
  32. The additional *out* and *dir* options can be specified after each line of
  33. URIs. This optional line must start with white space(s).
  34. See *Input File* subsection for details.
  35. *-l*, *--log*=LOG::
  36. The file name of the log file. If '-' is specified, log is written to
  37. stdout.
  38. *-j*, *--max-concurrent-downloads*=N::
  39. Set maximum number of parallel downloads for every static (HTTP/FTP) URL,
  40. torrent and metalink. See also *-s* and *-C* option.
  41. Default: '5'
  42. *-V*, *--check-integrity*[='true'|'false']::
  43. Check file integrity by validating piece hashes.
  44. This option has effect only in BitTorrent and Metalink downloads with
  45. chunk checksums.
  46. Use this option to re-download a damaged portion of a file.
  47. Default: 'false'
  48. *-c*, *--continue*::
  49. Continue downloading a partially downloaded file.
  50. Use this option to resume a download started by a web browser or another
  51. program which downloads files sequentially from the beginning.
  52. Currently this option is only applicable to HTTP(S)/FTP downloads.
  53. *-h*, *--help*[=TAG|KEYWORD]::
  54. The help messages are classified with tags. A tag starts with
  55. "#". For example, type "--help=#http" to get the usage for the
  56. options tagged with "#http". If non-tag word is given, print the
  57. usage for the options whose name includes that word.
  58. Available Values: '#basic', '#advanced', '#http', '#https', '#ftp',
  59. '#metalink', '#bittorrent', '#cookie', '#hook', '#file',
  60. '#xml-rpc', '#experimental', '#all'
  61. Default: '#basic'
  62. HTTP/FTP Options
  63. ~~~~~~~~~~~~~~~~
  64. *--all-proxy*=PROXY::
  65. Use this proxy server for all protocols.
  66. You can override this setting and specify a proxy server for a particular
  67. protocol using *--http-proxy*, *--https-proxy* and *--ftp-proxy* options.
  68. This affects all URLs.
  69. The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  70. *--connect-timeout*=SEC::
  71. Set the connect timeout in seconds to establish connection to
  72. HTTP/FTP/proxy server. After the connection is established, this
  73. option makes no effect and *--timeout* option is used instead.
  74. Default: '60'
  75. *--dry-run*[='true'|'false']::
  76. If 'true' is given, aria2 just checks whether the remote file is
  77. available and doesn't download data. This option has effect on
  78. HTTP/FTP download. BitTorrent downloads are canceled if 'true' is
  79. specified. Default: 'false'
  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-file-not-found*=NUM::
  88. If aria2 receives `file not found' status from the remote HTTP/FTP
  89. servers NUM times without getting a single byte, then force the
  90. download to fail. Specify '0' to disable this option. This options is
  91. effective only when using HTTP/FTP servers.
  92. Default: '0'
  93. *-m*, *--max-tries*=N::
  94. Set number of tries. '0' means unlimited.
  95. Default: '5'
  96. *-n*, *--no-netrc*::
  97. Disables netrc support. netrc support is enabled by default.
  98. *--no-proxy*=DOMAINS::
  99. Specify comma separated hostnames or domains where proxy should not be
  100. used.
  101. *-o*, *--out*=FILE::
  102. The file name of the downloaded file.
  103. [NOTE]
  104. In Metalink or BitTorrent download you cannot specify file name.
  105. The file name specified here is only used when the URLs fed to aria2
  106. are done by command line without *-i*, *-Z* option. For example:
  107. aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
  108. *--proxy-method*=METHOD::
  109. Set the method to use in proxy request. 'METHOD' is either 'get' or
  110. 'tunnel'. HTTPS downloads always use 'tunnel' regardless of this
  111. option.
  112. Default: 'get'
  113. *-R*, *--remote-time*[='true'|'false']::
  114. Retrieve timestamp of the remote file from the remote HTTP/FTP
  115. server and if it is available, apply it to the local file.
  116. Default: 'false'
  117. *--server-stat-of*=FILE::
  118. Specify the filename to which performance profile of the servers is
  119. saved. You can load saved data using *--server-stat-if* option. See
  120. *Server Performance Profile* subsection below for file format.
  121. *--server-stat-if*=FILE::
  122. Specify the filename to load performance profile of the servers. The
  123. loaded data will be used in some URI selector such as 'feedback'.
  124. See also *--uri-selector* option. See *Server Performance Profile*
  125. subsection below for file format.
  126. *--server-stat-timeout*=SEC::
  127. Specifies timeout in seconds to invalidate performance profile of
  128. the servers since the last contact to them.
  129. Default: '86400' (24hours)
  130. *-s*, *--split*=N::
  131. Download a file using N connections.
  132. If more than N URLs are given, first N URLs are used and remaining URLs are
  133. used for backup.
  134. If less than N URLs are given, those URLs are used more than once so that N
  135. connections total are made simultaneously.
  136. Please see *-j* option too.
  137. Please note that in Metalink download, this option has no effect and use
  138. *-C* option instead.
  139. Default: '5'
  140. *-t*, *--timeout*=SEC::
  141. Set timeout in seconds.
  142. Default: '60'
  143. *--uri-selector*=SELECTOR::
  144. Specify URI selection algorithm. The possible values are 'inorder',
  145. 'feedback' and 'adaptive'. If 'inorder' is given, URI is tried in
  146. the order appeared in the URI list. If 'feedback' is given, aria2
  147. uses download speed observed in the previous downloads and choose
  148. fastest server in the URI list. This also effectively skips dead
  149. mirrors. The observed download speed is a part of performance
  150. profile of servers mentioned in *--server-stat-of* and
  151. *--server-stat-if* options. If 'adaptive' is given, selects one of
  152. the best mirrors for the first and reserved connections. For
  153. supplementary ones, it returns mirrors which has not been tested
  154. yet, and if each of them has already been tested, returns mirrors
  155. which has to be tested again. Otherwise, it doesn't select anymore
  156. mirrors. Like 'feedback', it uses a performance profile of servers.
  157. Default: 'feedback'
  158. HTTP Specific Options
  159. ~~~~~~~~~~~~~~~~~~~~~
  160. *--ca-certificate*=FILE::
  161. Use the certificate authorities in FILE to verify the peers.
  162. The certificate file must be in PEM format and can contain multiple CA
  163. certificates.
  164. Use *--check-certificate* option to enable verification.
  165. *--certificate*=FILE::
  166. Use the client certificate in FILE.
  167. The certificate must be in PEM format.
  168. You may use *--private-key* option to specify the private key.
  169. *--check-certificate*[='true'|'false']::
  170. Verify the peer using certificates specified in *--ca-certificate* option.
  171. Default: 'true'
  172. *--http-auth-challenge*[='true'|'false']::
  173. Send HTTP authorization header only when it is requested by the
  174. server. If 'false' is set, then authorization header is always sent
  175. to the server. There is an exception: if username and password are
  176. embedded in URI, authorization header is always sent to the server
  177. regardless of this option. Default: 'false'
  178. *--http-auth-scheme*=SCHEME::
  179. Set HTTP authentication scheme.
  180. Currently, 'basic' is the only supported scheme.
  181. Default: 'basic'
  182. *--http-user*=USER::
  183. Set HTTP user. This affects all URLs.
  184. *--http-passwd*=PASSWD::
  185. Set HTTP password. This affects all URLs.
  186. *--http-proxy*=PROXY::
  187. Use this proxy server for HTTP. See also *--all-proxy* option.
  188. This affects all URLs.
  189. The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  190. *--https-proxy*=PROXY::
  191. Use this proxy server for HTTPS. See also *--all-proxy* option.
  192. This affects all URLs.
  193. The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  194. *--private-key*=FILE::
  195. Use the private key in FILE.
  196. The private key must be decrypted and in PEM format.
  197. The behavior when encrypted one is given is undefined.
  198. See also *--certificate* option.
  199. *--referer*=REFERER::
  200. Set Referer. This affects all URLs.
  201. *--enable-http-keep-alive*[='true'|'false']::
  202. Enable HTTP/1.1 persistent connection.
  203. Default: 'true'
  204. *--enable-http-pipelining*[='true'|'false']::
  205. Enable HTTP/1.1 pipelining.
  206. Default: 'false'
  207. *--header*=HEADER::
  208. Append HEADER to HTTP request header.
  209. You can use this option repeatedly to specify more than one header:
  210. aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" "http://host/file"
  211. *--load-cookies*=FILE::
  212. Load Cookies from FILE using the Firefox3 format (SQLite3) and the
  213. Mozilla/Firefox(1.x/2.x)/Netscape format.
  214. [NOTE]
  215. If aria2 is built without libsqlite3, then it doesn't support Firefox3 cookie format.
  216. *--save-cookies*=FILE::
  217. Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape
  218. format. If FILE already exists, it is overwritten. Session Cookies
  219. are also saved and their expiry values are treated as 0. Possible
  220. Values: '/path/to/file'
  221. *--use-head*[='true'|'false']::
  222. Use HEAD method for the first request to the HTTP server.
  223. Default: 'false'
  224. *-U*, *--user-agent*=USER_AGENT::
  225. Set user agent for HTTP(S) downloads.
  226. Default: 'aria2/$VERSION', $VERSION is replaced by package version.
  227. FTP Specific Options
  228. ~~~~~~~~~~~~~~~~~~~~
  229. *--ftp-user*=USER::
  230. Set FTP user. This affects all URLs.
  231. Default: 'anonymous'
  232. *--ftp-passwd*=PASSWD::
  233. Set FTP password. This affects all URLs.
  234. If user name is embedded but password is missing in URI, aria2 tries
  235. to resolve password using .netrc. If password is found in .netrc,
  236. then use it as password. If not, use the password specified in this
  237. option.
  238. Default: 'ARIA2USER@'
  239. *-p*, *--ftp-pasv*[='true'|'false']::
  240. Use the passive mode in FTP.
  241. If 'false' is given, the active mode will be used.
  242. Default: 'true'
  243. *--ftp-proxy*=PROXY::
  244. Use this proxy server for FTP. See also *--all-proxy* option.
  245. This affects all URLs.
  246. The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  247. *--ftp-type*=TYPE::
  248. Set FTP transfer type. TYPE is either 'binary' or 'ascii'.
  249. Default: 'binary'
  250. *--ftp-reuse-connection*[='true'|'false']::
  251. Reuse connection in FTP.
  252. Default: 'true'
  253. BitTorrent/Metalink Options
  254. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  255. *--select-file*=INDEX...::
  256. Set file to download by specifying its index.
  257. You can find the file index using the *--show-files* option.
  258. Multiple indexes can be specified by using ",", for example: '3,6'.
  259. You can also use "-" to specify a range: '1-5'.
  260. "," and "-" can be used together: '1-5,8,9'.
  261. When used with the -M option, index may vary depending on the query
  262. (see *--metalink-** options).
  263. [NOTE]
  264. In multi file torrent, the adjacent files specified by this option may
  265. also be downloaded. This is by design, not a bug.
  266. A single piece may include several files or part of files, and aria2
  267. writes the piece to the appropriate files.
  268. *-S*, *--show-files*::
  269. Print file listing of .torrent or .metalink file and exit.
  270. In case of .torrent file, additional information
  271. (infohash, piece length, etc) is also printed.
  272. BitTorrent Specific Options
  273. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  274. *--bt-external-ip*=IPADDRESS::
  275. Specify the external IP address to report to a BitTorrent
  276. tracker. Although this function is named "external", it can accept
  277. any kind of IP addresses. IPADDRESS must be a numeric IP address.
  278. *--bt-hash-check-seed*[='true'|'false']::
  279. If 'true' is given, after hash check using *--check-integrity* option and
  280. file is complete, continue to seed file. If you want to check file
  281. and download it only when it is damaged or incomplete, set this
  282. option to 'false'. This option has effect only on BitTorrent download.
  283. Default: 'true'
  284. *--bt-max-open-files*=NUM::
  285. Specify maximum number of files to open in each BitTorrent download.
  286. Default: '100'
  287. *--bt-max-peers*=NUM::
  288. Specify the maximum number of peers per torrent. '0' means
  289. unlimited. See also *--bt-request-peer-speed-limit* option.
  290. Default: '55'
  291. *--bt-min-crypto-level*='plain'|'arc4'::
  292. Set minimum level of encryption method.
  293. If several encryption methods are provided by a peer, aria2 chooses the lowest
  294. one which satisfies the given level.
  295. Default: 'plain'
  296. *--bt-require-crypto*='true'|'false'::
  297. If true is given, aria2 doesn't accept and establish connection with legacy
  298. BitTorrent handshake(\19BitTorrent protocol).
  299. Thus aria2 always uses Obfuscation handshake.
  300. Default: 'false'
  301. *--bt-request-peer-speed-limit*=SPEED::
  302. If the whole download speed of every torrent is lower than SPEED,
  303. aria2 temporarily increases the number of peers to try for more
  304. download speed. Configuring this option with your preferred download
  305. speed can increase your download speed in some cases.
  306. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  307. Default: '50K'
  308. *--bt-seed-unverified*[='true'|'false']::
  309. Seed previously downloaded files without verifying piece hashes.
  310. Default: 'false'
  311. *--bt-stop-timeout*=SEC::
  312. Stop BitTorrent download if download speed is 0 in consecutive SEC
  313. seconds. If '0' is given, this feature is disabled. Default: '0'
  314. *--bt-tracker-interval*=SEC::
  315. Set the interval in seconds between tracker requests. This
  316. completely overrides interval value and aria2 just uses this value
  317. and ignores the min interval and interval value in the response of
  318. tracker. If '0' is set, aria2 determines interval based on the
  319. response of tracker and the download progress. Default: '0'
  320. *--dht-entry-point*=HOST:PORT::
  321. Set host and port as an entry point to DHT network.
  322. *--dht-file-path*=PATH::
  323. Change the DHT routing table file to PATH.
  324. Default: '$HOME/.aria2/dht.dat'
  325. *--dht-listen-port*=PORT...::
  326. Set UDP listening port for DHT.
  327. Multiple ports can be specified by using ",", for example: '6881,6885'.
  328. You can also use "-" to specify a range: '6881-6999'. "," and "-" can be used
  329. together.
  330. Default: '6881-6999'
  331. [NOTE]
  332. Make sure that the specified ports are open for incoming UDP traffic.
  333. *--enable-dht*[='true'|'false']::
  334. Enable DHT functionality. If a private flag is set in a torrent, aria2
  335. doesn't use DHT for that download even if 'true' is given.
  336. Default: 'false'
  337. *--enable-peer-exchange*[='true'|'false']::
  338. Enable Peer Exchange extension. If a private flag is set in a torrent, this
  339. feature is disabled for that download even if 'true' is given.
  340. Default: 'true'
  341. *--follow-torrent*='true'|'false'|'mem'::
  342. If 'true' or 'mem' is specified, when a file whose suffix is ".torrent" or content
  343. type is "application/x-bittorrent" is downloaded, aria2 parses it as a torrent
  344. file and downloads files mentioned in it.
  345. If 'mem' is specified, a torrent file is not written to the disk, but is just
  346. kept in memory.
  347. If 'false' is specified, the action mentioned above is not taken.
  348. Default: 'true'
  349. *-O*, *--index-out*=INDEX=PATH::
  350. Set file path for file with index=INDEX. You can find the file index
  351. using the *--show-files* option. PATH is a relative path to the
  352. path specified in *--dir* option. You can use this option multiple
  353. times. Using this option, you can specify the output filenames of
  354. BitTorrent downloads.
  355. *--listen-port*=PORT...::
  356. Set TCP port number for BitTorrent downloads.
  357. Multiple ports can be specified by using ",", for example: '6881,6885'.
  358. You can also use "-" to specify a range: '6881-6999'.
  359. "," and "-" can be used together: '6881-6889,6999'.
  360. Default: '6881-6999'
  361. [NOTE]
  362. Make sure that the specified ports are open for incoming TCP traffic.
  363. *--max-overall-upload-limit*=SPEED::
  364. Set max overall upload speed in bytes/sec.
  365. '0' means unrestricted.
  366. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  367. To limit the upload speed per torrent, use *--max-upload-limit* option.
  368. Default: '0'
  369. *-u*, *--max-upload-limit*=SPEED::
  370. Set max upload speed per each torrent in bytes/sec.
  371. '0' means unrestricted.
  372. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  373. To limit the overall upload speed, use *--max-overall-upload-limit* option.
  374. Default: '0'
  375. *--peer-id-prefix*=PEER_ID_PREFIX::
  376. Specify the prefix of peer ID. The peer ID in
  377. BitTorrent is 20 byte length. If more than 20
  378. bytes are specified, only first 20 bytes are
  379. used. If less than 20 bytes are specified, random
  380. byte data are added to make its length 20 bytes.
  381. Default: 'aria2/$VERSION-', $VERSION is replaced by package version.
  382. *--seed-ratio*=RATIO::
  383. Specify share ratio. Seed completed torrents until share ratio reaches
  384. RATIO.
  385. You are strongly encouraged to specify equals or more than '1.0' here.
  386. Specify '0.0' if you intend to do seeding regardless of share ratio.
  387. If *--seed-time* option is specified along with this option, seeding ends when
  388. at least one of the conditions is satisfied.
  389. Default: '1.0'
  390. *--seed-time*=MINUTES::
  391. Specify seeding time in minutes. Also see the *--seed-ratio* option.
  392. *-T*, *--torrent-file*=TORRENT_FILE::
  393. The path to the .torrent file.
  394. You are not required to use this option because you can specify a torrent file without -T.
  395. Metalink Specific Options
  396. ~~~~~~~~~~~~~~~~~~~~~~~~~
  397. *--follow-metalink*='true'|'false'|'mem'::
  398. If 'true' or 'mem' is specified, when a file whose suffix is ".metalink" or content
  399. type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink
  400. file and downloads files mentioned in it.
  401. If 'mem' is specified, a metalink file is not written to the disk, but is just
  402. kept in memory.
  403. If 'false' is specified, the action mentioned above is not taken.
  404. Default: 'true'
  405. *-M*, *--metalink-file*=METALINK_FILE::
  406. The file path to .metalink file. You are not required to use this option because you can
  407. specify a metalink file without -M.
  408. *-C*, *--metalink-servers*=NUM_SERVERS::
  409. The number of servers to connect to simultaneously.
  410. Some Metalinks regulate the number of servers to connect.
  411. aria2 strictly respects them.
  412. This means that if Metalink defines the maxconnections attribute lower
  413. than NUM_SERVERS, then aria2 uses the value of maxconnections attribute
  414. instead of NUM_SERVERS.
  415. See also *-s* and *-j* options.
  416. Default: '5'
  417. *--metalink-language*=LANGUAGE::
  418. The language of the file to download.
  419. *--metalink-location*=LOCATION[,...]::
  420. The location of the preferred server.
  421. A comma-delimited list of locations is acceptable, for example, 'JP,US'.
  422. *--metalink-os*=OS::
  423. The operating system of the file to download.
  424. *--metalink-version*=VERSION::
  425. The version of the file to download.
  426. *--metalink-preferred-protocol*=PROTO::
  427. Specify preferred protocol.
  428. The possible values are 'http', 'https', 'ftp' and 'none'.
  429. Specify 'none' to disable this feature.
  430. Default: 'none'
  431. *--metalink-enable-unique-protocol*='true'|'false'::
  432. If 'true' is given and several protocols are available for a mirror in a
  433. metalink file, aria2 uses one of them.
  434. Use *--metalink-preferred-protocol* option to specify the preference of
  435. protocol.
  436. Default: 'true'
  437. XML-RPC Options
  438. ~~~~~~~~~~~~~~~
  439. *--enable-xml-rpc*[='true'|'false']::
  440. Enable XML-RPC server. It is strongly recommended to set username
  441. and password using *--xml-rpc-user* and *--xml-rpc-passwd*
  442. option. See also *--xml-rpc-listen-port* option. Default: 'false'
  443. *--xml-rpc-listen-all*[='true'|'false']::
  444. Listen incoming XML-RPC requests on all network interfaces. If false
  445. is given, listen only on local loopback interface. Default: 'false'
  446. *--xml-rpc-listen-port*=PORT::
  447. Specify a port number for XML-RPC server to listen to. Possible
  448. Values: '1024'-'65535' Default: '6800'
  449. *--xml-rpc-max-request-size*=SIZE::
  450. Set max size of XML-RPC request. If aria2 detects the request is
  451. more than SIZE bytes, it drops connection. Default: '2M'
  452. *--xml-rpc-passwd*=PASSWD::
  453. Set XML-RPC password.
  454. *--xml-rpc-user*=USER::
  455. Set XML-RPC user.
  456. Advanced Options
  457. ~~~~~~~~~~~~~~~~
  458. *--allow-overwrite*='true'|'false'::
  459. If 'false' is given, and a file already exists but the corresponding
  460. control file (filename.aria2) doesn't exist, then aria2 will not
  461. re-download the file. See also *--auto-file-renaming* option.
  462. Default: 'false'
  463. *--allow-piece-length-change*='true'|'false'::
  464. If false is given, aria2 aborts download when a piece length is different
  465. from one in a control file.
  466. If true is given, you can proceed but some download progress will be lost.
  467. Default: 'false'
  468. *--async-dns*[='true'|'false']::
  469. Enable asynchronous DNS.
  470. Default: 'true'
  471. *--auto-file-renaming*[='true'|'false']::
  472. Rename file name if the same file already exists.
  473. This option works only in HTTP(S)/FTP download.
  474. The new file name has a dot and a number(1..9999) appended.
  475. Default: 'true'
  476. *--auto-save-interval*=SEC::
  477. Save a control file(*.aria2) every SEC seconds.
  478. If '0' is given, a control file is not saved during download. aria2 saves a
  479. control file when it stops regardless of the value.
  480. The possible values are between '0' to '600'.
  481. Default: '60'
  482. *--conf-path*=PATH::
  483. Change the configuration file path to PATH.
  484. Default: '$HOME/.aria2/aria2.conf'
  485. *-D*, *--daemon*::
  486. Run as daemon. The current working directory will be changed to '/'
  487. and standard input, standard output and standard error will be
  488. redirected to '/dev/null'. Default: 'false'
  489. *--enable-direct-io*[='true'|'false']::
  490. Enable directI/O, which lowers cpu usage while allocating/checking files.
  491. Turn off if you encounter any error.
  492. Default: 'true'
  493. *--event-poll*=POLL::
  494. Specify the method for polling events. The possible Values are
  495. 'epoll' and 'select'. If you use recent Linux that has epoll, then
  496. the default value is 'epoll'. Otherwise, the default value is
  497. 'select'.
  498. *--file-allocation*=METHOD::
  499. Specify file allocation method.
  500. 'none' doesn't pre-allocate file space. 'prealloc' pre-allocates file space
  501. before download begins. This may take some time depending on the size of the
  502. file.
  503. If you are using newer file systems such as ext4
  504. (with extents support), btrfs or xfs, 'falloc' is
  505. your best choice. It allocates large(few GiB)
  506. files almost instantly. Don't use 'falloc' with
  507. legacy file systems such as ext3 because it takes
  508. almost same time as 'prealloc' and it blocks aria2
  509. entirely until allocation finishes. 'falloc' may
  510. not be available if your system doesn't have
  511. *posix_fallocate*() function.
  512. Possible Values: 'none', 'prealloc', 'falloc'
  513. Default: 'prealloc'
  514. *--log-level*=LEVEL::
  515. Set log level to output.
  516. LEVEL is either 'debug', 'info', 'notice', 'warn' or 'error'.
  517. Default: 'debug'
  518. *--on-download-complete*=COMMAND::
  519. Set the command to be executed when download completes. See
  520. *--on-download-start* option for the requirement of COMMAND. See
  521. also *--on-download-stop* option. Possible Values:
  522. '/path/to/command'
  523. *--on-download-error*=COMMAND::
  524. Set the command to be executed when download aborts due to error.
  525. See *--on-download-start* option for the requirement of COMMAND.
  526. See also *--on-download-stop* option. Possible Values:
  527. '/path/to/command'
  528. *--on-download-start*=COMMAND::
  529. Set the command to be executed when download starts up. COMMAND must
  530. take just one argument and GID is passed to COMMAND as a first
  531. argument. Possible Values: '/path/to/command'
  532. *--on-download-stop*=COMMAND::
  533. Set the command to be executed when download stops. You can override
  534. the command to be executed for particular download result using
  535. *--on-download-complete* and *--on-download-error*. If they are
  536. specified, command specified in this option is not executed. See
  537. *--on-download-start* option for the requirement of COMMAND.
  538. Possible Values: '/path/to/command'
  539. *--summary-interval*=SEC::
  540. Set interval in seconds to output download progress summary.
  541. Setting '0' suppresses the output.
  542. Default: '60'
  543. [NOTE]
  544. In multi file torrent downloads, the files adjacent forward to the specified files
  545. are also allocated if they share the same piece.
  546. *-Z*, *--force-sequential*[='true'|'false']::
  547. Fetch URIs in the command-line sequentially and download each URI in a
  548. separate session, like the usual command-line download utilities.
  549. Default: 'false'
  550. *--max-overall-download-limit*=SPEED::
  551. Set max overall download speed in bytes/sec. '0' means
  552. unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To
  553. limit the download speed per download, use *--max-download-limit*
  554. option. Default: '0'
  555. *--max-download-limit*=SPEED::
  556. Set max download speed per each download in bytes/sec. '0' means
  557. unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To
  558. limit the overall download speed, use *--max-overall-download-limit*
  559. option. Default: '0'
  560. *--no-conf*::
  561. Disable loading aria2.conf file.
  562. *--no-file-allocation-limit*=SIZE::
  563. No file allocation is made for files whose size is smaller than SIZE.
  564. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  565. Default: '5M'
  566. *-P*, *--parameterized-uri*[='true'|'false']::
  567. Enable parameterized URI support.
  568. You can specify set of parts: 'http://{sv1,sv2,sv3}/foo.iso'.
  569. Also you can specify numeric sequences with step counter:
  570. '\http://host/image[000-100:2].img'.
  571. A step counter can be omitted.
  572. If all URIs do not point to the same file, such as the second example above,
  573. -Z option is required.
  574. Default: 'false'
  575. *-q*, *--quiet*[='true'|'false']::
  576. Make aria2 quiet (no console output).
  577. Default: 'false'
  578. *--realtime-chunk-checksum*='true'|'false'::
  579. Validate chunk of data by calculating checksum while downloading a file if
  580. chunk checksums are provided.
  581. Default: 'true'
  582. *--stop*=SEC::
  583. Stop application after SEC seconds has passed.
  584. If '0' is given, this feature is disabled.
  585. Default: '0'
  586. *-v*, *--version*::
  587. Print the version number, copyright and the configuration information and
  588. exit.
  589. Options That Take An Optional Argument
  590. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  591. The options that have its argument surrounded by square brackets([])
  592. take an optional argument. Usually omiting the argument is evaluated to 'true'.
  593. If you use short form of these options(such as '-V') and give
  594. an argument, then the option name and its argument should be concatenated(e.g.
  595. '-Vfalse'). If any spaces are inserted between the option name and the argument,
  596. the argument will be treated as URI and usually this is not what you expect.
  597. URL, TORRENT_FILE, METALINK_FILE
  598. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  599. You can specify multiple URLs in command-line.
  600. Unless you specify *-Z* option, all URLs must point to the same file or downloading will fail.
  601. You can also specify arbitrary number of torrent files and metalink files
  602. stored on a local drive. Please note that they are always treated as a
  603. separate download.
  604. You can specify both torrent file with -T option and URLs. By doing
  605. this, you can download a file from both torrent swarm and HTTP(S)/FTP
  606. server at the same time, while the data from HTTP(S)/FTP are uploaded
  607. to the torrent swarm. For single file torrents, URL can be a complete
  608. URL pointing to the resource or if URL ends with /, name in torrent
  609. file in torrent is added. For multi-file torrents, name and path are
  610. added to form a URL for each file.
  611. [NOTE]
  612. Make sure that URL is quoted with single(') or double(") quotation if it
  613. contains "&" or any characters that have special meaning in shell.
  614. Resuming Download
  615. ~~~~~~~~~~~~~~~~~
  616. Usually, you can resume transfer by just issuing same command(aria2c
  617. URL) if the previous transfer is made by aria2.
  618. If the previous transfer is made by a browser or wget like sequential
  619. download manager, then use -c option to continue the transfer(aria2c
  620. *-c* URL).
  621. EXIT STATUS
  622. -----------
  623. Because aria2 can handle multiple downloads at once, it encounters
  624. lots of errors in a session. aria2 returns the following exit status
  625. based on the last error encountered.
  626. *0*::
  627. If all downloads are successful.
  628. *1*::
  629. If an unknown error occurs.
  630. *2*::
  631. If time out occurs.
  632. *3*::
  633. If a resource is not found.
  634. *4*::
  635. If aria2 sees the specfied number of "resource not found" error.
  636. See *--max-file-not-found* option).
  637. *5*::
  638. If a download aborts because download speed is too slow.
  639. See *--lowest-speed-limit* option)
  640. *6*::
  641. If network problem occurs.
  642. *7*::
  643. If there are unfinished downloads. This error is only reported if
  644. all finished downloads are successful and there are unfinished
  645. downloads in a queue when aria2 exits by pressing Ctrl-C by an user
  646. or sending TERM or INT signal.
  647. [NOTE]
  648. An error occurred in a finished download will not be reported
  649. as exit status.
  650. ENVIRONMENT
  651. -----------
  652. aria2 recognizes the following environment variables.
  653. http_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  654. Specify proxy server for use in HTTP.
  655. Overrides http-proxy value in configuration file.
  656. The command-line option *--http-proxy* overrides this value.
  657. https_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  658. Specify proxy server for use in HTTPS.
  659. Overrides https-proxy value in configuration file.
  660. The command-line option *--https-proxy* overrides this value.
  661. ftp_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  662. Specify proxy server for use in FTP.
  663. Overrides ftp-proxy value in configuration file.
  664. The command-line option *--ftp-proxy* overrides this value.
  665. all_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  666. Specify proxy server for use if no protocol-specific proxy is specified.
  667. Overrides all-proxy value in configuration file.
  668. The command-line option *--all-proxy* overrides this value.
  669. no_proxy [DOMAIN,...]::
  670. Specify comma-separated hostname or domains to which proxy should not be used.
  671. Overrides no-proxy value in configuration file.
  672. The command-line option *--no-proxy* overrides this value.
  673. FILES
  674. -----
  675. aria2.conf
  676. ~~~~~~~~~~
  677. By default, aria2 parses '$HOME/.aria2/aria2.conf' as a configuraiton
  678. file. You can specify the path to configuration file using
  679. *--conf-path* option. If you don't want to use the configuraitonf
  680. file, use *--no-conf* option.
  681. The configuration file is a text file and has 1 option per each
  682. line. In each line, you can specify name-value pair in the format:
  683. NAME=VALUE, where name is the long command-line option name without
  684. "--" prefix. You can use same syntax for the command-line option. The
  685. lines beginning "#" are treated as comments.
  686. --------------------------------------
  687. # sample configuration file for aria2c
  688. listen-port=60000
  689. dht-listen-port=60000
  690. seed-ratio=1.0
  691. max-upload-limit=50K
  692. ftp-pasv=true
  693. --------------------------------------
  694. dht.dat
  695. ~~~~~~~~
  696. By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.
  697. Control File
  698. ~~~~~~~~~~~~
  699. aria2 uses a control file to track the progress of a download. A
  700. control file is placed in the same directory as the downloading file
  701. and its filename is the filename of downloading file with ".aria2"
  702. appended. For example, if you are downloading file.zip, then the
  703. control file should be file.zip.aria2. (There is a exception for this
  704. naming convention. If you are downloading a multi torrent, its
  705. control file is the "top directory" name of the torrent with ".aria2"
  706. appended. The "top directory" name is a value of "name" key in "info"
  707. directory in a torrent file.)
  708. Usually a control file is deleted once download completed. If aria2
  709. decides that download cannot be resumed(for example, when downloading
  710. a file from a HTTP server which doesn't support resume), a control
  711. file is not created.
  712. Normally if you lose a control file, you cannot resume download. But
  713. if you have a torrent or metalink with chunk checksums for the file,
  714. you can resume the download without a control file by giving -V option
  715. to aria2c in command-line.
  716. Input File
  717. ~~~~~~~~~~
  718. The input file can contain a list of URIs for aria2 to download. You
  719. can specify multiple URIs for a single entity: separate URIs on a
  720. single line using the TAB character.
  721. Each line is treated as if it is provided in command-line argument.
  722. Therefore they are affected by *-Z* and *-P* options.
  723. Additionally, the following options can be specified after each line
  724. of URIs. These optional lines must start with white space(s).
  725. * dir
  726. * check-integrity
  727. * continue
  728. * all-proxy
  729. * connect-timeout
  730. * dry-run
  731. * lowest-speed-limit
  732. * max-file-not-found
  733. * max-tries
  734. * no-proxy
  735. * out
  736. * proxy-method
  737. * remote-time
  738. * split
  739. * timeout
  740. * http-auth-challenge
  741. * http-user
  742. * http-passwd
  743. * http-proxy
  744. * https-proxy
  745. * referer
  746. * enable-http-keep-alive
  747. * enable-http-pipelining
  748. * header
  749. * use-head
  750. * user-agent
  751. * ftp-user
  752. * ftp-passwd
  753. * ftp-pasv
  754. * ftp-proxy
  755. * ftp-type
  756. * ftp-reuse-connection
  757. * no-netrc
  758. * select-file
  759. * bt-external-ip
  760. * bt-hash-check-seed
  761. * bt-max-open-files
  762. * bt-max-peers
  763. * bt-min-crypto-level
  764. * bt-require-crypto
  765. * bt-request-peer-speed-limit
  766. * bt-seed-unverified
  767. * bt-stop-timeout
  768. * bt-tracker-interval
  769. * enable-peer-exchange
  770. * follow-torrent
  771. * index-out
  772. * max-upload-limit
  773. * seed-ratio
  774. * seed-time
  775. * follow-metalink
  776. * metalink-servers
  777. * metalink-language
  778. * metalink-location
  779. * metalink-os
  780. * metalink-version
  781. * metalink-preferred-protocol
  782. * metalink-enable-unique-protocol
  783. * allow-overwrite
  784. * allow-piece-length-change
  785. * async-dns
  786. * auto-file-renaming
  787. * file-allocation
  788. * max-download-limit
  789. * no-file-allocation-limit
  790. * parameterized-uri
  791. * realtime-chunk-checksum
  792. These options have exactly same meaning of the ones in the
  793. command-line options, but it just applies to the URIs it belongs to.
  794. For example, the content of uri.txt is
  795. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  796. http://server/file.iso http://mirror/file.iso
  797. dir=/iso_images
  798. out=file.img
  799. http://foo/bar
  800. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  801. If aria2 is executed with *-i* uri.txt *-d* /tmp options, then
  802. 'file.iso' is saved as '/iso_images/file.img' and it is downloaded
  803. from \http://server/file.iso and \http://mirror/file.iso. The file
  804. 'bar' is downloaded from \http://foo/bar and saved as '/tmp/bar'.
  805. In some cases, *out* parameter has no effect. See note of *--out*
  806. option for the restrictions.
  807. Server Performance Profile
  808. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  809. This section describes the format of server performance profile. The
  810. file is plain text and each line has several NAME=VALUE pair,
  811. delimited by comma. Currently following NAMEs are recognized:
  812. host::
  813. Hostname of the server. Required.
  814. protocol::
  815. Protocol for this profile, such as ftp, http. Required.
  816. dl_speed::
  817. The average download speed observed in the previous download in
  818. bytes per sec. Required.
  819. sc_avg_speed::
  820. The average download speed observed in the previous download in
  821. bytes per sec. This value is only updated if the download is done in
  822. single connection environment and only used by
  823. AdaptiveURISelector. Optional.
  824. mc_avg_speed::
  825. The average download speed observed in the previous download in
  826. bytes per sec. This value is only updated if the download is done in
  827. multi connection environment and only used by
  828. AdaptiveURISelector. Optional.
  829. counter::
  830. How many times the server is used. Currently this value is only used
  831. by AdaptiveURISelector. Optional.
  832. last_updated::
  833. Last contact time in GMT with this server, specified in the seconds
  834. from the Epoch. Required.
  835. status::
  836. ERROR is set when server cannot be reached or out-of-service or
  837. timeout occurred. Otherwise, OK is set.
  838. Those fields must exist in one line. The order of the fields is not
  839. significant. You can put pairs other than the above; they are simply
  840. ignored.
  841. An example follows:
  842. --------------------------------------------------------------------------------
  843. host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
  844. host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
  845. --------------------------------------------------------------------------------
  846. XML-RPC INTERFACE
  847. -----------------
  848. Terminology
  849. ~~~~~~~~~~~
  850. GID::
  851. GID(or gid) is the key to manage each download. Each download has an
  852. unique GID. Currently GID looks like an integer, but don't treat it
  853. as integer because it may be changed to another type in the future
  854. release.
  855. Methods
  856. ~~~~~~~
  857. *aria2.addUri* 'uris[, options[, position]]'
  858. This method adds new HTTP(S)/FTP download. 'uris' is of type array
  859. and its element is URI which is of type string. 'options' is of type
  860. struct and its members are a pair of option name and value. See
  861. *Options* below for more details. If 'position' is given as an
  862. integer starting from 0, the new download is inserted at 'position' in
  863. the waiting queue. If 'position' is not given or 'position' is larger
  864. than the size of the queue, it is appended at the end of the queue.
  865. This method returns GID of registered download.
  866. *aria2.addTorrent* 'torrent[, uris[, options[, position]]]'
  867. This method adds BitTorrent download by uploading .torrent file.
  868. 'torrent' is of type base64 which contains Base64-encoded .torrent
  869. file. 'uris' is of type array and its element is URI which is of type
  870. string. 'uris' is used for Web-seeding. For single file torrents, URI
  871. can be a complete URI pointing to the resource or if URI ends with /,
  872. name in torrent file is added. For multi-file torrents, name and path
  873. in torrent are added to form a URI for each file. 'options' is of
  874. type struct and its members are a pair of option name and value. See
  875. *Options* below for more details. If 'position' is given as an
  876. integer starting from 0, the new download is inserted at 'position' in
  877. the waiting queue. If 'position' is not given or 'position' is larger
  878. than the size of the queue, it is appended at the end of the queue.
  879. This method returns GID of registered download.
  880. *aria2.addMetalink* 'metalink[, options[, position]]'
  881. This method adds Metalink download by uploading .metalink file.
  882. 'metalink' is of type base64 which contains Base64-encoded .metalink
  883. file. 'options' is of type struct and its members are a pair of
  884. option name and value. See *Options* below for more details. If
  885. 'position' is given as an integer starting from 0, the new download is
  886. inserted at 'position' in the waiting queue. If 'position' is not
  887. given or 'position' is larger than the size of the queue, it is
  888. appended at the end of the queue. This method returns array of GID of
  889. registered download.
  890. *aria2.remove* 'gid'
  891. This method removes the download denoted by 'gid'. 'gid' is of type
  892. string. If specified download is in progress, it is stopped at
  893. first. The status of removed download becomes "removed". This method
  894. returns GID of removed download.
  895. *aria2.tellStatus* 'gid'
  896. This method returns download progress of the download denoted by
  897. 'gid'. 'gid' is of type string. The response is of type struct and it
  898. contains following keys. The value type is string.
  899. gid::
  900. GID of this download.
  901. status::
  902. "active" for currently downloading/seeding entry. "waiting" for the
  903. entry in the queue; download is not started. "error" for the stopped
  904. download because of error. "complete" for the stopped and completed
  905. download. "removed" for the download removed by user.
  906. totalLength::
  907. Total length of this download in bytes.
  908. completedLength::
  909. Completed length of this download in bytes.
  910. uploadLength::
  911. Uploaded length of this download in bytes.
  912. bitfield::
  913. Hexadecimal representation of the download progress. The highest bit
  914. corresponds to piece index 0. The set bits indicate the piece is
  915. available and unset bits indicate the piece is missing. The spare
  916. bits at the end are set to zero.
  917. downloadSpeed::
  918. Download speed of this download measured in bytes/sec.
  919. uploadSpeed::
  920. Upload speed of this download measured in bytes/sec.
  921. infoHash::
  922. InfoHash. BitTorrent only.
  923. numSeeders::
  924. The number of seeders the client has connected to. BitTorrent only.
  925. pieceLength::
  926. Piece length in bytes.
  927. numPieces::
  928. The number of pieces.
  929. connections::
  930. The number of peers/servers the client has connected to.
  931. errorCode::
  932. The last error code occurred in this download. The value is of type
  933. string. The error codes are defined in EXIT STATUS section. This
  934. value is only available for stopped/completed downloads.
  935. *aria2.getUris* 'gid'
  936. This method returns URIs used in the download denoted by 'gid'. 'gid'
  937. is of type string. The response is of type array and its element is of
  938. type struct and it contains following keys. The value type is string.
  939. uri::
  940. URI
  941. *aria2.getFiles* 'gid'
  942. This method returns file list of the download denoted by 'gid'. 'gid'
  943. is of type string. The response is of type array and its element is of
  944. type struct and it contains following keys. The value type is string.
  945. index::
  946. Index of file. Starting with 1. This is the same order with the
  947. files in multi-file torrent.
  948. path::
  949. File path.
  950. length::
  951. File size in bytes.
  952. selected::
  953. "true" if this file is selected by *--select-file* option. If
  954. *--select-file* is not specified or this is single torrent or no
  955. torrent download, this value is always "true". Otherwise "false".
  956. *aria2.getPeers* 'gid'
  957. This method returns peer list of the download denoted by 'gid'. 'gid'
  958. is of type string. This method is for BitTorrent only. The response
  959. is of type array and its element is of type struct and it contains
  960. following keys. The value type is string.
  961. peerId::
  962. Percent-encoded peer ID.
  963. ip::
  964. IP address of the peer.
  965. port::
  966. Port number of the peer.
  967. bitfield::
  968. Hexadecimal representation of the download progress of the peer. The
  969. highest bit corresponds to piece index 0. The set bits indicate the
  970. piece is available and unset bits indicate the piece is missing. The
  971. spare bits at the end are set to zero.
  972. amChoking::
  973. "true" if this client is choking the peer. Otherwise "false".
  974. peerChoking::
  975. "true" if the peer is choking this client. Otherwise "false".
  976. downloadSpeed::
  977. Download speed (byte/sec) that this client obtains from the peer.
  978. uploadSpeed::
  979. Upload speed(byte/sec) that this client uploads to the peer.
  980. seeder::
  981. "true" is this client is a seeder. Otherwise "false".
  982. *aria2.tellActive*
  983. This method returns the list of active downloads. The respose is of
  984. type array and its element is the same struct returned by
  985. *aria2.tellStatus* method.
  986. *aria2.tellWaiting* 'offset, num'
  987. This method returns the list of waiting download in the range of
  988. ['offset', 'offset'+'num'). 'offset' is of type integer and specifies
  989. the offset from the download waiting at the front. 'num' is of type
  990. integer and specifies the number of downloads to be returned. For
  991. example, imagine that three downloads "A","B" and "C" are waiting in
  992. this order. aria2.tellWaiting(0, 1) returns "A". aria2.tellWaiting(1,
  993. 2) returns "B" and "C". The respose is of type array and its element
  994. is the same struct returned by *aria2.tellStatus* method.
  995. *aria2.changeOption* 'gid, options'
  996. This method changes options of the download denoted by 'gid'
  997. dynamically. 'gid' is of type string. 'options' is of type struct
  998. and the available options are *max-download-limit* and *max-upload-limit*.
  999. This method returns "OK" for success.
  1000. *aria2.changeGlobalOption* 'options'
  1001. This method changes global options dynamically. 'options' is of type
  1002. struct and the available options are *max-concurrent-downloads*,
  1003. *max-overall-download-limit* and *max-overall-upload-limit*. This
  1004. method returns "OK" for success.
  1005. *aria2.purgeDownloadResult*
  1006. This method purges completed/error/removed downloads to free memory.
  1007. This method returns "OK".
  1008. *aria2.getVersion*
  1009. This method returns version of the program and the list of enabled
  1010. features. The response is of type struct and contains following keys.
  1011. version::
  1012. Version number of the program in string.
  1013. enabledFeatures::
  1014. List of enabled features. Each feature name is of type string.
  1015. Error Handling
  1016. ~~~~~~~~~~~~~~
  1017. In case of error, aria2 returns faultCode=1 and the error message in
  1018. faultString.
  1019. Options
  1020. ~~~~~~~
  1021. Same options for *-i* list are available. See *Input File* subsection
  1022. for complete list of options.
  1023. In the option struct, name element is option name(without preceeding
  1024. "--") and value element is argument as string.
  1025. -------------------------------------------------
  1026. <struct>
  1027. <member>
  1028. <name>split</name>
  1029. <value><string>1</string></value>
  1030. </member>
  1031. <member>
  1032. <name>http-proxy</name>
  1033. <value><string>http://proxy/</string></value>
  1034. </member>
  1035. </struct>
  1036. -------------------------------------------------
  1037. *header* and *index-out* option are allowed multiple times in
  1038. command-line. Since name should be unique in struct(many XML-RPC
  1039. library implementation uses hash or dict for struct), single string is
  1040. not enough. To overcome this situation, they can take array as value
  1041. as well as string.
  1042. ---------------------------------------------------------------
  1043. <struct>
  1044. <member>
  1045. <name>header</name>
  1046. <value>
  1047. <array>
  1048. <data>
  1049. <value><string>Accept-Language: ja</string></value>
  1050. <value><string>Accept-Charset: utf-8</string></value>
  1051. </data>
  1052. </array>
  1053. </value>
  1054. </member>
  1055. </struct>
  1056. ---------------------------------------------------------------
  1057. Sample XML-RPC Client Code
  1058. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  1059. The following Ruby script adds 'http://localhost/aria2.tar.bz2' to
  1060. aria2c operated on localhost with option *--dir*='/downloads' and
  1061. prints its reponse.
  1062. ----------------------------------------------
  1063. #!/usr/bin/env ruby
  1064. require 'xmlrpc/client'
  1065. require 'pp'
  1066. client=XMLRPC::Client.new2("http://localhost:6800/rpc")
  1067. options={ "dir" => "/downloads" }
  1068. result=client.call("aria2.addUri", [ "http://localhost/aria2.tar.bz2" ], options)
  1069. pp result
  1070. ----------------------------------------------
  1071. EXAMPLE
  1072. -------
  1073. HTTP/FTP Segmented Download
  1074. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1075. Download a file
  1076. ^^^^^^^^^^^^^^^
  1077. --------------------------------
  1078. aria2c "http://host/file.zip"
  1079. --------------------------------
  1080. [NOTE]
  1081. aria2 uses 5 connections to download 1 file by default.
  1082. Download a file using 1 connection
  1083. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1084. ----------------------------------
  1085. aria2c -s1 "http://host/file.zip"
  1086. ----------------------------------
  1087. [NOTE]
  1088. aria2 uses 5 connections to download 1 file by default.
  1089. -s1 limits the number of connections to just 1.
  1090. [NOTE]
  1091. To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory. You can change URLs as long as they are pointing to the same file.
  1092. Download a file from 2 different HTTP servers
  1093. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1094. ------------------------------------------------------
  1095. aria2c "http://host/file.zip" "http://mirror/file.zip"
  1096. ------------------------------------------------------
  1097. Download a file from HTTP and FTP servers
  1098. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1099. -----------------------------------------------------
  1100. aria2c "http://host1/file.zip" "ftp://host2/file.zip"
  1101. -----------------------------------------------------
  1102. Download files listed in a text file concurrently
  1103. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1104. ------------------------
  1105. aria2c -ifiles.txt -j2
  1106. ------------------------
  1107. [NOTE]
  1108. -j option specifies the number of parallel downloads.
  1109. Using proxy
  1110. ^^^^^^^^^^^
  1111. For HTTP:
  1112. ----------------------------------------------------------
  1113. aria2c --http-proxy="http://proxy:8080" "http://host/file"
  1114. ----------------------------------------------------------
  1115. For FTP:
  1116. --------------------------------------------------------
  1117. aria2c --ftp-proxy="http://proxy:8080" "ftp://host/file"
  1118. --------------------------------------------------------
  1119. [NOTE]
  1120. See *--http-proxy*, *--https-proxy*, *--ftp-proxy* and *--all-proxy* for
  1121. details.
  1122. You can specify proxy in the environment variables. See *ENVIRONMENT* section.
  1123. Proxy with authorization
  1124. ^^^^^^^^^^^^^^^^^^^^^^^^
  1125. ----------------------------------------------------------------------------
  1126. aria2c --http-proxy="http://username:password@proxy:8080" "http://host/file"
  1127. ----------------------------------------------------------------------------
  1128. Metalink Download
  1129. ~~~~~~~~~~~~~~~~~
  1130. Download files with remote Metalink
  1131. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1132. --------------------------------------------------------
  1133. aria2c --follow-metalink=mem "http://host/file.metalink"
  1134. --------------------------------------------------------
  1135. Download using a local metalink file
  1136. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1137. ----------------------------------------------------------
  1138. aria2c -p --lowest-speed-limit=4000 file.metalink
  1139. ----------------------------------------------------------
  1140. [NOTE]
  1141. To pause a download, press Ctrl-C.
  1142. You can resume the transfer by running aria2c with the same argument in the same
  1143. directory.
  1144. Download several local metalink files
  1145. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1146. ----------------------------------------
  1147. aria2c -j2 file1.metalink file2.metalink
  1148. ----------------------------------------
  1149. Download only selected files using index
  1150. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1151. -------------------------------------------
  1152. aria2c --select-file=1-4,8 file.metalink
  1153. -------------------------------------------
  1154. [NOTE]
  1155. The index is printed to the console using -S option.
  1156. Download a file using a local .metalink file with user preference
  1157. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1158. ------------------------------------------------------------------------------
  1159. aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US file.metalink
  1160. ------------------------------------------------------------------------------
  1161. BitTorrent Download
  1162. ~~~~~~~~~~~~~~~~~~~
  1163. Download files from remote BitTorrent file
  1164. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1165. ------------------------------------------------------
  1166. aria2c --follow-torrent=mem "http://host/file.torrent"
  1167. ------------------------------------------------------
  1168. Download using a local torrent file
  1169. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1170. ---------------------------------------------
  1171. aria2c --max-upload-limit=40K file.torrent
  1172. ---------------------------------------------
  1173. [NOTE]
  1174. --max-upload-limit specifies the max of upload rate.
  1175. [NOTE]
  1176. To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory.
  1177. Download 2 torrents
  1178. ^^^^^^^^^^^^^^^^^^^
  1179. --------------------------------------
  1180. aria2c -j2 file1.torrent file2.torrent
  1181. --------------------------------------
  1182. Download a file using torrent and HTTP/FTP server
  1183. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1184. ------------------------------------------------------------
  1185. aria2c -Ttest.torrent "http://host1/file" "ftp://host2/file"
  1186. ------------------------------------------------------------
  1187. [NOTE]
  1188. Downloading multi file torrent with HTTP/FTP is not supported.
  1189. Download only selected files using index(usually called "selectable download")
  1190. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1191. ---------------------------------------
  1192. aria2c --select-file=1-4,8 file.torrent
  1193. ---------------------------------------
  1194. [NOTE]
  1195. The index is printed to the console using -S option.
  1196. Specify output filename
  1197. ^^^^^^^^^^^^^^^^^^^^^^^
  1198. To specify output filename for BitTorrent downloads, you need to know
  1199. the index of file in torrent file using *-S* option. For example, the
  1200. output looks like this:
  1201. --------------------------
  1202. idx|path/length
  1203. ===+======================
  1204. 1|dist/base-2.6.18.iso
  1205. |99.9MiB
  1206. ---+----------------------
  1207. 2|dist/driver-2.6.18.iso
  1208. |169.0MiB
  1209. ---+----------------------
  1210. --------------------------
  1211. To save 'dist/base-2.6.18.iso' in '/tmp/mydir/base.iso' and
  1212. 'dist/driver-2.6.18.iso' in '/tmp/dir/driver.iso', use the following
  1213. command:
  1214. -----------------------------------------------------------------------------------------
  1215. aria2c --dir=/tmp --index-out=1=mydir/base.iso --index-out=2=dir/driver.iso file.torrent
  1216. -----------------------------------------------------------------------------------------
  1217. Change the listening port for incoming peer
  1218. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1219. ---------------------------------------------------
  1220. aria2c --listen-port=7000-7001,8000 file.torrent
  1221. ---------------------------------------------------
  1222. [NOTE]
  1223. Since aria2 doesn't configure firewall or router for port forwarding, it's up
  1224. to you to do it manually.
  1225. Specify the condition to stop program after torrent download finished
  1226. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1227. -------------------------------------------------------
  1228. aria2c --seed-time=120 --seed-ratio=1.0 file.torrent
  1229. -------------------------------------------------------
  1230. [NOTE]
  1231. In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.
  1232. Throttle upload speed
  1233. ^^^^^^^^^^^^^^^^^^^^^
  1234. ----------------------------------------------
  1235. aria2c --max-upload-limit=100K file.torrent
  1236. ----------------------------------------------
  1237. Enable DHT
  1238. ^^^^^^^^^^
  1239. ---------------------------------------------------------
  1240. aria2c --enable-dht --dht-listen-port=6881 file.torrent
  1241. ---------------------------------------------------------
  1242. [NOTE]
  1243. DHT uses udp port. Since aria2 doesn't configure firewall or router for port
  1244. forwarding, it's up to you to do it manually.
  1245. More advanced HTTP features
  1246. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1247. Load cookies
  1248. ^^^^^^^^^^^^
  1249. --------------------------------------------------------
  1250. aria2c --load-cookies=cookies.txt "http://host/file.zip"
  1251. --------------------------------------------------------
  1252. [NOTE]
  1253. You can use Firefox/Mozilla's cookie file without modification.
  1254. Resume download started by web browsers or another programs
  1255. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1256. -------------------------------------------------------
  1257. aria2c -c -s2 "http://host/partiallydownloadedfile.zip"
  1258. -------------------------------------------------------
  1259. Client certificate authorization for SSL/TLS
  1260. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1261. ------------------------------------------------------------------------------------------
  1262. aria2c --certificate=/path/to/mycert.pem --private-key=/path/to/mykey.pem https://host/file
  1263. ------------------------------------------------------------------------------------------
  1264. [NOTE]
  1265. The file specified in *--private-key* must be decrypted. The behavior when
  1266. encrypted one is given is undefined.
  1267. Verify peer in SSL/TLS using given CA certificates
  1268. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1269. ------------------------------------------------------------------------------------------
  1270. aria2c --ca-certificate=/path/to/ca-certificates.crt --check-certificate https://host/file
  1271. ------------------------------------------------------------------------------------------
  1272. And more advanced features
  1273. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  1274. Throttle download speed
  1275. ^^^^^^^^^^^^^^^^^^^^^^^
  1276. -------------------------------------------------
  1277. aria2c --max-download-limit=100K file.metalink
  1278. -------------------------------------------------
  1279. Repair a damaged download
  1280. ^^^^^^^^^^^^^^^^^^^^^^^^^
  1281. -----------------------
  1282. aria2c -V file.metalink
  1283. -----------------------
  1284. [NOTE]
  1285. This option is only available used with BitTorrent or metalink with chunk
  1286. checksums.
  1287. Drop connection if download speed is lower than specified value
  1288. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1289. ------------------------------------------------
  1290. aria2c --lowest-speed-limit=10K file.metalink
  1291. ------------------------------------------------
  1292. Parameterized URI support
  1293. ^^^^^^^^^^^^^^^^^^^^^^^^^
  1294. You can specify set of parts:
  1295. -----------------------------------------------
  1296. aria2c -P "http://{host1,host2,host3}/file.iso"
  1297. -----------------------------------------------
  1298. You can specify numeric sequence:
  1299. ---------------------------------------------
  1300. aria2c -Z -P "http://host/image[000-100].png"
  1301. ---------------------------------------------
  1302. [NOTE]
  1303. -Z option is required if the all URIs don't point to the same file, such as the above example.
  1304. You can specify step counter:
  1305. -------------------------------------------
  1306. aria2c -Z -P "http://host/image[A-Z:2].png"
  1307. -------------------------------------------
  1308. Parallel downloads of arbitrary number of URL,metalink,torrent
  1309. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1310. --------------------------------------------------------------
  1311. aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink
  1312. --------------------------------------------------------------
  1313. BitTorrent Encryption
  1314. ^^^^^^^^^^^^^^^^^^^^^
  1315. Encrypt whole payload using ARC4:
  1316. -------------------------------------------------------------------------
  1317. aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent
  1318. -------------------------------------------------------------------------
  1319. SEE ALSO
  1320. --------
  1321. Project Web Site: http://aria2.sourceforge.net/
  1322. aria2 Wiki: http://sourceforge.net/apps/trac/aria2/wiki
  1323. Metalink Homepage: http://www.metalinker.org/
  1324. COPYRIGHT
  1325. ---------
  1326. Copyright (C) 2006, 2009 Tatsuhiro Tsujikawa
  1327. This program is free software; you can redistribute it and/or modify
  1328. it under the terms of the GNU General Public License as published by
  1329. the Free Software Foundation; either version 2 of the License, or
  1330. (at your option) any later version.
  1331. This program is distributed in the hope that it will be useful,
  1332. but WITHOUT ANY WARRANTY; without even the implied warranty of
  1333. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  1334. GNU General Public License for more details.
  1335. You should have received a copy of the GNU General Public License
  1336. along with this program; if not, write to the Free Software
  1337. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  1338. In addition, as a special exception, the copyright holders give
  1339. permission to link the code of portions of this program with the
  1340. OpenSSL library under certain conditions as described in each
  1341. individual source file, and distribute linked combinations
  1342. including the two.
  1343. You must obey the GNU General Public License in all respects
  1344. for all of the code used other than OpenSSL. If you modify
  1345. file(s) with this exception, you may extend this exception to your
  1346. version of the file(s), but you are not obligated to do so. If you
  1347. do not wish to do so, delete this exception statement from your
  1348. version. If you delete this exception statement from all source
  1349. files in the program, then also delete it here.