aria2c.1 28 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156
  1. .\" Title: aria2c
  2. .\" Author:
  3. .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
  4. .\" Date: 05/10/2008
  5. .\" Manual:
  6. .\" Source:
  7. .\"
  8. .TH "ARIA2C" "1" "05/10/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. \fIaria2c\fR [OPTIONS] URL|TORRENT_FILE|METALINK_FILE \&...
  17. .sp
  18. .SH "DESCRIPTION"
  19. aria2 is a utility for downloading files\. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum\. 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. .PP
  23. \-d, \-\-dir=DIR
  24. .RS 4
  25. The directory to store the downloaded file\.
  26. .RE
  27. .PP
  28. \-o, \-\-out=FILE
  29. .RS 4
  30. The file name of the downloaded file\.
  31. .PP
  32. Note
  33. .RS 4
  34. 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 \-i option, like this: aria2c \-o myfile\.zip http://mirror1/file\.zip http://mirror2/file\.zip
  35. .RE
  36. .RE
  37. .PP
  38. \-l, \-\-log=LOG
  39. .RS 4
  40. The file name of the log file\. If
  41. \fI\-\fR
  42. is specified, log is written to stdout\.
  43. .RE
  44. .PP
  45. \-D, \-\-daemon
  46. .RS 4
  47. Run as daemon\.
  48. .RE
  49. .PP
  50. \-s, \-\-split=N
  51. .RS 4
  52. Download a file using N connections\. N must be between
  53. \fI1\fR
  54. and
  55. \fI5\fR\. This option affects all URLs\. Thus, aria2 connects to each URL with N connections\. Default:
  56. \fI1\fR
  57. .RE
  58. .PP
  59. \-\-retry\-wait=SEC
  60. .RS 4
  61. Set the seconds to wait to retry after an error has occured\. Specify a value between
  62. \fI0\fR
  63. and
  64. \fI60\fR\. Default:
  65. \fI5\fR
  66. .RE
  67. .PP
  68. \-t, \-\-timeout=SEC
  69. .RS 4
  70. Set timeout in seconds\. Default:
  71. \fI60\fR
  72. .RE
  73. .PP
  74. \-m, \-\-max\-tries=N
  75. .RS 4
  76. Set number of tries\.
  77. \fI0\fR
  78. means unlimited\. Default:
  79. \fI5\fR
  80. .RE
  81. .PP
  82. \-\-http\-proxy=HOST:PORT
  83. .RS 4
  84. Use HTTP proxy server\. This affects all URLs\.
  85. .RE
  86. .PP
  87. \-\-http\-user=USER
  88. .RS 4
  89. Set HTTP user\. This affects all URLs\.
  90. .RE
  91. .PP
  92. \-\-http\-passwd=PASSWD
  93. .RS 4
  94. Set HTTP password\. This affects all URLs\.
  95. .RE
  96. .PP
  97. \-\-http\-proxy\-user=USER
  98. .RS 4
  99. Set HTTP proxy user\. This affects all URLs\.
  100. .RE
  101. .PP
  102. \-\-http\-proxy\-passwd=PASSWD
  103. .RS 4
  104. Set HTTP proxy password\. This affects all URLs\.
  105. .RE
  106. .PP
  107. \-\-http\-proxy\-method=METHOD
  108. .RS 4
  109. Set the method to use in proxy request\.
  110. \fIMETHOD\fR
  111. is either
  112. \fIget\fR
  113. or
  114. \fItunnel\fR\. Default:
  115. \fItunnel\fR
  116. .RE
  117. .PP
  118. \-\-http\-auth\-scheme=SCHEME
  119. .RS 4
  120. Set HTTP authentication scheme\. Currently,
  121. \fIbasic\fR
  122. is the only supported scheme\. Default:
  123. \fIbasic\fR
  124. .RE
  125. .PP
  126. \-\-referer=REFERER
  127. .RS 4
  128. Set Referer\. This affects all URLs\.
  129. .RE
  130. .PP
  131. \-\-ftp\-user=USER
  132. .RS 4
  133. Set FTP user\. This affects all URLs\. Default:
  134. \fIanonymous\fR
  135. .RE
  136. .PP
  137. \-\-ftp\-passwd=PASSWD
  138. .RS 4
  139. Set FTP password\. This affects all URLs\. Default:
  140. \fIARIA2USER@\fR
  141. .RE
  142. .PP
  143. \-\-ftp\-type=TYPE
  144. .RS 4
  145. Set FTP transfer type\. TYPE is either
  146. \fIbinary\fR
  147. or
  148. \fIascii\fR\. Default:
  149. \fIbinary\fR
  150. .RE
  151. .PP
  152. \-p, \-\-ftp\-pasv
  153. .RS 4
  154. Use passive mode in FTP\.
  155. .RE
  156. .PP
  157. \-\-ftp\-via\-http\-proxy=METHOD
  158. .RS 4
  159. Use HTTP proxy in FTP\. METHOD is either
  160. \fIget\fR
  161. or
  162. \fItunnel\fR\. Default:
  163. \fItunnel\fR
  164. .RE
  165. .PP
  166. \-\-ftp\-reuse\-connection[=\fItrue\fR|\fIfalse\fR]
  167. .RS 4
  168. Reuse connection in FTP\. Default:
  169. \fItrue\fR
  170. .RE
  171. .PP
  172. \-\-lowest\-speed\-limit=SPEED
  173. .RS 4
  174. Close connection if download speed is lower than or equal to this value(bytes per sec)\.
  175. \fI0\fR
  176. means aria2 does not have a lowest speed limit\. You can append
  177. \fIK\fR
  178. or
  179. \fIM\fR(1K = 1024, 1M = 1024K)\. This option does not affect BitTorrent downloads\. Default:
  180. \fI0\fR
  181. .RE
  182. .PP
  183. \-\-max\-download\-limit=SPEED
  184. .RS 4
  185. Set max download speed in bytes per sec\.
  186. \fI0\fR
  187. means unrestricted\. You can append
  188. \fIK\fR
  189. or
  190. \fIM\fR(1K = 1024, 1M = 1024K)\. Default:
  191. \fI0\fR
  192. .RE
  193. .PP
  194. \-\-file\-allocation=METHOD
  195. .RS 4
  196. Specify file allocation method\. METHOD is either
  197. \fInone\fR
  198. or
  199. \fIprealloc\fR\.
  200. \fInone\fR
  201. doesn\'t pre\-allocate file space\.
  202. \fIprealloc\fR
  203. pre\-allocates file space before download begins\. This may take some time depending on the size of the file\. Default:
  204. \fIprealloc\fR
  205. .PP
  206. Note
  207. .RS 4
  208. In multi file torrent, the files adjacent forward to the specified files are also allocated if they share a same piece\.
  209. .RE
  210. .RE
  211. .PP
  212. \-\-no\-file\-allocation\-limit=SIZE
  213. .RS 4
  214. No file allocation is made for files whose size is smaller than SIZE\. You can append
  215. \fIK\fR
  216. or
  217. \fIM\fR(1K = 1024, 1M = 1024K)\. Default:
  218. \fI5M\fR
  219. .RE
  220. .PP
  221. \-\-enable\-direct\-io[=\fItrue\fR|\fIfalse\fR]
  222. .RS 4
  223. Enable directI/O, which lowers cpu usage while allocating/checking files\. Turn off if you encounter any error\. Default:
  224. \fIfalse\fR
  225. .RE
  226. .PP
  227. \-\-allow\-overwrite=\fItrue\fR|\fIfalse\fR
  228. .RS 4
  229. If
  230. \fIfalse\fR
  231. 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 \-\-auto\-file\-renaming=\fItrue\fR
  232. then, file name will be renamed\. See \-\-auto\-file\-renaming for details\. Default:
  233. \fIfalse\fR
  234. .RE
  235. .PP
  236. \-\-allow\-piece\-length\-change=\fItrue\fR|\fIfalse\fR
  237. .RS 4
  238. 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:
  239. \fIfalse\fR
  240. .RE
  241. .PP
  242. \-Z, \-\-force\-sequential[=\fItrue\fR|\fIfalse\fR]
  243. .RS 4
  244. Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\. Default:
  245. \fIfalse\fR
  246. .RE
  247. .PP
  248. \-\-auto\-file\-renaming[=\fItrue\fR|\fIfalse\fR]
  249. .RS 4
  250. 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:
  251. \fItrue\fR
  252. .RE
  253. .PP
  254. \-P, \-\-parameterized\-uri[=\fItrue\fR|\fIfalse\fR]
  255. .RS 4
  256. Enable parameterized URI support\. You can specify set of parts:
  257. \fIhttp://{sv1,sv2,sv3}/foo\.iso\fR\. Also you can specify numeric sequences with step counter:
  258. \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:
  259. \fIfalse\fR
  260. .RE
  261. .PP
  262. \-\-enable\-http\-keep\-alive[=\fItrue\fR|\fIfalse\fR]
  263. .RS 4
  264. Enable HTTP/1\.1 persistent connection\. Default:
  265. \fItrue\fR
  266. .RE
  267. .PP
  268. \-\-enable\-http\-pipelining[=\fItrue\fR|\fIfalse\fR]
  269. .RS 4
  270. Enable HTTP/1\.1 pipelining\. Default:
  271. \fIfalse\fR
  272. .RE
  273. .PP
  274. \-\-check\-integrity=\fItrue\fR|\fIfalse\fR
  275. .RS 4
  276. 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:
  277. \fIfalse\fR
  278. .RE
  279. .PP
  280. \-\-realtime\-chunk\-checksum=\fItrue\fR|\fIfalse\fR
  281. .RS 4
  282. 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:
  283. \fItrue\fR
  284. .RE
  285. .PP
  286. \-c, \-\-continue
  287. .RS 4
  288. 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\.
  289. .RE
  290. .PP
  291. \-U, \-\-user\-agent=USER_AGENT
  292. .RS 4
  293. Set user agent for HTTP(S) downloads\.
  294. .RE
  295. .PP
  296. \-n, \-\-no\-netrc
  297. .RS 4
  298. Disables netrc support\. netrc support is enabled by default\.
  299. .RE
  300. .PP
  301. \-i, \-\-input\-file=FILE
  302. .RS 4
  303. 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
  304. \fI\-\fR
  305. is specified\.
  306. .RE
  307. .PP
  308. \-j, \-\-max\-concurrent\-downloads=N
  309. .RS 4
  310. Set maximum number of parallel downloads\. Default:
  311. \fI1\fR
  312. .RE
  313. .PP
  314. \-\-load\-cookies=FILE
  315. .RS 4
  316. Load cookies from FILE\. The format of FILE is the same used by Netscape and Mozilla\.
  317. .RE
  318. .PP
  319. \-\-no\-conf
  320. .RS 4
  321. Disable loading aria2\.conf file\.
  322. .RE
  323. .PP
  324. \-\-conf\-path=PATH
  325. .RS 4
  326. Change the configuration file path to PATH\. Default:
  327. \fI$HOME/\.aria2/aria2\.conf\fR
  328. .RE
  329. .PP
  330. \-\-stop=SEC
  331. .RS 4
  332. Stop application after SEC seconds has passed\. If
  333. \fI0\fR
  334. is given, this feature is disabled\. Default:
  335. \fI0\fR
  336. .RE
  337. .PP
  338. \-S, \-\-show\-files
  339. .RS 4
  340. Print file listing of \.torrent or \.metalink file and exit\. In case of \.torrent file, additional information (infohash, piece length, etc) is also printed\.
  341. .RE
  342. .PP
  343. \-\-select\-file=INDEX\&...
  344. .RS 4
  345. Set file to download by specifing its index\. You can find the file index using the \-\-show\-files option\. Multiple indexes can be specified by using ",", for example:
  346. \fI3,6\fR\. You can also use "\-" to specify a range:
  347. \fI1\-5\fR\. "," and "\-" can be used together:
  348. \fI1\-5,8,9\fR\. When used with the \-M option, index may vary depending on the query (see \-\-metalink\-* options)\.
  349. .PP
  350. Note
  351. .RS 4
  352. 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\.
  353. .RE
  354. .RE
  355. .PP
  356. \-T, \-\-torrent\-file=TORRENT_FILE
  357. .RS 4
  358. The path to the \.torrent file\. You may not use this option because you can specify torrent file without \-T\.
  359. .RE
  360. .PP
  361. \-\-follow\-torrent=\fItrue\fR|\fIfalse\fR|\fImem\fR
  362. .RS 4
  363. If
  364. \fItrue\fR
  365. or
  366. \fImem\fR
  367. 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
  368. \fImem\fR
  369. is specified, a torrent file is not written to the disk, but is just kept in memory\. If
  370. \fIfalse\fR
  371. is specified, the action mentioned above is not taken\. Default:
  372. \fItrue\fR
  373. .RE
  374. .PP
  375. \-\-direct\-file\-mapping=\fItrue\fR|\fIfalse\fR
  376. .RS 4
  377. 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:
  378. \fItrue\fR
  379. .RE
  380. .PP
  381. \-\-listen\-port=PORT\&...
  382. .RS 4
  383. Set TCP port number for BitTorrent downloads\. Multiple ports can be specified by using ",", for example:
  384. \fI6881,6885\fR\. You can also use "\-" to specify a range:
  385. \fI6881\-6999\fR\. "," and "\-" can be used together:
  386. \fI6881\-6889,6999\fR\. Default:
  387. \fI6881\-6999\fR
  388. .PP
  389. Note
  390. .RS 4
  391. Make sure that the specified ports are open for incoming TCP traffic\.
  392. .RE
  393. .RE
  394. .PP
  395. \-\-max\-upload\-limit=SPEED
  396. .RS 4
  397. Set max upload speed in bytes per sec\.
  398. \fI0\fR
  399. means unrestricted\. You can append
  400. \fIK\fR
  401. or
  402. \fIM\fR(1K = 1024, 1M = 1024K)\. Default:
  403. \fI0\fR
  404. .RE
  405. .PP
  406. \-\-seed\-time=MINUTES
  407. .RS 4
  408. Specify seeding time in minutes\. Also see the \-\-seed\-ratio option\.
  409. .RE
  410. .PP
  411. \-\-seed\-ratio=RATIO
  412. .RS 4
  413. Specify share ratio\. Seed completed torrents until share ratio reaches] RATIO\. I strongly encourages you to specify equals or more than
  414. \fI1\.0\fR
  415. here\. Specify
  416. \fI0\.0\fR
  417. if you intend to do seeding regardless of share ratio\. If \-\-seed\-time option is specified along with this option, seeding ends when at least one of the conditions is satisfied\. Default:
  418. \fI1\.0\fR
  419. .RE
  420. .PP
  421. \-\-peer\-id\-prefix=PEERI_ID_PREFIX
  422. .RS 4
  423. 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:
  424. \fI\-aria2\-\fR
  425. .RE
  426. .PP
  427. \-\-enable\-peer\-exchange[=\fItrue\fR|\fIfalse\fR]
  428. .RS 4
  429. Enable Peer Exchange extension\. If a private flag is set in a torrent, this feature is disabled for that download even if
  430. \fItrue\fR
  431. is given\. Default:
  432. \fItrue\fR
  433. .RE
  434. .PP
  435. \-\-enable\-dht[=\fItrue\fR|\fIfalse\fR]
  436. .RS 4
  437. Enable DHT functionality\. If a private flag is set in a torrent, aria2 doesn\'t use DHT for that download even if
  438. \fItrue\fR
  439. is given\. Default:
  440. \fIfalse\fR
  441. .RE
  442. .PP
  443. \-\-dht\-listen\-port=PORT\&...
  444. .RS 4
  445. Set UDP listening port for DHT\. Multiple ports can be specified by using ",", for example:
  446. \fI6881,6885\fR\. You can also use "\-" to specify a range:
  447. \fI6881\-6999\fR\. "," and "\-" can be used together\. Default:
  448. \fI6881\-6999\fR
  449. .RE
  450. .PP
  451. \-\-dht\-entry\-point=HOST:PORT
  452. .RS 4
  453. Set host and port as an entry point to DHT network\.
  454. .RE
  455. .PP
  456. \-\-bt\-min\-crypto\-level=\fIplain\fR|\fIarc4\fR
  457. .RS 4
  458. 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:
  459. \fIplain\fR
  460. .RE
  461. .PP
  462. \-\-bt\-require\-crypto=\fItrue\fR|\fIfalse\fR
  463. .RS 4
  464. If true is given, aria2 doesn\'t accept and establish connection with legacy BitTorrent handshake(\e19BitTorrent protocol)\. Thus aria2 always uses Obfuscation handshake\. Default:
  465. \fIfalse\fR
  466. .RE
  467. .PP
  468. \-M, \-\-metalink\-file=METALINK_FILE
  469. .RS 4
  470. The file path to \.metalink file\. You may not use this option because you can specify metalink file without \-M\.
  471. .RE
  472. .PP
  473. \-C, \-\-metalink\-servers=NUM_SERVERS
  474. .RS 4
  475. The number of servers to connect to simultaneously\. Some metalinks regulates the number of servers to connect\. aria2 respects them\. Default:
  476. \fI1\fR
  477. .RE
  478. .PP
  479. \-\-metalink\-version=VERSION
  480. .RS 4
  481. The version of the file to download\.
  482. .RE
  483. .PP
  484. \-\-metalink\-language=LANGUAGE
  485. .RS 4
  486. The language of the file to download\.
  487. .RE
  488. .PP
  489. \-\-metalink\-os=OS
  490. .RS 4
  491. The operating system of the file to download\.
  492. .RE
  493. .PP
  494. \-\-metalink\-location=LOCATION[,\&...]
  495. .RS 4
  496. The location of the preferred server\. A comma\-deliminated list of locations is acceptable, for example,
  497. \fIJP,US\fR\.
  498. .RE
  499. .PP
  500. \-\-metalink\-preferred\-protocol=PROTO
  501. .RS 4
  502. Specify preferred protocol\. The possible values are
  503. \fIhttp\fR,
  504. \fIhttps\fR,
  505. \fIftp\fR
  506. and
  507. \fInone\fR\. Specifiy
  508. \fInone\fR
  509. to disable this feature\. Default:
  510. \fInone\fR
  511. .RE
  512. .PP
  513. \-\-follow\-metalink=\fItrue\fR|\fIfalse\fR|\fImem\fR
  514. .RS 4
  515. If
  516. \fItrue\fR
  517. or
  518. \fImem\fR
  519. 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
  520. \fImem\fR
  521. is specified, a metalink file is not written to the disk, but is just kept in memory\. If
  522. \fIfalse\fR
  523. is specified, the action mentioned above is not taken\. Default:
  524. \fItrue\fR
  525. .RE
  526. .PP
  527. \-\-metalink\-enable\-unique\-protocol=\fItrue\fR|\fIfalse\fR
  528. .RS 4
  529. If
  530. \fItrue\fR
  531. is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\. Use \-\-metalink\-preferred\-protocol option to specify the preference of protocol\. Default:
  532. \fItrue\fR
  533. .RE
  534. .PP
  535. \-\-header=HEADER
  536. .RS 4
  537. Append HEADER to HTTP request header\. You can use this option repeatedly to specify more than one header: aria2c \-\-header="X\-A: b78" \-\-header="X\-B: 9J1" http://host/file
  538. .RE
  539. .PP
  540. \-q, \-\-quiet[=\fItrue\fR|\fIfalse\fR]
  541. .RS 4
  542. Make aria2 quite (no console output)\. Default:
  543. \fIfalse\fR
  544. .RE
  545. .PP
  546. \-\-async\-dns[=\fItrue\fR|\fIfalse\fR]
  547. .RS 4
  548. Enable asynchronous DNS\. Default:
  549. \fItrue\fR
  550. .RE
  551. .PP
  552. \-v, \-\-version
  553. .RS 4
  554. Print the version number, copyright and the configuration information and exit\.
  555. .RE
  556. .PP
  557. \-h, \-\-help[=CATEGORY]
  558. .RS 4
  559. Print usage and exit\. The help messages are classified in several categories\. For example, type "\-\-help=http" for detailed explanation for the options related to HTTP\. If no matching category is found, search option name using a given word in forward match and print the result\. Available Values:
  560. \fIbasic\fR,
  561. \fIadvanced\fR,
  562. \fIhttp\fR,
  563. \fIftp\fR,
  564. \fImetalink\fR,
  565. \fIbittorrent\fR,
  566. \fIall\fR
  567. Default:
  568. \fIbasic\fR
  569. .RE
  570. .PP
  571. URL, TORRENT_FILE, METALINK_FILE
  572. .RS 4
  573. You can specify multiple URLs\. Unless you specify \-Z option, all URLs must point to the same file or downloading will fail\. 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\. 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\.
  574. .PP
  575. Note
  576. .RS 4
  577. Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell\.
  578. .RE
  579. .RE
  580. .SH "EXAMPLES"
  581. .SS "HTTP/FTP Segmented Download"
  582. .sp
  583. .it 1 an-trap
  584. .nr an-no-space-flag 1
  585. .nr an-break-flag 1
  586. .br
  587. Download a file using 1 connection
  588. .RS
  589. .sp
  590. .RS 4
  591. .nf
  592. aria2c http://host/file\.zip
  593. .fi
  594. .RE
  595. .sp
  596. .it 1 an-trap
  597. .nr an-no-space-flag 1
  598. .nr an-break-flag 1
  599. .br
  600. Note
  601. To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c with the same argument at the same directory\. You can change URLs as long as they are pointing to the same file\.
  602. .sp
  603. .RE
  604. .sp
  605. .it 1 an-trap
  606. .nr an-no-space-flag 1
  607. .nr an-break-flag 1
  608. .br
  609. Download a file using 2 connections
  610. .RS
  611. .sp
  612. .RS 4
  613. .nf
  614. aria2c \-s2 http://host/file\.zip
  615. .fi
  616. .RE
  617. .RE
  618. .sp
  619. .it 1 an-trap
  620. .nr an-no-space-flag 1
  621. .nr an-break-flag 1
  622. .br
  623. Download a file from 2 different HTTP servers
  624. .RS
  625. .sp
  626. .RS 4
  627. .nf
  628. aria2c http://host/file\.zip http://mirror/file\.zip
  629. .fi
  630. .RE
  631. .RE
  632. .sp
  633. .it 1 an-trap
  634. .nr an-no-space-flag 1
  635. .nr an-break-flag 1
  636. .br
  637. Download a file from HTTP and FTP servers
  638. .RS
  639. .sp
  640. .RS 4
  641. .nf
  642. aria2c http://host1/file\.zip ftp://host2/file\.zip
  643. .fi
  644. .RE
  645. .RE
  646. .sp
  647. .it 1 an-trap
  648. .nr an-no-space-flag 1
  649. .nr an-break-flag 1
  650. .br
  651. Download files listed in a file concurrently
  652. .RS
  653. .sp
  654. .RS 4
  655. .nf
  656. aria2c \-ifiles\.txt \-j2
  657. .fi
  658. .RE
  659. .sp
  660. .it 1 an-trap
  661. .nr an-no-space-flag 1
  662. .nr an-break-flag 1
  663. .br
  664. Note
  665. \-j option specifies the number of parallel downloads\.
  666. .sp
  667. .RE
  668. .SS "Metalink Download"
  669. .sp
  670. .it 1 an-trap
  671. .nr an-no-space-flag 1
  672. .nr an-break-flag 1
  673. .br
  674. Download files with remote Metalink
  675. .RS
  676. .sp
  677. .RS 4
  678. .nf
  679. aria2c \-\-follow\-metalink=mem http://host/file\.metalink
  680. .fi
  681. .RE
  682. .RE
  683. .sp
  684. .it 1 an-trap
  685. .nr an-no-space-flag 1
  686. .nr an-break-flag 1
  687. .br
  688. Download using a local metalink file
  689. .RS
  690. .sp
  691. .RS 4
  692. .nf
  693. aria2c \-p \-\-lowest\-speed\-limit=4000 file\.metalink
  694. .fi
  695. .RE
  696. .sp
  697. .it 1 an-trap
  698. .nr an-no-space-flag 1
  699. .nr an-break-flag 1
  700. .br
  701. Note
  702. To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c with the same argument at the same directory\.
  703. .sp
  704. .RE
  705. .sp
  706. .it 1 an-trap
  707. .nr an-no-space-flag 1
  708. .nr an-break-flag 1
  709. .br
  710. Download several local metalink files
  711. .RS
  712. .sp
  713. .RS 4
  714. .nf
  715. aria2c \-j2 file1\.metalink file2\.metalink
  716. .fi
  717. .RE
  718. .RE
  719. .sp
  720. .it 1 an-trap
  721. .nr an-no-space-flag 1
  722. .nr an-break-flag 1
  723. .br
  724. Download only selected files using index
  725. .RS
  726. .sp
  727. .RS 4
  728. .nf
  729. aria2c \-\-select\-file=1\-4,8 file\.metalink
  730. .fi
  731. .RE
  732. .sp
  733. .it 1 an-trap
  734. .nr an-no-space-flag 1
  735. .nr an-break-flag 1
  736. .br
  737. Note
  738. The index is printed to the console using \-S option\.
  739. .sp
  740. .RE
  741. .sp
  742. .it 1 an-trap
  743. .nr an-no-space-flag 1
  744. .nr an-break-flag 1
  745. .br
  746. Download a file using a local .metalink file with user preference
  747. .RS
  748. .sp
  749. .RS 4
  750. .nf
  751. aria2c \-\-metalink\-location=JP,US \-\-metalink\-version=1\.1 \-\-metalink\-language=en\-US \-C2 file\.metalink
  752. .fi
  753. .RE
  754. .RE
  755. .SS "BitTorrent Download"
  756. .sp
  757. .it 1 an-trap
  758. .nr an-no-space-flag 1
  759. .nr an-break-flag 1
  760. .br
  761. Download files from remote BitTorrent file
  762. .RS
  763. .sp
  764. .RS 4
  765. .nf
  766. aria2c \-\-follow\-bittorrent=mem http://host/file\.torrent
  767. .fi
  768. .RE
  769. .RE
  770. .sp
  771. .it 1 an-trap
  772. .nr an-no-space-flag 1
  773. .nr an-break-flag 1
  774. .br
  775. Download using a local torrent file
  776. .RS
  777. .sp
  778. .RS 4
  779. .nf
  780. aria2c \-\-max\-upload\-limit=40K file\.torrent
  781. .fi
  782. .RE
  783. .sp
  784. .it 1 an-trap
  785. .nr an-no-space-flag 1
  786. .nr an-break-flag 1
  787. .br
  788. Note
  789. \-\-max\-upload\-limit specifies the max of upload rate\.
  790. .sp
  791. .sp
  792. .it 1 an-trap
  793. .nr an-no-space-flag 1
  794. .nr an-break-flag 1
  795. .br
  796. Note
  797. To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c with the same argument at the same directory\.
  798. .sp
  799. .RE
  800. .sp
  801. .it 1 an-trap
  802. .nr an-no-space-flag 1
  803. .nr an-break-flag 1
  804. .br
  805. Download 2 torrents
  806. .RS
  807. .sp
  808. .RS 4
  809. .nf
  810. aria2c \-j2 file1\.torrent file2\.torrent
  811. .fi
  812. .RE
  813. .RE
  814. .sp
  815. .it 1 an-trap
  816. .nr an-no-space-flag 1
  817. .nr an-break-flag 1
  818. .br
  819. Download a file using torrent and HTTP/FTP server
  820. .RS
  821. .sp
  822. .RS 4
  823. .nf
  824. aria2c \-Ttest\.torrent http://host1/file ftp://host2/file
  825. .fi
  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. Note
  833. Downloading multi file torrent with HTTP/FTP is not supported\.
  834. .sp
  835. .RE
  836. .sp
  837. .it 1 an-trap
  838. .nr an-no-space-flag 1
  839. .nr an-break-flag 1
  840. .br
  841. Download only selected files using index(usually called "selectable download")
  842. .RS
  843. .sp
  844. .RS 4
  845. .nf
  846. aria2c \-\-select\-file=1\-4,8 file\.torrent
  847. .fi
  848. .RE
  849. .sp
  850. .it 1 an-trap
  851. .nr an-no-space-flag 1
  852. .nr an-break-flag 1
  853. .br
  854. Note
  855. The index is printed to the console using \-S option\.
  856. .sp
  857. .RE
  858. .sp
  859. .it 1 an-trap
  860. .nr an-no-space-flag 1
  861. .nr an-break-flag 1
  862. .br
  863. Change the listening port for incoming peer
  864. .RS
  865. .sp
  866. .RS 4
  867. .nf
  868. aria2c \-\-listen\-port=7000\-7001,8000 file\.torrent
  869. .fi
  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. Note
  877. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\.
  878. .sp
  879. .RE
  880. .sp
  881. .it 1 an-trap
  882. .nr an-no-space-flag 1
  883. .nr an-break-flag 1
  884. .br
  885. Specify the condition to stop program after torrent download finished
  886. .RS
  887. .sp
  888. .RS 4
  889. .nf
  890. aria2c \-\-seed\-time=120 \-\-seed\-ratio=1\.0 file\.torrent
  891. .fi
  892. .RE
  893. .sp
  894. .it 1 an-trap
  895. .nr an-no-space-flag 1
  896. .nr an-break-flag 1
  897. .br
  898. Note
  899. In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1\.0\.
  900. .sp
  901. .RE
  902. .sp
  903. .it 1 an-trap
  904. .nr an-no-space-flag 1
  905. .nr an-break-flag 1
  906. .br
  907. Throttle upload speed
  908. .RS
  909. .sp
  910. .RS 4
  911. .nf
  912. aria2c \-\-max\-upload\-limit=100K file\.torrent
  913. .fi
  914. .RE
  915. .RE
  916. .sp
  917. .it 1 an-trap
  918. .nr an-no-space-flag 1
  919. .nr an-break-flag 1
  920. .br
  921. Enable DHT
  922. .RS
  923. .sp
  924. .RS 4
  925. .nf
  926. aria2c \-\-enable\-dht \-\-dht\-listen\-port=6881 file\.torrent
  927. .fi
  928. .RE
  929. .sp
  930. .it 1 an-trap
  931. .nr an-no-space-flag 1
  932. .nr an-break-flag 1
  933. .br
  934. Note
  935. DHT uses udp port\. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\.
  936. .sp
  937. .RE
  938. .SS "More advanced HTTP features"
  939. .sp
  940. .it 1 an-trap
  941. .nr an-no-space-flag 1
  942. .nr an-break-flag 1
  943. .br
  944. Load cookies
  945. .RS
  946. .sp
  947. .RS 4
  948. .nf
  949. aria2c \-\-load\-cookies=cookies\.txt http://host/file\.zip
  950. .fi
  951. .RE
  952. .sp
  953. .it 1 an-trap
  954. .nr an-no-space-flag 1
  955. .nr an-break-flag 1
  956. .br
  957. Note
  958. You can use Firefox/Mozilla\'s cookie file without modification\.
  959. .sp
  960. .RE
  961. .sp
  962. .it 1 an-trap
  963. .nr an-no-space-flag 1
  964. .nr an-break-flag 1
  965. .br
  966. Resume download started by web browsers or another programs
  967. .RS
  968. .sp
  969. .RS 4
  970. .nf
  971. aria2c \-c \-s2 http://host/partiallydownloadedfile\.zip
  972. .fi
  973. .RE
  974. .RE
  975. .SS "And more advanced features"
  976. .sp
  977. .it 1 an-trap
  978. .nr an-no-space-flag 1
  979. .nr an-break-flag 1
  980. .br
  981. Throttle download speed
  982. .RS
  983. .sp
  984. .RS 4
  985. .nf
  986. aria2c \-\-max\-download\-limit=100K file\.metalink
  987. .fi
  988. .RE
  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. Repair a damaged download using --check-integrity option
  996. .RS
  997. .sp
  998. .RS 4
  999. .nf
  1000. aria2c \-\-check\-integrity=true file\.metalink
  1001. .fi
  1002. .RE
  1003. .sp
  1004. .it 1 an-trap
  1005. .nr an-no-space-flag 1
  1006. .nr an-break-flag 1
  1007. .br
  1008. Note
  1009. This option is only available used with BitTorrent or metalink with chunk checksums\.
  1010. .sp
  1011. .RE
  1012. .sp
  1013. .it 1 an-trap
  1014. .nr an-no-space-flag 1
  1015. .nr an-break-flag 1
  1016. .br
  1017. Drop connection if download speed is lower than specified value
  1018. .RS
  1019. .sp
  1020. .RS 4
  1021. .nf
  1022. aria2c \-\-lowest\-speed\-limit=10K file\.metalink
  1023. .fi
  1024. .RE
  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. Parameterized URI support
  1032. .RS
  1033. You can specify set of parts:
  1034. .sp
  1035. .sp
  1036. .RS 4
  1037. .nf
  1038. aria2c \-P http://{host1,host2,host3}/file\.iso
  1039. .fi
  1040. .RE
  1041. You can specify numeric sequence:
  1042. .sp
  1043. .sp
  1044. .RS 4
  1045. .nf
  1046. aria2c \-Z \-P http://host/image[000\-100]\.png
  1047. .fi
  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. Note
  1055. \-Z option is required if the all URIs don\'t point to the same file, such as the above example\.
  1056. .sp
  1057. You can specify step counter:
  1058. .sp
  1059. .sp
  1060. .RS 4
  1061. .nf
  1062. aria2c \-Z \-P http://host/image[A\-Z:2]\.png
  1063. .fi
  1064. .RE
  1065. .RE
  1066. .sp
  1067. .it 1 an-trap
  1068. .nr an-no-space-flag 1
  1069. .nr an-break-flag 1
  1070. .br
  1071. Parallel downloads of arbitrary number of URL,metalink,torrent
  1072. .RS
  1073. .sp
  1074. .RS 4
  1075. .nf
  1076. aria2c \-j3 \-Z http://host/file1 file2\.torrent file3\.metalink
  1077. .fi
  1078. .RE
  1079. .RE
  1080. .sp
  1081. .it 1 an-trap
  1082. .nr an-no-space-flag 1
  1083. .nr an-break-flag 1
  1084. .br
  1085. BitTorrent Encryption
  1086. .RS
  1087. Encrypt whole payload using ARC4:
  1088. .sp
  1089. .sp
  1090. .RS 4
  1091. .nf
  1092. aria2c \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true file\.torrent
  1093. .fi
  1094. .RE
  1095. .RE
  1096. .SH "RESUME DOWNLOAD"
  1097. Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\.
  1098. .sp
  1099. 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)\.
  1100. .sp
  1101. .SH "CONTROL FILE"
  1102. 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\.)
  1103. .sp
  1104. 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\.
  1105. .sp
  1106. 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\.
  1107. .sp
  1108. .SH "SEEDING DOWNLOADED FILE IN BITTORRENT"
  1109. You can seed downloaded file using \-\-check\-integrity=true option\.
  1110. .sp
  1111. .sp
  1112. .RS 4
  1113. .nf
  1114. aria2c \-\-check\-integrity=true file\.torrent
  1115. .fi
  1116. .RE
  1117. .SH "FILES"
  1118. .SS "aria2\.conf"
  1119. 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\.
  1120. .sp
  1121. .sp
  1122. .RS 4
  1123. .nf
  1124. # sample configuration file for aria2c
  1125. listen\-port=60000
  1126. seed\-ratio=1\.0
  1127. max\-upload\-limit=50K
  1128. ftp\-pasv=true
  1129. .fi
  1130. .RE
  1131. .SS "dht\.dat"
  1132. The routing table of DHT is saved to the path $HOME/\.aria2/dht\.dat\.
  1133. .sp
  1134. .SH "RESOURCES"
  1135. Project web site: http://aria2\.sourceforge\.net/
  1136. .sp
  1137. metalink: http://www\.metalinker\.org/
  1138. .sp
  1139. .SH "REPORTING BUGS"
  1140. Report bugs to Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net>
  1141. .sp
  1142. .SH "AUTHOR"
  1143. Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net>
  1144. .sp
  1145. .SH "COPYRIGHT"
  1146. Copyright \(co 2006, 2008 Tatsuhiro Tsujikawa
  1147. .sp
  1148. 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\.
  1149. .sp
  1150. 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\.
  1151. .sp
  1152. 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
  1153. .sp
  1154. 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\.
  1155. .sp