aria2c.1 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573
  1. .\" Title: aria2c
  2. .\" Author:
  3. .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
  4. .\" Date: 11/28/2008
  5. .\" Manual:
  6. .\" Source:
  7. .\"
  8. .TH "ARIA2C" "1" "11/28/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\&. aria2 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\-V\fR, \fB\-\-check\-integrity\fR[=\fItrue\fR|\fIfalse\fR]
  58. .RS 4
  59. Check file integrity by validating piece hashes\&. This option has effect only in BitTorrent 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 for all protocols\&. You can override this setting and specify a proxy server for a 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 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 where 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 or BitTorrent download you cannot specify file name\&. The file name specified here is only used when the URLs fed to aria2 are 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 built without libsqlite3, then it doesn\'t support Firefox3 cookie format\&.
  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[=\fItrue\fR|\fIfalse\fR]
  345. .RS 4
  346. Use the passive mode in FTP\&. If
  347. \fIfalse\fR
  348. is given, the active mode will be used\&. Default:
  349. \fItrue\fR
  350. .RE
  351. .PP
  352. \fB\-\-ftp\-proxy\fR=PROXY
  353. .RS 4
  354. Use this proxy server for FTP\&. See also
  355. \fB\-\-all\-proxy\fR
  356. option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  357. .RE
  358. .PP
  359. \fB\-\-ftp\-type\fR=TYPE
  360. .RS 4
  361. Set FTP transfer type\&. TYPE is either
  362. \fIbinary\fR
  363. or
  364. \fIascii\fR\&. Default:
  365. \fIbinary\fR
  366. .RE
  367. .PP
  368. \fB\-\-ftp\-reuse\-connection\fR[=\fItrue\fR|\fIfalse\fR]
  369. .RS 4
  370. Reuse connection in FTP\&. Default:
  371. \fItrue\fR
  372. .RE
  373. .PP
  374. \fB\-n\fR, \fB\-\-no\-netrc\fR
  375. .RS 4
  376. Disables netrc support\&. netrc support is enabled by default\&.
  377. .RE
  378. .SS "BitTorrent/Metalink Options"
  379. .PP
  380. \fB\-\-select\-file\fR=INDEX\&...
  381. .RS 4
  382. Set file to download by specifying its index\&. You can find the file index using the
  383. \fB\-\-show\-files\fR
  384. option\&. Multiple indexes can be specified by using ",", for example:
  385. \fI3,6\fR\&. You can also use "\-" to specify a range:
  386. \fI1\-5\fR\&. "," and "\-" can be used together:
  387. \fI1\-5,8,9\fR\&. When used with the \-M option, index may vary depending on the query (see
  388. \fB\-\-metalink\-\fR* options)\&.
  389. .RE
  390. .sp
  391. .it 1 an-trap
  392. .nr an-no-space-flag 1
  393. .nr an-break-flag 1
  394. .br
  395. Note
  396. 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\&.
  397. .PP
  398. \fB\-S\fR, \fB\-\-show\-files\fR
  399. .RS 4
  400. Print file listing of \&.torrent or \&.metalink file and exit\&. In case of \&.torrent file, additional information (infohash, piece length, etc) is also printed\&.
  401. .RE
  402. .SS "BitTorrent Specific Options"
  403. .PP
  404. \fB\-\-bt\-max\-open\-files\fR=NUM
  405. .RS 4
  406. Specify maximum number of files to open in each BitTorrent download\&. Default:
  407. \fI100\fR
  408. .RE
  409. .PP
  410. \fB\-\-bt\-min\-crypto\-level\fR=\fIplain\fR|\fIarc4\fR
  411. .RS 4
  412. Set minimum level of encryption method\&. If several encryption methods are provided by a peer, aria2 chooses the lowest one which satisfies the given level\&. Default:
  413. \fIplain\fR
  414. .RE
  415. .PP
  416. \fB\-\-bt\-require\-crypto\fR=\fItrue\fR|\fIfalse\fR
  417. .RS 4
  418. If true is given, aria2 doesn\'t accept and establish connection with legacy BitTorrent handshake(\e19BitTorrent protocol)\&. Thus aria2 always uses Obfuscation handshake\&. Default:
  419. \fIfalse\fR
  420. .RE
  421. .PP
  422. \fB\-\-bt\-request\-peer\-speed\-limit\fR=SPEED
  423. .RS 4
  424. In BitTorrent downloads, if the download speed is lower than SPEED, aria2 initiates and accepts connections ignoring max peer cap\&. You can append
  425. \fIK\fR
  426. or
  427. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  428. \fI51200\fR
  429. .RE
  430. .PP
  431. \fB\-\-bt\-seed\-unverified\fR[=\fItrue\fR|\fIfalse\fR]
  432. .RS 4
  433. Seed previously downloaded files without verifying piece hashes\&. Default:
  434. \fIfalse\fR
  435. .RE
  436. .PP
  437. \fB\-\-dht\-entry\-point\fR=HOST:PORT
  438. .RS 4
  439. Set host and port as an entry point to DHT network\&.
  440. .RE
  441. .PP
  442. \fB\-\-dht\-file\-path\fR=PATH
  443. .RS 4
  444. Change the DHT routing table file to PATH\&. Default:
  445. \fI$HOME/\&.aria2/dht\&.dat\fR
  446. .RE
  447. .PP
  448. \fB\-\-dht\-listen\-port\fR=PORT\&...
  449. .RS 4
  450. Set UDP listening port for DHT\&. Multiple ports can be specified by using ",", for example:
  451. \fI6881,6885\fR\&. You can also use "\-" to specify a range:
  452. \fI6881\-6999\fR\&. "," and "\-" can be used together\&. Default:
  453. \fI6881\-6999\fR
  454. .RE
  455. .PP
  456. \fB\-\-direct\-file\-mapping\fR=\fItrue\fR|\fIfalse\fR
  457. .RS 4
  458. 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:
  459. \fItrue\fR
  460. .RE
  461. .PP
  462. \fB\-\-enable\-dht\fR[=\fItrue\fR|\fIfalse\fR]
  463. .RS 4
  464. Enable DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\'t use DHT for that download even if
  465. \fItrue\fR
  466. is given\&. Default:
  467. \fIfalse\fR
  468. .RE
  469. .PP
  470. \fB\-\-enable\-peer\-exchange\fR[=\fItrue\fR|\fIfalse\fR]
  471. .RS 4
  472. Enable Peer Exchange extension\&. If a private flag is set in a torrent, this feature is disabled for that download even if
  473. \fItrue\fR
  474. is given\&. Default:
  475. \fItrue\fR
  476. .RE
  477. .PP
  478. \fB\-\-follow\-torrent\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
  479. .RS 4
  480. If
  481. \fItrue\fR
  482. or
  483. \fImem\fR
  484. 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
  485. \fImem\fR
  486. is specified, a torrent file is not written to the disk, but is just kept in memory\&. If
  487. \fIfalse\fR
  488. is specified, the action mentioned above is not taken\&. Default:
  489. \fItrue\fR
  490. .RE
  491. .PP
  492. \fB\-\-listen\-port\fR=PORT\&...
  493. .RS 4
  494. Set TCP port number for BitTorrent downloads\&. Multiple ports can be specified by using ",", for example:
  495. \fI6881,6885\fR\&. You can also use "\-" to specify a range:
  496. \fI6881\-6999\fR\&. "," and "\-" can be used together:
  497. \fI6881\-6889,6999\fR\&. Default:
  498. \fI6881\-6999\fR
  499. .RE
  500. .sp
  501. .it 1 an-trap
  502. .nr an-no-space-flag 1
  503. .nr an-break-flag 1
  504. .br
  505. Note
  506. Make sure that the specified ports are open for incoming TCP traffic\&.
  507. .PP
  508. \fB\-u\fR, \fB\-\-max\-upload\-limit\fR=SPEED
  509. .RS 4
  510. Set max upload speed in bytes per sec\&.
  511. \fI0\fR
  512. means unrestricted\&. You can append
  513. \fIK\fR
  514. or
  515. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  516. \fI0\fR
  517. .RE
  518. .PP
  519. \fB\-\-peer\-id\-prefix\fR=PEERI_ID_PREFIX
  520. .RS 4
  521. 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:
  522. \fI\-aria2\-\fR
  523. .RE
  524. .PP
  525. \fB\-\-seed\-ratio\fR=RATIO
  526. .RS 4
  527. Specify share ratio\&. Seed completed torrents until share ratio reaches] RATIO\&. You are strongly encouraged to specify equals or more than
  528. \fI1\&.0\fR
  529. here\&. Specify
  530. \fI0\&.0\fR
  531. if you intend to do seeding regardless of share ratio\&. If
  532. \fB\-\-seed\-time\fR
  533. option is specified along with this option, seeding ends when at least one of the conditions is satisfied\&. Default:
  534. \fI1\&.0\fR
  535. .RE
  536. .PP
  537. \fB\-\-seed\-time\fR=MINUTES
  538. .RS 4
  539. Specify seeding time in minutes\&. Also see the
  540. \fB\-\-seed\-ratio\fR
  541. option\&.
  542. .RE
  543. .PP
  544. \fB\-T\fR, \fB\-\-torrent\-file\fR=TORRENT_FILE
  545. .RS 4
  546. The path to the \&.torrent file\&. You are not required to use this option because you can specify a torrent file without \-T\&.
  547. .RE
  548. .SS "Metalink Specific Options"
  549. .PP
  550. \fB\-\-follow\-metalink\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
  551. .RS 4
  552. If
  553. \fItrue\fR
  554. or
  555. \fImem\fR
  556. is specified, when a file whose suffix is "\&.metaink" or content type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it\&. If
  557. \fImem\fR
  558. is specified, a metalink file is not written to the disk, but is just kept in memory\&. If
  559. \fIfalse\fR
  560. is specified, the action mentioned above is not taken\&. Default:
  561. \fItrue\fR
  562. .RE
  563. .PP
  564. \fB\-M\fR, \fB\-\-metalink\-file\fR=METALINK_FILE
  565. .RS 4
  566. The file path to \&.metalink file\&. You are not required to use this option because you can specify a metalink file without \-M\&.
  567. .RE
  568. .PP
  569. \fB\-C\fR, \fB\-\-metalink\-servers\fR=NUM_SERVERS
  570. .RS 4
  571. The number of servers to connect to simultaneously\&. Some Metalinks regulate 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
  572. \fB\-s\fR
  573. and
  574. \fB\-j\fR
  575. options\&. Default:
  576. \fI5\fR
  577. .RE
  578. .PP
  579. \fB\-\-metalink\-language\fR=LANGUAGE
  580. .RS 4
  581. The language of the file to download\&.
  582. .RE
  583. .PP
  584. \fB\-\-metalink\-location\fR=LOCATION[,\&...]
  585. .RS 4
  586. The location of the preferred server\&. A comma\-delimited list of locations is acceptable, for example,
  587. \fIJP,US\fR\&.
  588. .RE
  589. .PP
  590. \fB\-\-metalink\-os\fR=OS
  591. .RS 4
  592. The operating system of the file to download\&.
  593. .RE
  594. .PP
  595. \fB\-\-metalink\-version\fR=VERSION
  596. .RS 4
  597. The version of the file to download\&.
  598. .RE
  599. .PP
  600. \fB\-\-metalink\-preferred\-protocol\fR=PROTO
  601. .RS 4
  602. Specify preferred protocol\&. The possible values are
  603. \fIhttp\fR,
  604. \fIhttps\fR,
  605. \fIftp\fR
  606. and
  607. \fInone\fR\&. Specifiy
  608. \fInone\fR
  609. to disable this feature\&. Default:
  610. \fInone\fR
  611. .RE
  612. .PP
  613. \fB\-\-metalink\-enable\-unique\-protocol\fR=\fItrue\fR|\fIfalse\fR
  614. .RS 4
  615. If
  616. \fItrue\fR
  617. is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\&. Use
  618. \fB\-\-metalink\-preferred\-protocol\fR
  619. option to specify the preference of protocol\&. Default:
  620. \fItrue\fR
  621. .RE
  622. .SS "Advanced Options"
  623. .PP
  624. \fB\-\-allow\-overwrite\fR=\fItrue\fR|\fIfalse\fR
  625. .RS 4
  626. If
  627. \fIfalse\fR
  628. 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
  629. \fB\-\-auto\-file\-renaming\fR=\fItrue\fR
  630. then, file name will be renamed\&. See
  631. \fB\-\-auto\-file\-renaming\fR
  632. for details\&. Default:
  633. \fIfalse\fR
  634. .RE
  635. .PP
  636. \fB\-\-allow\-piece\-length\-change\fR=\fItrue\fR|\fIfalse\fR
  637. .RS 4
  638. 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:
  639. \fIfalse\fR
  640. .RE
  641. .PP
  642. \fB\-\-async\-dns\fR[=\fItrue\fR|\fIfalse\fR]
  643. .RS 4
  644. Enable asynchronous DNS\&. Default:
  645. \fItrue\fR
  646. .RE
  647. .PP
  648. \fB\-\-auto\-file\-renaming\fR[=\fItrue\fR|\fIfalse\fR]
  649. .RS 4
  650. 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:
  651. \fItrue\fR
  652. .RE
  653. .PP
  654. \fB\-\-auto\-save\-interval\fR=SEC
  655. .RS 4
  656. Save a control file(*\&.aria2) every SEC seconds\&. If
  657. \fI0\fR
  658. 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
  659. \fI0\fR
  660. to
  661. \fI600\fR\&. Default:
  662. \fI60\fR
  663. .RE
  664. .PP
  665. \fB\-\-conf\-path\fR=PATH
  666. .RS 4
  667. Change the configuration file path to PATH\&. Default:
  668. \fI$HOME/\&.aria2/aria2\&.conf\fR
  669. .RE
  670. .PP
  671. \fB\-D\fR, \fB\-\-daemon\fR
  672. .RS 4
  673. Run as daemon\&.
  674. .RE
  675. .PP
  676. \fB\-\-enable\-direct\-io\fR[=\fItrue\fR|\fIfalse\fR]
  677. .RS 4
  678. Enable directI/O, which lowers cpu usage while allocating/checking files\&. Turn off if you encounter any error\&. Default:
  679. \fItrue\fR
  680. .RE
  681. .PP
  682. \fB\-\-file\-allocation\fR=METHOD
  683. .RS 4
  684. Specify file allocation method\&. METHOD is either
  685. \fInone\fR
  686. or
  687. \fIprealloc\fR\&.
  688. \fInone\fR
  689. doesn\'t pre\-allocate file space\&.
  690. \fIprealloc\fR
  691. pre\-allocates file space before download begins\&. This may take some time depending on the size of the file\&. Default:
  692. \fIprealloc\fR
  693. .RE
  694. .PP
  695. \fB\-\-log\-level\fR=LEVEL
  696. .RS 4
  697. Set log level to output\&. LEVEL is either
  698. \fIdebug\fR,
  699. \fIinfo\fR,
  700. \fInotice\fR,
  701. \fIwarn\fR
  702. or
  703. \fIerror\fR\&. Default:
  704. \fIdebug\fR
  705. .RE
  706. .PP
  707. \fB\-\-summary\-interval\fR=SEC
  708. .RS 4
  709. Set interval in seconds to output download progress summary\&. Setting
  710. \fI0\fR
  711. suppresses the output\&. Default:
  712. \fI60\fR
  713. .RE
  714. .sp
  715. .it 1 an-trap
  716. .nr an-no-space-flag 1
  717. .nr an-break-flag 1
  718. .br
  719. Note
  720. In multi file torrent downloads, the files adjacent forward to the specified files are also allocated if they share the same piece\&.
  721. .PP
  722. \fB\-Z\fR, \fB\-\-force\-sequential\fR[=\fItrue\fR|\fIfalse\fR]
  723. .RS 4
  724. Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\&. Default:
  725. \fIfalse\fR
  726. .RE
  727. .PP
  728. \fB\-\-max\-download\-limit\fR=SPEED
  729. .RS 4
  730. Set max download speed in bytes per sec\&.
  731. \fI0\fR
  732. means unrestricted\&. You can append
  733. \fIK\fR
  734. or
  735. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  736. \fI0\fR
  737. .RE
  738. .PP
  739. \fB\-\-no\-conf\fR
  740. .RS 4
  741. Disable loading aria2\&.conf file\&.
  742. .RE
  743. .PP
  744. \fB\-\-no\-file\-allocation\-limit\fR=SIZE
  745. .RS 4
  746. No file allocation is made for files whose size is smaller than SIZE\&. You can append
  747. \fIK\fR
  748. or
  749. \fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
  750. \fI5M\fR
  751. .RE
  752. .PP
  753. \fB\-P\fR, \fB\-\-parameterized\-uri\fR[=\fItrue\fR|\fIfalse\fR]
  754. .RS 4
  755. Enable parameterized URI support\&. You can specify set of parts:
  756. \fIhttp://{sv1,sv2,sv3}/foo\&.iso\fR\&. Also you can specify numeric sequences with step counter:
  757. \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:
  758. \fIfalse\fR
  759. .RE
  760. .PP
  761. \fB\-q\fR, \fB\-\-quiet\fR[=\fItrue\fR|\fIfalse\fR]
  762. .RS 4
  763. Make aria2 quiet (no console output)\&. Default:
  764. \fIfalse\fR
  765. .RE
  766. .PP
  767. \fB\-\-realtime\-chunk\-checksum\fR=\fItrue\fR|\fIfalse\fR
  768. .RS 4
  769. Validate chunk of data by calculating checksum while downloading a file if chunk checksums are provided\&. Currently Metalink is the only way to provide chunk checksums\&. Default:
  770. \fItrue\fR
  771. .RE
  772. .PP
  773. \fB\-\-stop\fR=SEC
  774. .RS 4
  775. Stop application after SEC seconds has passed\&. If
  776. \fI0\fR
  777. is given, this feature is disabled\&. Default:
  778. \fI0\fR
  779. .RE
  780. .PP
  781. \fB\-v\fR, \fB\-\-version\fR
  782. .RS 4
  783. Print the version number, copyright and the configuration information and exit\&.
  784. .RE
  785. .SS "OPTIONS THAT TAKE AN OPTIONAL ARGUMENT"
  786. The options that have its argument surrounded by square brackets([]) take an optional argument\&. Usually ommiting the argument is evaluated to \fItrue\fR\&. If you use short form of these options(such as \fI\-V\fR) and give an argument, then the option name and its argument should be concatenated(e\&.g\&. \fI\-Vfalse\fR)\&. If any spaces are inserted between the option name and the argument, the argument will be treated as URI and usually this is not what you expect\&.
  787. .sp
  788. .SS "URL, TORRENT_FILE, METALINK_FILE"
  789. 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\&.
  790. .sp
  791. You can also specify arbitrary number of torrent files and metalink files stored on a local drive\&. Please note that they are always treated as a separate download\&.
  792. .sp
  793. You can specify both torrent file with \-T option and URLs\&. By doing this, you can 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\&.
  794. .sp
  795. .sp
  796. .it 1 an-trap
  797. .nr an-no-space-flag 1
  798. .nr an-break-flag 1
  799. .br
  800. Note
  801. Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell\&.
  802. .sp
  803. .SH "EXAMPLES"
  804. .SS "HTTP/FTP Segmented Download"
  805. .sp
  806. .it 1 an-trap
  807. .nr an-no-space-flag 1
  808. .nr an-break-flag 1
  809. .br
  810. Download a file
  811. .RS
  812. .sp
  813. .RS 4
  814. .nf
  815. aria2c http://host/file\&.zip
  816. .fi
  817. .RE
  818. .sp
  819. .it 1 an-trap
  820. .nr an-no-space-flag 1
  821. .nr an-break-flag 1
  822. .br
  823. Note
  824. aria2 uses 5 connections to download 1 file by default\&.
  825. .sp
  826. .RE
  827. .sp
  828. .it 1 an-trap
  829. .nr an-no-space-flag 1
  830. .nr an-break-flag 1
  831. .br
  832. Download a file using 1 connection
  833. .RS
  834. .sp
  835. .RS 4
  836. .nf
  837. aria2c \-s1 http://host/file\&.zip
  838. .fi
  839. .RE
  840. .sp
  841. .it 1 an-trap
  842. .nr an-no-space-flag 1
  843. .nr an-break-flag 1
  844. .br
  845. Note
  846. aria2 uses 5 connections to download 1 file by default\&. \-s1 limtis the number of connections to just 1\&.
  847. .sp
  848. .sp
  849. .it 1 an-trap
  850. .nr an-no-space-flag 1
  851. .nr an-break-flag 1
  852. .br
  853. Note
  854. To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument in the same directory\&. You can change URLs as long as they are pointing to the same file\&.
  855. .sp
  856. .RE
  857. .sp
  858. .it 1 an-trap
  859. .nr an-no-space-flag 1
  860. .nr an-break-flag 1
  861. .br
  862. Download a file from 2 different HTTP servers
  863. .RS
  864. .sp
  865. .RS 4
  866. .nf
  867. aria2c http://host/file\&.zip http://mirror/file\&.zip
  868. .fi
  869. .RE
  870. .RE
  871. .sp
  872. .it 1 an-trap
  873. .nr an-no-space-flag 1
  874. .nr an-break-flag 1
  875. .br
  876. Download a file from HTTP and FTP servers
  877. .RS
  878. .sp
  879. .RS 4
  880. .nf
  881. aria2c http://host1/file\&.zip ftp://host2/file\&.zip
  882. .fi
  883. .RE
  884. .RE
  885. .sp
  886. .it 1 an-trap
  887. .nr an-no-space-flag 1
  888. .nr an-break-flag 1
  889. .br
  890. Download files listed in a text file concurrently
  891. .RS
  892. .sp
  893. .RS 4
  894. .nf
  895. aria2c \-ifiles\&.txt \-j2
  896. .fi
  897. .RE
  898. .sp
  899. .it 1 an-trap
  900. .nr an-no-space-flag 1
  901. .nr an-break-flag 1
  902. .br
  903. Note
  904. \-j option specifies the number of parallel downloads\&.
  905. .sp
  906. .RE
  907. .sp
  908. .it 1 an-trap
  909. .nr an-no-space-flag 1
  910. .nr an-break-flag 1
  911. .br
  912. Using proxy
  913. .RS
  914. For HTTP:
  915. .sp
  916. .sp
  917. .RS 4
  918. .nf
  919. aria2c \-\-http\-proxy=http://proxy:8080 http://host/file
  920. .fi
  921. .RE
  922. For FTP:
  923. .sp
  924. .sp
  925. .RS 4
  926. .nf
  927. aria2c \-\-ftp\-proxy=http://proxy:8080 ftp://host/file
  928. .fi
  929. .RE
  930. .sp
  931. .it 1 an-trap
  932. .nr an-no-space-flag 1
  933. .nr an-break-flag 1
  934. .br
  935. Note
  936. 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\&.
  937. .sp
  938. .RE
  939. .sp
  940. .it 1 an-trap
  941. .nr an-no-space-flag 1
  942. .nr an-break-flag 1
  943. .br
  944. Proxy with authorization
  945. .RS
  946. .sp
  947. .RS 4
  948. .nf
  949. aria2c \-\-http\-proxy=http://username:password@proxy:8080 http://host/file
  950. .fi
  951. .RE
  952. .RE
  953. .SS "Metalink Download"
  954. .sp
  955. .it 1 an-trap
  956. .nr an-no-space-flag 1
  957. .nr an-break-flag 1
  958. .br
  959. Download files with remote Metalink
  960. .RS
  961. .sp
  962. .RS 4
  963. .nf
  964. aria2c \-\-follow\-metalink=mem http://host/file\&.metalink
  965. .fi
  966. .RE
  967. .RE
  968. .sp
  969. .it 1 an-trap
  970. .nr an-no-space-flag 1
  971. .nr an-break-flag 1
  972. .br
  973. Download using a local metalink file
  974. .RS
  975. .sp
  976. .RS 4
  977. .nf
  978. aria2c \-p \-\-lowest\-speed\-limit=4000 file\&.metalink
  979. .fi
  980. .RE
  981. .sp
  982. .it 1 an-trap
  983. .nr an-no-space-flag 1
  984. .nr an-break-flag 1
  985. .br
  986. Note
  987. To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument in the same directory\&.
  988. .sp
  989. .RE
  990. .sp
  991. .it 1 an-trap
  992. .nr an-no-space-flag 1
  993. .nr an-break-flag 1
  994. .br
  995. Download several local metalink files
  996. .RS
  997. .sp
  998. .RS 4
  999. .nf
  1000. aria2c \-j2 file1\&.metalink file2\&.metalink
  1001. .fi
  1002. .RE
  1003. .RE
  1004. .sp
  1005. .it 1 an-trap
  1006. .nr an-no-space-flag 1
  1007. .nr an-break-flag 1
  1008. .br
  1009. Download only selected files using index
  1010. .RS
  1011. .sp
  1012. .RS 4
  1013. .nf
  1014. aria2c \-\-select\-file=1\-4,8 file\&.metalink
  1015. .fi
  1016. .RE
  1017. .sp
  1018. .it 1 an-trap
  1019. .nr an-no-space-flag 1
  1020. .nr an-break-flag 1
  1021. .br
  1022. Note
  1023. The index is printed to the console using \-S option\&.
  1024. .sp
  1025. .RE
  1026. .sp
  1027. .it 1 an-trap
  1028. .nr an-no-space-flag 1
  1029. .nr an-break-flag 1
  1030. .br
  1031. Download a file using a local .metalink file with user preference
  1032. .RS
  1033. .sp
  1034. .RS 4
  1035. .nf
  1036. aria2c \-\-metalink\-location=JP,US \-\-metalink\-version=1\&.1 \-\-metalink\-language=en\-US file\&.metalink
  1037. .fi
  1038. .RE
  1039. .RE
  1040. .SS "BitTorrent Download"
  1041. .sp
  1042. .it 1 an-trap
  1043. .nr an-no-space-flag 1
  1044. .nr an-break-flag 1
  1045. .br
  1046. Download files from remote BitTorrent file
  1047. .RS
  1048. .sp
  1049. .RS 4
  1050. .nf
  1051. aria2c \-\-follow\-torrent=mem http://host/file\&.torrent
  1052. .fi
  1053. .RE
  1054. .RE
  1055. .sp
  1056. .it 1 an-trap
  1057. .nr an-no-space-flag 1
  1058. .nr an-break-flag 1
  1059. .br
  1060. Download using a local torrent file
  1061. .RS
  1062. .sp
  1063. .RS 4
  1064. .nf
  1065. aria2c \-\-max\-upload\-limit=40K file\&.torrent
  1066. .fi
  1067. .RE
  1068. .sp
  1069. .it 1 an-trap
  1070. .nr an-no-space-flag 1
  1071. .nr an-break-flag 1
  1072. .br
  1073. Note
  1074. \-\-max\-upload\-limit specifies the max of upload rate\&.
  1075. .sp
  1076. .sp
  1077. .it 1 an-trap
  1078. .nr an-no-space-flag 1
  1079. .nr an-break-flag 1
  1080. .br
  1081. Note
  1082. To pause a download, press Ctrl\-C\&. You can resume the transfer by run aria2c with the same argument in the same directory\&.
  1083. .sp
  1084. .RE
  1085. .sp
  1086. .it 1 an-trap
  1087. .nr an-no-space-flag 1
  1088. .nr an-break-flag 1
  1089. .br
  1090. Download 2 torrents
  1091. .RS
  1092. .sp
  1093. .RS 4
  1094. .nf
  1095. aria2c \-j2 file1\&.torrent file2\&.torrent
  1096. .fi
  1097. .RE
  1098. .RE
  1099. .sp
  1100. .it 1 an-trap
  1101. .nr an-no-space-flag 1
  1102. .nr an-break-flag 1
  1103. .br
  1104. Download a file using torrent and HTTP/FTP server
  1105. .RS
  1106. .sp
  1107. .RS 4
  1108. .nf
  1109. aria2c \-Ttest\&.torrent http://host1/file ftp://host2/file
  1110. .fi
  1111. .RE
  1112. .sp
  1113. .it 1 an-trap
  1114. .nr an-no-space-flag 1
  1115. .nr an-break-flag 1
  1116. .br
  1117. Note
  1118. Downloading multi file torrent with HTTP/FTP is not supported\&.
  1119. .sp
  1120. .RE
  1121. .sp
  1122. .it 1 an-trap
  1123. .nr an-no-space-flag 1
  1124. .nr an-break-flag 1
  1125. .br
  1126. Download only selected files using index(usually called "selectable download")
  1127. .RS
  1128. .sp
  1129. .RS 4
  1130. .nf
  1131. aria2c \-\-select\-file=1\-4,8 file\&.torrent
  1132. .fi
  1133. .RE
  1134. .sp
  1135. .it 1 an-trap
  1136. .nr an-no-space-flag 1
  1137. .nr an-break-flag 1
  1138. .br
  1139. Note
  1140. The index is printed to the console using \-S option\&.
  1141. .sp
  1142. .RE
  1143. .sp
  1144. .it 1 an-trap
  1145. .nr an-no-space-flag 1
  1146. .nr an-break-flag 1
  1147. .br
  1148. Change the listening port for incoming peer
  1149. .RS
  1150. .sp
  1151. .RS 4
  1152. .nf
  1153. aria2c \-\-listen\-port=7000\-7001,8000 file\&.torrent
  1154. .fi
  1155. .RE
  1156. .sp
  1157. .it 1 an-trap
  1158. .nr an-no-space-flag 1
  1159. .nr an-break-flag 1
  1160. .br
  1161. Note
  1162. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\&.
  1163. .sp
  1164. .RE
  1165. .sp
  1166. .it 1 an-trap
  1167. .nr an-no-space-flag 1
  1168. .nr an-break-flag 1
  1169. .br
  1170. Specify the condition to stop program after torrent download finished
  1171. .RS
  1172. .sp
  1173. .RS 4
  1174. .nf
  1175. aria2c \-\-seed\-time=120 \-\-seed\-ratio=1\&.0 file\&.torrent
  1176. .fi
  1177. .RE
  1178. .sp
  1179. .it 1 an-trap
  1180. .nr an-no-space-flag 1
  1181. .nr an-break-flag 1
  1182. .br
  1183. Note
  1184. In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1\&.0\&.
  1185. .sp
  1186. .RE
  1187. .sp
  1188. .it 1 an-trap
  1189. .nr an-no-space-flag 1
  1190. .nr an-break-flag 1
  1191. .br
  1192. Throttle upload speed
  1193. .RS
  1194. .sp
  1195. .RS 4
  1196. .nf
  1197. aria2c \-\-max\-upload\-limit=100K file\&.torrent
  1198. .fi
  1199. .RE
  1200. .RE
  1201. .sp
  1202. .it 1 an-trap
  1203. .nr an-no-space-flag 1
  1204. .nr an-break-flag 1
  1205. .br
  1206. Enable DHT
  1207. .RS
  1208. .sp
  1209. .RS 4
  1210. .nf
  1211. aria2c \-\-enable\-dht \-\-dht\-listen\-port=6881 file\&.torrent
  1212. .fi
  1213. .RE
  1214. .sp
  1215. .it 1 an-trap
  1216. .nr an-no-space-flag 1
  1217. .nr an-break-flag 1
  1218. .br
  1219. Note
  1220. DHT uses udp port\&. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\&.
  1221. .sp
  1222. .RE
  1223. .SS "More advanced HTTP features"
  1224. .sp
  1225. .it 1 an-trap
  1226. .nr an-no-space-flag 1
  1227. .nr an-break-flag 1
  1228. .br
  1229. Load cookies
  1230. .RS
  1231. .sp
  1232. .RS 4
  1233. .nf
  1234. aria2c \-\-load\-cookies=cookies\&.txt http://host/file\&.zip
  1235. .fi
  1236. .RE
  1237. .sp
  1238. .it 1 an-trap
  1239. .nr an-no-space-flag 1
  1240. .nr an-break-flag 1
  1241. .br
  1242. Note
  1243. You can use Firefox/Mozilla\'s cookie file without modification\&.
  1244. .sp
  1245. .RE
  1246. .sp
  1247. .it 1 an-trap
  1248. .nr an-no-space-flag 1
  1249. .nr an-break-flag 1
  1250. .br
  1251. Resume download started by web browsers or another programs
  1252. .RS
  1253. .sp
  1254. .RS 4
  1255. .nf
  1256. aria2c \-c \-s2 http://host/partiallydownloadedfile\&.zip
  1257. .fi
  1258. .RE
  1259. .RE
  1260. .sp
  1261. .it 1 an-trap
  1262. .nr an-no-space-flag 1
  1263. .nr an-break-flag 1
  1264. .br
  1265. Client certificate authorization for SSL/TLS
  1266. .RS
  1267. .sp
  1268. .RS 4
  1269. .nf
  1270. aria2c \-\-certificate=/path/to/mycert\&.pem \-\-private\-key=/path/to/mykey\&.pem https://host/file
  1271. .fi
  1272. .RE
  1273. .sp
  1274. .it 1 an-trap
  1275. .nr an-no-space-flag 1
  1276. .nr an-break-flag 1
  1277. .br
  1278. Note
  1279. The file specified in \fB\-\-private\-key\fR must be decrypted\&. The behavior when encrypted one is given is undefined\&.
  1280. .sp
  1281. .RE
  1282. .sp
  1283. .it 1 an-trap
  1284. .nr an-no-space-flag 1
  1285. .nr an-break-flag 1
  1286. .br
  1287. Verify peer in SSL/TLS using given CA certificates
  1288. .RS
  1289. .sp
  1290. .RS 4
  1291. .nf
  1292. aria2c \-\-ca\-certificate=/path/to/ca\-certificates\&.crt \-\-check\-certificate https://host/file
  1293. .fi
  1294. .RE
  1295. .RE
  1296. .SS "And more advanced features"
  1297. .sp
  1298. .it 1 an-trap
  1299. .nr an-no-space-flag 1
  1300. .nr an-break-flag 1
  1301. .br
  1302. Throttle download speed
  1303. .RS
  1304. .sp
  1305. .RS 4
  1306. .nf
  1307. aria2c \-\-max\-download\-limit=100K file\&.metalink
  1308. .fi
  1309. .RE
  1310. .RE
  1311. .sp
  1312. .it 1 an-trap
  1313. .nr an-no-space-flag 1
  1314. .nr an-break-flag 1
  1315. .br
  1316. Repair a damaged download using -V option
  1317. .RS
  1318. .sp
  1319. .RS 4
  1320. .nf
  1321. aria2c \-V file\&.metalink
  1322. .fi
  1323. .RE
  1324. .sp
  1325. .it 1 an-trap
  1326. .nr an-no-space-flag 1
  1327. .nr an-break-flag 1
  1328. .br
  1329. Note
  1330. This option is only available used with BitTorrent or metalink with chunk checksums\&.
  1331. .sp
  1332. .RE
  1333. .sp
  1334. .it 1 an-trap
  1335. .nr an-no-space-flag 1
  1336. .nr an-break-flag 1
  1337. .br
  1338. Drop connection if download speed is lower than specified value
  1339. .RS
  1340. .sp
  1341. .RS 4
  1342. .nf
  1343. aria2c \-\-lowest\-speed\-limit=10K file\&.metalink
  1344. .fi
  1345. .RE
  1346. .RE
  1347. .sp
  1348. .it 1 an-trap
  1349. .nr an-no-space-flag 1
  1350. .nr an-break-flag 1
  1351. .br
  1352. Parameterized URI support
  1353. .RS
  1354. You can specify set of parts:
  1355. .sp
  1356. .sp
  1357. .RS 4
  1358. .nf
  1359. aria2c \-P http://{host1,host2,host3}/file\&.iso
  1360. .fi
  1361. .RE
  1362. You can specify numeric sequence:
  1363. .sp
  1364. .sp
  1365. .RS 4
  1366. .nf
  1367. aria2c \-Z \-P http://host/image[000\-100]\&.png
  1368. .fi
  1369. .RE
  1370. .sp
  1371. .it 1 an-trap
  1372. .nr an-no-space-flag 1
  1373. .nr an-break-flag 1
  1374. .br
  1375. Note
  1376. \-Z option is required if the all URIs don\'t point to the same file, such as the above example\&.
  1377. .sp
  1378. You can specify step counter:
  1379. .sp
  1380. .sp
  1381. .RS 4
  1382. .nf
  1383. aria2c \-Z \-P http://host/image[A\-Z:2]\&.png
  1384. .fi
  1385. .RE
  1386. .RE
  1387. .sp
  1388. .it 1 an-trap
  1389. .nr an-no-space-flag 1
  1390. .nr an-break-flag 1
  1391. .br
  1392. Parallel downloads of arbitrary number of URL,metalink,torrent
  1393. .RS
  1394. .sp
  1395. .RS 4
  1396. .nf
  1397. aria2c \-j3 \-Z http://host/file1 file2\&.torrent file3\&.metalink
  1398. .fi
  1399. .RE
  1400. .RE
  1401. .sp
  1402. .it 1 an-trap
  1403. .nr an-no-space-flag 1
  1404. .nr an-break-flag 1
  1405. .br
  1406. BitTorrent Encryption
  1407. .RS
  1408. Encrypt whole payload using ARC4:
  1409. .sp
  1410. .sp
  1411. .RS 4
  1412. .nf
  1413. aria2c \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true file\&.torrent
  1414. .fi
  1415. .RE
  1416. .RE
  1417. .SH "RESUME DOWNLOAD"
  1418. Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\&.
  1419. .sp
  1420. If the previous transfer is made by a browser or wget like sequential download manager, then use \-c option to continue the transfer(aria2c \-c URL)\&.
  1421. .sp
  1422. .SH "CONTROL FILE"
  1423. aria2 uses a control file to track the progress of a download\&. A control file is placed in the same directory as 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\&.)
  1424. .sp
  1425. 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\&.
  1426. .sp
  1427. 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 \-V option to aria2c in command\-line\&.
  1428. .sp
  1429. .SH "SEEDING DOWNLOADED FILE IN BITTORRENT"
  1430. You can seed downloaded file using \-V option\&.
  1431. .sp
  1432. .sp
  1433. .RS 4
  1434. .nf
  1435. aria2c \-V file\&.torrent
  1436. .fi
  1437. .RE
  1438. .SH "INPUT FILE"
  1439. The input file can contain a list of URIs for aria2 to download\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&.
  1440. .sp
  1441. 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)\&.
  1442. .sp
  1443. For example, the content of uri\&.txt is
  1444. .sp
  1445. .sp
  1446. .RS 4
  1447. .nf
  1448. http://server/file\&.iso http://mirror/file\&.iso
  1449. dir=/iso_images
  1450. out=file\&.img
  1451. http://foo/bar
  1452. .fi
  1453. .RE
  1454. If aria2 is executed with \fB\-i\fR uri\&.txt \fB\-d\fR /tmp options, then \fIfile\&.iso\fR is saved as \fI/iso_images/file\&.img\fR and it is downloaded from http://server/file\&.iso and http://mirror/file\&.iso\&. The file \fIbar\fR is downloaded from http://foo/bar and saved as \fI/tmp/bar\fR\&.
  1455. .sp
  1456. In some cases, \fBout\fR parameter has no effect\&. See note of \fB\-\-out\fR option for the restrictions\&.
  1457. .sp
  1458. .SH "SERVER PERFORMANCE PROFILE"
  1459. 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:
  1460. .PP
  1461. host
  1462. .RS 4
  1463. Hostname of the server\&. Required\&.
  1464. .RE
  1465. .PP
  1466. protocol
  1467. .RS 4
  1468. Protocol for this profile, such as ftp, http\&. Required\&.
  1469. .RE
  1470. .PP
  1471. dl_speed
  1472. .RS 4
  1473. The average download speed observed in the previous download in bytes per sec\&. Required\&.
  1474. .RE
  1475. .PP
  1476. last_updated
  1477. .RS 4
  1478. Last contact time in GMT with this server, specified in the seconds from the Epoch\&. Required\&.
  1479. .RE
  1480. .PP
  1481. status
  1482. .RS 4
  1483. ERROR is set when server cannot be reached or out\-of\-service or timeout occurred\&. Otherwise, OK is set\&.
  1484. .RE
  1485. 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\&.
  1486. .sp
  1487. An example follows:
  1488. .sp
  1489. .sp
  1490. .RS 4
  1491. .nf
  1492. host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
  1493. host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
  1494. .fi
  1495. .RE
  1496. .SH "FILES"
  1497. .SS "aria2\&.conf"
  1498. User configuration file\&. It must be placed under $HOME/\&.aria2 and must be named 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\&.
  1499. .sp
  1500. .sp
  1501. .RS 4
  1502. .nf
  1503. # sample configuration file for aria2c
  1504. listen\-port=60000
  1505. dht\-listen\-port=60000
  1506. seed\-ratio=1\&.0
  1507. max\-upload\-limit=50K
  1508. ftp\-pasv=true
  1509. .fi
  1510. .RE
  1511. .SS "dht\&.dat"
  1512. By default, the routing table of DHT is saved to the path $HOME/\&.aria2/dht\&.dat\&.
  1513. .sp
  1514. .SH "ENVIRONMENT"
  1515. aria2 recognizes the following environment variables\&.
  1516. .PP
  1517. http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1518. .RS 4
  1519. Specify proxy server for use in HTTP\&. Overrides http\-proxy value in configuration file\&. The command\-line option
  1520. \fB\-\-http\-proxy\fR
  1521. overrides this value\&.
  1522. .RE
  1523. .PP
  1524. https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1525. .RS 4
  1526. Specify proxy server for use in HTTPS\&. Overrides https\-proxy value in configuration file\&. The command\-line option
  1527. \fB\-\-https\-proxy\fR
  1528. overrides this value\&.
  1529. .RE
  1530. .PP
  1531. ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1532. .RS 4
  1533. Specify proxy server for use in FTP\&. Overrides ftp\-proxy value in configuration file\&. The command\-line option
  1534. \fB\-\-ftp\-proxy\fR
  1535. overrides this value\&.
  1536. .RE
  1537. .PP
  1538. all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1539. .RS 4
  1540. Specify proxy server for use if no protocol\-specific proxy is specified\&. Overrides all\-proxy value in configuration file\&. The command\-line option
  1541. \fB\-\-all\-proxy\fR
  1542. overrides this value\&.
  1543. .RE
  1544. .PP
  1545. no_proxy [DOMAIN,\&...]
  1546. .RS 4
  1547. Specify comma\-separated hostname or domains to which proxy should not be used\&. Overrides no\-proxy value in configuration file\&. The command\-line option
  1548. \fB\-\-no\-proxy\fR
  1549. overrides this value\&.
  1550. .RE
  1551. .SH "RESOURCES"
  1552. Project web site: http://aria2\&.sourceforge\&.net/
  1553. .sp
  1554. metalink: http://www\&.metalinker\&.org/
  1555. .sp
  1556. .SH "REPORTING BUGS"
  1557. Report bugs to Tatsuhiro Tsujikawa <t\-tujikawa at users\&.sourceforge\&.net>
  1558. .sp
  1559. .SH "AUTHOR"
  1560. Tatsuhiro Tsujikawa <t\-tujikawa at users\&.sourceforge\&.net>
  1561. .sp
  1562. .SH "COPYRIGHT"
  1563. Copyright \(co 2006, 2008 Tatsuhiro Tsujikawa
  1564. .sp
  1565. 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\&.
  1566. .sp
  1567. 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\&.
  1568. .sp
  1569. 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
  1570. .sp
  1571. 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\&.
  1572. .sp