aria2c.1 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565
  1. .\" Title: aria2c
  2. .\" Author:
  3. .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
  4. .\" Date: 11/15/2008
  5. .\" Manual:
  6. .\" Source:
  7. .\"
  8. .TH "ARIA2C" "1" "11/15/2008" "" ""
  9. .\" disable hyphenation
  10. .nh
  11. .\" disable justification (adjust text to left margin only)
  12. .ad l
  13. .SH "NAME"
  14. aria2c \- The ultra fast download utility
  15. .SH "SYNOPSIS"
  16. aria2c [\fIOPTIONS\fR] [\fIURL\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&...
  17. .sp
  18. .SH "DESCRIPTION"
  19. aria2 is a utility for downloading files\&. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\&. It can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth\&. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm\&. Using Metalink\'s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\&.
  20. .sp
  21. .SH "OPTIONS"
  22. .SS "Basic Options"
  23. .PP
  24. \fB\-d\fR, \fB\-\-dir\fR=DIR
  25. .RS 4
  26. The directory to store the downloaded file\&.
  27. .RE
  28. .PP
  29. \fB\-i\fR, \fB\-\-input\-file\fR=FILE
  30. .RS 4
  31. Downloads URIs found in FILE\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&. Reads input from stdin when
  32. \fI\-\fR
  33. is specified\&. The additional
  34. \fBout\fR
  35. and
  36. \fBdir\fR
  37. options can be specified after each line of URIs\&. This optional line must start with white space(s)\&. See INPUT FILE section for details\&.
  38. .RE
  39. .PP
  40. \fB\-l\fR, \fB\-\-log\fR=LOG
  41. .RS 4
  42. The file name of the log file\&. If
  43. \fI\-\fR
  44. is specified, log is written to stdout\&.
  45. .RE
  46. .PP
  47. \fB\-j\fR, \fB\-\-max\-concurrent\-downloads\fR=N
  48. .RS 4
  49. Set maximum number of parallel downloads for every static (HTTP/FTP) URL, torrent and metalink\&. See also
  50. \fB\-s\fR
  51. and
  52. \fB\-C\fR
  53. option\&. Default:
  54. \fI5\fR
  55. .RE
  56. .PP
  57. \fB\-\-check\-integrity\fR=\fItrue\fR|\fIfalse\fR
  58. .RS 4
  59. Check file integrity by validating piece hash\&. This option only affects in BitTorrent downloads and Metalink downloads with chunk checksums\&. Use this option to re\-download a damaged portion of a file\&. Default:
  60. \fIfalse\fR
  61. .RE
  62. .PP
  63. \fB\-c\fR, \fB\-\-continue\fR
  64. .RS 4
  65. Continue downloading a partially downloaded file\&. Use this option to resume a download started by a web browser or another program which downloads files sequentially from the beginning\&. Currently this option is only applicable to HTTP(S)/FTP downloads\&.
  66. .RE
  67. .PP
  68. \fB\-h\fR, \fB\-\-help\fR[=CATEGORY]
  69. .RS 4
  70. Print usage and exit\&. The help messages are classified in several categories\&. For example, type "\fB\-\-help\fR=http" for detailed explanation for the options related to HTTP\&. If no matching category is found, search option name using a given word in middle match and print the result\&. Available Values:
  71. \fIbasic\fR,
  72. \fIadvanced\fR,
  73. \fIhttp\fR,
  74. \fIftp\fR,
  75. \fImetalink\fR,
  76. \fIbittorrent\fR,
  77. \fIall\fR
  78. Default:
  79. \fIbasic\fR
  80. .RE
  81. .SS "HTTP/FTP Options"
  82. .PP
  83. \fB\-\-all\-proxy\fR=PROXY
  84. .RS 4
  85. Use this proxy server in the all protocols\&. You can override this setting and specify a proxy server for particular proctol using
  86. \fB\-\-http\-proxy\fR,
  87. \fB\-\-https\-proxy\fR
  88. and
  89. \fB\-\-ftp\-proxy\fR
  90. options\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  91. .RE
  92. .PP
  93. \fB\-\-connect\-timeout\fR=SEC
  94. .RS 4
  95. Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server\&. After the connection is established, this option makes no effect and
  96. \fB\-\-timeout\fR
  97. option is used instead\&. Default:
  98. \fI60\fR
  99. .RE
  100. .PP
  101. \fB\-\-lowest\-speed\-limit\fR=SPEED
  102. .RS 4
  103. Close connection if download speed is lower than or equal to this value(bytes per sec)\&.
  104. \fI0\fR
  105. means aria2 does not have a lowest speed limit\&. You can append
  106. \fIK\fR
  107. or
  108. \fIM\fR(1K = 1024, 1M = 1024K)\&. This option does not affect BitTorrent downloads\&. Default:
  109. \fI0\fR
  110. .RE
  111. .PP
  112. \fB\-\-max\-file\-not\-found\fR=NUM
  113. .RS 4
  114. If aria2 recieves `file not found\' status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify
  115. \fI0\fR
  116. to disable this option\&. This options is only effective only when using HTTP/FTP servers\&. Default:
  117. \fI0\fR
  118. .RE
  119. .PP
  120. \fB\-m\fR, \fB\-\-max\-tries\fR=N
  121. .RS 4
  122. Set number of tries\&.
  123. \fI0\fR
  124. means unlimited\&. Default:
  125. \fI5\fR
  126. .RE
  127. .PP
  128. \fB\-\-no\-proxy\fR=DOMAINS
  129. .RS 4
  130. Specify comma separated hostnames or domains to which proxy should not be used\&.
  131. .RE
  132. .PP
  133. \fB\-o\fR, \fB\-\-out\fR=FILE
  134. .RS 4
  135. The file name of the downloaded file\&.
  136. .RE
  137. .sp
  138. .it 1 an-trap
  139. .nr an-no-space-flag 1
  140. .nr an-break-flag 1
  141. .br
  142. Note
  143. In Metalink, BitTorrent download you cannot specify file name\&. The file name specified here is only used when the URLs fed to aria2 is done by command line without \fB\-i\fR, \fB\-Z\fR option\&. For example: aria2c \-o myfile\&.zip http://mirror1/file\&.zip http://mirror2/file\&.zip
  144. .PP
  145. \fB\-\-proxy\-method\fR=METHOD
  146. .RS 4
  147. Set the method to use in proxy request\&.
  148. \fIMETHOD\fR
  149. is either
  150. \fIget\fR
  151. or
  152. \fItunnel\fR\&. Default:
  153. \fItunnel\fR
  154. .RE
  155. .PP
  156. \fB\-R\fR, \fB\-\-remote\-time\fR[=\fItrue\fR|\fIfalse\fR]
  157. .RS 4
  158. Retrieve timestamp of the remote file from the remote HTTP/FTP server and if it is available, apply it to the local file\&. Default:
  159. \fIfalse\fR
  160. .RE
  161. .PP
  162. \fB\-\-retry\-wait\fR=SEC
  163. .RS 4
  164. Set the seconds to wait to retry after an error has occured\&. Specify a value between
  165. \fI0\fR
  166. and
  167. \fI60\fR\&. Default:
  168. \fI5\fR
  169. .RE
  170. .PP
  171. \fB\-\-server\-stat\-of\fR=FILE
  172. .RS 4
  173. Specify the filename to which performance profile of the servers is saved\&. You can load saved data using
  174. \fB\-\-server\-stat\-if\fR
  175. option\&. See SERVER PERFORMANCE PROFILE section below for file format\&.
  176. .RE
  177. .PP
  178. \fB\-\-server\-stat\-if\fR=FILE
  179. .RS 4
  180. Specify the filename to load performance profile of the servers\&. The loaded data will be used in some URI selector such as
  181. \fIfeedback\fR\&. See also
  182. \fB\-\-uri\-selector\fR
  183. option\&. See SERVER PERFORMANCE PROFILE section below for file format\&.
  184. .RE
  185. .PP
  186. \fB\-\-server\-stat\-timeout\fR=SEC
  187. .RS 4
  188. Specifies timeout in seconds to invalidate performance profile of the servers since the last contact to them\&. Default:
  189. \fI86400\fR
  190. (24hours)
  191. .RE
  192. .PP
  193. \fB\-s\fR, \fB\-\-split\fR=N
  194. .RS 4
  195. Download a file using N connections\&. If more than N URLs are given, first N URLs are used and remaining URLs are used for backup\&. If less than N URLs are given, those URLs are used more than once so that N connections total are made simultaneously\&. N must be between
  196. \fI1\fR
  197. and
  198. \fI16\fR\&. Please see
  199. \fB\-j\fR
  200. option too\&. Please note that in Metalink download, this option has no effect and use
  201. \fB\-C\fR
  202. option instead\&. Default:
  203. \fI5\fR
  204. .RE
  205. .PP
  206. \fB\-t\fR, \fB\-\-timeout\fR=SEC
  207. .RS 4
  208. Set timeout in seconds\&. Default:
  209. \fI60\fR
  210. .RE
  211. .PP
  212. \fB\-\-uri\-selector\fR=SELECTOR
  213. .RS 4
  214. Specify URI selection algorithm\&. Possible values are
  215. \fIinorder\fR
  216. and
  217. \fIfeedback\fR\&. If
  218. \fIinorder\fR
  219. is given, URI is tried in the order appeared in the URI list\&. If
  220. \fIfeedback\fR
  221. is given, aria2 uses download speed observed in the previous downloads and choose fastest server in the URI list\&. This also effectively skips dead mirrors\&. The observed download speed is a part of performance profile of servers mentioned in
  222. \fB\-\-server\-stat\-of\fR
  223. and
  224. \fB\-\-server\-stat\-if\fR
  225. options\&. Default:
  226. \fIinorder\fR
  227. .RE
  228. .SS "HTTP Specific Options"
  229. .PP
  230. \fB\-\-ca\-certificate\fR=FILE
  231. .RS 4
  232. Use the certificate authorities in FILE to verify the peers\&. The certificate file must be in PEM format and can contain multiple CA certificates\&. Use
  233. \fB\-\-check\-certificate\fR
  234. option to enable verification\&.
  235. .RE
  236. .PP
  237. \fB\-\-certificate\fR=FILE
  238. .RS 4
  239. Use the client certificate in FILE\&. The certificate must be in PEM format\&. You may use
  240. \fB\-\-private\-key\fR
  241. option to specify the private key\&.
  242. .RE
  243. .PP
  244. \fB\-\-check\-certificate\fR[=\fItrue\fR|\fIfalse\fR]
  245. .RS 4
  246. Verify the peer using certificates specified in
  247. \fB\-\-ca\-certificate\fR
  248. option\&.
  249. .RE
  250. .PP
  251. \fB\-\-http\-auth\-scheme\fR=SCHEME
  252. .RS 4
  253. Set HTTP authentication scheme\&. Currently,
  254. \fIbasic\fR
  255. is the only supported scheme\&. Default:
  256. \fIbasic\fR
  257. .RE
  258. .PP
  259. \fB\-\-http\-user\fR=USER
  260. .RS 4
  261. Set HTTP user\&. This affects all URLs\&.
  262. .RE
  263. .PP
  264. \fB\-\-http\-passwd\fR=PASSWD
  265. .RS 4
  266. Set HTTP password\&. This affects all URLs\&.
  267. .RE
  268. .PP
  269. \fB\-\-http\-proxy\fR=PROXY
  270. .RS 4
  271. Use this proxy server for HTTP\&. See also
  272. \fB\-\-all\-proxy\fR
  273. option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  274. .RE
  275. .PP
  276. \fB\-\-https\-proxy\fR=PROXY
  277. .RS 4
  278. Use this proxy server for HTTPS\&. See also
  279. \fB\-\-all\-proxy\fR
  280. option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  281. .RE
  282. .PP
  283. \fB\-\-private\-key\fR=FILE
  284. .RS 4
  285. Use the private key in FILE\&. The private key must be decrypted and in PEM format\&. The behavior when encrypted one is given is undefined\&. See also
  286. \fB\-\-certificate\fR
  287. option\&.
  288. .RE
  289. .PP
  290. \fB\-\-referer\fR=REFERER
  291. .RS 4
  292. Set Referer\&. This affects all URLs\&.
  293. .RE
  294. .PP
  295. \fB\-\-enable\-http\-keep\-alive\fR[=\fItrue\fR|\fIfalse\fR]
  296. .RS 4
  297. Enable HTTP/1\&.1 persistent connection\&. Default:
  298. \fItrue\fR
  299. .RE
  300. .PP
  301. \fB\-\-enable\-http\-pipelining\fR[=\fItrue\fR|\fIfalse\fR]
  302. .RS 4
  303. Enable HTTP/1\&.1 pipelining\&. Default:
  304. \fIfalse\fR
  305. .RE
  306. .PP
  307. \fB\-\-header\fR=HEADER
  308. .RS 4
  309. Append HEADER to HTTP request header\&. You can use this option repeatedly to specify more than one header: aria2c
  310. \fB\-\-header\fR="X\-A: b78"
  311. \fB\-\-header\fR="X\-B: 9J1" http://host/file
  312. .RE
  313. .PP
  314. \fB\-\-load\-cookies\fR=FILE
  315. .RS 4
  316. Load Cookies from FILE using the Firefox3 format(SQLite3) and the Mozilla/Firefox(1\&.x/2\&.x)/Netscape format\&.
  317. .RE
  318. .sp
  319. .it 1 an-trap
  320. .nr an-no-space-flag 1
  321. .nr an-break-flag 1
  322. .br
  323. Note
  324. If aria2 is build without libsqlite3, then it doesn\'t support Firefox3 cookie\&.
  325. .PP
  326. \fB\-U\fR, \fB\-\-user\-agent\fR=USER_AGENT
  327. .RS 4
  328. Set user agent for HTTP(S) downloads\&.
  329. .RE
  330. .SS "FTP Specific Options"
  331. .PP
  332. \fB\-\-ftp\-user\fR=USER
  333. .RS 4
  334. Set FTP user\&. This affects all URLs\&. Default:
  335. \fIanonymous\fR
  336. .RE
  337. .PP
  338. \fB\-\-ftp\-passwd\fR=PASSWD
  339. .RS 4
  340. Set FTP password\&. This affects all URLs\&. Default:
  341. \fIARIA2USER@\fR
  342. .RE
  343. .PP
  344. \fB\-p\fR, \fB\-\-ftp\-pasv\fR
  345. .RS 4
  346. Use passive mode in FTP\&.
  347. .RE
  348. .PP
  349. \fB\-\-ftp\-proxy\fR=PROXY
  350. .RS 4
  351. Use this proxy server for FTP\&. See also
  352. \fB\-\-all\-proxy\fR
  353. option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  354. .RE
  355. .PP
  356. \fB\-\-ftp\-type\fR=TYPE
  357. .RS 4
  358. Set FTP transfer type\&. TYPE is either
  359. \fIbinary\fR
  360. or
  361. \fIascii\fR\&. Default:
  362. \fIbinary\fR
  363. .RE
  364. .PP
  365. \fB\-\-ftp\-reuse\-connection\fR[=\fItrue\fR|\fIfalse\fR]
  366. .RS 4
  367. Reuse connection in FTP\&. Default:
  368. \fItrue\fR
  369. .RE
  370. .PP
  371. \fB\-n\fR, \fB\-\-no\-netrc\fR
  372. .RS 4
  373. Disables netrc support\&. netrc support is enabled by default\&.
  374. .RE
  375. .SS "BitTorrent/Metalink Options"
  376. .PP
  377. \fB\-\-select\-file\fR=INDEX\&...
  378. .RS 4
  379. Set file to download by specifing its index\&. You can find the file index using the
  380. \fB\-\-show\-files\fR
  381. option\&. Multiple indexes can be specified by using ",", for example:
  382. \fI3,6\fR\&. You can also use "\-" to specify a range:
  383. \fI1\-5\fR\&. "," and "\-" can be used together:
  384. \fI1\-5,8,9\fR\&. When used with the \-M option, index may vary depending on the query (see
  385. \fB\-\-metalink\-\fR* options)\&.
  386. .RE
  387. .sp
  388. .it 1 an-trap
  389. .nr an-no-space-flag 1
  390. .nr an-break-flag 1
  391. .br
  392. Note
  393. In multi file torrent, the adjacent files specified by this option may also be downloaded\&. This is by design, not a bug\&. A single piece may include several files or part of files, and aria2 writes the piece to the appropriate files\&.
  394. .PP
  395. \fB\-S\fR, \fB\-\-show\-files\fR
  396. .RS 4
  397. Print file listing of \&.torrent or \&.metalink file and exit\&. In case of \&.torrent file, additional information (infohash, piece length, etc) is also printed\&.
  398. .RE
  399. .SS "BitTorrent Specific Options"
  400. .PP
  401. \fB\-\-bt\-max\-open\-files\fR=NUM
  402. .RS 4
  403. Specify maximum number of files to open in each BitTorrent download\&. Default:
  404. \fI100\fR
  405. .RE
  406. .PP
  407. \fB\-\-bt\-min\-crypto\-level\fR=\fIplain\fR|\fIarc4\fR
  408. .RS 4
  409. Set minimum level of encryption method\&. If several encryption methods are provided by a peer, aria2 chooses a lowest one which satisfies the given level\&. Default:
  410. \fIplain\fR
  411. .RE
  412. .PP
  413. \fB\-\-bt\-require\-crypto\fR=\fItrue\fR|\fIfalse\fR
  414. .RS 4
  415. If true is given, aria2 doesn\'t accept and establish connection with legacy BitTorrent handshake(\e19BitTorrent protocol)\&. Thus aria2 always uses Obfuscation handshake\&. Default:
  416. \fIfalse\fR
  417. .RE
  418. .PP
  419. \fB\-\-bt\-request\-peer\-speed\-limit\fR=SPEED
  420. .RS 4
  421. In BitTorrent downloads, if the download speed is lower than SPEED, aria2 initiates and accepts connections ignoring max peer cap\&. You can append
  422. \fIK\fR
  423. or
  424. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  425. \fI51200\fR
  426. .RE
  427. .PP
  428. \fB\-\-bt\-seed\-unverified\fR[=\fItrue\fR|\fIfalse\fR]
  429. .RS 4
  430. Seed previously downloaded files without verifying piece hashes\&. Default:
  431. \fIfalse\fR
  432. .RE
  433. .PP
  434. \fB\-\-dht\-entry\-point\fR=HOST:PORT
  435. .RS 4
  436. Set host and port as an entry point to DHT network\&.
  437. .RE
  438. .PP
  439. \fB\-\-dht\-file\-path\fR=PATH
  440. .RS 4
  441. Change the DHT routing table file to PATH\&. Default:
  442. \fI$HOME/\&.aria2/dht\&.dat\fR
  443. .RE
  444. .PP
  445. \fB\-\-dht\-listen\-port\fR=PORT\&...
  446. .RS 4
  447. Set UDP listening port for DHT\&. Multiple ports can be specified by using ",", for example:
  448. \fI6881,6885\fR\&. You can also use "\-" to specify a range:
  449. \fI6881\-6999\fR\&. "," and "\-" can be used together\&. Default:
  450. \fI6881\-6999\fR
  451. .RE
  452. .PP
  453. \fB\-\-direct\-file\-mapping\fR=\fItrue\fR|\fIfalse\fR
  454. .RS 4
  455. Directly read from and write to each file mentioned in \&.torrent file\&. Use this option if lots of files are listed in \&.torrent file and aria2 complains it cannot open files anymore\&. Default:
  456. \fItrue\fR
  457. .RE
  458. .PP
  459. \fB\-\-enable\-dht\fR[=\fItrue\fR|\fIfalse\fR]
  460. .RS 4
  461. Enable DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\'t use DHT for that download even if
  462. \fItrue\fR
  463. is given\&. Default:
  464. \fIfalse\fR
  465. .RE
  466. .PP
  467. \fB\-\-enable\-peer\-exchange\fR[=\fItrue\fR|\fIfalse\fR]
  468. .RS 4
  469. Enable Peer Exchange extension\&. If a private flag is set in a torrent, this feature is disabled for that download even if
  470. \fItrue\fR
  471. is given\&. Default:
  472. \fItrue\fR
  473. .RE
  474. .PP
  475. \fB\-\-follow\-torrent\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
  476. .RS 4
  477. If
  478. \fItrue\fR
  479. or
  480. \fImem\fR
  481. is specified, when a file whose suffix is "\&.torrent" or content type is "application/x\-bittorrent" is downloaded, aria2 parses it as a torrent file and downloads files mentioned in it\&. If
  482. \fImem\fR
  483. is specified, a torrent file is not written to the disk, but is just kept in memory\&. If
  484. \fIfalse\fR
  485. is specified, the action mentioned above is not taken\&. Default:
  486. \fItrue\fR
  487. .RE
  488. .PP
  489. \fB\-\-listen\-port\fR=PORT\&...
  490. .RS 4
  491. Set TCP port number for BitTorrent downloads\&. Multiple ports can be specified by using ",", for example:
  492. \fI6881,6885\fR\&. You can also use "\-" to specify a range:
  493. \fI6881\-6999\fR\&. "," and "\-" can be used together:
  494. \fI6881\-6889,6999\fR\&. Default:
  495. \fI6881\-6999\fR
  496. .RE
  497. .sp
  498. .it 1 an-trap
  499. .nr an-no-space-flag 1
  500. .nr an-break-flag 1
  501. .br
  502. Note
  503. Make sure that the specified ports are open for incoming TCP traffic\&.
  504. .PP
  505. \fB\-\-max\-upload\-limit\fR=SPEED
  506. .RS 4
  507. Set max upload speed in bytes per sec\&.
  508. \fI0\fR
  509. means unrestricted\&. You can append
  510. \fIK\fR
  511. or
  512. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  513. \fI0\fR
  514. .RE
  515. .PP
  516. \fB\-\-peer\-id\-prefix\fR=PEERI_ID_PREFIX
  517. .RS 4
  518. Specify the prefix of peer ID\&. The peer ID in BitTorrent is 20 byte length\&. If more than 20 bytes are specified, only first 20 bytes are used\&. If less than 20 bytes are specified, the random alphabet characters are added to make it\'s length 20 bytes\&. Default:
  519. \fI\-aria2\-\fR
  520. .RE
  521. .PP
  522. \fB\-\-seed\-ratio\fR=RATIO
  523. .RS 4
  524. Specify share ratio\&. Seed completed torrents until share ratio reaches] RATIO\&. I strongly encourages you to specify equals or more than
  525. \fI1\&.0\fR
  526. here\&. Specify
  527. \fI0\&.0\fR
  528. if you intend to do seeding regardless of share ratio\&. If
  529. \fB\-\-seed\-time\fR
  530. option is specified along with this option, seeding ends when at least one of the conditions is satisfied\&. Default:
  531. \fI1\&.0\fR
  532. .RE
  533. .PP
  534. \fB\-\-seed\-time\fR=MINUTES
  535. .RS 4
  536. Specify seeding time in minutes\&. Also see the
  537. \fB\-\-seed\-ratio\fR
  538. option\&.
  539. .RE
  540. .PP
  541. \fB\-T\fR, \fB\-\-torrent\-file\fR=TORRENT_FILE
  542. .RS 4
  543. The path to the \&.torrent file\&. You may not use this option because you can specify torrent file without \-T\&.
  544. .RE
  545. .SS "Metalink Specific Options"
  546. .PP
  547. \fB\-\-follow\-metalink\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
  548. .RS 4
  549. If
  550. \fItrue\fR
  551. or
  552. \fImem\fR
  553. is specified, when a file whose suffix is "\&.metaink" or content type is "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it\&. If
  554. \fImem\fR
  555. is specified, a metalink file is not written to the disk, but is just kept in memory\&. If
  556. \fIfalse\fR
  557. is specified, the action mentioned above is not taken\&. Default:
  558. \fItrue\fR
  559. .RE
  560. .PP
  561. \fB\-M\fR, \fB\-\-metalink\-file\fR=METALINK_FILE
  562. .RS 4
  563. The file path to \&.metalink file\&. You may not use this option because you can specify metalink file without \-M\&.
  564. .RE
  565. .PP
  566. \fB\-C\fR, \fB\-\-metalink\-servers\fR=NUM_SERVERS
  567. .RS 4
  568. The number of servers to connect to simultaneously\&. Some Metalinks regulates the number of servers to connect\&. aria2 strictly respects them\&. This means that if Metalink defines the maxconnections attribute lower than NUM_SERVERS, then aria2 uses the value of maxconnections attribute instead of NUM_SERVERS\&. See also
  569. \fB\-s\fR
  570. and
  571. \fB\-j\fR
  572. options\&. Default:
  573. \fI5\fR
  574. .RE
  575. .PP
  576. \fB\-\-metalink\-language\fR=LANGUAGE
  577. .RS 4
  578. The language of the file to download\&.
  579. .RE
  580. .PP
  581. \fB\-\-metalink\-location\fR=LOCATION[,\&...]
  582. .RS 4
  583. The location of the preferred server\&. A comma\-deliminated list of locations is acceptable, for example,
  584. \fIJP,US\fR\&.
  585. .RE
  586. .PP
  587. \fB\-\-metalink\-os\fR=OS
  588. .RS 4
  589. The operating system of the file to download\&.
  590. .RE
  591. .PP
  592. \fB\-\-metalink\-version\fR=VERSION
  593. .RS 4
  594. The version of the file to download\&.
  595. .RE
  596. .PP
  597. \fB\-\-metalink\-preferred\-protocol\fR=PROTO
  598. .RS 4
  599. Specify preferred protocol\&. The possible values are
  600. \fIhttp\fR,
  601. \fIhttps\fR,
  602. \fIftp\fR
  603. and
  604. \fInone\fR\&. Specifiy
  605. \fInone\fR
  606. to disable this feature\&. Default:
  607. \fInone\fR
  608. .RE
  609. .PP
  610. \fB\-\-metalink\-enable\-unique\-protocol\fR=\fItrue\fR|\fIfalse\fR
  611. .RS 4
  612. If
  613. \fItrue\fR
  614. is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\&. Use
  615. \fB\-\-metalink\-preferred\-protocol\fR
  616. option to specify the preference of protocol\&. Default:
  617. \fItrue\fR
  618. .RE
  619. .SS "Advanced Options"
  620. .PP
  621. \fB\-\-allow\-overwrite\fR=\fItrue\fR|\fIfalse\fR
  622. .RS 4
  623. If
  624. \fIfalse\fR
  625. is given, aria2 doesn\'t download a file which already exists but the corresponding \&.aria2 file doesn\'t exist\&. In HTTP(S)/FTP download, if
  626. \fB\-\-auto\-file\-renaming\fR=\fItrue\fR
  627. then, file name will be renamed\&. See
  628. \fB\-\-auto\-file\-renaming\fR
  629. for details\&. Default:
  630. \fIfalse\fR
  631. .RE
  632. .PP
  633. \fB\-\-allow\-piece\-length\-change\fR=\fItrue\fR|\fIfalse\fR
  634. .RS 4
  635. If false is given, aria2 aborts download when a piece length is different from one in a control file\&. If true is given, you can proceed but some download progress will be lost\&. Default:
  636. \fIfalse\fR
  637. .RE
  638. .PP
  639. \fB\-\-async\-dns\fR[=\fItrue\fR|\fIfalse\fR]
  640. .RS 4
  641. Enable asynchronous DNS\&. Default:
  642. \fItrue\fR
  643. .RE
  644. .PP
  645. \fB\-\-auto\-file\-renaming\fR[=\fItrue\fR|\fIfalse\fR]
  646. .RS 4
  647. Rename file name if the same file already exists\&. This option works only in HTTP(S)/FTP download\&. The new file name has a dot and a number(1\&.\&.9999) appended\&. Default:
  648. \fItrue\fR
  649. .RE
  650. .PP
  651. \fB\-\-auto\-save\-interval\fR=SEC
  652. .RS 4
  653. Save a control file(*\&.aria2) every SEC seconds\&. If
  654. \fI0\fR
  655. is given, a control file is not saved during download\&. aria2 saves a control file when it stops regardless of the value\&. The possible values are between
  656. \fI0\fR
  657. to
  658. \fI600\fR\&. Default:
  659. \fI60\fR
  660. .RE
  661. .PP
  662. \fB\-\-conf\-path\fR=PATH
  663. .RS 4
  664. Change the configuration file path to PATH\&. Default:
  665. \fI$HOME/\&.aria2/aria2\&.conf\fR
  666. .RE
  667. .PP
  668. \fB\-D\fR, \fB\-\-daemon\fR
  669. .RS 4
  670. Run as daemon\&.
  671. .RE
  672. .PP
  673. \fB\-\-enable\-direct\-io\fR[=\fItrue\fR|\fIfalse\fR]
  674. .RS 4
  675. Enable directI/O, which lowers cpu usage while allocating/checking files\&. Turn off if you encounter any error\&. Default:
  676. \fItrue\fR
  677. .RE
  678. .PP
  679. \fB\-\-file\-allocation\fR=METHOD
  680. .RS 4
  681. Specify file allocation method\&. METHOD is either
  682. \fInone\fR
  683. or
  684. \fIprealloc\fR\&.
  685. \fInone\fR
  686. doesn\'t pre\-allocate file space\&.
  687. \fIprealloc\fR
  688. pre\-allocates file space before download begins\&. This may take some time depending on the size of the file\&. Default:
  689. \fIprealloc\fR
  690. .RE
  691. .PP
  692. \fB\-\-log\-level\fR=LEVEL
  693. .RS 4
  694. Set log level to output\&. LEVEL is either
  695. \fIdebug\fR,
  696. \fIinfo\fR,
  697. \fInotice\fR,
  698. \fIwarn\fR
  699. or
  700. \fIerror\fR\&. Default:
  701. \fIdebug\fR
  702. .RE
  703. .PP
  704. \fB\-\-summary\-interval\fR=SEC
  705. .RS 4
  706. Set interval in seconds to output download progress summary\&. Setting
  707. \fI0\fR
  708. suppresses the output\&. Default:
  709. \fI60\fR
  710. .RE
  711. .sp
  712. .it 1 an-trap
  713. .nr an-no-space-flag 1
  714. .nr an-break-flag 1
  715. .br
  716. Note
  717. In multi file torrent, the files adjacent forward to the specified files are also allocated if they share a same piece\&.
  718. .PP
  719. \fB\-Z\fR, \fB\-\-force\-sequential\fR[=\fItrue\fR|\fIfalse\fR]
  720. .RS 4
  721. Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\&. Default:
  722. \fIfalse\fR
  723. .RE
  724. .PP
  725. \fB\-\-max\-download\-limit\fR=SPEED
  726. .RS 4
  727. Set max download speed in bytes per sec\&.
  728. \fI0\fR
  729. means unrestricted\&. You can append
  730. \fIK\fR
  731. or
  732. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  733. \fI0\fR
  734. .RE
  735. .PP
  736. \fB\-\-no\-conf\fR
  737. .RS 4
  738. Disable loading aria2\&.conf file\&.
  739. .RE
  740. .PP
  741. \fB\-\-no\-file\-allocation\-limit\fR=SIZE
  742. .RS 4
  743. No file allocation is made for files whose size is smaller than SIZE\&. You can append
  744. \fIK\fR
  745. or
  746. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  747. \fI5M\fR
  748. .RE
  749. .PP
  750. \fB\-P\fR, \fB\-\-parameterized\-uri\fR[=\fItrue\fR|\fIfalse\fR]
  751. .RS 4
  752. Enable parameterized URI support\&. You can specify set of parts:
  753. \fIhttp://{sv1,sv2,sv3}/foo\&.iso\fR\&. Also you can specify numeric sequences with step counter:
  754. \fIhttp://host/image[000\-100:2]\&.img\fR\&. A step counter can be omitted\&. If all URIs do not point to the same file, such as the second example above, \-Z option is required\&. Default:
  755. \fIfalse\fR
  756. .RE
  757. .PP
  758. \fB\-q\fR, \fB\-\-quiet\fR[=\fItrue\fR|\fIfalse\fR]
  759. .RS 4
  760. Make aria2 quite (no console output)\&. Default:
  761. \fIfalse\fR
  762. .RE
  763. .PP
  764. \fB\-\-realtime\-chunk\-checksum\fR=\fItrue\fR|\fIfalse\fR
  765. .RS 4
  766. Validate chunk of data by calculating checkusm while download a file if chunk checksums are provided\&. Currently Metalink is the only way to to provide chunk checksums\&. Default:
  767. \fItrue\fR
  768. .RE
  769. .PP
  770. \fB\-\-stop\fR=SEC
  771. .RS 4
  772. Stop application after SEC seconds has passed\&. If
  773. \fI0\fR
  774. is given, this feature is disabled\&. Default:
  775. \fI0\fR
  776. .RE
  777. .PP
  778. \fB\-v\fR, \fB\-\-version\fR
  779. .RS 4
  780. Print the version number, copyright and the configuration information and exit\&.
  781. .RE
  782. .SS "URL, TORRENT_FILE, METALINK_FILE"
  783. You can specify multiple URLs in command\-line\&. Unless you specify \fB\-Z\fR option, all URLs must point to the same file or downloading will fail\&.
  784. .sp
  785. You can also specify arbitrary number of torrent files and metalink files stored in a local drive\&. Please note that they are always treated as a separate download\&.
  786. .sp
  787. You can specify both torrent file with \-T option and URLs\&. By doing this, download a file from both torrent swarm and HTTP(S)/FTP server at the same time, while the data from HTTP(S)/FTP are uploaded to the torrent swarm\&. Note that only single file torrent can be integrated with HTTP(S)/FTP\&.
  788. .sp
  789. .sp
  790. .it 1 an-trap
  791. .nr an-no-space-flag 1
  792. .nr an-break-flag 1
  793. .br
  794. Note
  795. Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell\&.
  796. .sp
  797. .SH "EXAMPLES"
  798. .SS "HTTP/FTP Segmented Download"
  799. .sp
  800. .it 1 an-trap
  801. .nr an-no-space-flag 1
  802. .nr an-break-flag 1
  803. .br
  804. Download a file
  805. .RS
  806. .sp
  807. .RS 4
  808. .nf
  809. aria2c http://host/file\&.zip
  810. .fi
  811. .RE
  812. .sp
  813. .it 1 an-trap
  814. .nr an-no-space-flag 1
  815. .nr an-break-flag 1
  816. .br
  817. Note
  818. aria2 uses 5 connections to download 1 file by default\&.
  819. .sp
  820. .RE
  821. .sp
  822. .it 1 an-trap
  823. .nr an-no-space-flag 1
  824. .nr an-break-flag 1
  825. .br
  826. Download a file using 1 connection
  827. .RS
  828. .sp
  829. .RS 4
  830. .nf
  831. aria2c \-s1 http://host/file\&.zip
  832. .fi
  833. .RE
  834. .sp
  835. .it 1 an-trap
  836. .nr an-no-space-flag 1
  837. .nr an-break-flag 1
  838. .br
  839. Note
  840. aria2 uses 5 connections to download 1 file by default\&. \-s1 limtis the number of connections to just 1\&.
  841. .sp
  842. .sp
  843. .it 1 an-trap
  844. .nr an-no-space-flag 1
  845. .nr an-break-flag 1
  846. .br
  847. Note
  848. To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument at the same directory\&. You can change URLs as long as they are pointing to the same file\&.
  849. .sp
  850. .RE
  851. .sp
  852. .it 1 an-trap
  853. .nr an-no-space-flag 1
  854. .nr an-break-flag 1
  855. .br
  856. Download a file from 2 different HTTP servers
  857. .RS
  858. .sp
  859. .RS 4
  860. .nf
  861. aria2c http://host/file\&.zip http://mirror/file\&.zip
  862. .fi
  863. .RE
  864. .RE
  865. .sp
  866. .it 1 an-trap
  867. .nr an-no-space-flag 1
  868. .nr an-break-flag 1
  869. .br
  870. Download a file from HTTP and FTP servers
  871. .RS
  872. .sp
  873. .RS 4
  874. .nf
  875. aria2c http://host1/file\&.zip ftp://host2/file\&.zip
  876. .fi
  877. .RE
  878. .RE
  879. .sp
  880. .it 1 an-trap
  881. .nr an-no-space-flag 1
  882. .nr an-break-flag 1
  883. .br
  884. Download files listed in a file concurrently
  885. .RS
  886. .sp
  887. .RS 4
  888. .nf
  889. aria2c \-ifiles\&.txt \-j2
  890. .fi
  891. .RE
  892. .sp
  893. .it 1 an-trap
  894. .nr an-no-space-flag 1
  895. .nr an-break-flag 1
  896. .br
  897. Note
  898. \-j option specifies the number of parallel downloads\&.
  899. .sp
  900. .RE
  901. .sp
  902. .it 1 an-trap
  903. .nr an-no-space-flag 1
  904. .nr an-break-flag 1
  905. .br
  906. Using proxy
  907. .RS
  908. For HTTP:
  909. .sp
  910. .sp
  911. .RS 4
  912. .nf
  913. aria2c \-\-http\-proxy=http://proxy:8080 http://host/file
  914. .fi
  915. .RE
  916. For FTP:
  917. .sp
  918. .sp
  919. .RS 4
  920. .nf
  921. aria2c \-\-ftp\-proxy=http://proxy:8080 ftp://host/file
  922. .fi
  923. .RE
  924. .sp
  925. .it 1 an-trap
  926. .nr an-no-space-flag 1
  927. .nr an-break-flag 1
  928. .br
  929. Note
  930. See \fB\-\-http\-proxy\fR, \fB\-\-https\-proxy\fR, \fB\-\-ftp\-proxy\fR and \fB\-\-all\-proxy\fR for details\&. You can specify proxy in the environment variables\&. See ENVIRONMENT section\&.
  931. .sp
  932. .RE
  933. .sp
  934. .it 1 an-trap
  935. .nr an-no-space-flag 1
  936. .nr an-break-flag 1
  937. .br
  938. Proxy with authorization
  939. .RS
  940. .sp
  941. .RS 4
  942. .nf
  943. aria2c \-\-http\-proxy=http://username:password@proxy:8080 http://host/file
  944. .fi
  945. .RE
  946. .RE
  947. .SS "Metalink Download"
  948. .sp
  949. .it 1 an-trap
  950. .nr an-no-space-flag 1
  951. .nr an-break-flag 1
  952. .br
  953. Download files with remote Metalink
  954. .RS
  955. .sp
  956. .RS 4
  957. .nf
  958. aria2c \-\-follow\-metalink=mem http://host/file\&.metalink
  959. .fi
  960. .RE
  961. .RE
  962. .sp
  963. .it 1 an-trap
  964. .nr an-no-space-flag 1
  965. .nr an-break-flag 1
  966. .br
  967. Download using a local metalink file
  968. .RS
  969. .sp
  970. .RS 4
  971. .nf
  972. aria2c \-p \-\-lowest\-speed\-limit=4000 file\&.metalink
  973. .fi
  974. .RE
  975. .sp
  976. .it 1 an-trap
  977. .nr an-no-space-flag 1
  978. .nr an-break-flag 1
  979. .br
  980. Note
  981. To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument at the same directory\&.
  982. .sp
  983. .RE
  984. .sp
  985. .it 1 an-trap
  986. .nr an-no-space-flag 1
  987. .nr an-break-flag 1
  988. .br
  989. Download several local metalink files
  990. .RS
  991. .sp
  992. .RS 4
  993. .nf
  994. aria2c \-j2 file1\&.metalink file2\&.metalink
  995. .fi
  996. .RE
  997. .RE
  998. .sp
  999. .it 1 an-trap
  1000. .nr an-no-space-flag 1
  1001. .nr an-break-flag 1
  1002. .br
  1003. Download only selected files using index
  1004. .RS
  1005. .sp
  1006. .RS 4
  1007. .nf
  1008. aria2c \-\-select\-file=1\-4,8 file\&.metalink
  1009. .fi
  1010. .RE
  1011. .sp
  1012. .it 1 an-trap
  1013. .nr an-no-space-flag 1
  1014. .nr an-break-flag 1
  1015. .br
  1016. Note
  1017. The index is printed to the console using \-S option\&.
  1018. .sp
  1019. .RE
  1020. .sp
  1021. .it 1 an-trap
  1022. .nr an-no-space-flag 1
  1023. .nr an-break-flag 1
  1024. .br
  1025. Download a file using a local .metalink file with user preference
  1026. .RS
  1027. .sp
  1028. .RS 4
  1029. .nf
  1030. aria2c \-\-metalink\-location=JP,US \-\-metalink\-version=1\&.1 \-\-metalink\-language=en\-US file\&.metalink
  1031. .fi
  1032. .RE
  1033. .RE
  1034. .SS "BitTorrent Download"
  1035. .sp
  1036. .it 1 an-trap
  1037. .nr an-no-space-flag 1
  1038. .nr an-break-flag 1
  1039. .br
  1040. Download files from remote BitTorrent file
  1041. .RS
  1042. .sp
  1043. .RS 4
  1044. .nf
  1045. aria2c \-\-follow\-torrent=mem http://host/file\&.torrent
  1046. .fi
  1047. .RE
  1048. .RE
  1049. .sp
  1050. .it 1 an-trap
  1051. .nr an-no-space-flag 1
  1052. .nr an-break-flag 1
  1053. .br
  1054. Download using a local torrent file
  1055. .RS
  1056. .sp
  1057. .RS 4
  1058. .nf
  1059. aria2c \-\-max\-upload\-limit=40K file\&.torrent
  1060. .fi
  1061. .RE
  1062. .sp
  1063. .it 1 an-trap
  1064. .nr an-no-space-flag 1
  1065. .nr an-break-flag 1
  1066. .br
  1067. Note
  1068. \-\-max\-upload\-limit specifies the max of upload rate\&.
  1069. .sp
  1070. .sp
  1071. .it 1 an-trap
  1072. .nr an-no-space-flag 1
  1073. .nr an-break-flag 1
  1074. .br
  1075. Note
  1076. To pause a download, press Ctrl\-C\&. You can resume the transfer by run aria2c with the same argument at the same directory\&.
  1077. .sp
  1078. .RE
  1079. .sp
  1080. .it 1 an-trap
  1081. .nr an-no-space-flag 1
  1082. .nr an-break-flag 1
  1083. .br
  1084. Download 2 torrents
  1085. .RS
  1086. .sp
  1087. .RS 4
  1088. .nf
  1089. aria2c \-j2 file1\&.torrent file2\&.torrent
  1090. .fi
  1091. .RE
  1092. .RE
  1093. .sp
  1094. .it 1 an-trap
  1095. .nr an-no-space-flag 1
  1096. .nr an-break-flag 1
  1097. .br
  1098. Download a file using torrent and HTTP/FTP server
  1099. .RS
  1100. .sp
  1101. .RS 4
  1102. .nf
  1103. aria2c \-Ttest\&.torrent http://host1/file ftp://host2/file
  1104. .fi
  1105. .RE
  1106. .sp
  1107. .it 1 an-trap
  1108. .nr an-no-space-flag 1
  1109. .nr an-break-flag 1
  1110. .br
  1111. Note
  1112. Downloading multi file torrent with HTTP/FTP is not supported\&.
  1113. .sp
  1114. .RE
  1115. .sp
  1116. .it 1 an-trap
  1117. .nr an-no-space-flag 1
  1118. .nr an-break-flag 1
  1119. .br
  1120. Download only selected files using index(usually called "selectable download")
  1121. .RS
  1122. .sp
  1123. .RS 4
  1124. .nf
  1125. aria2c \-\-select\-file=1\-4,8 file\&.torrent
  1126. .fi
  1127. .RE
  1128. .sp
  1129. .it 1 an-trap
  1130. .nr an-no-space-flag 1
  1131. .nr an-break-flag 1
  1132. .br
  1133. Note
  1134. The index is printed to the console using \-S option\&.
  1135. .sp
  1136. .RE
  1137. .sp
  1138. .it 1 an-trap
  1139. .nr an-no-space-flag 1
  1140. .nr an-break-flag 1
  1141. .br
  1142. Change the listening port for incoming peer
  1143. .RS
  1144. .sp
  1145. .RS 4
  1146. .nf
  1147. aria2c \-\-listen\-port=7000\-7001,8000 file\&.torrent
  1148. .fi
  1149. .RE
  1150. .sp
  1151. .it 1 an-trap
  1152. .nr an-no-space-flag 1
  1153. .nr an-break-flag 1
  1154. .br
  1155. Note
  1156. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\&.
  1157. .sp
  1158. .RE
  1159. .sp
  1160. .it 1 an-trap
  1161. .nr an-no-space-flag 1
  1162. .nr an-break-flag 1
  1163. .br
  1164. Specify the condition to stop program after torrent download finished
  1165. .RS
  1166. .sp
  1167. .RS 4
  1168. .nf
  1169. aria2c \-\-seed\-time=120 \-\-seed\-ratio=1\&.0 file\&.torrent
  1170. .fi
  1171. .RE
  1172. .sp
  1173. .it 1 an-trap
  1174. .nr an-no-space-flag 1
  1175. .nr an-break-flag 1
  1176. .br
  1177. Note
  1178. In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1\&.0\&.
  1179. .sp
  1180. .RE
  1181. .sp
  1182. .it 1 an-trap
  1183. .nr an-no-space-flag 1
  1184. .nr an-break-flag 1
  1185. .br
  1186. Throttle upload speed
  1187. .RS
  1188. .sp
  1189. .RS 4
  1190. .nf
  1191. aria2c \-\-max\-upload\-limit=100K file\&.torrent
  1192. .fi
  1193. .RE
  1194. .RE
  1195. .sp
  1196. .it 1 an-trap
  1197. .nr an-no-space-flag 1
  1198. .nr an-break-flag 1
  1199. .br
  1200. Enable DHT
  1201. .RS
  1202. .sp
  1203. .RS 4
  1204. .nf
  1205. aria2c \-\-enable\-dht \-\-dht\-listen\-port=6881 file\&.torrent
  1206. .fi
  1207. .RE
  1208. .sp
  1209. .it 1 an-trap
  1210. .nr an-no-space-flag 1
  1211. .nr an-break-flag 1
  1212. .br
  1213. Note
  1214. DHT uses udp port\&. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\&.
  1215. .sp
  1216. .RE
  1217. .SS "More advanced HTTP features"
  1218. .sp
  1219. .it 1 an-trap
  1220. .nr an-no-space-flag 1
  1221. .nr an-break-flag 1
  1222. .br
  1223. Load cookies
  1224. .RS
  1225. .sp
  1226. .RS 4
  1227. .nf
  1228. aria2c \-\-load\-cookies=cookies\&.txt http://host/file\&.zip
  1229. .fi
  1230. .RE
  1231. .sp
  1232. .it 1 an-trap
  1233. .nr an-no-space-flag 1
  1234. .nr an-break-flag 1
  1235. .br
  1236. Note
  1237. You can use Firefox/Mozilla\'s cookie file without modification\&.
  1238. .sp
  1239. .RE
  1240. .sp
  1241. .it 1 an-trap
  1242. .nr an-no-space-flag 1
  1243. .nr an-break-flag 1
  1244. .br
  1245. Resume download started by web browsers or another programs
  1246. .RS
  1247. .sp
  1248. .RS 4
  1249. .nf
  1250. aria2c \-c \-s2 http://host/partiallydownloadedfile\&.zip
  1251. .fi
  1252. .RE
  1253. .RE
  1254. .sp
  1255. .it 1 an-trap
  1256. .nr an-no-space-flag 1
  1257. .nr an-break-flag 1
  1258. .br
  1259. Client certificate authorization for SSL/TLS
  1260. .RS
  1261. .sp
  1262. .RS 4
  1263. .nf
  1264. aria2c \-\-certificate=/path/to/mycert\&.pem \-\-private\-key=/path/to/mykey\&.pem https://host/file
  1265. .fi
  1266. .RE
  1267. .sp
  1268. .it 1 an-trap
  1269. .nr an-no-space-flag 1
  1270. .nr an-break-flag 1
  1271. .br
  1272. Note
  1273. The file specified in \fB\-\-private\-key\fR must be decrypted\&. The behavior when encrypted one is given is undefined\&.
  1274. .sp
  1275. .RE
  1276. .sp
  1277. .it 1 an-trap
  1278. .nr an-no-space-flag 1
  1279. .nr an-break-flag 1
  1280. .br
  1281. Verify peer in SSL/TLS using given CA certificates
  1282. .RS
  1283. .sp
  1284. .RS 4
  1285. .nf
  1286. aria2c \-\-ca\-certificate=/path/to/ca\-certificates\&.crt \-\-check\-certificate https://host/file
  1287. .fi
  1288. .RE
  1289. .RE
  1290. .SS "And more advanced features"
  1291. .sp
  1292. .it 1 an-trap
  1293. .nr an-no-space-flag 1
  1294. .nr an-break-flag 1
  1295. .br
  1296. Throttle download speed
  1297. .RS
  1298. .sp
  1299. .RS 4
  1300. .nf
  1301. aria2c \-\-max\-download\-limit=100K file\&.metalink
  1302. .fi
  1303. .RE
  1304. .RE
  1305. .sp
  1306. .it 1 an-trap
  1307. .nr an-no-space-flag 1
  1308. .nr an-break-flag 1
  1309. .br
  1310. Repair a damaged download using --check-integrity option
  1311. .RS
  1312. .sp
  1313. .RS 4
  1314. .nf
  1315. aria2c \-\-check\-integrity=true file\&.metalink
  1316. .fi
  1317. .RE
  1318. .sp
  1319. .it 1 an-trap
  1320. .nr an-no-space-flag 1
  1321. .nr an-break-flag 1
  1322. .br
  1323. Note
  1324. This option is only available used with BitTorrent or metalink with chunk checksums\&.
  1325. .sp
  1326. .RE
  1327. .sp
  1328. .it 1 an-trap
  1329. .nr an-no-space-flag 1
  1330. .nr an-break-flag 1
  1331. .br
  1332. Drop connection if download speed is lower than specified value
  1333. .RS
  1334. .sp
  1335. .RS 4
  1336. .nf
  1337. aria2c \-\-lowest\-speed\-limit=10K file\&.metalink
  1338. .fi
  1339. .RE
  1340. .RE
  1341. .sp
  1342. .it 1 an-trap
  1343. .nr an-no-space-flag 1
  1344. .nr an-break-flag 1
  1345. .br
  1346. Parameterized URI support
  1347. .RS
  1348. You can specify set of parts:
  1349. .sp
  1350. .sp
  1351. .RS 4
  1352. .nf
  1353. aria2c \-P http://{host1,host2,host3}/file\&.iso
  1354. .fi
  1355. .RE
  1356. You can specify numeric sequence:
  1357. .sp
  1358. .sp
  1359. .RS 4
  1360. .nf
  1361. aria2c \-Z \-P http://host/image[000\-100]\&.png
  1362. .fi
  1363. .RE
  1364. .sp
  1365. .it 1 an-trap
  1366. .nr an-no-space-flag 1
  1367. .nr an-break-flag 1
  1368. .br
  1369. Note
  1370. \-Z option is required if the all URIs don\'t point to the same file, such as the above example\&.
  1371. .sp
  1372. You can specify step counter:
  1373. .sp
  1374. .sp
  1375. .RS 4
  1376. .nf
  1377. aria2c \-Z \-P http://host/image[A\-Z:2]\&.png
  1378. .fi
  1379. .RE
  1380. .RE
  1381. .sp
  1382. .it 1 an-trap
  1383. .nr an-no-space-flag 1
  1384. .nr an-break-flag 1
  1385. .br
  1386. Parallel downloads of arbitrary number of URL,metalink,torrent
  1387. .RS
  1388. .sp
  1389. .RS 4
  1390. .nf
  1391. aria2c \-j3 \-Z http://host/file1 file2\&.torrent file3\&.metalink
  1392. .fi
  1393. .RE
  1394. .RE
  1395. .sp
  1396. .it 1 an-trap
  1397. .nr an-no-space-flag 1
  1398. .nr an-break-flag 1
  1399. .br
  1400. BitTorrent Encryption
  1401. .RS
  1402. Encrypt whole payload using ARC4:
  1403. .sp
  1404. .sp
  1405. .RS 4
  1406. .nf
  1407. aria2c \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true file\&.torrent
  1408. .fi
  1409. .RE
  1410. .RE
  1411. .SH "RESUME DOWNLOAD"
  1412. Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\&.
  1413. .sp
  1414. If the previous transfer is made by a browser or wget like sequencial download manager, then use \-c option to continue the transfer(aria2c \-c URL)\&.
  1415. .sp
  1416. .SH "CONTROL FILE"
  1417. aria2 uses a control file to keep track the progress of download\&. A control file is placed at the same directory of the dowloading file and its filename is the filename of downloading file with "\&.aria2" appended\&. For example, if you are downloading file\&.zip, then the control file should be file\&.zip\&.aria2\&. (There is a exception for this naming convention\&. If you are downloading a multi torrent, its control file is the "top directory" name of the torrent with "\&.aria2" appended\&. The "top directory" name is a value of "name" key in "info" directory in a torrent file\&.)
  1418. .sp
  1419. Usually a control file is deleted once download completed\&. If aria2 decides that download cannot be resumed(for example, when downloading a file from a HTTP server which doesn\'t support resume), a control file is not created\&.
  1420. .sp
  1421. Normally if you lose a control file, you cannot resume download\&. But if you have a torrent or metalink with chunk checksums for the file, you can resume the download without a control file by giving \-\-check\-integrity=true option to aria2c in command\-line\&.
  1422. .sp
  1423. .SH "SEEDING DOWNLOADED FILE IN BITTORRENT"
  1424. You can seed downloaded file using \-\-check\-integrity=true option\&.
  1425. .sp
  1426. .sp
  1427. .RS 4
  1428. .nf
  1429. aria2c \-\-check\-integrity=true file\&.torrent
  1430. .fi
  1431. .RE
  1432. .SH "INPUT FILE"
  1433. The input file can contain list of URIs to feed them into aria2\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&.
  1434. .sp
  1435. Each line is treated as if it is provided in command\-line argument\&. Therefore they are affected by \fB\-Z\fR and \fB\-P\fR options\&. The additional \fBout\fR and \fBdir\fR options can be specified after each line of URIs\&. This optional line must start with white space(s)\&.
  1436. .sp
  1437. For example, the content of uri\&.txt is:
  1438. .sp
  1439. .sp
  1440. .RS 4
  1441. .nf
  1442. http://server/file\&.iso http://mirror/file\&.iso
  1443. dir=/iso_images
  1444. out=file\&.img
  1445. http://foo/bar
  1446. .fi
  1447. .RE
  1448. and if aria2 is executed with \-i uri\&.txt \-d /tmp options, then file\&.iso is saved as /iso_images/file\&.img and it is downloaded from http://server/file\&.iso and http://mirror/file\&.iso\&. The file bar is downloaded from http://foo/bar and saved as /tmp/bar\&.
  1449. .sp
  1450. .SH "SERVER PERFORMANCE PROFILE"
  1451. This section describes the format of server performance profile\&. The file is plain text and each line has several NAME=VALUE pair, delimited by comma\&. Currently following NAMEs are recognized:
  1452. .PP
  1453. host
  1454. .RS 4
  1455. Hostname of the server\&. Required\&.
  1456. .RE
  1457. .PP
  1458. protocol
  1459. .RS 4
  1460. Protocol for this profile, such as ftp, http\&. Required\&.
  1461. .RE
  1462. .PP
  1463. dl_speed
  1464. .RS 4
  1465. The average download speed observed in the previous download in bytes per sec\&. Required\&.
  1466. .RE
  1467. .PP
  1468. last_updated
  1469. .RS 4
  1470. Last contact time in GMT with this server, specified in the seconds from the Epoch\&. Required\&.
  1471. .RE
  1472. .PP
  1473. status
  1474. .RS 4
  1475. ERROR is set when server cannot be reached or out\-of\-service or timeout occurred\&. Otherwise, OK is set\&.
  1476. .RE
  1477. Those fields must exist in one line\&. The order of the fields is not significant\&.You can put pairs other than above; they are simply ignored\&.
  1478. .sp
  1479. An example is follow:
  1480. .sp
  1481. .sp
  1482. .RS 4
  1483. .nf
  1484. host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
  1485. host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
  1486. .fi
  1487. .RE
  1488. .SH "FILES"
  1489. .SS "aria2\&.conf"
  1490. User configuration file\&. It must be placed under $HOME/\&.aria2 and must be named as aria2\&.conf\&. In each line, there is 1 parameter whose syntax is name=value pair, where name is the long command\-line option name without \fI\-\-\fR prefix\&. The lines beginning \fI#\fR are treated as comments\&.
  1491. .sp
  1492. .sp
  1493. .RS 4
  1494. .nf
  1495. # sample configuration file for aria2c
  1496. listen\-port=60000
  1497. dht\-listen\-port=60000
  1498. seed\-ratio=1\&.0
  1499. max\-upload\-limit=50K
  1500. ftp\-pasv=true
  1501. .fi
  1502. .RE
  1503. .SS "dht\&.dat"
  1504. By default, the routing table of DHT is saved to the path $HOME/\&.aria2/dht\&.dat\&.
  1505. .sp
  1506. .SH "ENVIRONMENT"
  1507. aria2 recognizes the following environment variables\&.
  1508. .PP
  1509. http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1510. .RS 4
  1511. Specify proxy server for use in HTTP\&. Overrides http\-proxy value in configuration file\&. The command\-line option
  1512. \fB\-\-http\-proxy\fR
  1513. overrides this value\&.
  1514. .RE
  1515. .PP
  1516. https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1517. .RS 4
  1518. Specify proxy server for use in HTTPS\&. Overrides https\-proxy value in configuration file\&. The command\-line option
  1519. \fB\-\-https\-proxy\fR
  1520. overrides this value\&.
  1521. .RE
  1522. .PP
  1523. ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1524. .RS 4
  1525. Specify proxy server for use in FTP\&. Overrides ftp\-proxy value in configuration file\&. The command\-line option
  1526. \fB\-\-ftp\-proxy\fR
  1527. overrides this value\&.
  1528. .RE
  1529. .PP
  1530. all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1531. .RS 4
  1532. Specify proxy server for use if no protocol\-specific proxy is specified\&. Overrides all\-proxy value in configuration file\&. The command\-line option
  1533. \fB\-\-all\-proxy\fR
  1534. overrides this value\&.
  1535. .RE
  1536. .PP
  1537. no_proxy [DOMAIN,\&...]
  1538. .RS 4
  1539. Specify comma\-separated hostname or domains to which proxy should not be used\&. Overrides no\-proxy value in configuration file\&. The command\-line option
  1540. \fB\-\-no\-proxy\fR
  1541. overrides this value\&.
  1542. .RE
  1543. .SH "RESOURCES"
  1544. Project web site: http://aria2\&.sourceforge\&.net/
  1545. .sp
  1546. metalink: http://www\&.metalinker\&.org/
  1547. .sp
  1548. .SH "REPORTING BUGS"
  1549. Report bugs to Tatsuhiro Tsujikawa <t\-tujikawa at users\&.sourceforge\&.net>
  1550. .sp
  1551. .SH "AUTHOR"
  1552. Tatsuhiro Tsujikawa <t\-tujikawa at users\&.sourceforge\&.net>
  1553. .sp
  1554. .SH "COPYRIGHT"
  1555. Copyright \(co 2006, 2008 Tatsuhiro Tsujikawa
  1556. .sp
  1557. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
  1558. .sp
  1559. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
  1560. .sp
  1561. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc\&., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA
  1562. .sp
  1563. In addition, as a special exception, the copyright holders give permission to link the code of portions of this program with the OpenSSL library under certain conditions as described in each individual source file, and distribute linked combinations including the two\&. You must obey the GNU General Public License in all respects for all of the code used other than OpenSSL\&. If you modify file(s) with this exception, you may extend this exception to your version of the file(s), but you are not obligated to do so\&. If you do not wish to do so, delete this exception statement from your version\&. If you delete this exception statement from all source files in the program, then also delete it here\&.
  1564. .sp