aria2c.1.txt 61 KB

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