aria2c.1 27 KB

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