aria2c.1.html 39 KB

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