aria2c.1.txt 83 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413
  1. ARIA2C(1)
  2. =========
  3. Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
  4. :man source: Aria2
  5. :man manual: Aria2 Manual
  6. :man version: 1.10.3
  7. NAME
  8. ----
  9. aria2c - The ultra fast download utility
  10. SYNOPSIS
  11. --------
  12. aria2c ['OPTIONS'] ['URI' | 'MAGNET' | 'TORRENT_FILE' | 'METALINK_FILE']...
  13. DESCRIPTION
  14. -----------
  15. aria2 is a utility for downloading files. The supported protocols are
  16. HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
  17. multiple sources/protocols and tries to utilize your maximum download
  18. bandwidth. It supports downloading a file from HTTP(S)/FTP and
  19. BitTorrent at the same time, while the data downloaded from
  20. HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's
  21. chunk checksums, aria2 automatically validates chunks of data while
  22. downloading a file like BitTorrent.
  23. OPTIONS
  24. -------
  25. Basic Options
  26. ~~~~~~~~~~~~~
  27. *-d*, *--dir*=DIR::
  28. The directory to store the downloaded file.
  29. *-i*, *--input-file*=FILE::
  30. Downloads URIs found in FILE. You can specify multiple URIs for a single
  31. entity: separate URIs on a single line using the TAB character.
  32. Reads input from stdin when '-' is specified.
  33. The additional *out* and *dir* options can be specified after each line of
  34. URIs. This optional line must start with white space(s).
  35. See *Input File* subsection for details.
  36. *-l*, *--log*=LOG::
  37. The file name of the log file. If '-' is specified, log is written to
  38. stdout. If empty string("") is specified, log is not written to file.
  39. *-j*, *--max-concurrent-downloads*=N::
  40. Set maximum number of parallel downloads for every static (HTTP/FTP) URI,
  41. torrent and metalink. See also *-s* and *-C* option.
  42. Default: '5'
  43. *-V*, *--check-integrity*[='true'|'false']::
  44. Check file integrity by validating piece hashes or a hash of entire
  45. file. This option has effect only in BitTorrent and Metalink
  46. downloads with checksums. If piece hashes are provided, this option
  47. can detect damaged portions of a file and re-download them. If a
  48. hash of entire file is provided, hash check is only done when file
  49. has benn already download. This is determined by file length. If
  50. hash check fails, file is re-downloaded from scratch. If both piece
  51. hashes and a hash of entire file are provided, only piece hashes are
  52. used. Default: 'false'
  53. *-c*, *--continue*::
  54. Continue downloading a partially downloaded file.
  55. Use this option to resume a download started by a web browser or another
  56. program which downloads files sequentially from the beginning.
  57. Currently this option is only applicable to HTTP(S)/FTP downloads.
  58. *-h*, *--help*[=TAG|KEYWORD]::
  59. The help messages are classified with tags. A tag starts with
  60. "#". For example, type "--help=#http" to get the usage for the
  61. options tagged with "#http". If non-tag word is given, print the
  62. usage for the options whose name includes that word.
  63. Available Values: '#basic', '#advanced', '#http', '#https', '#ftp',
  64. '#metalink', '#bittorrent', '#cookie', '#hook', '#file',
  65. '#xml-rpc', '#experimental', '#all'
  66. Default: '#basic'
  67. HTTP/FTP Options
  68. ~~~~~~~~~~~~~~~~
  69. *--all-proxy*=PROXY::
  70. Use this proxy server for all protocols. To erase previously
  71. defined proxy, use "". You can override this setting and specify a
  72. proxy server for a particular protocol using *--http-proxy*,
  73. *--https-proxy* and *--ftp-proxy* options. This affects all URIs.
  74. The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  75. [NOTE]
  76. If user and password are embedded in proxy URI and they are also
  77. specified by *--{http,https,ftp,all}-proxy-{user,passwd}* options,
  78. those appeared later have precedence. For example, you have
  79. http-proxy-user="myname", http-proxy-passwd="mypass" in aria2.conf and
  80. you specify --http-proxy="http://proxy" in command-line, then you get
  81. HTTP proxy "http://proxy" with user "myname" and password
  82. "mypass". Another example: if you specified in command-line
  83. --http-proxy="http://user:pass@proxy" --http-proxy-user="myname"
  84. --http-proxy-passwd="mypass", then you will get HTTP proxy
  85. "http://proxy" with user "myname" and password "mypass". One more
  86. example: if you specified in command-line --http-proxy-user="myname"
  87. --http-proxy-passwd="mypass" --http-proxy="http://user:pass@proxy",
  88. then you get HTTP proxy "http://proxy" with user "user" and password
  89. "pass".
  90. *--all-proxy-passwd*=PASSWD::
  91. Set password for *--all-proxy* option.
  92. *--all-proxy-user*=USER::
  93. Set user for *--all-proxy* option.
  94. *--connect-timeout*=SEC::
  95. Set the connect timeout in seconds to establish connection to
  96. HTTP/FTP/proxy server. After the connection is established, this
  97. option makes no effect and *--timeout* option is used instead.
  98. Default: '60'
  99. *--dry-run*[='true'|'false']::
  100. If 'true' is given, aria2 just checks whether the remote file is
  101. available and doesn't download data. This option has effect on
  102. HTTP/FTP download. BitTorrent downloads are canceled if 'true' is
  103. specified. Default: 'false'
  104. *--lowest-speed-limit*=SPEED::
  105. Close connection if download speed is lower than or equal to this
  106. value(bytes per sec).
  107. '0' means aria2 does not have a lowest speed limit.
  108. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  109. This option does not affect BitTorrent downloads.
  110. Default: '0'
  111. *--max-file-not-found*=NUM::
  112. If aria2 receives `file not found' status from the remote HTTP/FTP
  113. servers NUM times without getting a single byte, then force the
  114. download to fail. Specify '0' to disable this option. This options is
  115. effective only when using HTTP/FTP servers.
  116. Default: '0'
  117. *-m*, *--max-tries*=N::
  118. Set number of tries. '0' means unlimited.
  119. Default: '5'
  120. *-n*, *--no-netrc*::
  121. Disables netrc support. netrc support is enabled by default.
  122. *--no-proxy*=DOMAINS::
  123. Specify comma separated hostnames, domains and network address with
  124. or without CIDR block where proxy should not be used.
  125. [NOTE]
  126. For network address with CIDR block, only IPv4 address works. Current
  127. implementation does not resolve hostname in URI to compare network
  128. address specified in *--no-proxy*. So it is only effecive if URI has
  129. numeric IP addresses.
  130. *-o*, *--out*=FILE::
  131. The file name of the downloaded file. When *-Z* option is used, this
  132. option is ignored.
  133. [NOTE]
  134. In Metalink or BitTorrent download you cannot specify file name.
  135. The file name specified here is only used when the URIs fed to aria2
  136. are done by command line without *-i*, *-Z* option. For example:
  137. aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
  138. *--proxy-method*=METHOD::
  139. Set the method to use in proxy request. 'METHOD' is either 'get' or
  140. 'tunnel'. HTTPS downloads always use 'tunnel' regardless of this
  141. option.
  142. Default: 'get'
  143. *-R*, *--remote-time*[='true'|'false']::
  144. Retrieve timestamp of the remote file from the remote HTTP/FTP
  145. server and if it is available, apply it to the local file.
  146. Default: 'false'
  147. *--reuse-uri[='true'|'false']::
  148. Reuse already used URIs if no unused URIs are left.
  149. Default: 'true'
  150. *--server-stat-of*=FILE::
  151. Specify the filename to which performance profile of the servers is
  152. saved. You can load saved data using *--server-stat-if* option. See
  153. *Server Performance Profile* subsection below for file format.
  154. *--server-stat-if*=FILE::
  155. Specify the filename to load performance profile of the servers. The
  156. loaded data will be used in some URI selector such as 'feedback'.
  157. See also *--uri-selector* option. See *Server Performance Profile*
  158. subsection below for file format.
  159. *--server-stat-timeout*=SEC::
  160. Specifies timeout in seconds to invalidate performance profile of
  161. the servers since the last contact to them.
  162. Default: '86400' (24hours)
  163. *-s*, *--split*=N::
  164. Download a file using N connections. If more than N URIs are given,
  165. first N URIs are used and remaining URIs are used for backup. If
  166. less than N URIs are given, those URIs are used more than once so
  167. that N connections total are made simultaneously. The number of
  168. connections to the same host is restricted by
  169. *--max-connection-per-server* option. Please see *-j* and
  170. *--min-split-size* option too. Please note that in Metalink
  171. download, this option has no effect and use *-C* option instead.
  172. Default: '5'
  173. *-t*, *--timeout*=SEC::
  174. Set timeout in seconds.
  175. Default: '60'
  176. *--uri-selector*=SELECTOR::
  177. Specify URI selection algorithm. The possible values are 'inorder',
  178. 'feedback' and 'adaptive'. If 'inorder' is given, URI is tried in
  179. the order appeared in the URI list. If 'feedback' is given, aria2
  180. uses download speed observed in the previous downloads and choose
  181. fastest server in the URI list. This also effectively skips dead
  182. mirrors. The observed download speed is a part of performance
  183. profile of servers mentioned in *--server-stat-of* and
  184. *--server-stat-if* options. If 'adaptive' is given, selects one of
  185. the best mirrors for the first and reserved connections. For
  186. supplementary ones, it returns mirrors which has not been tested
  187. yet, and if each of them has already been tested, returns mirrors
  188. which has to be tested again. Otherwise, it doesn't select anymore
  189. mirrors. Like 'feedback', it uses a performance profile of servers.
  190. Default: 'feedback'
  191. HTTP Specific Options
  192. ~~~~~~~~~~~~~~~~~~~~~
  193. *--ca-certificate*=FILE::
  194. Use the certificate authorities in FILE to verify the peers.
  195. The certificate file must be in PEM format and can contain multiple CA
  196. certificates.
  197. Use *--check-certificate* option to enable verification.
  198. *--certificate*=FILE::
  199. Use the client certificate in FILE.
  200. The certificate must be in PEM format.
  201. You may use *--private-key* option to specify the private key.
  202. *--check-certificate*[='true'|'false']::
  203. Verify the peer using certificates specified in *--ca-certificate* option.
  204. Default: 'true'
  205. *--http-accept-gzip*[='true'|'false']::
  206. Send "Accept: deflate, gzip" request header and inflate response if
  207. remote server responds with "Content-Encoding: gzip" or
  208. "Content-Encoding: deflate". Default: 'false'
  209. [NOTE]
  210. Some server responds with "Content-Encoding: gzip" for files which
  211. itself is gzipped file. aria2 inflates them anyway because of the
  212. response header.
  213. *--http-auth-challenge*[='true'|'false']::
  214. Send HTTP authorization header only when it is requested by the
  215. server. If 'false' is set, then authorization header is always sent
  216. to the server. There is an exception: if username and password are
  217. embedded in URI, authorization header is always sent to the server
  218. regardless of this option. Default: 'false'
  219. *--http-no-cache*[='true'|'false']::
  220. Send Cache-Control: no-cache and Pragma: no-cache header to avoid
  221. cached content. If 'false' is given, these headers are not sent
  222. and you can add Cache-Control header with a directive you like
  223. using *--header* option. Default: 'true'
  224. *--http-user*=USER::
  225. Set HTTP user. This affects all URIs.
  226. *--http-passwd*=PASSWD::
  227. Set HTTP password. This affects all URIs.
  228. *--http-proxy*=PROXY::
  229. Use this proxy server for HTTP. To erase previously defined proxy,
  230. use "". See also *--all-proxy* option. This affects all URIs. The
  231. format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  232. *--http-proxy-passwd*=PASSWD::
  233. Set password for *--http-proxy* option.
  234. *--http-proxy-user*=USER:
  235. Set user for *--http-proxy* option.
  236. *--https-proxy*=PROXY::
  237. Use this proxy server for HTTPS. To erase previously defined proxy,
  238. use "". See also *--all-proxy* option. This affects all URIs. The
  239. format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  240. *--https-proxy-passwd*=PASSWD::
  241. Set password for *--https-proxy* option.
  242. *--https-proxy-user*=USER::
  243. Set user for *--https-proxy* option.
  244. *--private-key*=FILE::
  245. Use the private key in FILE.
  246. The private key must be decrypted and in PEM format.
  247. The behavior when encrypted one is given is undefined.
  248. See also *--certificate* option.
  249. *--referer*=REFERER::
  250. Set Referer. This affects all URIs.
  251. *--enable-http-keep-alive*[='true'|'false']::
  252. Enable HTTP/1.1 persistent connection.
  253. Default: 'true'
  254. *--enable-http-pipelining*[='true'|'false']::
  255. Enable HTTP/1.1 pipelining.
  256. Default: 'false'
  257. In performance perspective, there is no advantage to enable this
  258. option for normal case.
  259. *--header*=HEADER::
  260. Append HEADER to HTTP request header.
  261. You can use this option repeatedly to specify more than one header:
  262. aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" "http://host/file"
  263. *--load-cookies*=FILE::
  264. Load Cookies from FILE using the Firefox3 format (SQLite3),
  265. Chromium/Google Chrome (SQLite3) and the
  266. Mozilla/Firefox(1.x/2.x)/Netscape format.
  267. [NOTE]
  268. If aria2 is built without libsqlite3, then it doesn't support Firefox3
  269. and Chromium/Google Chrome cookie format.
  270. *--save-cookies*=FILE::
  271. Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape
  272. format. If FILE already exists, it is overwritten. Session Cookies
  273. are also saved and their expiry values are treated as 0. Possible
  274. Values: '/path/to/file'
  275. *--use-head*[='true'|'false']::
  276. Use HEAD method for the first request to the HTTP server.
  277. Default: 'false'
  278. *-U*, *--user-agent*=USER_AGENT::
  279. Set user agent for HTTP(S) downloads.
  280. Default: 'aria2/$VERSION', $VERSION is replaced by package version.
  281. FTP Specific Options
  282. ~~~~~~~~~~~~~~~~~~~~
  283. *--ftp-user*=USER::
  284. Set FTP user. This affects all URIs.
  285. Default: 'anonymous'
  286. *--ftp-passwd*=PASSWD::
  287. Set FTP password. This affects all URIs.
  288. If user name is embedded but password is missing in URI, aria2 tries
  289. to resolve password using .netrc. If password is found in .netrc,
  290. then use it as password. If not, use the password specified in this
  291. option.
  292. Default: 'ARIA2USER@'
  293. *-p*, *--ftp-pasv*[='true'|'false']::
  294. Use the passive mode in FTP.
  295. If 'false' is given, the active mode will be used.
  296. Default: 'true'
  297. *--ftp-proxy*=PROXY::
  298. Use this proxy server for FTP. To erase previously defined proxy,
  299. use "". See also *--all-proxy* option. This affects all URIs. The
  300. format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
  301. *--ftp-proxy-passwd*=PASSWD::
  302. Set password for *--ftp-proxy* option.
  303. *--ftp-proxy-user*=USER::
  304. Set user for *--ftp-proxy* option.
  305. *--ftp-type*=TYPE::
  306. Set FTP transfer type. TYPE is either 'binary' or 'ascii'.
  307. Default: 'binary'
  308. *--ftp-reuse-connection*[='true'|'false']::
  309. Reuse connection in FTP.
  310. Default: 'true'
  311. BitTorrent/Metalink Options
  312. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  313. *--select-file*=INDEX...::
  314. Set file to download by specifying its index.
  315. You can find the file index using the *--show-files* option.
  316. Multiple indexes can be specified by using ",", for example: '3,6'.
  317. You can also use "-" to specify a range: '1-5'.
  318. "," and "-" can be used together: '1-5,8,9'.
  319. When used with the -M option, index may vary depending on the query
  320. (see *--metalink-** options).
  321. [NOTE]
  322. In multi file torrent, the adjacent files specified by this option may
  323. also be downloaded. This is by design, not a bug.
  324. A single piece may include several files or part of files, and aria2
  325. writes the piece to the appropriate files.
  326. *-S*, *--show-files*::
  327. Print file listing of .torrent or .metalink file and exit.
  328. In case of .torrent file, additional information
  329. (infohash, piece length, etc) is also printed.
  330. BitTorrent Specific Options
  331. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  332. *--bt-enable-lpd*[='true'|'false']::
  333. Enable Local Peer Discovery. If a private flag is set in a torrent,
  334. aria2 doesn't use this feature for that download even if 'true' is
  335. given. Default: 'false'
  336. *--bt-exclude-tracker*=URI[,...]::
  337. Comma separated list of BitTorrent tracker's announce URI to
  338. remove. You can use special value "\*" which matches all URIs, thus
  339. removes all announce URIs. When specifying "\*" in shell
  340. command-line, don't forget to escape or quote it. See also
  341. *--bt-tracker* option.
  342. *--bt-external-ip*=IPADDRESS::
  343. Specify the external IP address to report to a BitTorrent
  344. tracker. Although this function is named "external", it can accept
  345. any kind of IP addresses. IPADDRESS must be a numeric IP address.
  346. *--bt-hash-check-seed*[='true'|'false']::
  347. If 'true' is given, after hash check using *--check-integrity* option and
  348. file is complete, continue to seed file. If you want to check file
  349. and download it only when it is damaged or incomplete, set this
  350. option to 'false'. This option has effect only on BitTorrent download.
  351. Default: 'true'
  352. *--bt-lpd-interface*=INTERFACE::
  353. Use given interface for Local Peer Discovery. If this option is not
  354. specified, the default interface is chosen. You can specify
  355. interface name and IP address. Possible Values: interface, IP
  356. addres
  357. *--bt-max-open-files*=NUM::
  358. Specify maximum number of files to open in each BitTorrent download.
  359. Default: '100'
  360. *--bt-max-peers*=NUM::
  361. Specify the maximum number of peers per torrent. '0' means
  362. unlimited. See also *--bt-request-peer-speed-limit* option.
  363. Default: '55'
  364. *--bt-metadata-only*[='true'|'false']::
  365. Download metadata only. The file(s) described in metadata will not
  366. be downloaded. This option has effect only when BitTorrent Magnet
  367. URI is used. See also *--bt-save-metadata* option. Default: 'false'
  368. *--bt-min-crypto-level*='plain'|'arc4'::
  369. Set minimum level of encryption method.
  370. If several encryption methods are provided by a peer, aria2 chooses the lowest
  371. one which satisfies the given level.
  372. Default: 'plain'
  373. *--bt-prioritize-piece*='head'[=SIZE],'tail'[=SIZE]::
  374. Try to download first and last pieces of each file first. This is
  375. useful for previewing files. The argument can contain 2 keywords:
  376. 'head' and 'tail'. To include both keywords, they must be separated
  377. by comma. These keywords can take one parameter, SIZE. For example,
  378. if 'head'=SIZE is specified, pieces in the range of first SIZE bytes
  379. of each file get higher priority. 'tail'=SIZE means the range of
  380. last SIZE bytes of each file. SIZE can include 'K' or 'M'(1K = 1024,
  381. 1M = 1024K). If SIZE is omitted, SIZE=1M is used.
  382. *--bt-require-crypto*='true'|'false'::
  383. If true is given, aria2 doesn't accept and establish connection with legacy
  384. BitTorrent handshake(\19BitTorrent protocol).
  385. Thus aria2 always uses Obfuscation handshake.
  386. Default: 'false'
  387. *--bt-request-peer-speed-limit*=SPEED::
  388. If the whole download speed of every torrent is lower than SPEED,
  389. aria2 temporarily increases the number of peers to try for more
  390. download speed. Configuring this option with your preferred download
  391. speed can increase your download speed in some cases.
  392. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  393. Default: '50K'
  394. *--bt-save-metadata*[='true'|'false']::
  395. Save metadata as .torrent file. This option has effect only when
  396. BitTorrent Magnet URI is used. The filename is hex encoded info
  397. hash with suffix .torrent. The directory to be saved is the same
  398. directory where download file is saved. If the same file already
  399. exists, metadata is not saved. See also *--bt-metadata-only*
  400. option. Default: 'false'
  401. *--bt-seed-unverified*[='true'|'false']::
  402. Seed previously downloaded files without verifying piece hashes.
  403. Default: 'false'
  404. *--bt-stop-timeout*=SEC::
  405. Stop BitTorrent download if download speed is 0 in consecutive SEC
  406. seconds. If '0' is given, this feature is disabled. Default: '0'
  407. *--bt-tracker*=URI[,...]::
  408. Comma separated list of additional BitTorrent tracker's announce
  409. URI. These URIs are not affected by *--bt-exclude-tracker* option
  410. because they are added after URIs in *--bt-exclude-tracker* option are
  411. removed.
  412. *--bt-tracker-connect-timeout*=SEC::
  413. Set the connect timeout in seconds to establish connection to
  414. tracker. After the connection is established, this option makes no
  415. effect and *--bt-tracker-timeout* option is used instead. Default:
  416. '60'
  417. *--bt-tracker-interval*=SEC::
  418. Set the interval in seconds between tracker requests. This
  419. completely overrides interval value and aria2 just uses this value
  420. and ignores the min interval and interval value in the response of
  421. tracker. If '0' is set, aria2 determines interval based on the
  422. response of tracker and the download progress. Default: '0'
  423. *--bt-tracker-timeout*=SEC::
  424. Set timeout in seconds. Default: '60'
  425. *--dht-entry-point*=HOST:PORT::
  426. Set host and port as an entry point to IPv4 DHT network.
  427. *--dht-entry-point6*=HOST:PORT::
  428. Set host and port as an entry point to IPv6 DHT network.
  429. *--dht-file-path*=PATH::
  430. Change the IPv4 DHT routing table file to PATH.
  431. Default: '$HOME/.aria2/dht.dat'
  432. *--dht-file-path6*=PATH::
  433. Change the IPv6 DHT routing table file to PATH.
  434. Default: '$HOME/.aria2/dht6.dat'
  435. *--dht-listen-addr6*=ADDR::
  436. Specify address to bind socket for IPv6 DHT. It should be a global
  437. unicast IPv6 address of the host.
  438. *--dht-listen-port*=PORT...::
  439. Set UDP listening port for both IPv4 and IPv6 DHT.
  440. Multiple ports can be specified by using ",", for example: '6881,6885'.
  441. You can also use "-" to specify a range: '6881-6999'. "," and "-" can be used
  442. together.
  443. Default: '6881-6999'
  444. [NOTE]
  445. Make sure that the specified ports are open for incoming UDP traffic.
  446. *--dht-message-timeout*=SEC::
  447. Set timeout in seconds. Default: '10'
  448. *--enable-dht*[='true'|'false']::
  449. Enable IPv4 DHT functionality. If a private flag is set in a
  450. torrent, aria2 doesn't use DHT for that download even if 'true' is
  451. given. Default: 'true'
  452. *--enable-dht6*[='true'|'false']::
  453. Enable IPv6 DHT functionality. If a private flag is set in a
  454. torrent, aria2 doesn't use DHT for that download even if 'true' is
  455. given. Use *--dht-listen-port* option to specify port number to
  456. listen on. See also *--dht-listen-addr6* option.
  457. *--enable-peer-exchange*[='true'|'false']::
  458. Enable Peer Exchange extension. If a private flag is set in a torrent, this
  459. feature is disabled for that download even if 'true' is given.
  460. Default: 'true'
  461. *--follow-torrent*='true'|'false'|'mem'::
  462. If 'true' or 'mem' is specified, when a file whose suffix is ".torrent" or content
  463. type is "application/x-bittorrent" is downloaded, aria2 parses it as a torrent
  464. file and downloads files mentioned in it.
  465. If 'mem' is specified, a torrent file is not written to the disk, but is just
  466. kept in memory.
  467. If 'false' is specified, the action mentioned above is not taken.
  468. Default: 'true'
  469. *-O*, *--index-out*=INDEX=PATH::
  470. Set file path for file with index=INDEX. You can find the file index
  471. using the *--show-files* option. PATH is a relative path to the
  472. path specified in *--dir* option. You can use this option multiple
  473. times. Using this option, you can specify the output filenames of
  474. BitTorrent downloads.
  475. *--listen-port*=PORT...::
  476. Set TCP port number for BitTorrent downloads.
  477. Multiple ports can be specified by using ",", for example: '6881,6885'.
  478. You can also use "-" to specify a range: '6881-6999'.
  479. "," and "-" can be used together: '6881-6889,6999'.
  480. Default: '6881-6999'
  481. [NOTE]
  482. Make sure that the specified ports are open for incoming TCP traffic.
  483. *--max-overall-upload-limit*=SPEED::
  484. Set max overall upload speed in bytes/sec.
  485. '0' means unrestricted.
  486. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  487. To limit the upload speed per torrent, use *--max-upload-limit* option.
  488. Default: '0'
  489. *-u*, *--max-upload-limit*=SPEED::
  490. Set max upload speed per each torrent in bytes/sec.
  491. '0' means unrestricted.
  492. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  493. To limit the overall upload speed, use *--max-overall-upload-limit* option.
  494. Default: '0'
  495. *--peer-id-prefix*=PEER_ID_PREFIX::
  496. Specify the prefix of peer ID. The peer ID in
  497. BitTorrent is 20 byte length. If more than 20
  498. bytes are specified, only first 20 bytes are
  499. used. If less than 20 bytes are specified, random
  500. byte data are added to make its length 20 bytes.
  501. Default: 'aria2/$VERSION-', $VERSION is replaced by package version.
  502. *--seed-ratio*=RATIO::
  503. Specify share ratio. Seed completed torrents until share ratio reaches
  504. RATIO.
  505. You are strongly encouraged to specify equals or more than '1.0' here.
  506. Specify '0.0' if you intend to do seeding regardless of share ratio.
  507. If *--seed-time* option is specified along with this option, seeding ends when
  508. at least one of the conditions is satisfied.
  509. Default: '1.0'
  510. *--seed-time*=MINUTES::
  511. Specify seeding time in minutes. Also see the *--seed-ratio* option.
  512. [NOTE]
  513. Specifying *--seed-time*='0' disables seeding after download completed.
  514. *-T*, *--torrent-file*=TORRENT_FILE::
  515. The path to the .torrent file. You are not required to use this
  516. option because you can specify .torrent files without *-T*.
  517. Metalink Specific Options
  518. ~~~~~~~~~~~~~~~~~~~~~~~~~
  519. *--follow-metalink*='true'|'false'|'mem'::
  520. If 'true' or 'mem' is specified, when a file whose suffix is ".metalink" or content
  521. type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink
  522. file and downloads files mentioned in it.
  523. If 'mem' is specified, a metalink file is not written to the disk, but is just
  524. kept in memory.
  525. If 'false' is specified, the action mentioned above is not taken.
  526. Default: 'true'
  527. *-M*, *--metalink-file*=METALINK_FILE::
  528. The file path to .metalink file. Reads input from stdin when '-' is
  529. specified. You are not required to use this option because you can
  530. specify .metalink files without *-M*.
  531. *-C*, *--metalink-servers*=NUM_SERVERS::
  532. The number of servers to connect to simultaneously.
  533. Some Metalinks regulate the number of servers to connect.
  534. aria2 strictly respects them.
  535. This means that if Metalink defines the maxconnections attribute lower
  536. than NUM_SERVERS, then aria2 uses the value of maxconnections attribute
  537. instead of NUM_SERVERS.
  538. See also *-s* and *-j* options.
  539. Default: '5'
  540. *--metalink-language*=LANGUAGE::
  541. The language of the file to download.
  542. *--metalink-location*=LOCATION[,...]::
  543. The location of the preferred server.
  544. A comma-delimited list of locations is acceptable, for example, 'jp,us'.
  545. *--metalink-os*=OS::
  546. The operating system of the file to download.
  547. *--metalink-version*=VERSION::
  548. The version of the file to download.
  549. *--metalink-preferred-protocol*=PROTO::
  550. Specify preferred protocol.
  551. The possible values are 'http', 'https', 'ftp' and 'none'.
  552. Specify 'none' to disable this feature.
  553. Default: 'none'
  554. *--metalink-enable-unique-protocol*='true'|'false'::
  555. If 'true' is given and several protocols are available for a mirror in a
  556. metalink file, aria2 uses one of them.
  557. Use *--metalink-preferred-protocol* option to specify the preference of
  558. protocol.
  559. Default: 'true'
  560. XML-RPC Options
  561. ~~~~~~~~~~~~~~~
  562. *--enable-xml-rpc*[='true'|'false']::
  563. Enable XML-RPC server. It is strongly recommended to set username
  564. and password using *--xml-rpc-user* and *--xml-rpc-passwd*
  565. option. See also *--xml-rpc-listen-port* option. Default: 'false'
  566. *--xml-rpc-listen-all*[='true'|'false']::
  567. Listen incoming XML-RPC requests on all network interfaces. If false
  568. is given, listen only on local loopback interface. Default: 'false'
  569. *--xml-rpc-listen-port*=PORT::
  570. Specify a port number for XML-RPC server to listen to. Possible
  571. Values: '1024'-'65535' Default: '6800'
  572. *--xml-rpc-max-request-size*=SIZE::
  573. Set max size of XML-RPC request. If aria2 detects the request is
  574. more than SIZE bytes, it drops connection. Default: '2M'
  575. *--xml-rpc-passwd*=PASSWD::
  576. Set XML-RPC password.
  577. *--xml-rpc-user*=USER::
  578. Set XML-RPC user.
  579. Advanced Options
  580. ~~~~~~~~~~~~~~~~
  581. *--allow-overwrite*='true'|'false'::
  582. Restart download from scratch if the corresponding control file
  583. doesn't exist. See also *--auto-file-renaming* option. Default:
  584. 'false'
  585. *--allow-piece-length-change*='true'|'false'::
  586. If false is given, aria2 aborts download when a piece length is different
  587. from one in a control file.
  588. If true is given, you can proceed but some download progress will be lost.
  589. Default: 'false'
  590. *--always-resume*[='true'|'false']::
  591. Always resume download. If 'true' is given, aria2 always tries to
  592. resume download and if resume is not possible, aborts download. If
  593. 'false' is given, when all given URIs do not support resume or aria2
  594. encounters 'N' URIs which does not support resume ('N' is the value
  595. specified using *--max-resume-failure-tries* option), aria2
  596. downloads file from scratch. See *--max-resume-failure-tries*
  597. option. Default: 'true'
  598. *--async-dns*[='true'|'false']::
  599. Enable asynchronous DNS.
  600. Default: 'true'
  601. *--auto-file-renaming*[='true'|'false']::
  602. Rename file name if the same file already exists.
  603. This option works only in HTTP(S)/FTP download.
  604. The new file name has a dot and a number(1..9999) appended.
  605. Default: 'true'
  606. *--auto-save-interval*=SEC::
  607. Save a control file(*.aria2) every SEC seconds.
  608. If '0' is given, a control file is not saved during download. aria2 saves a
  609. control file when it stops regardless of the value.
  610. The possible values are between '0' to '600'.
  611. Default: '60'
  612. *--conditional-get*[='true'|'false']::
  613. Download file only when the local file is older than remote
  614. file. This function only works with HTTP(S) downloads only. It does
  615. not work if file size is specified in Metalink. It also ignores
  616. Content-Disposition header. If a control file exists, this option
  617. will be ignored. This function uses If-Modified-Since header to get
  618. only newer file conditionally. When getting modification time of
  619. local file, it uses user supplied filename(see *--out* option) or
  620. filename part in URI if *--out* is not specified. Default: 'false'
  621. *--conf-path*=PATH::
  622. Change the configuration file path to PATH.
  623. Default: '$HOME/.aria2/aria2.conf'
  624. *-D*, *--daemon*::
  625. Run as daemon. The current working directory will be changed to '/'
  626. and standard input, standard output and standard error will be
  627. redirected to '/dev/null'. Default: 'false'
  628. *--disable-ipv6*[='true'|'false']::
  629. Disable IPv6. This is useful if you have to use broken DNS and want
  630. to avoid terribly slow AAAA record lookup. Default: 'false'
  631. *--enable-async-dns6*[='true'|'false']::
  632. Enable IPv6 name resolution in asynchronous DNS resolver. This
  633. option will be ignored when *--async-dns*='false'.
  634. Default: 'false'
  635. *--enable-direct-io*[='true'|'false']::
  636. Enable directI/O, which lowers cpu usage while allocating/checking files.
  637. Turn off if you encounter any error.
  638. Default: 'true'
  639. *--event-poll*=POLL::
  640. Specify the method for polling events. The possible values are
  641. 'epoll', 'kqueue', 'port', 'poll' and 'select'. For each 'epoll',
  642. 'kqueue', 'port' and 'poll', it is available if system supports it.
  643. 'epoll' is available on recent Linux. 'kqueue' is available on
  644. various *BSD systems including Mac OS X. 'port' is available on Open
  645. Solaris. The default value may vary depending on the system you use.
  646. *--file-allocation*=METHOD::
  647. Specify file allocation method.
  648. 'none' doesn't pre-allocate file space. 'prealloc' pre-allocates file space
  649. before download begins. This may take some time depending on the size of the
  650. file.
  651. If you are using newer file systems such as ext4
  652. (with extents support), btrfs or xfs, 'falloc' is
  653. your best choice. It allocates large(few GiB)
  654. files almost instantly. Don't use 'falloc' with
  655. legacy file systems such as ext3 because it takes
  656. almost same time as 'prealloc' and it blocks aria2
  657. entirely until allocation finishes. 'falloc' may
  658. not be available if your system doesn't have
  659. *posix_fallocate*() function.
  660. Possible Values: 'none', 'prealloc', 'falloc'
  661. Default: 'prealloc'
  662. *--human-readable*[='true'|'false']::
  663. Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi)
  664. in the console readout. Default: 'true'
  665. *--interface*=INTERFACE::
  666. Bind sockets to given interface. You can specify interface name, IP
  667. address and hostname.
  668. Possible Values: interface, IP address, hostname
  669. [NOTE]
  670. If an interface has multiple addresses, it is highly recommended to
  671. specify IP address explicitly. See also *--disable-ipv6*. If your
  672. system doesn't have getifaddrs(), this option doesn't accept interface
  673. name.
  674. *-x*, *--max-connection-per-server*=NUM::
  675. The maximum number of connections to one server for each download.
  676. Default: '1'
  677. *--max-download-result*=NUM::
  678. Set maximum number of download result kept in memory. The download
  679. results are completed/error/removed downloads. The download results
  680. are stored in FIFO queue and it can store at most NUM download
  681. results. When queue is full and new download result is created,
  682. oldest download result is removed from the front of the queue and
  683. new one is pushed to the back. Setting big number in this option may
  684. result high memory consumption after thousands of
  685. downloads. Specifying 0 means no download result is kept. Default:
  686. '1000'
  687. *--max-resume-failure-tries*=N::
  688. When used with *--always-resume*='false', aria2 downloads file from
  689. scratch when aria2 detects 'N' number of URIs that does not support
  690. resume. If 'N' is '0', aria2 downloads file from scratch when all
  691. given URIs do not support resume. See *--always-resume* option.
  692. Default: '0'
  693. *-k*, *--min-split-size*=SIZE::
  694. aria2 does not split less than 2*SIZE byte range. For example,
  695. let's consider downloading 20MiB file. If SIZE is 10M, aria2 can
  696. split file into 2 range [0-10MiB) and [10MiB-20MiB) and download it
  697. using 2 sources(if *--split* >= 2, of course). If SIZE is 15M,
  698. since 2*15M > 20MiB, aria2 does not split file and download it using
  699. 1 source. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  700. Possible Values: '1M'-'1024M' Default: '20M'
  701. *--log-level*=LEVEL::
  702. Set log level to output.
  703. LEVEL is either 'debug', 'info', 'notice', 'warn' or 'error'.
  704. Default: 'debug'
  705. *--on-bt-download-complete*=COMMAND::
  706. For BitTorrent, a command specified in *--on-download-complete* is
  707. called when download completes and seeding is over. On the other
  708. hand, this option set the command to be executed when download
  709. completes but before seeding. See *--on-download-start* option for
  710. the requirement of COMMAND. Possible Values: '/path/to/command'
  711. *--on-download-complete*=COMMAND::
  712. Set the command to be executed when download completes. See
  713. *--on-download-start* option for the requirement of COMMAND. See
  714. also *--on-download-stop* option. Possible Values:
  715. '/path/to/command'
  716. *--on-download-error*=COMMAND::
  717. Set the command to be executed when download aborts due to error.
  718. See *--on-download-start* option for the requirement of COMMAND.
  719. See also *--on-download-stop* option. Possible Values:
  720. '/path/to/command'
  721. *--on-download-pause*=COMMAND::
  722. Set the command to be executed when download is paused. See
  723. *--on-download-start* option for the requirement of COMMAND.
  724. Possible Values: '/path/to/command'
  725. *--on-download-start*=COMMAND::
  726. Set the command to be executed when download starts up. COMMAND must
  727. take just one argument and GID is passed to COMMAND as a first
  728. argument. Possible Values: '/path/to/command'
  729. *--on-download-stop*=COMMAND::
  730. Set the command to be executed when download stops. You can override
  731. the command to be executed for particular download result using
  732. *--on-download-complete* and *--on-download-error*. If they are
  733. specified, command specified in this option is not executed. See
  734. *--on-download-start* option for the requirement of COMMAND.
  735. Possible Values: '/path/to/command'
  736. *--summary-interval*=SEC::
  737. Set interval in seconds to output download progress summary.
  738. Setting '0' suppresses the output.
  739. Default: '60'
  740. [NOTE]
  741. In multi file torrent downloads, the files adjacent forward to the specified files
  742. are also allocated if they share the same piece.
  743. *-Z*, *--force-sequential*[='true'|'false']::
  744. Fetch URIs in the command-line sequentially and download each URI in a
  745. separate session, like the usual command-line download utilities.
  746. Default: 'false'
  747. *--max-overall-download-limit*=SPEED::
  748. Set max overall download speed in bytes/sec. '0' means
  749. unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To
  750. limit the download speed per download, use *--max-download-limit*
  751. option. Default: '0'
  752. *--max-download-limit*=SPEED::
  753. Set max download speed per each download in bytes/sec. '0' means
  754. unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To
  755. limit the overall download speed, use *--max-overall-download-limit*
  756. option. Default: '0'
  757. *--no-conf*::
  758. Disable loading aria2.conf file.
  759. *--no-file-allocation-limit*=SIZE::
  760. No file allocation is made for files whose size is smaller than SIZE.
  761. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
  762. Default: '5M'
  763. *-P*, *--parameterized-uri*[='true'|'false']::
  764. Enable parameterized URI support.
  765. You can specify set of parts: 'http://{sv1,sv2,sv3}/foo.iso'.
  766. Also you can specify numeric sequences with step counter:
  767. '\http://host/image[000-100:2].img'.
  768. A step counter can be omitted.
  769. If all URIs do not point to the same file, such as the second example above,
  770. -Z option is required.
  771. Default: 'false'
  772. *-q*, *--quiet*[='true'|'false']::
  773. Make aria2 quiet (no console output).
  774. Default: 'false'
  775. *--realtime-chunk-checksum*='true'|'false'::
  776. Validate chunk of data by calculating checksum while downloading a file if
  777. chunk checksums are provided.
  778. Default: 'true'
  779. *--remove-control-file*[='true'|'false']::
  780. Remove control file before download. Using with
  781. *--allow-overwrite*='true', download always starts from
  782. scratch. This will be useful for users behind proxy server which
  783. disables resume.
  784. [NOTE]
  785. For Metalink downloads, -C1 is recommended for proxy server which
  786. disables resume, in order to avoid establishing unnecessary
  787. connections.
  788. *--save-session*=FILE::
  789. Save error/unfinished downloads to FILE on exit. You can pass this
  790. output file to aria2c with *-i* option on restart. Please note that
  791. downloads added by *aria2.addTorrent* and *aria2.addMetalink*
  792. XML-RPC method are not saved.
  793. *--stop*=SEC::
  794. Stop application after SEC seconds has passed.
  795. If '0' is given, this feature is disabled.
  796. Default: '0'
  797. *-v*, *--version*::
  798. Print the version number, copyright and the configuration information and
  799. exit.
  800. Options That Take An Optional Argument
  801. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  802. The options that have its argument surrounded by square brackets([])
  803. take an optional argument. Usually omiting the argument is evaluated to 'true'.
  804. If you use short form of these options(such as '-V') and give
  805. an argument, then the option name and its argument should be concatenated(e.g.
  806. '-Vfalse'). If any spaces are inserted between the option name and the argument,
  807. the argument will be treated as URI and usually this is not what you expect.
  808. URI, MAGNET, TORRENT_FILE, METALINK_FILE
  809. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  810. You can specify multiple URIs in command-line. Unless you specify
  811. *-Z* option, all URIs must point to the same file or downloading will
  812. fail.
  813. You can specify arbitrary number of BitTorrent Magnet URI. Please note
  814. that they are always treated as a separate download. Both hex encoded
  815. 40 characters Info Hash and Base32 encoded 32 characters Info Hash are
  816. supported. The multiple "tr" parameters are supported. Because
  817. BitTorrent Magnet URI is likely to contain "&" character, it is highly
  818. recommended to always quote URI with single(') or double(") quotation.
  819. It is strongly recommended to enable DHT especially when "tr"
  820. parameter is missing. See http://www.bittorrent.org/beps/bep_0009.html
  821. for more details about BitTorrent Magnet URI.
  822. You can also specify arbitrary number of torrent files and Metalink
  823. documents stored on a local drive. Please note that they are always
  824. treated as a separate download. Both Metalink4 and Metalink version
  825. 3.0 are supported.
  826. You can specify both torrent file with -T option and URIs. By doing
  827. this, you can download a file from both torrent swarm and HTTP(S)/FTP
  828. server at the same time, while the data from HTTP(S)/FTP are uploaded
  829. to the torrent swarm. For single file torrents, URI can be a complete
  830. URI pointing to the resource or if URI ends with /, name in torrent
  831. file in torrent is added. For multi-file torrents, name and path are
  832. added to form a URI for each file.
  833. [NOTE]
  834. Make sure that URI is quoted with single(') or double(") quotation if it
  835. contains "&" or any characters that have special meaning in shell.
  836. Resuming Download
  837. ~~~~~~~~~~~~~~~~~
  838. Usually, you can resume transfer by just issuing same command(aria2c
  839. URI) if the previous transfer is made by aria2.
  840. If the previous transfer is made by a browser or wget like sequential
  841. download manager, then use -c option to continue the transfer(aria2c
  842. *-c* URI).
  843. EXIT STATUS
  844. -----------
  845. Because aria2 can handle multiple downloads at once, it encounters
  846. lots of errors in a session. aria2 returns the following exit status
  847. based on the last error encountered.
  848. *0*::
  849. If all downloads are successful.
  850. *1*::
  851. If an unknown error occurs.
  852. *2*::
  853. If time out occurs.
  854. *3*::
  855. If a resource is not found.
  856. *4*::
  857. If aria2 sees the specfied number of "resource not found" error.
  858. See *--max-file-not-found* option).
  859. *5*::
  860. If a download aborts because download speed is too slow.
  861. See *--lowest-speed-limit* option)
  862. *6*::
  863. If network problem occurs.
  864. *7*::
  865. If there are unfinished downloads. This error is only reported if
  866. all finished downloads are successful and there are unfinished
  867. downloads in a queue when aria2 exits by pressing Ctrl-C by an user
  868. or sending TERM or INT signal.
  869. *8*::
  870. If server does not support resume when resume is required to
  871. complete download.
  872. [NOTE]
  873. An error occurred in a finished download will not be reported
  874. as exit status.
  875. ENVIRONMENT
  876. -----------
  877. aria2 recognizes the following environment variables.
  878. http_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  879. Specify proxy server for use in HTTP.
  880. Overrides http-proxy value in configuration file.
  881. The command-line option *--http-proxy* overrides this value.
  882. https_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  883. Specify proxy server for use in HTTPS.
  884. Overrides https-proxy value in configuration file.
  885. The command-line option *--https-proxy* overrides this value.
  886. ftp_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  887. Specify proxy server for use in FTP.
  888. Overrides ftp-proxy value in configuration file.
  889. The command-line option *--ftp-proxy* overrides this value.
  890. all_proxy [\http://][USER:PASSWORD@]HOST[:PORT]::
  891. Specify proxy server for use if no protocol-specific proxy is specified.
  892. Overrides all-proxy value in configuration file.
  893. The command-line option *--all-proxy* overrides this value.
  894. no_proxy [DOMAIN,...]::
  895. Specify comma-separated hostname, domains and network address with
  896. or without CIDR block to which proxy should not be used. Overrides
  897. no-proxy value in configuration file. The command-line option
  898. *--no-proxy* overrides this value.
  899. FILES
  900. -----
  901. aria2.conf
  902. ~~~~~~~~~~
  903. By default, aria2 parses '$HOME/.aria2/aria2.conf' as a configuraiton
  904. file. You can specify the path to configuration file using
  905. *--conf-path* option. If you don't want to use the configuraitonf
  906. file, use *--no-conf* option.
  907. The configuration file is a text file and has 1 option per each
  908. line. In each line, you can specify name-value pair in the format:
  909. NAME=VALUE, where name is the long command-line option name without
  910. "--" prefix. You can use same syntax for the command-line option. The
  911. lines beginning "#" are treated as comments.
  912. --------------------------------------
  913. # sample configuration file for aria2c
  914. listen-port=60000
  915. dht-listen-port=60000
  916. seed-ratio=1.0
  917. max-upload-limit=50K
  918. ftp-pasv=true
  919. --------------------------------------
  920. dht.dat
  921. ~~~~~~~~
  922. By default, the routing table of IPv4 DHT is saved to the path
  923. $HOME/.aria2/dht.dat and the routing table of IPv6 DHT is saved to the
  924. path $HOME/.aria2/dht6.dat.
  925. Netrc
  926. ~~~~~
  927. Netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
  928. support, specify *-n* option. Your .netrc file should have correct
  929. permissions(600).
  930. If machine name starts ".", aria2 performs domain match instead of
  931. exact match. This is an extension of aria2. For example of domain
  932. match, imagine the following .netrc entry:
  933. -------------------------------------------------
  934. machine .example.org login myid password mypasswd
  935. -------------------------------------------------
  936. In domain match, aria2.example.org matches .example.org and uses myid
  937. and mypasswd. example.org also matches .example.org. But example.net
  938. does not match .example.org.
  939. Control File
  940. ~~~~~~~~~~~~
  941. aria2 uses a control file to track the progress of a download. A
  942. control file is placed in the same directory as the downloading file
  943. and its filename is the filename of downloading file with ".aria2"
  944. appended. For example, if you are downloading file.zip, then the
  945. control file should be file.zip.aria2. (There is a exception for this
  946. naming convention. If you are downloading a multi torrent, its
  947. control file is the "top directory" name of the torrent with ".aria2"
  948. appended. The "top directory" name is a value of "name" key in "info"
  949. directory in a torrent file.)
  950. Usually a control file is deleted once download completed. If aria2
  951. decides that download cannot be resumed(for example, when downloading
  952. a file from a HTTP server which doesn't support resume), a control
  953. file is not created.
  954. Normally if you lose a control file, you cannot resume download. But
  955. if you have a torrent or metalink with chunk checksums for the file,
  956. you can resume the download without a control file by giving -V option
  957. to aria2c in command-line.
  958. Input File
  959. ~~~~~~~~~~
  960. The input file can contain a list of URIs for aria2 to download. You
  961. can specify multiple URIs for a single entity: separate URIs on a
  962. single line using the TAB character.
  963. Each line is treated as if it is provided in command-line argument.
  964. Therefore they are affected by *-Z* and *-P* options.
  965. Lines starting with "#" are treated as comments and skipped.
  966. Additionally, the following options can be specified after each line
  967. of URIs. These optional lines must start with white space(s).
  968. * dir
  969. * check-integrity
  970. * continue
  971. * all-proxy
  972. * all-proxy-user
  973. * all-proxy-passwd
  974. * connect-timeout
  975. * dry-run
  976. * lowest-speed-limit
  977. * max-file-not-found
  978. * max-tries
  979. * no-proxy
  980. * out
  981. * proxy-method
  982. * remote-time
  983. * split
  984. * timeout
  985. * http-auth-challenge
  986. * http-no-cache
  987. * http-user
  988. * http-passwd
  989. * http-proxy
  990. * http-proxy-user
  991. * http-proxy-passwd
  992. * https-proxy
  993. * https-proxy-user
  994. * https-proxy-passwd
  995. * referer
  996. * enable-http-keep-alive
  997. * enable-http-pipelining
  998. * header
  999. * use-head
  1000. * user-agent
  1001. * ftp-user
  1002. * ftp-passwd
  1003. * ftp-pasv
  1004. * ftp-proxy
  1005. * ftp-proxy-user
  1006. * ftp-proxy-passwd
  1007. * ftp-type
  1008. * ftp-reuse-connection
  1009. * no-netrc
  1010. * reuse-uri
  1011. * select-file
  1012. * bt-enable-lpd
  1013. * bt-external-ip
  1014. * bt-hash-check-seed
  1015. * bt-max-open-files
  1016. * bt-max-peers
  1017. * bt-metadata-only
  1018. * bt-min-crypto-level
  1019. * bt-prioritize-piece
  1020. * bt-require-crypto
  1021. * bt-request-peer-speed-limit
  1022. * bt-save-metadata
  1023. * bt-seed-unverified
  1024. * bt-stop-timeout
  1025. * bt-tracker-interval
  1026. * bt-tracker-timeout
  1027. * bt-tracker-connect-timeout
  1028. * enable-peer-exchange
  1029. * follow-torrent
  1030. * index-out
  1031. * max-upload-limit
  1032. * seed-ratio
  1033. * seed-time
  1034. * follow-metalink
  1035. * metalink-servers
  1036. * metalink-language
  1037. * metalink-location
  1038. * metalink-os
  1039. * metalink-version
  1040. * metalink-preferred-protocol
  1041. * metalink-enable-unique-protocol
  1042. * allow-overwrite
  1043. * allow-piece-length-change
  1044. * async-dns
  1045. * auto-file-renaming
  1046. * file-allocation
  1047. * max-download-limit
  1048. * no-file-allocation-limit
  1049. * parameterized-uri
  1050. * realtime-chunk-checksum
  1051. * remove-control-file
  1052. * always-resume
  1053. * max-resume-failure-tries
  1054. * http-accept-gzip
  1055. * max-connection-per-server
  1056. * min-split-size
  1057. * conditional-get
  1058. * enable-async-dns6
  1059. * bt-tracker
  1060. * bt-exclude-tracker
  1061. These options have exactly same meaning of the ones in the
  1062. command-line options, but it just applies to the URIs it belongs to.
  1063. For example, the content of uri.txt is
  1064. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1065. http://server/file.iso http://mirror/file.iso
  1066. dir=/iso_images
  1067. out=file.img
  1068. http://foo/bar
  1069. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1070. If aria2 is executed with *-i* uri.txt *-d* /tmp options, then
  1071. 'file.iso' is saved as '/iso_images/file.img' and it is downloaded
  1072. from \http://server/file.iso and \http://mirror/file.iso. The file
  1073. 'bar' is downloaded from \http://foo/bar and saved as '/tmp/bar'.
  1074. In some cases, *out* parameter has no effect. See note of *--out*
  1075. option for the restrictions.
  1076. Server Performance Profile
  1077. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  1078. This section describes the format of server performance profile. The
  1079. file is plain text and each line has several NAME=VALUE pair,
  1080. delimited by comma. Currently following NAMEs are recognized:
  1081. host::
  1082. Hostname of the server. Required.
  1083. protocol::
  1084. Protocol for this profile, such as ftp, http. Required.
  1085. dl_speed::
  1086. The average download speed observed in the previous download in
  1087. bytes per sec. Required.
  1088. sc_avg_speed::
  1089. The average download speed observed in the previous download in
  1090. bytes per sec. This value is only updated if the download is done in
  1091. single connection environment and only used by
  1092. AdaptiveURISelector. Optional.
  1093. mc_avg_speed::
  1094. The average download speed observed in the previous download in
  1095. bytes per sec. This value is only updated if the download is done in
  1096. multi connection environment and only used by
  1097. AdaptiveURISelector. Optional.
  1098. counter::
  1099. How many times the server is used. Currently this value is only used
  1100. by AdaptiveURISelector. Optional.
  1101. last_updated::
  1102. Last contact time in GMT with this server, specified in the seconds
  1103. since the Epoch(00:00:00 on January 1, 1970, UTC). Required.
  1104. status::
  1105. ERROR is set when server cannot be reached or out-of-service or
  1106. timeout occurred. Otherwise, OK is set.
  1107. Those fields must exist in one line. The order of the fields is not
  1108. significant. You can put pairs other than the above; they are simply
  1109. ignored.
  1110. An example follows:
  1111. --------------------------------------------------------------------------------
  1112. host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
  1113. host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
  1114. --------------------------------------------------------------------------------
  1115. XML-RPC INTERFACE
  1116. -----------------
  1117. Terminology
  1118. ~~~~~~~~~~~
  1119. GID::
  1120. GID(or gid) is the key to manage each download. Each download has an
  1121. unique GID. Currently GID looks like an integer, but don't treat it
  1122. as integer because it may be changed to another type in the future
  1123. release. Please note that GID is session local and not persisted
  1124. when aria2 exits.
  1125. Methods
  1126. ~~~~~~~
  1127. *aria2.addUri* 'uris[, options[, position]]'
  1128. This method adds new HTTP(S)/FTP/BitTorrent Magnet URI. 'uris' is of
  1129. type array and its element is URI which is of type string. For
  1130. BitTorrent Magnet URI, 'uris' must have only one element and it should
  1131. be BitTorrent Magnet URI. URIs in 'uris' must point to the same
  1132. file. For example, a file chunkybaconlinux.iso is hosted in 2
  1133. locations: http://server/chunkybaconlinux.iso and
  1134. http://mirror/chunkybaconlinux.iso. You can download this iso image
  1135. using 2 URIs by issuing
  1136. aria2.addUri(['http://server/chunkybaconlinux.iso',
  1137. 'http://mirror/chunkybaconlinux.iso']). Imagine there is an another
  1138. file URI, say, http://mirror2/chunkydonutslinux.iso, which is
  1139. different iso image. You cannot mix this URI with previous URIs in
  1140. one aria2.addUri command. If you do, aria2 does not complain but
  1141. download may fail. 'options' is of type struct and its members are a
  1142. pair of option name and value. See *Options* below for more details.
  1143. If 'position' is given as an integer starting from 0, the new download
  1144. is inserted at 'position' in the waiting queue. If 'position' is not
  1145. given or 'position' is larger than the size of the queue, it is
  1146. appended at the end of the queue. This method returns GID of
  1147. registered download.
  1148. *aria2.addTorrent* 'torrent[, uris[, options[, position]]]'
  1149. This method adds BitTorrent download by uploading .torrent file. If
  1150. you want to add BitTorrent Magnet URI, use *aria2.addUri* method
  1151. instead. 'torrent' is of type base64 which contains Base64-encoded
  1152. .torrent file. 'uris' is of type array and its element is URI which
  1153. is of type string. 'uris' is used for Web-seeding. For single file
  1154. torrents, URI can be a complete URI pointing to the resource or if URI
  1155. ends with /, name in torrent file is added. For multi-file torrents,
  1156. name and path in torrent are added to form a URI for each file.
  1157. 'options' is of type struct and its members are a pair of option name
  1158. and value. See *Options* below for more details. If 'position' is
  1159. given as an integer starting from 0, the new download is inserted at
  1160. 'position' in the waiting queue. If 'position' is not given or
  1161. 'position' is larger than the size of the queue, it is appended at the
  1162. end of the queue. This method returns GID of registered download.
  1163. Please note that the downloads added by this method are not saved by
  1164. *--save-session*.
  1165. *aria2.addMetalink* 'metalink[, options[, position]]'
  1166. This method adds Metalink download by uploading .metalink file.
  1167. 'metalink' is of type base64 which contains Base64-encoded .metalink
  1168. file. 'options' is of type struct and its members are a pair of
  1169. option name and value. See *Options* below for more details. If
  1170. 'position' is given as an integer starting from 0, the new download is
  1171. inserted at 'position' in the waiting queue. If 'position' is not
  1172. given or 'position' is larger than the size of the queue, it is
  1173. appended at the end of the queue. This method returns array of GID of
  1174. registered download. Please note that the downloads added by this
  1175. method are not saved by *--save-session*.
  1176. *aria2.remove* 'gid'
  1177. This method removes the download denoted by 'gid'. 'gid' is of type
  1178. string. If specified download is in progress, it is stopped at
  1179. first. The status of removed download becomes "removed". This method
  1180. returns GID of removed download.
  1181. *aria2.forceRemove* 'gid'
  1182. This method removes the download denoted by 'gid'. This method
  1183. behaves just like *aria2.remove* except that this method removes
  1184. download without any action which takes time such as contacting
  1185. BitTorrent tracker.
  1186. *aria2.pause* 'gid'
  1187. This method pauses the download denoted by 'gid'. 'gid' is of type
  1188. string. The status of paused download becomes "paused". If the
  1189. download is active, the download is placed on the first position of
  1190. waiting queue. As long as the status is "paused", the download is not
  1191. started. To change status to "waiting", use *aria2.unpause* method.
  1192. This method returns GID of paused download.
  1193. *aria2.pauseAll*
  1194. This method is equal to calling *aria2.pause* for every active/waiting
  1195. download. This methods returns "OK" for success.
  1196. *aria2.forcePause* 'pid'
  1197. This method pauses the download denoted by 'gid'. This method
  1198. behaves just like *aria2.pause* except that this method pauses
  1199. download without any action which takes time such as contacting
  1200. BitTorrent tracker.
  1201. *aria2.forcePauseAll*
  1202. This method is equal to calling *aria2.forcePause* for every
  1203. active/waiting download. This methods returns "OK" for success.
  1204. *aria2.unpause* 'gid'
  1205. This method changes the status of the download denoted by 'gid' from
  1206. "paused" to "waiting". This makes the download eligible to restart.
  1207. 'gid' is of type string. This method returns GID of unpaused
  1208. download.
  1209. *aria2.unpauseAll*
  1210. This method is equal to calling *aria2.unpause* for every active/waiting
  1211. download. This methods returns "OK" for success.
  1212. *aria2.tellStatus* 'gid[, keys]'
  1213. This method returns download progress of the download denoted by
  1214. 'gid'. 'gid' is of type string. 'keys' is array of string. If it is
  1215. specified, the response contains only keys in 'keys' array. If 'keys'
  1216. is empty or not specified, the response contains all keys. This is
  1217. useful when you just want specific keys and avoid unnecessary
  1218. transfers. For example, *aria2.tellStatus*("1", ["gid", "status"])
  1219. returns 'gid' and 'status' key. The response is of type struct and it
  1220. contains following keys. The value type is string.
  1221. gid::
  1222. GID of this download.
  1223. status::
  1224. "active" for currently downloading/seeding entry. "waiting" for the
  1225. entry in the queue; download is not started. "paused" for the
  1226. paused entry. "error" for the stopped download because of
  1227. error. "complete" for the stopped and completed download. "removed"
  1228. for the download removed by user.
  1229. totalLength::
  1230. Total length of this download in bytes.
  1231. completedLength::
  1232. Completed length of this download in bytes.
  1233. uploadLength::
  1234. Uploaded length of this download in bytes.
  1235. bitfield::
  1236. Hexadecimal representation of the download progress. The highest bit
  1237. corresponds to piece index 0. The set bits indicate the piece is
  1238. available and unset bits indicate the piece is missing. The spare
  1239. bits at the end are set to zero. When download has not started yet,
  1240. this key will not be included in the response.
  1241. downloadSpeed::
  1242. Download speed of this download measured in bytes/sec.
  1243. uploadSpeed::
  1244. Upload speed of this download measured in bytes/sec.
  1245. infoHash::
  1246. InfoHash. BitTorrent only.
  1247. numSeeders::
  1248. The number of seeders the client has connected to. BitTorrent only.
  1249. pieceLength::
  1250. Piece length in bytes.
  1251. numPieces::
  1252. The number of pieces.
  1253. connections::
  1254. The number of peers/servers the client has connected to.
  1255. errorCode::
  1256. The last error code occurred in this download. The value is of type
  1257. string. The error codes are defined in EXIT STATUS section. This
  1258. value is only available for stopped/completed downloads.
  1259. followedBy::
  1260. List of GIDs which are generated by the consequence of this
  1261. download. For example, when aria2 downloaded Metalink file, it
  1262. generates downloads described in it(see *--follow-metalink*
  1263. option). This value is useful to track these auto generated
  1264. downloads. If there is no such downloads, this key will not
  1265. be included in the response.
  1266. belongsTo::
  1267. GID of a parent download. Some downloads are a part of another
  1268. download. For example, if a file in Metalink has BitTorrent
  1269. resource, the download of .torrent is a part of that file. If this
  1270. download has no parent, this key will not be included in the
  1271. response.
  1272. dir::
  1273. Directory to save files. This key is not available for stopped
  1274. downloads.
  1275. files::
  1276. Returns the list of files. The element of list is the same struct
  1277. used in *aria2.getFiles* method.
  1278. bittorrent::
  1279. Struct which contains information retrieved from .torrent
  1280. file. BitTorrent only. It contains following keys.
  1281. announceList;;
  1282. List of lists of announce URI. If .torrent file contains announce
  1283. and no announce-list, announce is converted to announce-list
  1284. format.
  1285. comment;;
  1286. The comment for the torrent. comment.utf-8 is used if available.
  1287. creationDate;;
  1288. The creation time of the torrent. The value is an integer since
  1289. the Epoch, measured in seconds.
  1290. mode;;
  1291. File mode of the torrent. The value is either 'single' or 'multi'.
  1292. info;;
  1293. Struct which contains data from Info dictionary. It contains
  1294. following keys.
  1295. name:::
  1296. name in info dictionary. name.utf-8 is used if available.
  1297. *aria2.getUris* 'gid'
  1298. This method returns URIs used in the download denoted by 'gid'. 'gid'
  1299. is of type string. The response is of type array and its element is of
  1300. type struct and it contains following keys. The value type is string.
  1301. uri::
  1302. URI
  1303. status::
  1304. 'used' if the URI is already used. 'waiting' if the URI is waiting
  1305. in the queue.
  1306. *aria2.getFiles* 'gid'
  1307. This method returns file list of the download denoted by 'gid'. 'gid'
  1308. is of type string. The response is of type array and its element is of
  1309. type struct and it contains following keys. The value type is string.
  1310. index::
  1311. Index of file. Starting with 1. This is the same order with the
  1312. files in multi-file torrent.
  1313. path::
  1314. File path.
  1315. length::
  1316. File size in bytes.
  1317. selected::
  1318. "true" if this file is selected by *--select-file* option. If
  1319. *--select-file* is not specified or this is single torrent or no
  1320. torrent download, this value is always "true". Otherwise "false".
  1321. uris::
  1322. Returns the list of URI for this file. The element of list is the
  1323. same struct used in *aria2.getUris* method.
  1324. *aria2.getPeers* 'gid'
  1325. This method returns peer list of the download denoted by 'gid'. 'gid'
  1326. is of type string. This method is for BitTorrent only. The response
  1327. is of type array and its element is of type struct and it contains
  1328. following keys. The value type is string.
  1329. peerId::
  1330. Percent-encoded peer ID.
  1331. ip::
  1332. IP address of the peer.
  1333. port::
  1334. Port number of the peer.
  1335. bitfield::
  1336. Hexadecimal representation of the download progress of the peer. The
  1337. highest bit corresponds to piece index 0. The set bits indicate the
  1338. piece is available and unset bits indicate the piece is missing. The
  1339. spare bits at the end are set to zero.
  1340. amChoking::
  1341. "true" if this client is choking the peer. Otherwise "false".
  1342. peerChoking::
  1343. "true" if the peer is choking this client. Otherwise "false".
  1344. downloadSpeed::
  1345. Download speed (byte/sec) that this client obtains from the peer.
  1346. uploadSpeed::
  1347. Upload speed(byte/sec) that this client uploads to the peer.
  1348. seeder::
  1349. "true" is this client is a seeder. Otherwise "false".
  1350. *aria2.getServers* 'gid'
  1351. This method returns currently connected HTTP(S)/FTP servers of the download denoted by 'gid'. 'gid' is of type string. The response
  1352. is of type array and its element is of type struct and it contains
  1353. following keys. The value type is string.
  1354. index::
  1355. Index of file. Starting with 1. This is the same order with the
  1356. files in multi-file torrent.
  1357. servers::
  1358. The list of struct which contains following keys.
  1359. uri;;
  1360. URI originally added.
  1361. currentUri;;
  1362. This is the URI currently used for downloading. If redirection is
  1363. involved, currentUri and uri may differ.
  1364. downloadSpeed;;
  1365. Download speed (byte/sec)
  1366. *aria2.tellActive* '[keys]'
  1367. This method returns the list of active downloads. The response is of
  1368. type array and its element is the same struct returned by
  1369. *aria2.tellStatus* method. For 'keys' parameter, please refer to
  1370. *aria2.tellStatus* method.
  1371. *aria2.tellWaiting* 'offset, num, [keys]'
  1372. This method returns the list of waiting download, including paused
  1373. downloads. 'offset' is of type integer and specifies the offset from
  1374. the download waiting at the front. 'num' is of type integer and
  1375. specifies the number of downloads to be returned. For 'keys'
  1376. parameter, please refer to *aria2.tellStatus* method.
  1377. If offset is a positive integer, this method returns downloads in the
  1378. range of ['offset', 'offset'+'num').
  1379. 'offset' can be a negative integer. 'offset' == -1 points last
  1380. download in the waiting queue and 'offset' == -2 points the download
  1381. before the last download, and so on. The downloads in the response are
  1382. in reversed order.
  1383. For example, imagine that three downloads "A","B" and "C" are waiting
  1384. in this order. aria2.tellWaiting(0, 1) returns
  1385. ["A"]. aria2.tellWaiting(1, 2) returns ["B", "C"].
  1386. aria2.tellWaiting(-1, 2) returns ["C", "B"].
  1387. The response is of type array and its element is the same struct
  1388. returned by *aria2.tellStatus* method.
  1389. *aria2.tellStopped* 'offset, num, [keys]'
  1390. This method returns the list of stopped download. 'offset' is of type
  1391. integer and specifies the offset from the oldest download. 'num' is of
  1392. type integer and specifies the number of downloads to be returned.
  1393. For 'keys' parameter, please refer to *aria2.tellStatus* method.
  1394. 'offset' and 'num' have the same semantics as *aria2.tellWaiting*
  1395. method.
  1396. The response is of type array and its element is the same struct
  1397. returned by *aria2.tellStatus* method.
  1398. *aria2.changePosition* 'gid, pos, how'
  1399. This method changes the position of the download denoted by
  1400. 'gid'. 'pos' is of type integer. 'how' is of type string. If 'how' is
  1401. "POS_SET", it moves the download to a position relative to the
  1402. beginning of the queue. If 'how' is "POS_CUR", it moves the download
  1403. to a position relative to the current position. If 'how' is "POS_END",
  1404. it moves the download to a position relative to the end of the
  1405. queue. If the destination position is less than 0 or beyond the end of
  1406. the queue, it moves the download to the beginning or the end of the
  1407. queue respectively. The response is of type integer and it is the
  1408. destination position.
  1409. For example, if GID#1 is placed in position 3, aria2.changePosition(1,
  1410. -1, POS_CUR) will change its position to 2. Additional
  1411. aria2.changePosition(1, 0, POS_SET) will change its position to 0(the
  1412. beginning of the queue).
  1413. *aria2.changeUri* 'gid, fileIndex, delUris, addUris[, position]'
  1414. This method removes URIs in 'delUris' from and appends URIs in
  1415. 'addUris' to download denoted by 'gid'. 'delUris' and 'addUris' are
  1416. list of string. A download can contain multiple files and URIs are
  1417. attached to each file. 'fileIndex' is used to select which file to
  1418. remove/attach given URIs. 'fileIndex' is 1-based. 'position' is used
  1419. to specify where URIs are inserted in the existing waiting URI
  1420. list. 'position' is 0-based. When 'position' is omitted, URIs are
  1421. appended to the back of the list. This method first execute removal
  1422. and then addition. 'position' is the position after URIs are removed,
  1423. not the position when this method is called. When removing URI, if
  1424. same URIs exist in download, only one of them is removed for each URI
  1425. in 'delUris'. In other words, there are three URIs
  1426. "http://example.org/aria2" and you want remove them all, you have to
  1427. specify (at least) 3 "http://example.org/aria2" in 'delUris'. This
  1428. method returns a list which contains 2 integers. The first integer is
  1429. the number of URIs deleted. The second integer is the number of URIs
  1430. added.
  1431. *aria2.getOption* 'gid'
  1432. This method returns options of the download denoted by 'gid'. The
  1433. response is of type struct. Its key is the name of option. The value type
  1434. is string.
  1435. *aria2.changeOption* 'gid, options'
  1436. This method changes options of the download denoted by 'gid'
  1437. dynamically. 'gid' is of type string. 'options' is of type struct
  1438. and the available options are: *bt-max-peers*,
  1439. *bt-request-peer-speed-limit*, *max-download-limit* and
  1440. *max-upload-limit*. This method returns "OK" for success.
  1441. *aria2.getGlobalOption*
  1442. This method returns global options. The response is of type
  1443. struct. Its key is the name of option. The value type is string.
  1444. Because global options are used as a template for the options of newly
  1445. added download, the response contains keys returned by
  1446. *aria2.getOption* method.
  1447. *aria2.changeGlobalOption* 'options'
  1448. This method changes global options dynamically. 'options' is of type
  1449. struct and the available options are *max-concurrent-downloads*,
  1450. *max-overall-download-limit*, *max-overall-upload-limit*, *log-level*
  1451. and *log*. Using *log* option, you can dynamically start logging or
  1452. change log file. To stop logging, give empty string("") as a parameter
  1453. value. Note that log file is always opened in append mode. This method
  1454. returns "OK" for success.
  1455. *aria2.purgeDownloadResult*
  1456. This method purges completed/error/removed downloads to free memory.
  1457. This method returns "OK".
  1458. *aria2.getVersion*
  1459. This method returns version of the program and the list of enabled
  1460. features. The response is of type struct and contains following keys.
  1461. version::
  1462. Version number of the program in string.
  1463. enabledFeatures::
  1464. List of enabled features. Each feature name is of type string.
  1465. *aria2.getSessionInfo*
  1466. This method returns session information.
  1467. The response is of type struct and contains following key.
  1468. sessionId::
  1469. Session ID, which is generated each time when aria2 is invoked.
  1470. *aria2.shutdown*
  1471. This method shutdowns aria2. This method returns "OK".
  1472. *aria2.forceShutdown*
  1473. This method shutdowns aria2. This method behaves like *aria2.shutdown*
  1474. except that any actions which takes time such as contacting BitTorrent
  1475. tracker are skipped. This method returns "OK".
  1476. *system.multicall* 'methods'
  1477. This methods encapsulates multiple method calls in a single request.
  1478. 'methods' is of type array and its element is struct. The struct
  1479. contains two keys: "methodName" and "params". "methodName" is the
  1480. method name to call and "params" is array containing parameters to the
  1481. method. This method returns array of responses. The element of array
  1482. will either be a one-item array containing the return value of each
  1483. method call or struct of fault element if an encapsulated method call
  1484. fails.
  1485. Error Handling
  1486. ~~~~~~~~~~~~~~
  1487. In case of error, aria2 returns faultCode=1 and the error message in
  1488. faultString.
  1489. Options
  1490. ~~~~~~~
  1491. Same options for *-i* list are available. See *Input File* subsection
  1492. for complete list of options.
  1493. In the option struct, name element is option name(without preceding
  1494. "--") and value element is argument as string.
  1495. -------------------------------------------------
  1496. <struct>
  1497. <member>
  1498. <name>split</name>
  1499. <value><string>1</string></value>
  1500. </member>
  1501. <member>
  1502. <name>http-proxy</name>
  1503. <value><string>http://proxy/</string></value>
  1504. </member>
  1505. </struct>
  1506. -------------------------------------------------
  1507. *header* and *index-out* option are allowed multiple times in
  1508. command-line. Since name should be unique in struct(many XML-RPC
  1509. library implementation uses hash or dict for struct), single string is
  1510. not enough. To overcome this situation, they can take array as value
  1511. as well as string.
  1512. ---------------------------------------------------------------
  1513. <struct>
  1514. <member>
  1515. <name>header</name>
  1516. <value>
  1517. <array>
  1518. <data>
  1519. <value><string>Accept-Language: ja</string></value>
  1520. <value><string>Accept-Charset: utf-8</string></value>
  1521. </data>
  1522. </array>
  1523. </value>
  1524. </member>
  1525. </struct>
  1526. ---------------------------------------------------------------
  1527. Sample XML-RPC Client Code
  1528. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  1529. The following Ruby script adds 'http://localhost/aria2.tar.bz2' to
  1530. aria2c operated on localhost with option *--dir*='/downloads' and
  1531. prints its reponse.
  1532. ----------------------------------------------
  1533. #!/usr/bin/env ruby
  1534. require 'xmlrpc/client'
  1535. require 'pp'
  1536. client=XMLRPC::Client.new2("http://localhost:6800/rpc")
  1537. options={ "dir" => "/downloads" }
  1538. result=client.call("aria2.addUri", [ "http://localhost/aria2.tar.bz2" ], options)
  1539. pp result
  1540. ----------------------------------------------
  1541. If you are a Python lover, you can use xmlrpclib(for Python3.x, use
  1542. xmlrpc.client instead) to interact with aria2.
  1543. ----------------------------------------------
  1544. import xmlrpclib
  1545. from pprint import pprint
  1546. s = xmlrpclib.ServerProxy("http://localhost:6800/rpc")
  1547. r = s.aria2.addUri(["http://localhost/aria2.tar.bz2"], {"dir":"/downloads"})
  1548. pprint(r)
  1549. ----------------------------------------------
  1550. EXAMPLE
  1551. -------
  1552. HTTP/FTP Segmented Download
  1553. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1554. Download a file
  1555. ^^^^^^^^^^^^^^^
  1556. --------------------------------
  1557. aria2c "http://host/file.zip"
  1558. --------------------------------
  1559. [NOTE]
  1560. To stop a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory. You can change URIs as long as they are pointing to the same file.
  1561. Download a file from 2 different HTTP servers
  1562. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1563. ------------------------------------------------------
  1564. aria2c "http://host/file.zip" "http://mirror/file.zip"
  1565. ------------------------------------------------------
  1566. Download a file from HTTP and FTP servers
  1567. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1568. -----------------------------------------------------
  1569. aria2c "http://host1/file.zip" "ftp://host2/file.zip"
  1570. -----------------------------------------------------
  1571. Download files listed in a text file concurrently
  1572. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1573. ------------------------
  1574. aria2c -ifiles.txt -j2
  1575. ------------------------
  1576. [NOTE]
  1577. -j option specifies the number of parallel downloads.
  1578. Using proxy
  1579. ^^^^^^^^^^^
  1580. For HTTP:
  1581. ----------------------------------------------------------
  1582. aria2c --http-proxy="http://proxy:8080" "http://host/file"
  1583. ----------------------------------------------------------
  1584. ----------------------------------------------------------
  1585. aria2c --http-proxy="http://proxy:8080" --no-proxy="localhost,127.0.0.1,192.168.0.0/16" "http://host/file"
  1586. ----------------------------------------------------------
  1587. For FTP:
  1588. --------------------------------------------------------
  1589. aria2c --ftp-proxy="http://proxy:8080" "ftp://host/file"
  1590. --------------------------------------------------------
  1591. [NOTE]
  1592. See *--http-proxy*, *--https-proxy*, *--ftp-proxy*, *--all-proxy* and
  1593. *--no-proxy* for details. You can specify proxy in the environment
  1594. variables. See *ENVIRONMENT* section.
  1595. Proxy with authorization
  1596. ^^^^^^^^^^^^^^^^^^^^^^^^
  1597. ----------------------------------------------------------------------------
  1598. aria2c --http-proxy="http://username:password@proxy:8080" "http://host/file"
  1599. ----------------------------------------------------------------------------
  1600. ----------------------------------------------------------------------------
  1601. aria2c --http-proxy="http://proxy:8080" --http-proxy-user="username" --http-proxy-passwd="password" "http://host/file"
  1602. ----------------------------------------------------------------------------
  1603. Metalink Download
  1604. ~~~~~~~~~~~~~~~~~
  1605. Download files with remote Metalink
  1606. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1607. --------------------------------------------------------
  1608. aria2c --follow-metalink=mem "http://host/file.metalink"
  1609. --------------------------------------------------------
  1610. Download using a local metalink file
  1611. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1612. ----------------------------------------------------------
  1613. aria2c -p --lowest-speed-limit=4000 file.metalink
  1614. ----------------------------------------------------------
  1615. [NOTE]
  1616. To stop a download, press Ctrl-C.
  1617. You can resume the transfer by running aria2c with the same argument in the same
  1618. directory.
  1619. Download several local metalink files
  1620. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1621. ----------------------------------------
  1622. aria2c -j2 file1.metalink file2.metalink
  1623. ----------------------------------------
  1624. Download only selected files using index
  1625. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1626. -------------------------------------------
  1627. aria2c --select-file=1-4,8 file.metalink
  1628. -------------------------------------------
  1629. [NOTE]
  1630. The index is printed to the console using -S option.
  1631. Download a file using a local .metalink file with user preference
  1632. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1633. ------------------------------------------------------------------------------
  1634. aria2c --metalink-location=jp,us --metalink-version=1.1 --metalink-language=en-US file.metalink
  1635. ------------------------------------------------------------------------------
  1636. BitTorrent Download
  1637. ~~~~~~~~~~~~~~~~~~~
  1638. Download files from remote BitTorrent file
  1639. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1640. ------------------------------------------------------
  1641. aria2c --follow-torrent=mem "http://host/file.torrent"
  1642. ------------------------------------------------------
  1643. Download using a local torrent file
  1644. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1645. ---------------------------------------------
  1646. aria2c --max-upload-limit=40K file.torrent
  1647. ---------------------------------------------
  1648. [NOTE]
  1649. --max-upload-limit specifies the max of upload rate.
  1650. [NOTE]
  1651. To stop a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory.
  1652. Download using BitTorrent Magnet URI
  1653. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1654. ------------------------------------------------------------------------------
  1655. aria2c "magnet:?xt=urn:btih:248D0A1CD08284299DE78D5C1ED359BB46717D8C&dn=aria2"
  1656. ------------------------------------------------------------------------------
  1657. [NOTE]
  1658. Don't forget to quote BitTorrent Magnet URI which includes "&"
  1659. character with single(') or double(") quotation.
  1660. Download 2 torrents
  1661. ^^^^^^^^^^^^^^^^^^^
  1662. --------------------------------------
  1663. aria2c -j2 file1.torrent file2.torrent
  1664. --------------------------------------
  1665. Download a file using torrent and HTTP/FTP server
  1666. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1667. ------------------------------------------------------------
  1668. aria2c -Ttest.torrent "http://host1/file" "ftp://host2/file"
  1669. ------------------------------------------------------------
  1670. [NOTE]
  1671. Downloading multi file torrent with HTTP/FTP is not supported.
  1672. Download only selected files using index(usually called "selectable download")
  1673. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1674. ---------------------------------------
  1675. aria2c --select-file=1-4,8 file.torrent
  1676. ---------------------------------------
  1677. [NOTE]
  1678. The index is printed to the console using -S option.
  1679. Specify output filename
  1680. ^^^^^^^^^^^^^^^^^^^^^^^
  1681. To specify output filename for BitTorrent downloads, you need to know
  1682. the index of file in torrent file using *-S* option. For example, the
  1683. output looks like this:
  1684. --------------------------
  1685. idx|path/length
  1686. ===+======================
  1687. 1|dist/base-2.6.18.iso
  1688. |99.9MiB
  1689. ---+----------------------
  1690. 2|dist/driver-2.6.18.iso
  1691. |169.0MiB
  1692. ---+----------------------
  1693. --------------------------
  1694. To save 'dist/base-2.6.18.iso' in '/tmp/mydir/base.iso' and
  1695. 'dist/driver-2.6.18.iso' in '/tmp/dir/driver.iso', use the following
  1696. command:
  1697. -----------------------------------------------------------------------------------------
  1698. aria2c --dir=/tmp --index-out=1=mydir/base.iso --index-out=2=dir/driver.iso file.torrent
  1699. -----------------------------------------------------------------------------------------
  1700. Change the listening port for incoming peer
  1701. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1702. ---------------------------------------------------
  1703. aria2c --listen-port=7000-7001,8000 file.torrent
  1704. ---------------------------------------------------
  1705. [NOTE]
  1706. Since aria2 doesn't configure firewall or router for port forwarding, it's up
  1707. to you to do it manually.
  1708. Specify the condition to stop program after torrent download finished
  1709. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1710. -------------------------------------------------------
  1711. aria2c --seed-time=120 --seed-ratio=1.0 file.torrent
  1712. -------------------------------------------------------
  1713. [NOTE]
  1714. In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.
  1715. Throttle upload speed
  1716. ^^^^^^^^^^^^^^^^^^^^^
  1717. ----------------------------------------------
  1718. aria2c --max-upload-limit=100K file.torrent
  1719. ----------------------------------------------
  1720. Enable IPv4 DHT
  1721. ^^^^^^^^^^^^^^^
  1722. ---------------------------------------------------------
  1723. aria2c --enable-dht --dht-listen-port=6881 file.torrent
  1724. ---------------------------------------------------------
  1725. [NOTE]
  1726. DHT uses udp port. Since aria2 doesn't configure firewall or router for port
  1727. forwarding, it's up to you to do it manually.
  1728. Enable IPv6 DHT
  1729. ^^^^^^^^^^^^^^^
  1730. -----------------------------------------------------------------------------------------------------------
  1731. aria2c --enable-dht6 --dht-listen-port=6881 --dht-listen-addr6=YOUR_GLOBAL_UNICAST_IPV6_ADDR --enable-async-dns6
  1732. -----------------------------------------------------------------------------------------------------------
  1733. [NOTE]
  1734. If aria2c is not built with c-ares, *--enable-async-dns6* is
  1735. unnecessary. aria2 shares same port between IPv4 and IPv6 DHT.
  1736. Add and remove tracker URI
  1737. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  1738. Removes all tracker announce URIs described in file.torrent and use
  1739. "http://tracker1/announce" and "http://tracker2/announce" instead.
  1740. ---------------------------------------------------------------------------------------------------------
  1741. aria2c --bt-exclude-tracker="*" --bt-tracker="http://tracker1/announce,http://tracker2/announce" file.torrent
  1742. ---------------------------------------------------------------------------------------------------------
  1743. More advanced HTTP features
  1744. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1745. Load cookies
  1746. ^^^^^^^^^^^^
  1747. --------------------------------------------------------
  1748. aria2c --load-cookies=cookies.txt "http://host/file.zip"
  1749. --------------------------------------------------------
  1750. [NOTE]
  1751. You can use Firefox/Mozilla/Chromium's cookie file without modification.
  1752. Resume download started by web browsers or another programs
  1753. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1754. -------------------------------------------------------
  1755. aria2c -c -s2 "http://host/partiallydownloadedfile.zip"
  1756. -------------------------------------------------------
  1757. Client certificate authorization for SSL/TLS
  1758. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1759. ------------------------------------------------------------------------------------------
  1760. aria2c --certificate=/path/to/mycert.pem --private-key=/path/to/mykey.pem https://host/file
  1761. ------------------------------------------------------------------------------------------
  1762. [NOTE]
  1763. The file specified in *--private-key* must be decrypted. The behavior when
  1764. encrypted one is given is undefined.
  1765. Verify peer in SSL/TLS using given CA certificates
  1766. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1767. ------------------------------------------------------------------------------------------
  1768. aria2c --ca-certificate=/path/to/ca-certificates.crt --check-certificate https://host/file
  1769. ------------------------------------------------------------------------------------------
  1770. And more advanced features
  1771. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  1772. Throttle download speed
  1773. ^^^^^^^^^^^^^^^^^^^^^^^
  1774. -------------------------------------------------
  1775. aria2c --max-download-limit=100K file.metalink
  1776. -------------------------------------------------
  1777. Repair a damaged download
  1778. ^^^^^^^^^^^^^^^^^^^^^^^^^
  1779. -----------------------
  1780. aria2c -V file.metalink
  1781. -----------------------
  1782. [NOTE]
  1783. This option is only available used with BitTorrent or metalink with chunk
  1784. checksums.
  1785. Drop connection if download speed is lower than specified value
  1786. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1787. ------------------------------------------------
  1788. aria2c --lowest-speed-limit=10K file.metalink
  1789. ------------------------------------------------
  1790. Parameterized URI support
  1791. ^^^^^^^^^^^^^^^^^^^^^^^^^
  1792. You can specify set of parts:
  1793. -----------------------------------------------
  1794. aria2c -P "http://{host1,host2,host3}/file.iso"
  1795. -----------------------------------------------
  1796. You can specify numeric sequence:
  1797. ---------------------------------------------
  1798. aria2c -Z -P "http://host/image[000-100].png"
  1799. ---------------------------------------------
  1800. [NOTE]
  1801. -Z option is required if the all URIs don't point to the same file, such as the above example.
  1802. You can specify step counter:
  1803. -------------------------------------------
  1804. aria2c -Z -P "http://host/image[A-Z:2].png"
  1805. -------------------------------------------
  1806. Parallel downloads of arbitrary number of URI,metalink,torrent
  1807. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1808. --------------------------------------------------------------
  1809. aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink
  1810. --------------------------------------------------------------
  1811. BitTorrent Encryption
  1812. ^^^^^^^^^^^^^^^^^^^^^
  1813. Encrypt whole payload using ARC4:
  1814. -------------------------------------------------------------------------
  1815. aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent
  1816. -------------------------------------------------------------------------
  1817. SEE ALSO
  1818. --------
  1819. Project Web Site: http://aria2.sourceforge.net/
  1820. aria2 Wiki: http://sourceforge.net/apps/trac/aria2/wiki
  1821. Metalink Homepage: http://www.metalinker.org/
  1822. The Metalink Download Description Format: http://tools.ietf.org/html/rfc5854
  1823. COPYRIGHT
  1824. ---------
  1825. Copyright (C) 2006, 2010 Tatsuhiro Tsujikawa
  1826. This program is free software; you can redistribute it and/or modify
  1827. it under the terms of the GNU General Public License as published by
  1828. the Free Software Foundation; either version 2 of the License, or
  1829. (at your option) any later version.
  1830. This program is distributed in the hope that it will be useful,
  1831. but WITHOUT ANY WARRANTY; without even the implied warranty of
  1832. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  1833. GNU General Public License for more details.
  1834. You should have received a copy of the GNU General Public License
  1835. along with this program; if not, write to the Free Software
  1836. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  1837. In addition, as a special exception, the copyright holders give
  1838. permission to link the code of portions of this program with the
  1839. OpenSSL library under certain conditions as described in each
  1840. individual source file, and distribute linked combinations
  1841. including the two.
  1842. You must obey the GNU General Public License in all respects
  1843. for all of the code used other than OpenSSL. If you modify
  1844. file(s) with this exception, you may extend this exception to your
  1845. version of the file(s), but you are not obligated to do so. If you
  1846. do not wish to do so, delete this exception statement from your
  1847. version. If you delete this exception statement from all source
  1848. files in the program, then also delete it here.