aria2c.1 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. .\" Title: aria2c
  2. .\" Author:
  3. .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
  4. .\" Date: 12/04/2007
  5. .\" Manual:
  6. .\" Source:
  7. .\"
  8. .TH "ARIA2C" "1" "12/04/2007" "" ""
  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/Metalink\. aria2 has powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols, utilizing your download bandwidth to the max\. It even supports downloading a file from http(s)/ftp and BitTorrent at the same time, while the data downloaded form http(s)/ftp is uploaded to BitTorrent swarm\.
  24. .sp
  25. aria2 also provides most reliable http(s)/ftp downloading experience ever\. Using Metalink\'s chunk checksums, aria2 automatically validates chunk of data while downloading a file like BitTorrent\.
  26. .sp
  27. .SH "OPTIONS"
  28. .PP
  29. \-d, \-\-dir=DIR
  30. .RS 4
  31. The directory to store the downloaded file\.
  32. .RE
  33. .PP
  34. \-o, \-\-out=FILE
  35. .RS 4
  36. The file name of the downloaded file\.
  37. .RE
  38. .PP
  39. \-l, \-\-log=LOG
  40. .RS 4
  41. The file name of the log file\. If
  42. \fI\-\fR
  43. is specified, log is written to stdout\.
  44. .RE
  45. .PP
  46. \-D, \-\-daemon
  47. .RS 4
  48. Run as daemon\.
  49. .RE
  50. .PP
  51. \-s, \-\-split=N
  52. .RS 4
  53. Download a file using N connections\. N must be between
  54. \fI1\fR
  55. and
  56. \fI5\fR\. This option affects all URLs\. Thus, aria2 connects to each URL with N connections\. Default:
  57. \fI1\fR
  58. .RE
  59. .PP
  60. \-\-retry\-wait=SEC
  61. .RS 4
  62. Set the seconds to wait to retry after an error has occured\. Specify a value between
  63. \fI0\fR
  64. and
  65. \fI60\fR\. Default:
  66. \fI5\fR
  67. .RE
  68. .PP
  69. \-t, \-\-timeout=SEC
  70. .RS 4
  71. Set timeout in seconds\. Default:
  72. \fI60\fR
  73. .RE
  74. .PP
  75. \-m, \-\-max\-tries=N
  76. .RS 4
  77. Set number of tries\.
  78. \fI0\fR
  79. means unlimited\. Default:
  80. \fI5\fR
  81. .RE
  82. .PP
  83. \-\-http\-proxy=HOST:PORT
  84. .RS 4
  85. Use HTTP proxy server\. This affects all URLs\.
  86. .RE
  87. .PP
  88. \-\-http\-user=USER
  89. .RS 4
  90. Set HTTP user\. This affects all URLs\.
  91. .RE
  92. .PP
  93. \-\-http\-passwd=PASSWD
  94. .RS 4
  95. Set HTTP password\. This affects all URLs\.
  96. .RE
  97. .PP
  98. \-\-http\-proxy\-user=USER
  99. .RS 4
  100. Set HTTP proxy user\. This affects all URLs\.
  101. .RE
  102. .PP
  103. \-\-http\-proxy\-passwd=PASSWD
  104. .RS 4
  105. Set HTTP proxy password\. This affects all URLs\.
  106. .RE
  107. .PP
  108. \-\-http\-proxy\-method=METHOD
  109. .RS 4
  110. Set the method to use in proxy request\.
  111. \fIMETHOD\fR
  112. is either
  113. \fIget\fR
  114. or
  115. \fItunnel\fR\. Default:
  116. \fItunnel\fR
  117. .RE
  118. .PP
  119. \-\-http\-auth\-scheme=SCHEME
  120. .RS 4
  121. Set HTTP authentication scheme\. Currently,
  122. \fIbasic\fR
  123. is the only supported scheme\. Default:
  124. \fIbasic\fR
  125. .RE
  126. .PP
  127. \-\-referer=REFERER
  128. .RS 4
  129. Set Referer\. This affects all URLs\.
  130. .RE
  131. .PP
  132. \-\-ftp\-user=USER
  133. .RS 4
  134. Set FTP user\. This affects all URLs\. Default:
  135. \fIanonymous\fR
  136. .RE
  137. .PP
  138. \-\-ftp\-passwd=PASSWD
  139. .RS 4
  140. Set FTP password\. This affects all URLs\. Default:
  141. \fIARIA2USER@\fR
  142. .RE
  143. .PP
  144. \-\-ftp\-type=TYPE
  145. .RS 4
  146. Set FTP transfer type\. TYPE is either
  147. \fIbinary\fR
  148. or
  149. \fIascii\fR\. Default:
  150. \fIbinary\fR
  151. .RE
  152. .PP
  153. \-p, \-\-ftp\-pasv
  154. .RS 4
  155. Use passive mode in FTP\.
  156. .RE
  157. .PP
  158. \-\-ftp\-via\-http\-proxy=METHOD
  159. .RS 4
  160. Use HTTP proxy in
  161. \fIFTP\fR\.
  162. \fIMETHOD\fR
  163. 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 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. \-S, \-\-show\-files
  318. .RS 4
  319. Print file listing of \.torrent or \.metalink file and exit\. In case of \.torrent file, additional information (infohash, piece length, etc) is also printed\.
  320. .RE
  321. .PP
  322. \-\-select\-file=INDEX\&...
  323. .RS 4
  324. 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:
  325. \fI3,6\fR\. You can also use "\-" to specify a range:
  326. \fI1\-5\fR\. "," and "\-" can be used together:
  327. \fI1\-5,8,9\fR\. When used with the \-M option, index may vary depending on the query (see \-\-metalink\-* options)\.
  328. .PP
  329. Note
  330. .RS 4
  331. 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\.
  332. .RE
  333. .RE
  334. .PP
  335. \-T, \-\-torrent\-file=TORRENT_FILE
  336. .RS 4
  337. The path to the \.torrent file\.
  338. .RE
  339. .PP
  340. \-\-follow\-torrent=\fItrue\fR|\fIfalse\fR|\fImem\fR
  341. .RS 4
  342. If true or mem is specified, when a file whose suffix is \.metaink or content type is application/x\-bittorrent is downloaded, aria2 parses it as a torrent file and downloads files mentioned in it\. If mem is specified, a metalink file is not written to the disk, but is just kept in memory\. If false is specified, the action mentioned above is not taken\. Default: true
  343. .RE
  344. .PP
  345. \-\-direct\-file\-mapping=\fItrue\fR|\fIfalse\fR
  346. .RS 4
  347. 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:
  348. \fItrue\fR
  349. .RE
  350. .PP
  351. \-\-listen\-port=PORT\&...
  352. .RS 4
  353. Set TCP port number for BitTorrent downloads\. Multiple ports can be specified by using ",", for example:
  354. \fI6881,6885\fR\. You can also use "\-" to specify a range:
  355. \fI6881\-6999\fR\. "," and "\-" can be used together:
  356. \fI6881\-6889,6999\fR\. Default:
  357. \fI6881\-6999\fR
  358. .RE
  359. .PP
  360. \-\-max\-upload\-limit=SPEED
  361. .RS 4
  362. Set max upload speed in bytes per sec\.
  363. \fI0\fR
  364. means unrestricted\. You can append
  365. \fIK\fR
  366. or
  367. \fIM\fR(1K = 1024, 1M = 1024K)\. Default:
  368. \fI0\fR
  369. .RE
  370. .PP
  371. \-\-seed\-time=MINUTES
  372. .RS 4
  373. Specify seeding time in minutes\. Also see the \-\-seed\-ratio option\.
  374. .RE
  375. .PP
  376. \-\-seed\-ratio=RATIO
  377. .RS 4
  378. Specify share ratio\. Seed completed torrents until share ratio reaches] RATIO\. I strongly encourages you to specify equals or more than
  379. \fI1\.0\fR
  380. here\. Specify
  381. \fI0\.0\fR
  382. 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:
  383. \fI1\.0\fR
  384. .RE
  385. .PP
  386. \-\-peer\-id\-prefix=PEERI_ID_PREFIX
  387. .RS 4
  388. 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:
  389. \fI\-aria2\-\fR
  390. .RE
  391. .PP
  392. \-M, \-\-metalink\-file=METALINK_FILE
  393. .RS 4
  394. The file path to \.metalink file\.
  395. .RE
  396. .PP
  397. \-C, \-\-metalink\-servers=NUM_SERVERS
  398. .RS 4
  399. The number of servers to connect to simultaneously\. Some metalinks regulates the number of servers to connect\. aria2 respects them\. Default:
  400. \fI5\fR
  401. .RE
  402. .PP
  403. \-\-metalink\-version=VERSION
  404. .RS 4
  405. The version of the file to download\.
  406. .RE
  407. .PP
  408. \-\-metalink\-language=LANGUAGE
  409. .RS 4
  410. The language of the file to download\.
  411. .RE
  412. .PP
  413. \-\-metalink\-os=OS
  414. .RS 4
  415. The operating system of the file to download\.
  416. .RE
  417. .PP
  418. \-\-metalink\-location=LOCATION[,\&...]
  419. .RS 4
  420. The location of the preferred server\. A comma\-deliminated list of locations is acceptable, for example,
  421. \fIJP,US\fR\.
  422. .RE
  423. .PP
  424. \-\-follow\-metalink=\fItrue\fR|\fIfalse\fR|\fImem\fR
  425. .RS 4
  426. If true or mem 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 mem is specified, a metalink file is not written to the disk, but is just kept in memory\. If false is specified, the action mentioned above is not taken\. Default:
  427. \fItrue\fR
  428. .RE
  429. .PP
  430. \-v, \-\-version
  431. .RS 4
  432. Print the version number, copyright and the configuration information and exit\.
  433. .RE
  434. .PP
  435. \-h, \-\-help
  436. .RS 4
  437. Print this message and exit\.
  438. .RE
  439. .PP
  440. URL
  441. .RS 4
  442. 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\.
  443. .RE
  444. .SH "EXAMPLES"
  445. .SS "HTTP/FTP Segmented Download"
  446. .sp
  447. .it 1 an-trap
  448. .nr an-no-space-flag 1
  449. .nr an-break-flag 1
  450. .br
  451. Download a file using 1 connection
  452. .RS
  453. .sp
  454. .RS 4
  455. .nf
  456. aria2c http://host/file\.zip
  457. .fi
  458. .RE
  459. .sp
  460. .it 1 an-trap
  461. .nr an-no-space-flag 1
  462. .nr an-break-flag 1
  463. .br
  464. Note
  465. 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\.
  466. .sp
  467. .RE
  468. .sp
  469. .it 1 an-trap
  470. .nr an-no-space-flag 1
  471. .nr an-break-flag 1
  472. .br
  473. Download a file using 2 connections
  474. .RS
  475. .sp
  476. .RS 4
  477. .nf
  478. aria2c \-s 2 http://host/file\.zip
  479. .fi
  480. .RE
  481. .RE
  482. .sp
  483. .it 1 an-trap
  484. .nr an-no-space-flag 1
  485. .nr an-break-flag 1
  486. .br
  487. Download a file from 2 difference http servers
  488. .RS
  489. .sp
  490. .RS 4
  491. .nf
  492. aria2c http://host1/file\.zip ftp://host2/file\.zip
  493. .fi
  494. .RE
  495. .RE
  496. .sp
  497. .it 1 an-trap
  498. .nr an-no-space-flag 1
  499. .nr an-break-flag 1
  500. .br
  501. Download a file from http and ftp servers
  502. .RS
  503. .sp
  504. .RS 4
  505. .nf
  506. aria2c http://host1/file\.zip ftp://host2/file\.zip
  507. .fi
  508. .RE
  509. .RE
  510. .sp
  511. .it 1 an-trap
  512. .nr an-no-space-flag 1
  513. .nr an-break-flag 1
  514. .br
  515. Download files listed in a file concurrently
  516. .RS
  517. .sp
  518. .RS 4
  519. .nf
  520. aria2c \-i files\.txt \-j 5
  521. .fi
  522. .RE
  523. .sp
  524. .it 1 an-trap
  525. .nr an-no-space-flag 1
  526. .nr an-break-flag 1
  527. .br
  528. Note
  529. \-j option specifies the number of concurrent downloads\.
  530. .sp
  531. .RE
  532. .SS "Metalink Download"
  533. .sp
  534. .it 1 an-trap
  535. .nr an-no-space-flag 1
  536. .nr an-break-flag 1
  537. .br
  538. Download files with remote Metalink
  539. .RS
  540. .sp
  541. .RS 4
  542. .nf
  543. aria2c \-\-follow\-metalink=mem http://host/file\.metalink
  544. .fi
  545. .RE
  546. .RE
  547. .sp
  548. .it 1 an-trap
  549. .nr an-no-space-flag 1
  550. .nr an-break-flag 1
  551. .br
  552. Download using a local metalink file
  553. .RS
  554. .sp
  555. .RS 4
  556. .nf
  557. aria2c \-p \-t 10 \-\-lowest\-speed\-limit 4000 \-M test\.metalink
  558. .fi
  559. .RE
  560. .sp
  561. .it 1 an-trap
  562. .nr an-no-space-flag 1
  563. .nr an-break-flag 1
  564. .br
  565. Note
  566. To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c with the same argument at the same directory\.
  567. .sp
  568. .RE
  569. .sp
  570. .it 1 an-trap
  571. .nr an-no-space-flag 1
  572. .nr an-break-flag 1
  573. .br
  574. Download only selected files using index
  575. .RS
  576. .sp
  577. .RS 4
  578. .nf
  579. aria2c \-M test\.metalink \-\-select\-file 1\-4,8
  580. .fi
  581. .RE
  582. .sp
  583. .it 1 an-trap
  584. .nr an-no-space-flag 1
  585. .nr an-break-flag 1
  586. .br
  587. Note
  588. The index is printed to the console using \-S option\.
  589. .sp
  590. .RE
  591. .sp
  592. .it 1 an-trap
  593. .nr an-no-space-flag 1
  594. .nr an-break-flag 1
  595. .br
  596. Download a file using a local .metalink file with user preference
  597. .RS
  598. .sp
  599. .RS 4
  600. .nf
  601. aria2c \-M test\.metalink \-\-metalink\-location=JP,US \-\-metalink\-version=1\.1 \-\-metalink\-language=en\-US
  602. .fi
  603. .RE
  604. .RE
  605. .SS "BitTorrent Download"
  606. .sp
  607. .it 1 an-trap
  608. .nr an-no-space-flag 1
  609. .nr an-break-flag 1
  610. .br
  611. Download files from remote BitTorrent file
  612. .RS
  613. .sp
  614. .RS 4
  615. .nf
  616. aria2c \-\-follow\-bittorrent=mem http://host/file\.torrent
  617. .fi
  618. .RE
  619. .RE
  620. .sp
  621. .it 1 an-trap
  622. .nr an-no-space-flag 1
  623. .nr an-break-flag 1
  624. .br
  625. Download using a local torrent file
  626. .RS
  627. .sp
  628. .RS 4
  629. .nf
  630. aria2c \-\-max\-upload\-limit 40K \-T file\.torrent
  631. .fi
  632. .RE
  633. .sp
  634. .it 1 an-trap
  635. .nr an-no-space-flag 1
  636. .nr an-break-flag 1
  637. .br
  638. Note
  639. \-\-max\-upload\-limit specifies the max of upload rate\.
  640. .sp
  641. .sp
  642. .it 1 an-trap
  643. .nr an-no-space-flag 1
  644. .nr an-break-flag 1
  645. .br
  646. Note
  647. To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c with the same argument at the same directory\.
  648. .sp
  649. .RE
  650. .sp
  651. .it 1 an-trap
  652. .nr an-no-space-flag 1
  653. .nr an-break-flag 1
  654. .br
  655. Download a file using torrent and http/ftp server
  656. .RS
  657. .sp
  658. .RS 4
  659. .nf
  660. aria2c \-T test\.torrent http://host1/file ftp://host2/file
  661. .fi
  662. .RE
  663. .sp
  664. .it 1 an-trap
  665. .nr an-no-space-flag 1
  666. .nr an-break-flag 1
  667. .br
  668. Note
  669. Downloading multi file torrent with http/ftp is not supported\.
  670. .sp
  671. .RE
  672. .sp
  673. .it 1 an-trap
  674. .nr an-no-space-flag 1
  675. .nr an-break-flag 1
  676. .br
  677. Download only selected files using index(usually called "selectable download")
  678. .RS
  679. .sp
  680. .RS 4
  681. .nf
  682. aria2c \-T test\.torrent \-\-select\-file 1\-4,8
  683. .fi
  684. .RE
  685. .sp
  686. .it 1 an-trap
  687. .nr an-no-space-flag 1
  688. .nr an-break-flag 1
  689. .br
  690. Note
  691. The index is printed to the console using \-S option\.
  692. .sp
  693. .RE
  694. .sp
  695. .it 1 an-trap
  696. .nr an-no-space-flag 1
  697. .nr an-break-flag 1
  698. .br
  699. Change the listening port for incoming peer
  700. .RS
  701. .sp
  702. .RS 4
  703. .nf
  704. aria2c \-T test\.torrent \-\-listen\-port 7000\-7001,8000
  705. .fi
  706. .RE
  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. Specify the condition to stop program after torrent download finished
  714. .RS
  715. .sp
  716. .RS 4
  717. .nf
  718. aria2c \-T test\.torrent \-\-seed\-time 120 \-\-seed\-ratio 1\.0
  719. .fi
  720. .RE
  721. .sp
  722. .it 1 an-trap
  723. .nr an-no-space-flag 1
  724. .nr an-break-flag 1
  725. .br
  726. Note
  727. In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1\.0\.
  728. .sp
  729. .RE
  730. .sp
  731. .it 1 an-trap
  732. .nr an-no-space-flag 1
  733. .nr an-break-flag 1
  734. .br
  735. Throttle upload speed
  736. .RS
  737. .sp
  738. .RS 4
  739. .nf
  740. aria2c \-T test\.torrent \-\-max\-upload\-limit 100K
  741. .fi
  742. .RE
  743. .RE
  744. .SS "More advanced HTTP features"
  745. .sp
  746. .it 1 an-trap
  747. .nr an-no-space-flag 1
  748. .nr an-break-flag 1
  749. .br
  750. Load cookies
  751. .RS
  752. .sp
  753. .RS 4
  754. .nf
  755. aria2c \-\-load\-cookies cookies\.txt http://host/file\.zip
  756. .fi
  757. .RE
  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. You can use Firefox/Mozilla\'s cookie file without modification\.
  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. Resume download started by web browsers or another programs
  773. .RS
  774. .sp
  775. .RS 4
  776. .nf
  777. aria2c \-c \-s 2 http://host/partiallydownloadedfile\.zip
  778. .fi
  779. .RE
  780. .RE
  781. .SS "And more advanced features"
  782. .sp
  783. .it 1 an-trap
  784. .nr an-no-space-flag 1
  785. .nr an-break-flag 1
  786. .br
  787. Throttle download speed
  788. .RS
  789. .sp
  790. .RS 4
  791. .nf
  792. aria2c \-M test\.metalink \-\-max\-download\-limit 100K
  793. .fi
  794. .RE
  795. .RE
  796. .sp
  797. .it 1 an-trap
  798. .nr an-no-space-flag 1
  799. .nr an-break-flag 1
  800. .br
  801. Repair a damaged download using --check-integrity option
  802. .RS
  803. .sp
  804. .RS 4
  805. .nf
  806. aria2c \-M test\.metalink \-\-check\-integrity=true
  807. .fi
  808. .RE
  809. .sp
  810. .it 1 an-trap
  811. .nr an-no-space-flag 1
  812. .nr an-break-flag 1
  813. .br
  814. Note
  815. This option is only available used with BitTorrent or metalink with chunk checksums\.
  816. .sp
  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. Drop connection if download speed is lower than specified value
  824. .RS
  825. .sp
  826. .RS 4
  827. .nf
  828. aria2c \-M test\.metalink \-\-lowest\-speed\-limit 10K
  829. .fi
  830. .RE
  831. .RE
  832. .sp
  833. .it 1 an-trap
  834. .nr an-no-space-flag 1
  835. .nr an-break-flag 1
  836. .br
  837. Parameterized URI support
  838. .RS
  839. You can specify set of parts:
  840. .sp
  841. .sp
  842. .RS 4
  843. .nf
  844. aria2c \-P http://{host1,host2,host3}/file\.iso
  845. .fi
  846. .RE
  847. You can specify numeric sequence:
  848. .sp
  849. .sp
  850. .RS 4
  851. .nf
  852. aria2c \-Z \-P http://host/image[000\-100]\.png
  853. .fi
  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. Note
  861. \-Z option is required if the all URIs don\'t point to the same file, such as the above example\.
  862. .sp
  863. You can specify step counter:
  864. .sp
  865. .sp
  866. .RS 4
  867. .nf
  868. aria2c \-Z \-P http://host/image[A\-Z:2]\.png
  869. .fi
  870. .RE
  871. .RE
  872. .SH "RESUME DOWNLOAD"
  873. Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\.
  874. .sp
  875. 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)\.
  876. .sp
  877. .SH "CONTROL FILE"
  878. 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\.)
  879. .sp
  880. 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\.
  881. .sp
  882. 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\.
  883. .sp
  884. .SH "SEEDING DOWNLOADED FILE IN BITTORRENT"
  885. You can seed downloaded file using \-\-check\-integrity=true option\.
  886. .sp
  887. .sp
  888. .RS 4
  889. .nf
  890. aria2c \-\-check\-integrity=true \-T file\.torrent
  891. .fi
  892. .RE
  893. .SH "FILES"
  894. .SS "aria2\.conf"
  895. User configuration file\. It must be placed under ~/\.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\.
  896. .sp
  897. .sp
  898. .RS 4
  899. .nf
  900. # sample configuration file for aria2c
  901. file\-allocation=prealloc
  902. listen\-port=60000
  903. seed\-ratio=1\.0
  904. max\-upload\-limit=100K
  905. ftp\-pasv=true
  906. .fi
  907. .RE
  908. .SH "RESOURCES"
  909. Project web site: http://aria2\.sourceforge\.net/
  910. .sp
  911. metalink: http://www\.metalinker\.org/
  912. .sp
  913. .SH "REPORTING BUGS"
  914. Report bugs to Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net>
  915. .sp
  916. .SH "AUTHOR"
  917. Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net>
  918. .sp
  919. .SH "COPYRIGHT"
  920. Copyright \(co 2006, 2007 Tatsuhiro Tsujikawa
  921. .sp
  922. 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\.
  923. .sp
  924. 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\.
  925. .sp
  926. 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
  927. .sp
  928. 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\.
  929. .sp