aria2c.1.txt 56 KB

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