aria2c.1.html 73 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730
  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.4.4" />
  7. <title>ARIA2C(1)</title>
  8. <style type="text/css">
  9. /* Debug borders */
  10. p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11. /*
  12. border: 1px solid red;
  13. */
  14. }
  15. body {
  16. margin: 1em 5% 1em 5%;
  17. }
  18. a {
  19. color: blue;
  20. text-decoration: underline;
  21. }
  22. a:visited {
  23. color: fuchsia;
  24. }
  25. em {
  26. font-style: italic;
  27. color: navy;
  28. }
  29. strong {
  30. font-weight: bold;
  31. color: #083194;
  32. }
  33. tt {
  34. color: navy;
  35. }
  36. h1, h2, h3, h4, h5, h6 {
  37. color: #527bbd;
  38. font-family: sans-serif;
  39. margin-top: 1.2em;
  40. margin-bottom: 0.5em;
  41. line-height: 1.3;
  42. }
  43. h1, h2, h3 {
  44. border-bottom: 2px solid silver;
  45. }
  46. h2 {
  47. padding-top: 0.5em;
  48. }
  49. h3 {
  50. float: left;
  51. }
  52. h3 + * {
  53. clear: left;
  54. }
  55. div.sectionbody {
  56. font-family: serif;
  57. margin-left: 0;
  58. }
  59. hr {
  60. border: 1px solid silver;
  61. }
  62. p {
  63. margin-top: 0.5em;
  64. margin-bottom: 0.5em;
  65. }
  66. ul, ol, li > p {
  67. margin-top: 0;
  68. }
  69. pre {
  70. padding: 0;
  71. margin: 0;
  72. }
  73. span#author {
  74. color: #527bbd;
  75. font-family: sans-serif;
  76. font-weight: bold;
  77. font-size: 1.1em;
  78. }
  79. span#email {
  80. }
  81. span#revision {
  82. font-family: sans-serif;
  83. }
  84. div#footer {
  85. font-family: sans-serif;
  86. font-size: small;
  87. border-top: 2px solid silver;
  88. padding-top: 0.5em;
  89. margin-top: 4.0em;
  90. }
  91. div#footer-text {
  92. float: left;
  93. padding-bottom: 0.5em;
  94. }
  95. div#footer-badges {
  96. float: right;
  97. padding-bottom: 0.5em;
  98. }
  99. div#preamble {
  100. margin-top: 1.5em;
  101. margin-bottom: 1.5em;
  102. }
  103. div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
  104. div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
  105. div.admonitionblock {
  106. margin-top: 1.5em;
  107. margin-bottom: 1.5em;
  108. }
  109. div.admonitionblock {
  110. margin-top: 2.5em;
  111. margin-bottom: 2.5em;
  112. }
  113. div.content { /* Block element content. */
  114. padding: 0;
  115. }
  116. /* Block element titles. */
  117. div.title, caption.title {
  118. color: #527bbd;
  119. font-family: sans-serif;
  120. font-weight: bold;
  121. text-align: left;
  122. margin-top: 1.0em;
  123. margin-bottom: 0.5em;
  124. }
  125. div.title + * {
  126. margin-top: 0;
  127. }
  128. td div.title:first-child {
  129. margin-top: 0.0em;
  130. }
  131. div.content div.title:first-child {
  132. margin-top: 0.0em;
  133. }
  134. div.content + div.title {
  135. margin-top: 0.0em;
  136. }
  137. div.sidebarblock > div.content {
  138. background: #ffffee;
  139. border: 1px solid silver;
  140. padding: 0.5em;
  141. }
  142. div.listingblock > div.content {
  143. border: 1px solid silver;
  144. background: #f4f4f4;
  145. padding: 0.5em;
  146. }
  147. div.quoteblock {
  148. padding-left: 2.0em;
  149. margin-right: 10%;
  150. }
  151. div.quoteblock > div.attribution {
  152. padding-top: 0.5em;
  153. text-align: right;
  154. }
  155. div.verseblock {
  156. padding-left: 2.0em;
  157. margin-right: 10%;
  158. }
  159. div.verseblock > div.content {
  160. white-space: pre;
  161. }
  162. div.verseblock > div.attribution {
  163. padding-top: 0.75em;
  164. text-align: left;
  165. }
  166. /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
  167. div.verseblock + div.attribution {
  168. text-align: left;
  169. }
  170. div.admonitionblock .icon {
  171. vertical-align: top;
  172. font-size: 1.1em;
  173. font-weight: bold;
  174. text-decoration: underline;
  175. color: #527bbd;
  176. padding-right: 0.5em;
  177. }
  178. div.admonitionblock td.content {
  179. padding-left: 0.5em;
  180. border-left: 2px solid silver;
  181. }
  182. div.exampleblock > div.content {
  183. border-left: 2px solid silver;
  184. padding: 0.5em;
  185. }
  186. div.imageblock div.content { padding-left: 0; }
  187. div.imageblock img { border: 1px solid silver; }
  188. span.image img { border-style: none; }
  189. dl {
  190. margin-top: 0.8em;
  191. margin-bottom: 0.8em;
  192. }
  193. dt {
  194. margin-top: 0.5em;
  195. margin-bottom: 0;
  196. font-style: normal;
  197. color: navy;
  198. }
  199. dd > *:first-child {
  200. margin-top: 0.1em;
  201. }
  202. ul, ol {
  203. list-style-position: outside;
  204. }
  205. ol.arabic {
  206. list-style-type: decimal;
  207. }
  208. ol.loweralpha {
  209. list-style-type: lower-alpha;
  210. }
  211. ol.upperalpha {
  212. list-style-type: upper-alpha;
  213. }
  214. ol.lowerroman {
  215. list-style-type: lower-roman;
  216. }
  217. ol.upperroman {
  218. list-style-type: upper-roman;
  219. }
  220. div.compact ul, div.compact ol,
  221. div.compact p, div.compact p,
  222. div.compact div, div.compact div {
  223. margin-top: 0.1em;
  224. margin-bottom: 0.1em;
  225. }
  226. div.tableblock > table {
  227. border: 3px solid #527bbd;
  228. }
  229. thead {
  230. font-family: sans-serif;
  231. font-weight: bold;
  232. }
  233. tfoot {
  234. font-weight: bold;
  235. }
  236. td > div.verse {
  237. white-space: pre;
  238. }
  239. p.table {
  240. margin-top: 0;
  241. }
  242. /* Because the table frame attribute is overriden by CSS in most browsers. */
  243. div.tableblock > table[frame="void"] {
  244. border-style: none;
  245. }
  246. div.tableblock > table[frame="hsides"] {
  247. border-left-style: none;
  248. border-right-style: none;
  249. }
  250. div.tableblock > table[frame="vsides"] {
  251. border-top-style: none;
  252. border-bottom-style: none;
  253. }
  254. div.hdlist {
  255. margin-top: 0.8em;
  256. margin-bottom: 0.8em;
  257. }
  258. div.hdlist tr {
  259. padding-bottom: 15px;
  260. }
  261. dt.hdlist1.strong, td.hdlist1.strong {
  262. font-weight: bold;
  263. }
  264. td.hdlist1 {
  265. vertical-align: top;
  266. font-style: normal;
  267. padding-right: 0.8em;
  268. color: navy;
  269. }
  270. td.hdlist2 {
  271. vertical-align: top;
  272. }
  273. div.hdlist.compact tr {
  274. margin: 0;
  275. padding-bottom: 0;
  276. }
  277. .comment {
  278. background: yellow;
  279. }
  280. @media print {
  281. div#footer-badges { display: none; }
  282. }
  283. div#toctitle {
  284. color: #527bbd;
  285. font-family: sans-serif;
  286. font-size: 1.1em;
  287. font-weight: bold;
  288. margin-top: 1.0em;
  289. margin-bottom: 0.1em;
  290. }
  291. div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  292. margin-top: 0;
  293. margin-bottom: 0;
  294. }
  295. div.toclevel2 {
  296. margin-left: 2em;
  297. font-size: 0.9em;
  298. }
  299. div.toclevel3 {
  300. margin-left: 4em;
  301. font-size: 0.9em;
  302. }
  303. div.toclevel4 {
  304. margin-left: 6em;
  305. font-size: 0.9em;
  306. }
  307. /* Overrides for manpage documents */
  308. h1 {
  309. padding-top: 0.5em;
  310. padding-bottom: 0.5em;
  311. border-top: 2px solid silver;
  312. border-bottom: 2px solid silver;
  313. }
  314. h2 {
  315. border-style: none;
  316. }
  317. div.sectionbody {
  318. margin-left: 5%;
  319. }
  320. @media print {
  321. div#toc { display: none; }
  322. }
  323. /* Workarounds for IE6's broken and incomplete CSS2. */
  324. div.sidebar-content {
  325. background: #ffffee;
  326. border: 1px solid silver;
  327. padding: 0.5em;
  328. }
  329. div.sidebar-title, div.image-title {
  330. color: #527bbd;
  331. font-family: sans-serif;
  332. font-weight: bold;
  333. margin-top: 0.0em;
  334. margin-bottom: 0.5em;
  335. }
  336. div.listingblock div.content {
  337. border: 1px solid silver;
  338. background: #f4f4f4;
  339. padding: 0.5em;
  340. }
  341. div.quoteblock-attribution {
  342. padding-top: 0.5em;
  343. text-align: right;
  344. }
  345. div.verseblock-content {
  346. white-space: pre;
  347. }
  348. div.verseblock-attribution {
  349. padding-top: 0.75em;
  350. text-align: left;
  351. }
  352. div.exampleblock-content {
  353. border-left: 2px solid silver;
  354. padding-left: 0.5em;
  355. }
  356. /* IE6 sets dynamically generated links as visited. */
  357. div#toc a:visited { color: blue; }
  358. </style>
  359. </head>
  360. <body>
  361. <div id="header">
  362. <h1>
  363. ARIA2C(1) Manual Page
  364. </h1>
  365. <h2>NAME</h2>
  366. <div class="sectionbody">
  367. <p>aria2c -
  368. The ultra fast download utility
  369. </p>
  370. </div>
  371. </div>
  372. <h2>SYNOPSIS</h2>
  373. <div class="sectionbody">
  374. <div class="paragraph"><p>aria2c [<em>OPTIONS</em>] [<em>URL</em> | <em>TORRENT_FILE</em> | <em>METALINK_FILE</em>]&#8230;</p></div>
  375. </div>
  376. <h2 id="_description">DESCRIPTION</h2>
  377. <div class="sectionbody">
  378. <div class="paragraph"><p>aria2 is a utility for downloading files. The supported protocols are
  379. HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
  380. multiple sources/protocols and tries to utilize your maximum download
  381. bandwidth. It supports downloading a file from HTTP(S)/FTP and
  382. BitTorrent at the same time, while the data downloaded from
  383. HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink&#8217;s
  384. chunk checksums, aria2 automatically validates chunks of data while
  385. downloading a file like BitTorrent.</p></div>
  386. </div>
  387. <h2 id="_options">OPTIONS</h2>
  388. <div class="sectionbody">
  389. <h3 id="_basic_options">Basic Options</h3><div style="clear:left"></div>
  390. <div class="dlist"><dl>
  391. <dt class="hdlist1">
  392. <strong>-d</strong>, <strong>--dir</strong>=DIR
  393. </dt>
  394. <dd>
  395. <p>
  396. The directory to store the downloaded file.
  397. </p>
  398. </dd>
  399. <dt class="hdlist1">
  400. <strong>-i</strong>, <strong>--input-file</strong>=FILE
  401. </dt>
  402. <dd>
  403. <p>
  404. Downloads URIs found in FILE. You can specify multiple URIs for a single
  405. entity: separate URIs on a single line using the TAB character.
  406. Reads input from stdin when <em>-</em> is specified.
  407. The additional <strong>out</strong> and <strong>dir</strong> options can be specified after each line of
  408. URIs. This optional line must start with white space(s).
  409. See <strong>Input File</strong> subsection for details.
  410. </p>
  411. </dd>
  412. <dt class="hdlist1">
  413. <strong>-l</strong>, <strong>--log</strong>=LOG
  414. </dt>
  415. <dd>
  416. <p>
  417. The file name of the log file. If <em>-</em> is specified, log is written to
  418. stdout.
  419. </p>
  420. </dd>
  421. <dt class="hdlist1">
  422. <strong>-j</strong>, <strong>--max-concurrent-downloads</strong>=N
  423. </dt>
  424. <dd>
  425. <p>
  426. Set maximum number of parallel downloads for every static (HTTP/FTP) URL,
  427. torrent and metalink. See also <strong>-s</strong> and <strong>-C</strong> option.
  428. Default: <em>5</em>
  429. </p>
  430. </dd>
  431. <dt class="hdlist1">
  432. <strong>-V</strong>, <strong>--check-integrity</strong>[=<em>true</em>|<em>false</em>]
  433. </dt>
  434. <dd>
  435. <p>
  436. Check file integrity by validating piece hashes.
  437. This option has effect only in BitTorrent and Metalink downloads with
  438. chunk checksums.
  439. Use this option to re-download a damaged portion of a file.
  440. Default: <em>false</em>
  441. </p>
  442. </dd>
  443. <dt class="hdlist1">
  444. <strong>-c</strong>, <strong>--continue</strong>
  445. </dt>
  446. <dd>
  447. <p>
  448. Continue downloading a partially downloaded file.
  449. Use this option to resume a download started by a web browser or another
  450. program which downloads files sequentially from the beginning.
  451. Currently this option is only applicable to HTTP(S)/FTP downloads.
  452. </p>
  453. </dd>
  454. <dt class="hdlist1">
  455. <strong>-h</strong>, <strong>--help</strong>[=CATEGORY]
  456. </dt>
  457. <dd>
  458. <p>
  459. Print usage and exit.
  460. The help messages are classified in several categories.
  461. For example, type "<strong>--help</strong>=http" for detailed explanation for the options
  462. related to HTTP. If no matching category is found, search option name using
  463. a given word in middle match and print the result.
  464. Available Values: <em>basic</em>, <em>advanced</em>, <em>http</em>, <em>https</em>, <em>ftp</em>, <em>metalink</em>,
  465. <em>bittorrent</em>, <em>all</em>
  466. Default: <em>basic</em>
  467. </p>
  468. </dd>
  469. </dl></div>
  470. <h3 id="_http_ftp_options">HTTP/FTP Options</h3><div style="clear:left"></div>
  471. <div class="dlist"><dl>
  472. <dt class="hdlist1">
  473. <strong>--all-proxy</strong>=PROXY
  474. </dt>
  475. <dd>
  476. <p>
  477. Use this proxy server for all protocols.
  478. You can override this setting and specify a proxy server for a particular
  479. protocol using <strong>--http-proxy</strong>, <strong>--https-proxy</strong> and <strong>--ftp-proxy</strong> options.
  480. This affects all URLs.
  481. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  482. </p>
  483. </dd>
  484. <dt class="hdlist1">
  485. <strong>--connect-timeout</strong>=SEC
  486. </dt>
  487. <dd>
  488. <p>
  489. Set the connect timeout in seconds to establish connection to
  490. HTTP/FTP/proxy server. After the connection is established, this
  491. option makes no effect and <strong>--timeout</strong> option is used instead.
  492. Default: <em>60</em>
  493. </p>
  494. </dd>
  495. <dt class="hdlist1">
  496. <strong>--dry-run</strong>[=<em>true</em>|<em>false</em>]
  497. </dt>
  498. <dd>
  499. <p>
  500. If <em>true</em> is given, aria2 just checks whether the remote file is
  501. available and doesn&#8217;t download data. This option has effect on
  502. HTTP/FTP download. BitTorrent downloads are canceled if <em>true</em> is
  503. specified. Default: <em>false</em>
  504. </p>
  505. </dd>
  506. <dt class="hdlist1">
  507. <strong>--lowest-speed-limit</strong>=SPEED
  508. </dt>
  509. <dd>
  510. <p>
  511. Close connection if download speed is lower than or equal to this
  512. value(bytes per sec).
  513. <em>0</em> means aria2 does not have a lowest speed limit.
  514. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
  515. This option does not affect BitTorrent downloads.
  516. Default: <em>0</em>
  517. </p>
  518. </dd>
  519. <dt class="hdlist1">
  520. <strong>--max-file-not-found</strong>=NUM
  521. </dt>
  522. <dd>
  523. <p>
  524. If aria2 receives &#8216;file not found&#8217; status from the remote HTTP/FTP
  525. servers NUM times without getting a single byte, then force the
  526. download to fail. Specify <em>0</em> to disable this option. This options is
  527. effective only when using HTTP/FTP servers.
  528. Default: <em>0</em>
  529. </p>
  530. </dd>
  531. <dt class="hdlist1">
  532. <strong>-m</strong>, <strong>--max-tries</strong>=N
  533. </dt>
  534. <dd>
  535. <p>
  536. Set number of tries. <em>0</em> means unlimited.
  537. Default: <em>5</em>
  538. </p>
  539. </dd>
  540. <dt class="hdlist1">
  541. <strong>-n</strong>, <strong>--no-netrc</strong>
  542. </dt>
  543. <dd>
  544. <p>
  545. Disables netrc support. netrc support is enabled by default.
  546. </p>
  547. </dd>
  548. <dt class="hdlist1">
  549. <strong>--no-proxy</strong>=DOMAINS
  550. </dt>
  551. <dd>
  552. <p>
  553. Specify comma separated hostnames or domains where proxy should not be
  554. used.
  555. </p>
  556. </dd>
  557. <dt class="hdlist1">
  558. <strong>-o</strong>, <strong>--out</strong>=FILE
  559. </dt>
  560. <dd>
  561. <p>
  562. The file name of the downloaded file.
  563. </p>
  564. </dd>
  565. </dl></div>
  566. <div class="admonitionblock">
  567. <table><tr>
  568. <td class="icon">
  569. <div class="title">Note</div>
  570. </td>
  571. <td class="content">In Metalink or BitTorrent download you cannot specify file name.
  572. The file name specified here is only used when the URLs fed to aria2
  573. are done by command line without <strong>-i</strong>, <strong>-Z</strong> option. For example:
  574. aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
  575. </tr></table>
  576. </div>
  577. <div class="dlist"><dl>
  578. <dt class="hdlist1">
  579. <strong>--proxy-method</strong>=METHOD
  580. </dt>
  581. <dd>
  582. <p>
  583. Set the method to use in proxy request. <em>METHOD</em> is either <em>get</em> or
  584. <em>tunnel</em>. HTTPS downloads always use <em>tunnel</em> regardless of this
  585. option.
  586. Default: <em>get</em>
  587. </p>
  588. </dd>
  589. <dt class="hdlist1">
  590. <strong>-R</strong>, <strong>--remote-time</strong>[=<em>true</em>|<em>false</em>]
  591. </dt>
  592. <dd>
  593. <p>
  594. Retrieve timestamp of the remote file from the remote HTTP/FTP
  595. server and if it is available, apply it to the local file.
  596. Default: <em>false</em>
  597. </p>
  598. </dd>
  599. <dt class="hdlist1">
  600. <strong>--retry-wait</strong>=SEC
  601. </dt>
  602. <dd>
  603. <p>
  604. Set the seconds to wait to retry after an error has occured.
  605. Specify a value between <em>0</em> and <em>60</em>.
  606. Default: <em>5</em>
  607. </p>
  608. </dd>
  609. <dt class="hdlist1">
  610. <strong>--server-stat-of</strong>=FILE
  611. </dt>
  612. <dd>
  613. <p>
  614. Specify the filename to which performance profile of the servers is
  615. saved. You can load saved data using <strong>--server-stat-if</strong> option. See
  616. <strong>Server Performance Profile</strong> subsection below for file format.
  617. </p>
  618. </dd>
  619. <dt class="hdlist1">
  620. <strong>--server-stat-if</strong>=FILE
  621. </dt>
  622. <dd>
  623. <p>
  624. Specify the filename to load performance profile of the servers. The
  625. loaded data will be used in some URI selector such as <em>feedback</em>.
  626. See also <strong>--uri-selector</strong> option. See <strong>Server Performance Profile</strong>
  627. subsection below for file format.
  628. </p>
  629. </dd>
  630. <dt class="hdlist1">
  631. <strong>--server-stat-timeout</strong>=SEC
  632. </dt>
  633. <dd>
  634. <p>
  635. Specifies timeout in seconds to invalidate performance profile of
  636. the servers since the last contact to them.
  637. Default: <em>86400</em> (24hours)
  638. </p>
  639. </dd>
  640. <dt class="hdlist1">
  641. <strong>-s</strong>, <strong>--split</strong>=N
  642. </dt>
  643. <dd>
  644. <p>
  645. Download a file using N connections.
  646. If more than N URLs are given, first N URLs are used and remaining URLs are
  647. used for backup.
  648. If less than N URLs are given, those URLs are used more than once so that N
  649. connections total are made simultaneously.
  650. Please see <strong>-j</strong> option too.
  651. Please note that in Metalink download, this option has no effect and use
  652. <strong>-C</strong> option instead.
  653. Default: <em>5</em>
  654. </p>
  655. </dd>
  656. <dt class="hdlist1">
  657. <strong>-t</strong>, <strong>--timeout</strong>=SEC
  658. </dt>
  659. <dd>
  660. <p>
  661. Set timeout in seconds.
  662. Default: <em>60</em>
  663. </p>
  664. </dd>
  665. <dt class="hdlist1">
  666. <strong>--uri-selector</strong>=SELECTOR
  667. </dt>
  668. <dd>
  669. <p>
  670. Specify URI selection algorithm. The possible values are <em>inorder</em>,
  671. <em>feedback</em> and <em>adaptive</em>. If <em>inorder</em> is given, URI is tried in
  672. the order appeared in the URI list. If <em>feedback</em> is given, aria2
  673. uses download speed observed in the previous downloads and choose
  674. fastest server in the URI list. This also effectively skips dead
  675. mirrors. The observed download speed is a part of performance
  676. profile of servers mentioned in <strong>--server-stat-of</strong> and
  677. <strong>--server-stat-if</strong> options. If <em>adaptive</em> is given, selects one of
  678. the best mirrors for the first and reserved connections. For
  679. supplementary ones, it returns mirrors which has not been tested
  680. yet, and if each of them has already been tested, returns mirrors
  681. which has to be tested again. Otherwise, it doesn&#8217;t select anymore
  682. mirrors. Like <em>feedback</em>, it uses a performance profile of servers.
  683. Default: <em>feedback</em>
  684. </p>
  685. </dd>
  686. </dl></div>
  687. <h3 id="_http_specific_options">HTTP Specific Options</h3><div style="clear:left"></div>
  688. <div class="dlist"><dl>
  689. <dt class="hdlist1">
  690. <strong>--ca-certificate</strong>=FILE
  691. </dt>
  692. <dd>
  693. <p>
  694. Use the certificate authorities in FILE to verify the peers.
  695. The certificate file must be in PEM format and can contain multiple CA
  696. certificates.
  697. Use <strong>--check-certificate</strong> option to enable verification.
  698. </p>
  699. </dd>
  700. <dt class="hdlist1">
  701. <strong>--certificate</strong>=FILE
  702. </dt>
  703. <dd>
  704. <p>
  705. Use the client certificate in FILE.
  706. The certificate must be in PEM format.
  707. You may use <strong>--private-key</strong> option to specify the private key.
  708. </p>
  709. </dd>
  710. <dt class="hdlist1">
  711. <strong>--check-certificate</strong>[=<em>true</em>|<em>false</em>]
  712. </dt>
  713. <dd>
  714. <p>
  715. Verify the peer using certificates specified in <strong>--ca-certificate</strong> option.
  716. Default: <em>true</em>
  717. </p>
  718. </dd>
  719. <dt class="hdlist1">
  720. <strong>--http-auth-challenge</strong>[=<em>true</em>|<em>false</em>]
  721. </dt>
  722. <dd>
  723. <p>
  724. Send HTTP authorization header only when it is requested by the
  725. server. If <em>false</em> is set, then authorization header is always sent
  726. to the server. There is an exception: if username and password are
  727. embedded in URI, authorization header is always sent to the server
  728. regardless of this option. Default: <em>false</em>
  729. </p>
  730. </dd>
  731. <dt class="hdlist1">
  732. <strong>--http-auth-scheme</strong>=SCHEME
  733. </dt>
  734. <dd>
  735. <p>
  736. Set HTTP authentication scheme.
  737. Currently, <em>basic</em> is the only supported scheme.
  738. Default: <em>basic</em>
  739. </p>
  740. </dd>
  741. <dt class="hdlist1">
  742. <strong>--http-user</strong>=USER
  743. </dt>
  744. <dd>
  745. <p>
  746. Set HTTP user. This affects all URLs.
  747. </p>
  748. </dd>
  749. <dt class="hdlist1">
  750. <strong>--http-passwd</strong>=PASSWD
  751. </dt>
  752. <dd>
  753. <p>
  754. Set HTTP password. This affects all URLs.
  755. </p>
  756. </dd>
  757. <dt class="hdlist1">
  758. <strong>--http-proxy</strong>=PROXY
  759. </dt>
  760. <dd>
  761. <p>
  762. Use this proxy server for HTTP. See also <strong>--all-proxy</strong> option.
  763. This affects all URLs.
  764. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  765. </p>
  766. </dd>
  767. <dt class="hdlist1">
  768. <strong>--https-proxy</strong>=PROXY
  769. </dt>
  770. <dd>
  771. <p>
  772. Use this proxy server for HTTPS. See also <strong>--all-proxy</strong> option.
  773. This affects all URLs.
  774. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  775. </p>
  776. </dd>
  777. <dt class="hdlist1">
  778. <strong>--private-key</strong>=FILE
  779. </dt>
  780. <dd>
  781. <p>
  782. Use the private key in FILE.
  783. The private key must be decrypted and in PEM format.
  784. The behavior when encrypted one is given is undefined.
  785. See also <strong>--certificate</strong> option.
  786. </p>
  787. </dd>
  788. <dt class="hdlist1">
  789. <strong>--referer</strong>=REFERER
  790. </dt>
  791. <dd>
  792. <p>
  793. Set Referer. This affects all URLs.
  794. </p>
  795. </dd>
  796. <dt class="hdlist1">
  797. <strong>--enable-http-keep-alive</strong>[=<em>true</em>|<em>false</em>]
  798. </dt>
  799. <dd>
  800. <p>
  801. Enable HTTP/1.1 persistent connection.
  802. Default: <em>true</em>
  803. </p>
  804. </dd>
  805. <dt class="hdlist1">
  806. <strong>--enable-http-pipelining</strong>[=<em>true</em>|<em>false</em>]
  807. </dt>
  808. <dd>
  809. <p>
  810. Enable HTTP/1.1 pipelining.
  811. Default: <em>false</em>
  812. </p>
  813. </dd>
  814. <dt class="hdlist1">
  815. <strong>--header</strong>=HEADER
  816. </dt>
  817. <dd>
  818. <p>
  819. Append HEADER to HTTP request header.
  820. You can use this option repeatedly to specify more than one header:
  821. aria2c <strong>--header</strong>="X-A: b78" <strong>--header</strong>="X-B: 9J1" "http://host/file"
  822. </p>
  823. </dd>
  824. <dt class="hdlist1">
  825. <strong>--load-cookies</strong>=FILE
  826. </dt>
  827. <dd>
  828. <p>
  829. Load Cookies from FILE using the Firefox3 format (SQLite3) and the
  830. Mozilla/Firefox(1.x/2.x)/Netscape format.
  831. </p>
  832. </dd>
  833. </dl></div>
  834. <div class="admonitionblock">
  835. <table><tr>
  836. <td class="icon">
  837. <div class="title">Note</div>
  838. </td>
  839. <td class="content">If aria2 is built without libsqlite3, then it doesn&#8217;t support Firefox3 cookie format.</td>
  840. </tr></table>
  841. </div>
  842. <div class="dlist"><dl>
  843. <dt class="hdlist1">
  844. <strong>--use-head</strong>[=<em>true</em>|<em>false</em>]
  845. </dt>
  846. <dd>
  847. <p>
  848. Use HEAD method for the first request to the HTTP server.
  849. Default: <em>true</em>
  850. </p>
  851. </dd>
  852. <dt class="hdlist1">
  853. <strong>-U</strong>, <strong>--user-agent</strong>=USER_AGENT
  854. </dt>
  855. <dd>
  856. <p>
  857. Set user agent for HTTP(S) downloads.
  858. </p>
  859. </dd>
  860. </dl></div>
  861. <h3 id="_ftp_specific_options">FTP Specific Options</h3><div style="clear:left"></div>
  862. <div class="dlist"><dl>
  863. <dt class="hdlist1">
  864. <strong>--ftp-user</strong>=USER
  865. </dt>
  866. <dd>
  867. <p>
  868. Set FTP user. This affects all URLs.
  869. Default: <em>anonymous</em>
  870. </p>
  871. </dd>
  872. <dt class="hdlist1">
  873. <strong>--ftp-passwd</strong>=PASSWD
  874. </dt>
  875. <dd>
  876. <p>
  877. Set FTP password. This affects all URLs.
  878. Default: <em>ARIA2USER@</em>
  879. </p>
  880. </dd>
  881. <dt class="hdlist1">
  882. <strong>-p</strong>, <strong>--ftp-pasv</strong>[=<em>true</em>|<em>false</em>]
  883. </dt>
  884. <dd>
  885. <p>
  886. Use the passive mode in FTP.
  887. If <em>false</em> is given, the active mode will be used.
  888. Default: <em>true</em>
  889. </p>
  890. </dd>
  891. <dt class="hdlist1">
  892. <strong>--ftp-proxy</strong>=PROXY
  893. </dt>
  894. <dd>
  895. <p>
  896. Use this proxy server for FTP. See also <strong>--all-proxy</strong> option.
  897. This affects all URLs.
  898. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
  899. </p>
  900. </dd>
  901. <dt class="hdlist1">
  902. <strong>--ftp-type</strong>=TYPE
  903. </dt>
  904. <dd>
  905. <p>
  906. Set FTP transfer type. TYPE is either <em>binary</em> or <em>ascii</em>.
  907. Default: <em>binary</em>
  908. </p>
  909. </dd>
  910. <dt class="hdlist1">
  911. <strong>--ftp-reuse-connection</strong>[=<em>true</em>|<em>false</em>]
  912. </dt>
  913. <dd>
  914. <p>
  915. Reuse connection in FTP.
  916. Default: <em>true</em>
  917. </p>
  918. </dd>
  919. </dl></div>
  920. <h3 id="_bittorrent_metalink_options">BitTorrent/Metalink Options</h3><div style="clear:left"></div>
  921. <div class="dlist"><dl>
  922. <dt class="hdlist1">
  923. <strong>--select-file</strong>=INDEX&#8230;
  924. </dt>
  925. <dd>
  926. <p>
  927. Set file to download by specifying its index.
  928. You can find the file index using the <strong>--show-files</strong> option.
  929. Multiple indexes can be specified by using ",", for example: <em>3,6</em>.
  930. You can also use "-" to specify a range: <em>1-5</em>.
  931. "," and "-" can be used together: <em>1-5,8,9</em>.
  932. When used with the -M option, index may vary depending on the query
  933. (see <strong>--metalink-</strong>* options).
  934. </p>
  935. </dd>
  936. </dl></div>
  937. <div class="admonitionblock">
  938. <table><tr>
  939. <td class="icon">
  940. <div class="title">Note</div>
  941. </td>
  942. <td class="content">In multi file torrent, the adjacent files specified by this option may
  943. also be downloaded. This is by design, not a bug.
  944. A single piece may include several files or part of files, and aria2
  945. writes the piece to the appropriate files.</td>
  946. </tr></table>
  947. </div>
  948. <div class="dlist"><dl>
  949. <dt class="hdlist1">
  950. <strong>-S</strong>, <strong>--show-files</strong>
  951. </dt>
  952. <dd>
  953. <p>
  954. Print file listing of .torrent or .metalink file and exit.
  955. In case of .torrent file, additional information
  956. (infohash, piece length, etc) is also printed.
  957. </p>
  958. </dd>
  959. </dl></div>
  960. <h3 id="_bittorrent_specific_options">BitTorrent Specific Options</h3><div style="clear:left"></div>
  961. <div class="dlist"><dl>
  962. <dt class="hdlist1">
  963. <strong>--bt-external-ip</strong>=IPADDRESS
  964. </dt>
  965. <dd>
  966. <p>
  967. Specify the external IP address to report to a BitTorrent
  968. tracker. Although this function is named "external", it can accept
  969. any kind of IP addresses. IPADDRESS must be a numeric IP address.
  970. </p>
  971. </dd>
  972. <dt class="hdlist1">
  973. <strong>--bt-hash-check-seed</strong>[=<em>true</em>|<em>false</em>]
  974. </dt>
  975. <dd>
  976. <p>
  977. If <em>true</em> is given, after hash check using <strong>--check-integrity</strong> option and
  978. file is complete, continue to seed file. If you want to check file
  979. and download it only when it is damaged or incomplete, set this
  980. option to <em>false</em>. This option has effect only on BitTorrent download.
  981. Default: <em>true</em>
  982. </p>
  983. </dd>
  984. <dt class="hdlist1">
  985. <strong>--bt-max-open-files</strong>=NUM
  986. </dt>
  987. <dd>
  988. <p>
  989. Specify maximum number of files to open in each BitTorrent download.
  990. Default: <em>100</em>
  991. </p>
  992. </dd>
  993. <dt class="hdlist1">
  994. <strong>--bt-max-peers</strong>=NUM
  995. </dt>
  996. <dd>
  997. <p>
  998. Specify the maximum number of peers per torrent. <em>0</em> means
  999. unlimited. See also <strong>--bt-request-peer-speed-limit</strong> option.
  1000. Default: <em>55</em>
  1001. </p>
  1002. </dd>
  1003. <dt class="hdlist1">
  1004. <strong>--bt-min-crypto-level</strong>=<em>plain</em>|<em>arc4</em>
  1005. </dt>
  1006. <dd>
  1007. <p>
  1008. Set minimum level of encryption method.
  1009. If several encryption methods are provided by a peer, aria2 chooses the lowest
  1010. one which satisfies the given level.
  1011. Default: <em>plain</em>
  1012. </p>
  1013. </dd>
  1014. <dt class="hdlist1">
  1015. <strong>--bt-require-crypto</strong>=<em>true</em>|<em>false</em>
  1016. </dt>
  1017. <dd>
  1018. <p>
  1019. If true is given, aria2 doesn&#8217;t accept and establish connection with legacy
  1020. BitTorrent handshake(\19BitTorrent protocol).
  1021. Thus aria2 always uses Obfuscation handshake.
  1022. Default: <em>false</em>
  1023. </p>
  1024. </dd>
  1025. <dt class="hdlist1">
  1026. <strong>--bt-request-peer-speed-limit</strong>=SPEED
  1027. </dt>
  1028. <dd>
  1029. <p>
  1030. If the whole download speed of every torrent is lower than SPEED,
  1031. aria2 temporarily increases the number of peers to try for more
  1032. download speed. Configuring this option with your preferred download
  1033. speed can increase your download speed in some cases.
  1034. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
  1035. Default: <em>50K</em>
  1036. </p>
  1037. </dd>
  1038. <dt class="hdlist1">
  1039. <strong>--bt-seed-unverified</strong>[=<em>true</em>|<em>false</em>]
  1040. </dt>
  1041. <dd>
  1042. <p>
  1043. Seed previously downloaded files without verifying piece hashes.
  1044. Default: <em>false</em>
  1045. </p>
  1046. </dd>
  1047. <dt class="hdlist1">
  1048. <strong>--bt-tracker-interval</strong>=SEC
  1049. </dt>
  1050. <dd>
  1051. <p>
  1052. Set the interval in seconds between tracker requests. This
  1053. completely overrides interval value and aria2 just uses this value
  1054. and ignores the min interval and interval value in the response of
  1055. tracker. If <em>0</em> is set, aria2 determines interval based on the
  1056. response of tracker and the download progress. Default: <em>0</em>
  1057. </p>
  1058. </dd>
  1059. <dt class="hdlist1">
  1060. <strong>--dht-entry-point</strong>=HOST:PORT
  1061. </dt>
  1062. <dd>
  1063. <p>
  1064. Set host and port as an entry point to DHT network.
  1065. </p>
  1066. </dd>
  1067. <dt class="hdlist1">
  1068. <strong>--dht-file-path</strong>=PATH
  1069. </dt>
  1070. <dd>
  1071. <p>
  1072. Change the DHT routing table file to PATH.
  1073. Default: <em>$HOME/.aria2/dht.dat</em>
  1074. </p>
  1075. </dd>
  1076. <dt class="hdlist1">
  1077. <strong>--dht-listen-port</strong>=PORT&#8230;
  1078. </dt>
  1079. <dd>
  1080. <p>
  1081. Set UDP listening port for DHT.
  1082. Multiple ports can be specified by using ",", for example: <em>6881,6885</em>.
  1083. You can also use "-" to specify a range: <em>6881-6999</em>. "," and "-" can be used
  1084. together.
  1085. Default: <em>6881-6999</em>
  1086. </p>
  1087. </dd>
  1088. </dl></div>
  1089. <div class="admonitionblock">
  1090. <table><tr>
  1091. <td class="icon">
  1092. <div class="title">Note</div>
  1093. </td>
  1094. <td class="content">Make sure that the specified ports are open for incoming UDP traffic.</td>
  1095. </tr></table>
  1096. </div>
  1097. <div class="dlist"><dl>
  1098. <dt class="hdlist1">
  1099. <strong>--enable-dht</strong>[=<em>true</em>|<em>false</em>]
  1100. </dt>
  1101. <dd>
  1102. <p>
  1103. Enable DHT functionality. If a private flag is set in a torrent, aria2
  1104. doesn&#8217;t use DHT for that download even if <em>true</em> is given.
  1105. Default: <em>false</em>
  1106. </p>
  1107. </dd>
  1108. <dt class="hdlist1">
  1109. <strong>--enable-peer-exchange</strong>[=<em>true</em>|<em>false</em>]
  1110. </dt>
  1111. <dd>
  1112. <p>
  1113. Enable Peer Exchange extension. If a private flag is set in a torrent, this
  1114. feature is disabled for that download even if <em>true</em> is given.
  1115. Default: <em>true</em>
  1116. </p>
  1117. </dd>
  1118. <dt class="hdlist1">
  1119. <strong>--follow-torrent</strong>=<em>true</em>|<em>false</em>|<em>mem</em>
  1120. </dt>
  1121. <dd>
  1122. <p>
  1123. If <em>true</em> or <em>mem</em> is specified, when a file whose suffix is ".torrent" or content
  1124. type is "application/x-bittorrent" is downloaded, aria2 parses it as a torrent
  1125. file and downloads files mentioned in it.
  1126. If <em>mem</em> is specified, a torrent file is not written to the disk, but is just
  1127. kept in memory.
  1128. If <em>false</em> is specified, the action mentioned above is not taken.
  1129. Default: <em>true</em>
  1130. </p>
  1131. </dd>
  1132. <dt class="hdlist1">
  1133. <strong>-O</strong>, <strong>--index-out</strong>=INDEX=PATH
  1134. </dt>
  1135. <dd>
  1136. <p>
  1137. Set file path for file with index=INDEX. You can find the file index
  1138. using the <strong>--show-files</strong> option. PATH is a relative path to the
  1139. path specified in <strong>--dir</strong> option. You can use this option multiple
  1140. times. Using this option, you can specify the output filenames of
  1141. BitTorrent downloads.
  1142. </p>
  1143. </dd>
  1144. <dt class="hdlist1">
  1145. <strong>--listen-port</strong>=PORT&#8230;
  1146. </dt>
  1147. <dd>
  1148. <p>
  1149. Set TCP port number for BitTorrent downloads.
  1150. Multiple ports can be specified by using ",", for example: <em>6881,6885</em>.
  1151. You can also use "-" to specify a range: <em>6881-6999</em>.
  1152. "," and "-" can be used together: <em>6881-6889,6999</em>.
  1153. Default: <em>6881-6999</em>
  1154. </p>
  1155. </dd>
  1156. </dl></div>
  1157. <div class="admonitionblock">
  1158. <table><tr>
  1159. <td class="icon">
  1160. <div class="title">Note</div>
  1161. </td>
  1162. <td class="content">Make sure that the specified ports are open for incoming TCP traffic.</td>
  1163. </tr></table>
  1164. </div>
  1165. <div class="dlist"><dl>
  1166. <dt class="hdlist1">
  1167. <strong>--max-overall-upload-limit</strong>=SPEED
  1168. </dt>
  1169. <dd>
  1170. <p>
  1171. Set max overall upload speed in bytes/sec.
  1172. <em>0</em> means unrestricted.
  1173. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
  1174. To limit the upload speed per torrent, use <strong>--max-upload-limit</strong> option.
  1175. Default: <em>0</em>
  1176. </p>
  1177. </dd>
  1178. <dt class="hdlist1">
  1179. <strong>-u</strong>, <strong>--max-upload-limit</strong>=SPEED
  1180. </dt>
  1181. <dd>
  1182. <p>
  1183. Set max upload speed per each torrent in bytes/sec.
  1184. <em>0</em> means unrestricted.
  1185. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
  1186. To limit the overall upload speed, use <strong>--max-overall-upload-limit</strong> option.
  1187. Default: <em>0</em>
  1188. </p>
  1189. </dd>
  1190. <dt class="hdlist1">
  1191. <strong>--peer-id-prefix</strong>=PEERI_ID_PREFIX
  1192. </dt>
  1193. <dd>
  1194. <p>
  1195. Specify the prefix of peer ID. The peer ID in BitTorrent is 20 byte length.
  1196. If more than 20 bytes are specified, only first 20 bytes are used.
  1197. If less than 20 bytes are specified, the random alphabet characters are
  1198. added to make it&#8217;s length 20 bytes.
  1199. Default: <em>-aria2-</em>
  1200. </p>
  1201. </dd>
  1202. <dt class="hdlist1">
  1203. <strong>--seed-ratio</strong>=RATIO
  1204. </dt>
  1205. <dd>
  1206. <p>
  1207. Specify share ratio. Seed completed torrents until share ratio reaches
  1208. RATIO.
  1209. You are strongly encouraged to specify equals or more than <em>1.0</em> here.
  1210. Specify <em>0.0</em> if you intend to do seeding regardless of share ratio.
  1211. If <strong>--seed-time</strong> option is specified along with this option, seeding ends when
  1212. at least one of the conditions is satisfied.
  1213. Default: <em>1.0</em>
  1214. </p>
  1215. </dd>
  1216. <dt class="hdlist1">
  1217. <strong>--seed-time</strong>=MINUTES
  1218. </dt>
  1219. <dd>
  1220. <p>
  1221. Specify seeding time in minutes. Also see the <strong>--seed-ratio</strong> option.
  1222. </p>
  1223. </dd>
  1224. <dt class="hdlist1">
  1225. <strong>-T</strong>, <strong>--torrent-file</strong>=TORRENT_FILE
  1226. </dt>
  1227. <dd>
  1228. <p>
  1229. The path to the .torrent file.
  1230. You are not required to use this option because you can specify a torrent file without -T.
  1231. </p>
  1232. </dd>
  1233. </dl></div>
  1234. <h3 id="_metalink_specific_options">Metalink Specific Options</h3><div style="clear:left"></div>
  1235. <div class="dlist"><dl>
  1236. <dt class="hdlist1">
  1237. <strong>--follow-metalink</strong>=<em>true</em>|<em>false</em>|<em>mem</em>
  1238. </dt>
  1239. <dd>
  1240. <p>
  1241. If <em>true</em> or <em>mem</em> is specified, when a file whose suffix is ".metaink" or content
  1242. type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink
  1243. file and downloads files mentioned in it.
  1244. If <em>mem</em> is specified, a metalink file is not written to the disk, but is just
  1245. kept in memory.
  1246. If <em>false</em> is specified, the action mentioned above is not taken.
  1247. Default: <em>true</em>
  1248. </p>
  1249. </dd>
  1250. <dt class="hdlist1">
  1251. <strong>-M</strong>, <strong>--metalink-file</strong>=METALINK_FILE
  1252. </dt>
  1253. <dd>
  1254. <p>
  1255. The file path to .metalink file. You are not required to use this option because you can
  1256. specify a metalink file without -M.
  1257. </p>
  1258. </dd>
  1259. <dt class="hdlist1">
  1260. <strong>-C</strong>, <strong>--metalink-servers</strong>=NUM_SERVERS
  1261. </dt>
  1262. <dd>
  1263. <p>
  1264. The number of servers to connect to simultaneously.
  1265. Some Metalinks regulate the number of servers to connect.
  1266. aria2 strictly respects them.
  1267. This means that if Metalink defines the maxconnections attribute lower
  1268. than NUM_SERVERS, then aria2 uses the value of maxconnections attribute
  1269. instead of NUM_SERVERS.
  1270. See also <strong>-s</strong> and <strong>-j</strong> options.
  1271. Default: <em>5</em>
  1272. </p>
  1273. </dd>
  1274. <dt class="hdlist1">
  1275. <strong>--metalink-language</strong>=LANGUAGE
  1276. </dt>
  1277. <dd>
  1278. <p>
  1279. The language of the file to download.
  1280. </p>
  1281. </dd>
  1282. <dt class="hdlist1">
  1283. <strong>--metalink-location</strong>=LOCATION[,&#8230;]
  1284. </dt>
  1285. <dd>
  1286. <p>
  1287. The location of the preferred server.
  1288. A comma-delimited list of locations is acceptable, for example, <em>JP,US</em>.
  1289. </p>
  1290. </dd>
  1291. <dt class="hdlist1">
  1292. <strong>--metalink-os</strong>=OS
  1293. </dt>
  1294. <dd>
  1295. <p>
  1296. The operating system of the file to download.
  1297. </p>
  1298. </dd>
  1299. <dt class="hdlist1">
  1300. <strong>--metalink-version</strong>=VERSION
  1301. </dt>
  1302. <dd>
  1303. <p>
  1304. The version of the file to download.
  1305. </p>
  1306. </dd>
  1307. <dt class="hdlist1">
  1308. <strong>--metalink-preferred-protocol</strong>=PROTO
  1309. </dt>
  1310. <dd>
  1311. <p>
  1312. Specify preferred protocol.
  1313. The possible values are <em>http</em>, <em>https</em>, <em>ftp</em> and <em>none</em>.
  1314. Specify <em>none</em> to disable this feature.
  1315. Default: <em>none</em>
  1316. </p>
  1317. </dd>
  1318. <dt class="hdlist1">
  1319. <strong>--metalink-enable-unique-protocol</strong>=<em>true</em>|<em>false</em>
  1320. </dt>
  1321. <dd>
  1322. <p>
  1323. If <em>true</em> is given and several protocols are available for a mirror in a
  1324. metalink file, aria2 uses one of them.
  1325. Use <strong>--metalink-preferred-protocol</strong> option to specify the preference of
  1326. protocol.
  1327. Default: <em>true</em>
  1328. </p>
  1329. </dd>
  1330. </dl></div>
  1331. <h3 id="_xml_rpc_options">XML-RPC Options</h3><div style="clear:left"></div>
  1332. <div class="dlist"><dl>
  1333. <dt class="hdlist1">
  1334. <strong>--enable-xml-rpc</strong>[=<em>true</em>|<em>false</em>]
  1335. </dt>
  1336. <dd>
  1337. <p>
  1338. Enable XML-RPC server. It is strongly recommended to set username
  1339. and password using <strong>--xml-rpc-user</strong> and <strong>--xml-rpc-passwd</strong>
  1340. option. See also <strong>--xml-rpc-listen-port</strong> option. Default: <em>false</em>
  1341. </p>
  1342. </dd>
  1343. <dt class="hdlist1">
  1344. <strong>--xml-rpc-listen-port</strong>=PORT
  1345. </dt>
  1346. <dd>
  1347. <p>
  1348. Specify a port number for XML-RPC server to listen to. Possible
  1349. Values: <em>1024</em>-<em>65535</em> Default: <em>6800</em>
  1350. </p>
  1351. </dd>
  1352. <dt class="hdlist1">
  1353. <strong>--xml-rpc-passwd</strong>=PASSWD
  1354. </dt>
  1355. <dd>
  1356. <p>
  1357. Set XML-RPC password.
  1358. </p>
  1359. </dd>
  1360. <dt class="hdlist1">
  1361. <strong>--xml-rpc-user</strong>=USER
  1362. </dt>
  1363. <dd>
  1364. <p>
  1365. Set XML-RPC user.
  1366. </p>
  1367. </dd>
  1368. </dl></div>
  1369. <h3 id="_advanced_options">Advanced Options</h3><div style="clear:left"></div>
  1370. <div class="dlist"><dl>
  1371. <dt class="hdlist1">
  1372. <strong>--allow-overwrite</strong>=<em>true</em>|<em>false</em>
  1373. </dt>
  1374. <dd>
  1375. <p>
  1376. If <em>false</em> is given, aria2 doesn&#8217;t download a file which already exists but
  1377. the corresponding .aria2 file doesn&#8217;t exist.
  1378. In HTTP(S)/FTP download, if <strong>--auto-file-renaming</strong>=<em>true</em> then,
  1379. file name will be renamed. See <strong>--auto-file-renaming</strong> for details.
  1380. Default: <em>false</em>
  1381. </p>
  1382. </dd>
  1383. <dt class="hdlist1">
  1384. <strong>--allow-piece-length-change</strong>=<em>true</em>|<em>false</em>
  1385. </dt>
  1386. <dd>
  1387. <p>
  1388. If false is given, aria2 aborts download when a piece length is different
  1389. from one in a control file.
  1390. If true is given, you can proceed but some download progress will be lost.
  1391. Default: <em>false</em>
  1392. </p>
  1393. </dd>
  1394. <dt class="hdlist1">
  1395. <strong>--async-dns</strong>[=<em>true</em>|<em>false</em>]
  1396. </dt>
  1397. <dd>
  1398. <p>
  1399. Enable asynchronous DNS.
  1400. Default: <em>true</em>
  1401. </p>
  1402. </dd>
  1403. <dt class="hdlist1">
  1404. <strong>--auto-file-renaming</strong>[=<em>true</em>|<em>false</em>]
  1405. </dt>
  1406. <dd>
  1407. <p>
  1408. Rename file name if the same file already exists.
  1409. This option works only in HTTP(S)/FTP download.
  1410. The new file name has a dot and a number(1..9999) appended.
  1411. Default: <em>true</em>
  1412. </p>
  1413. </dd>
  1414. <dt class="hdlist1">
  1415. <strong>--auto-save-interval</strong>=SEC
  1416. </dt>
  1417. <dd>
  1418. <p>
  1419. Save a control file(*.aria2) every SEC seconds.
  1420. If <em>0</em> is given, a control file is not saved during download. aria2 saves a
  1421. control file when it stops regardless of the value.
  1422. The possible values are between <em>0</em> to <em>600</em>.
  1423. Default: <em>60</em>
  1424. </p>
  1425. </dd>
  1426. <dt class="hdlist1">
  1427. <strong>--conf-path</strong>=PATH
  1428. </dt>
  1429. <dd>
  1430. <p>
  1431. Change the configuration file path to PATH.
  1432. Default: <em>$HOME/.aria2/aria2.conf</em>
  1433. </p>
  1434. </dd>
  1435. <dt class="hdlist1">
  1436. <strong>-D</strong>, <strong>--daemon</strong>
  1437. </dt>
  1438. <dd>
  1439. <p>
  1440. Run as daemon.
  1441. </p>
  1442. </dd>
  1443. <dt class="hdlist1">
  1444. <strong>--enable-direct-io</strong>[=<em>true</em>|<em>false</em>]
  1445. </dt>
  1446. <dd>
  1447. <p>
  1448. Enable directI/O, which lowers cpu usage while allocating/checking files.
  1449. Turn off if you encounter any error.
  1450. Default: <em>true</em>
  1451. </p>
  1452. </dd>
  1453. <dt class="hdlist1">
  1454. <strong>--event-poll</strong>=POLL
  1455. </dt>
  1456. <dd>
  1457. <p>
  1458. Specify the method for polling events. The possible Values are
  1459. <em>epoll</em> and <em>select</em>. If you use recent Linux that has epoll, then
  1460. the default value is <em>epoll</em>. Otherwise, the default value is
  1461. <em>select</em>.
  1462. </p>
  1463. </dd>
  1464. <dt class="hdlist1">
  1465. <strong>--file-allocation</strong>=METHOD
  1466. </dt>
  1467. <dd>
  1468. <p>
  1469. Specify file allocation method. METHOD is either <em>none</em> or <em>prealloc</em>.
  1470. <em>none</em> doesn&#8217;t pre-allocate file space. <em>prealloc</em> pre-allocates file space
  1471. before download begins. This may take some time depending on the size of the
  1472. file.
  1473. If you are using newer file systems such as ext4
  1474. (with extents support), btrfs or xfs, <em>falloc</em> is
  1475. your best choice. It allocates large(few GiB)
  1476. files almost instantly. Don&#8217;t use <em>falloc</em> with
  1477. legacy file systems such as ext3 because it takes
  1478. almost same time as <em>prealloc</em> and it blocks aria2
  1479. entirely until allocation finishes. <em>falloc</em> may
  1480. not be available if your system doesn&#8217;t have
  1481. <strong>posix_fallocate</strong>() function.
  1482. Default: <em>prealloc</em>
  1483. </p>
  1484. </dd>
  1485. <dt class="hdlist1">
  1486. <strong>--log-level</strong>=LEVEL
  1487. </dt>
  1488. <dd>
  1489. <p>
  1490. Set log level to output.
  1491. LEVEL is either <em>debug</em>, <em>info</em>, <em>notice</em>, <em>warn</em> or <em>error</em>.
  1492. Default: <em>debug</em>
  1493. </p>
  1494. </dd>
  1495. <dt class="hdlist1">
  1496. <strong>--summary-interval</strong>=SEC
  1497. </dt>
  1498. <dd>
  1499. <p>
  1500. Set interval in seconds to output download progress summary.
  1501. Setting <em>0</em> suppresses the output.
  1502. Default: <em>60</em>
  1503. </p>
  1504. </dd>
  1505. </dl></div>
  1506. <div class="admonitionblock">
  1507. <table><tr>
  1508. <td class="icon">
  1509. <div class="title">Note</div>
  1510. </td>
  1511. <td class="content">In multi file torrent downloads, the files adjacent forward to the specified files
  1512. are also allocated if they share the same piece.</td>
  1513. </tr></table>
  1514. </div>
  1515. <div class="dlist"><dl>
  1516. <dt class="hdlist1">
  1517. <strong>-Z</strong>, <strong>--force-sequential</strong>[=<em>true</em>|<em>false</em>]
  1518. </dt>
  1519. <dd>
  1520. <p>
  1521. Fetch URIs in the command-line sequentially and download each URI in a
  1522. separate session, like the usual command-line download utilities.
  1523. Default: <em>false</em>
  1524. </p>
  1525. </dd>
  1526. <dt class="hdlist1">
  1527. <strong>--max-overall-download-limit</strong>=SPEED
  1528. </dt>
  1529. <dd>
  1530. <p>
  1531. Set max overall download speed in bytes/sec. <em>0</em> means
  1532. unrestricted. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K). To
  1533. limit the download speed per download, use <strong>--max-download-limit</strong>
  1534. option. Default: <em>0</em>
  1535. </p>
  1536. </dd>
  1537. <dt class="hdlist1">
  1538. <strong>--max-download-limit</strong>=SPEED
  1539. </dt>
  1540. <dd>
  1541. <p>
  1542. Set max download speed per each download in bytes/sec. <em>0</em> means
  1543. unrestricted. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K). To
  1544. limit the overall download speed, use <strong>--max-overall-download-limit</strong>
  1545. option. Default: <em>0</em>
  1546. </p>
  1547. </dd>
  1548. <dt class="hdlist1">
  1549. <strong>--no-conf</strong>
  1550. </dt>
  1551. <dd>
  1552. <p>
  1553. Disable loading aria2.conf file.
  1554. </p>
  1555. </dd>
  1556. <dt class="hdlist1">
  1557. <strong>--no-file-allocation-limit</strong>=SIZE
  1558. </dt>
  1559. <dd>
  1560. <p>
  1561. No file allocation is made for files whose size is smaller than SIZE.
  1562. You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
  1563. Default: <em>5M</em>
  1564. </p>
  1565. </dd>
  1566. <dt class="hdlist1">
  1567. <strong>-P</strong>, <strong>--parameterized-uri</strong>[=<em>true</em>|<em>false</em>]
  1568. </dt>
  1569. <dd>
  1570. <p>
  1571. Enable parameterized URI support.
  1572. You can specify set of parts: <em>http://{sv1,sv2,sv3}/foo.iso</em>.
  1573. Also you can specify numeric sequences with step counter:
  1574. <em>http://host/image[000-100:2].img</em>.
  1575. A step counter can be omitted.
  1576. If all URIs do not point to the same file, such as the second example above,
  1577. -Z option is required.
  1578. Default: <em>false</em>
  1579. </p>
  1580. </dd>
  1581. <dt class="hdlist1">
  1582. <strong>-q</strong>, <strong>--quiet</strong>[=<em>true</em>|<em>false</em>]
  1583. </dt>
  1584. <dd>
  1585. <p>
  1586. Make aria2 quiet (no console output).
  1587. Default: <em>false</em>
  1588. </p>
  1589. </dd>
  1590. <dt class="hdlist1">
  1591. <strong>--realtime-chunk-checksum</strong>=<em>true</em>|<em>false</em>
  1592. </dt>
  1593. <dd>
  1594. <p>
  1595. Validate chunk of data by calculating checksum while downloading a file if
  1596. chunk checksums are provided.
  1597. Default: <em>true</em>
  1598. </p>
  1599. </dd>
  1600. <dt class="hdlist1">
  1601. <strong>--stop</strong>=SEC
  1602. </dt>
  1603. <dd>
  1604. <p>
  1605. Stop application after SEC seconds has passed.
  1606. If <em>0</em> is given, this feature is disabled.
  1607. Default: <em>0</em>
  1608. </p>
  1609. </dd>
  1610. <dt class="hdlist1">
  1611. <strong>-v</strong>, <strong>--version</strong>
  1612. </dt>
  1613. <dd>
  1614. <p>
  1615. Print the version number, copyright and the configuration information and
  1616. exit.
  1617. </p>
  1618. </dd>
  1619. </dl></div>
  1620. <h3 id="_options_that_take_an_optional_argument">Options That Take An Optional Argument</h3><div style="clear:left"></div>
  1621. <div class="paragraph"><p>The options that have its argument surrounded by square brackets([])
  1622. take an optional argument. Usually omiting the argument is evaluated to <em>true</em>.
  1623. If you use short form of these options(such as <em>-V</em>) and give
  1624. an argument, then the option name and its argument should be concatenated(e.g.
  1625. <em>-Vfalse</em>). If any spaces are inserted between the option name and the argument,
  1626. the argument will be treated as URI and usually this is not what you expect.</p></div>
  1627. <h3 id="_url_torrent_file_metalink_file">URL, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div>
  1628. <div class="paragraph"><p>You can specify multiple URLs in command-line.
  1629. Unless you specify <strong>-Z</strong> option, all URLs must point to the same file or downloading will fail.</p></div>
  1630. <div class="paragraph"><p>You can also specify arbitrary number of torrent files and metalink files
  1631. stored on a local drive. Please note that they are always treated as a
  1632. separate download.</p></div>
  1633. <div class="paragraph"><p>You can specify both torrent file with -T option and URLs. By doing this,
  1634. you can download a file from both torrent swarm and HTTP(S)/FTP server at the same time,
  1635. while the data from HTTP(S)/FTP are uploaded to the torrent swarm. Note that
  1636. only single file torrent can be integrated with HTTP(S)/FTP.</p></div>
  1637. <div class="admonitionblock">
  1638. <table><tr>
  1639. <td class="icon">
  1640. <div class="title">Note</div>
  1641. </td>
  1642. <td class="content">Make sure that URL is quoted with single(') or double(") quotation if it
  1643. contains "&amp;" or any characters that have special meaning in shell.</td>
  1644. </tr></table>
  1645. </div>
  1646. <h3 id="_resuming_download">Resuming Download</h3><div style="clear:left"></div>
  1647. <div class="paragraph"><p>Usually, you can resume transfer by just issuing same command(aria2c
  1648. URL) if the previous transfer is made by aria2.</p></div>
  1649. <div class="paragraph"><p>If the previous transfer is made by a browser or wget like sequential
  1650. download manager, then use -c option to continue the transfer(aria2c
  1651. <strong>-c</strong> URL).</p></div>
  1652. </div>
  1653. <h2 id="_exit_status">EXIT STATUS</h2>
  1654. <div class="sectionbody">
  1655. <div class="paragraph"><p>Because aria2 can handle multiple downloads at once, it encounters
  1656. lots of errors in a session. aria2 returns the following exit status
  1657. based on the last error encountered.</p></div>
  1658. <div class="dlist"><dl>
  1659. <dt class="hdlist1">
  1660. <strong>0</strong>
  1661. </dt>
  1662. <dd>
  1663. <p>
  1664. If all downloads are successful.
  1665. </p>
  1666. </dd>
  1667. <dt class="hdlist1">
  1668. <strong>1</strong>
  1669. </dt>
  1670. <dd>
  1671. <p>
  1672. If an unknown error occurs.
  1673. </p>
  1674. </dd>
  1675. <dt class="hdlist1">
  1676. <strong>2</strong>
  1677. </dt>
  1678. <dd>
  1679. <p>
  1680. If time out occurs.
  1681. </p>
  1682. </dd>
  1683. <dt class="hdlist1">
  1684. <strong>3</strong>
  1685. </dt>
  1686. <dd>
  1687. <p>
  1688. If a resource is not found.
  1689. </p>
  1690. </dd>
  1691. <dt class="hdlist1">
  1692. <strong>4</strong>
  1693. </dt>
  1694. <dd>
  1695. <p>
  1696. If aria2 sees the specfied number of "resource not found" error.
  1697. See <strong>--max-file-not-found</strong> option).
  1698. </p>
  1699. </dd>
  1700. <dt class="hdlist1">
  1701. <strong>5</strong>
  1702. </dt>
  1703. <dd>
  1704. <p>
  1705. If a download aborts because download speed is too slow.
  1706. See <strong>--lowest-speed-limit</strong> option)
  1707. </p>
  1708. </dd>
  1709. <dt class="hdlist1">
  1710. <strong>6</strong>
  1711. </dt>
  1712. <dd>
  1713. <p>
  1714. If network problem occurs.
  1715. </p>
  1716. </dd>
  1717. <dt class="hdlist1">
  1718. <strong>7</strong>
  1719. </dt>
  1720. <dd>
  1721. <p>
  1722. If there are unfinished downloads. This error is only reported if
  1723. all finished downloads are successful and there are unfinished
  1724. downloads in a queue when aria2 exits by pressing Ctrl-C by an user
  1725. or sending TERM or INT signal.
  1726. </p>
  1727. </dd>
  1728. </dl></div>
  1729. <div class="admonitionblock">
  1730. <table><tr>
  1731. <td class="icon">
  1732. <div class="title">Note</div>
  1733. </td>
  1734. <td class="content">An error occurred in a finished download will not be reported
  1735. as exit status.</td>
  1736. </tr></table>
  1737. </div>
  1738. </div>
  1739. <h2 id="_environment">ENVIRONMENT</h2>
  1740. <div class="sectionbody">
  1741. <div class="paragraph"><p>aria2 recognizes the following environment variables.</p></div>
  1742. <div class="dlist"><dl>
  1743. <dt class="hdlist1">
  1744. http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1745. </dt>
  1746. <dd>
  1747. <p>
  1748. Specify proxy server for use in HTTP.
  1749. Overrides http-proxy value in configuration file.
  1750. The command-line option <strong>--http-proxy</strong> overrides this value.
  1751. </p>
  1752. </dd>
  1753. <dt class="hdlist1">
  1754. https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1755. </dt>
  1756. <dd>
  1757. <p>
  1758. Specify proxy server for use in HTTPS.
  1759. Overrides https-proxy value in configuration file.
  1760. The command-line option <strong>--https-proxy</strong> overrides this value.
  1761. </p>
  1762. </dd>
  1763. <dt class="hdlist1">
  1764. ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1765. </dt>
  1766. <dd>
  1767. <p>
  1768. Specify proxy server for use in FTP.
  1769. Overrides ftp-proxy value in configuration file.
  1770. The command-line option <strong>--ftp-proxy</strong> overrides this value.
  1771. </p>
  1772. </dd>
  1773. <dt class="hdlist1">
  1774. all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
  1775. </dt>
  1776. <dd>
  1777. <p>
  1778. Specify proxy server for use if no protocol-specific proxy is specified.
  1779. Overrides all-proxy value in configuration file.
  1780. The command-line option <strong>--all-proxy</strong> overrides this value.
  1781. </p>
  1782. </dd>
  1783. <dt class="hdlist1">
  1784. no_proxy [DOMAIN,&#8230;]
  1785. </dt>
  1786. <dd>
  1787. <p>
  1788. Specify comma-separated hostname or domains to which proxy should not be used.
  1789. Overrides no-proxy value in configuration file.
  1790. The command-line option <strong>--no-proxy</strong> overrides this value.
  1791. </p>
  1792. </dd>
  1793. </dl></div>
  1794. </div>
  1795. <h2 id="_files">FILES</h2>
  1796. <div class="sectionbody">
  1797. <h3 id="_aria2_conf">aria2.conf</h3><div style="clear:left"></div>
  1798. <div class="paragraph"><p>By default, aria2 parses <em>$HOME/.aria2/aria2.conf</em> as a configuraiton
  1799. file. You can specify the path to configuration file using
  1800. <strong>--conf-path</strong> option. If you don&#8217;t want to use the configuraitonf
  1801. file, use <strong>--no-conf</strong> option.</p></div>
  1802. <div class="paragraph"><p>The configuration file is a text file and has 1 option per each
  1803. line. In each line, you can specify name-value pair in the format:
  1804. NAME=VALUE, where name is the long command-line option name without
  1805. "--" prefix. You can use same syntax for the command-line option. The
  1806. lines beginning "#" are treated as comments.</p></div>
  1807. <div class="listingblock">
  1808. <div class="content">
  1809. <pre><tt># sample configuration file for aria2c
  1810. listen-port=60000
  1811. dht-listen-port=60000
  1812. seed-ratio=1.0
  1813. max-upload-limit=50K
  1814. ftp-pasv=true</tt></pre>
  1815. </div></div>
  1816. <h3 id="_dht_dat">dht.dat</h3><div style="clear:left"></div>
  1817. <div class="paragraph"><p>By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.</p></div>
  1818. <h3 id="_control_file">Control File</h3><div style="clear:left"></div>
  1819. <div class="paragraph"><p>aria2 uses a control file to track the progress of a download. A
  1820. control file is placed in the same directory as the downloading file
  1821. and its filename is the filename of downloading file with ".aria2"
  1822. appended. For example, if you are downloading file.zip, then the
  1823. control file should be file.zip.aria2. (There is a exception for this
  1824. naming convention. If you are downloading a multi torrent, its
  1825. control file is the "top directory" name of the torrent with ".aria2"
  1826. appended. The "top directory" name is a value of "name" key in "info"
  1827. directory in a torrent file.)</p></div>
  1828. <div class="paragraph"><p>Usually a control file is deleted once download completed. If aria2
  1829. decides that download cannot be resumed(for example, when downloading
  1830. a file from a HTTP server which doesn&#8217;t support resume), a control
  1831. file is not created.</p></div>
  1832. <div class="paragraph"><p>Normally if you lose a control file, you cannot resume download. But
  1833. if you have a torrent or metalink with chunk checksums for the file,
  1834. you can resume the download without a control file by giving -V option
  1835. to aria2c in command-line.</p></div>
  1836. <h3 id="_input_file">Input File</h3><div style="clear:left"></div>
  1837. <div class="paragraph"><p>The input file can contain a list of URIs for aria2 to download. You
  1838. can specify multiple URIs for a single entity: separate URIs on a
  1839. single line using the TAB character.</p></div>
  1840. <div class="paragraph"><p>Each line is treated as if it is provided in command-line argument.
  1841. Therefore they are affected by <strong>-Z</strong> and <strong>-P</strong> options.</p></div>
  1842. <div class="paragraph"><p>Additionally, the following options can be specified after each line
  1843. of URIs. These optional lines must start with white space(s).</p></div>
  1844. <div class="ulist"><ul>
  1845. <li>
  1846. <p>
  1847. dir
  1848. </p>
  1849. </li>
  1850. <li>
  1851. <p>
  1852. check-integrity
  1853. </p>
  1854. </li>
  1855. <li>
  1856. <p>
  1857. continue
  1858. </p>
  1859. </li>
  1860. <li>
  1861. <p>
  1862. all-proxy
  1863. </p>
  1864. </li>
  1865. <li>
  1866. <p>
  1867. connect-timeout
  1868. </p>
  1869. </li>
  1870. <li>
  1871. <p>
  1872. dry-run
  1873. </p>
  1874. </li>
  1875. <li>
  1876. <p>
  1877. lowest-speed-limit
  1878. </p>
  1879. </li>
  1880. <li>
  1881. <p>
  1882. max-file-not-found
  1883. </p>
  1884. </li>
  1885. <li>
  1886. <p>
  1887. max-tries
  1888. </p>
  1889. </li>
  1890. <li>
  1891. <p>
  1892. no-proxy
  1893. </p>
  1894. </li>
  1895. <li>
  1896. <p>
  1897. out
  1898. </p>
  1899. </li>
  1900. <li>
  1901. <p>
  1902. proxy-method
  1903. </p>
  1904. </li>
  1905. <li>
  1906. <p>
  1907. remote-time
  1908. </p>
  1909. </li>
  1910. <li>
  1911. <p>
  1912. retry-wait
  1913. </p>
  1914. </li>
  1915. <li>
  1916. <p>
  1917. split
  1918. </p>
  1919. </li>
  1920. <li>
  1921. <p>
  1922. timeout
  1923. </p>
  1924. </li>
  1925. <li>
  1926. <p>
  1927. http-auth-challenge
  1928. </p>
  1929. </li>
  1930. <li>
  1931. <p>
  1932. http-user
  1933. </p>
  1934. </li>
  1935. <li>
  1936. <p>
  1937. http-passwd
  1938. </p>
  1939. </li>
  1940. <li>
  1941. <p>
  1942. http-proxy
  1943. </p>
  1944. </li>
  1945. <li>
  1946. <p>
  1947. https-proxy
  1948. </p>
  1949. </li>
  1950. <li>
  1951. <p>
  1952. referer
  1953. </p>
  1954. </li>
  1955. <li>
  1956. <p>
  1957. enable-http-keep-alive
  1958. </p>
  1959. </li>
  1960. <li>
  1961. <p>
  1962. enable-http-pipelining
  1963. </p>
  1964. </li>
  1965. <li>
  1966. <p>
  1967. header
  1968. </p>
  1969. </li>
  1970. <li>
  1971. <p>
  1972. use-head
  1973. </p>
  1974. </li>
  1975. <li>
  1976. <p>
  1977. user-agent
  1978. </p>
  1979. </li>
  1980. <li>
  1981. <p>
  1982. ftp-user
  1983. </p>
  1984. </li>
  1985. <li>
  1986. <p>
  1987. ftp-passwd
  1988. </p>
  1989. </li>
  1990. <li>
  1991. <p>
  1992. ftp-pasv
  1993. </p>
  1994. </li>
  1995. <li>
  1996. <p>
  1997. ftp-proxy
  1998. </p>
  1999. </li>
  2000. <li>
  2001. <p>
  2002. ftp-type
  2003. </p>
  2004. </li>
  2005. <li>
  2006. <p>
  2007. ftp-reuse-connection
  2008. </p>
  2009. </li>
  2010. <li>
  2011. <p>
  2012. no-netrc
  2013. </p>
  2014. </li>
  2015. <li>
  2016. <p>
  2017. select-file
  2018. </p>
  2019. </li>
  2020. <li>
  2021. <p>
  2022. bt-external-ip
  2023. </p>
  2024. </li>
  2025. <li>
  2026. <p>
  2027. bt-hash-check-seed
  2028. </p>
  2029. </li>
  2030. <li>
  2031. <p>
  2032. bt-max-open-files
  2033. </p>
  2034. </li>
  2035. <li>
  2036. <p>
  2037. bt-max-peers
  2038. </p>
  2039. </li>
  2040. <li>
  2041. <p>
  2042. bt-min-crypto-level
  2043. </p>
  2044. </li>
  2045. <li>
  2046. <p>
  2047. bt-require-crypto
  2048. </p>
  2049. </li>
  2050. <li>
  2051. <p>
  2052. bt-request-peer-speed-limit
  2053. </p>
  2054. </li>
  2055. <li>
  2056. <p>
  2057. bt-seed-unverified
  2058. </p>
  2059. </li>
  2060. <li>
  2061. <p>
  2062. bt-tracker-interval
  2063. </p>
  2064. </li>
  2065. <li>
  2066. <p>
  2067. enable-peer-exchange
  2068. </p>
  2069. </li>
  2070. <li>
  2071. <p>
  2072. follow-torrent
  2073. </p>
  2074. </li>
  2075. <li>
  2076. <p>
  2077. index-out
  2078. </p>
  2079. </li>
  2080. <li>
  2081. <p>
  2082. max-upload-limit
  2083. </p>
  2084. </li>
  2085. <li>
  2086. <p>
  2087. peer-id-prefix
  2088. </p>
  2089. </li>
  2090. <li>
  2091. <p>
  2092. seed-ratio
  2093. </p>
  2094. </li>
  2095. <li>
  2096. <p>
  2097. seed-time
  2098. </p>
  2099. </li>
  2100. <li>
  2101. <p>
  2102. follow-metalink
  2103. </p>
  2104. </li>
  2105. <li>
  2106. <p>
  2107. metalink-servers
  2108. </p>
  2109. </li>
  2110. <li>
  2111. <p>
  2112. metalink-language
  2113. </p>
  2114. </li>
  2115. <li>
  2116. <p>
  2117. metalink-location
  2118. </p>
  2119. </li>
  2120. <li>
  2121. <p>
  2122. metalink-os
  2123. </p>
  2124. </li>
  2125. <li>
  2126. <p>
  2127. metalink-version
  2128. </p>
  2129. </li>
  2130. <li>
  2131. <p>
  2132. metalink-preferred-protocol
  2133. </p>
  2134. </li>
  2135. <li>
  2136. <p>
  2137. metalink-enable-unique-protocol
  2138. </p>
  2139. </li>
  2140. <li>
  2141. <p>
  2142. allow-overwrite
  2143. </p>
  2144. </li>
  2145. <li>
  2146. <p>
  2147. allow-piece-length-change
  2148. </p>
  2149. </li>
  2150. <li>
  2151. <p>
  2152. async-dns
  2153. </p>
  2154. </li>
  2155. <li>
  2156. <p>
  2157. auto-file-renaming
  2158. </p>
  2159. </li>
  2160. <li>
  2161. <p>
  2162. file-allocation
  2163. </p>
  2164. </li>
  2165. <li>
  2166. <p>
  2167. max-download-limit
  2168. </p>
  2169. </li>
  2170. <li>
  2171. <p>
  2172. no-file-allocation-limit
  2173. </p>
  2174. </li>
  2175. <li>
  2176. <p>
  2177. parameterized-uri
  2178. </p>
  2179. </li>
  2180. <li>
  2181. <p>
  2182. realtime-chunk-checksum
  2183. </p>
  2184. </li>
  2185. </ul></div>
  2186. <div class="paragraph"><p>These options have exactly same meaning of the ones in the
  2187. command-line options, but it just applies to the URIs it belongs to.</p></div>
  2188. <div class="paragraph"><p>For example, the content of uri.txt is</p></div>
  2189. <div class="listingblock">
  2190. <div class="content">
  2191. <pre><tt>http://server/file.iso http://mirror/file.iso
  2192. dir=/iso_images
  2193. out=file.img
  2194. http://foo/bar</tt></pre>
  2195. </div></div>
  2196. <div class="paragraph"><p>If aria2 is executed with <strong>-i</strong> uri.txt <strong>-d</strong> /tmp options, then
  2197. <em>file.iso</em> is saved as <em>/iso_images/file.img</em> and it is downloaded
  2198. from http://server/file.iso and http://mirror/file.iso. The file
  2199. <em>bar</em> is downloaded from http://foo/bar and saved as <em>/tmp/bar</em>.</p></div>
  2200. <div class="paragraph"><p>In some cases, <strong>out</strong> parameter has no effect. See note of <strong>--out</strong>
  2201. option for the restrictions.</p></div>
  2202. <h3 id="_server_performance_profile">Server Performance Profile</h3><div style="clear:left"></div>
  2203. <div class="paragraph"><p>This section describes the format of server performance profile. The
  2204. file is plain text and each line has several NAME=VALUE pair,
  2205. delimited by comma. Currently following NAMEs are recognized:</p></div>
  2206. <div class="dlist"><dl>
  2207. <dt class="hdlist1">
  2208. host
  2209. </dt>
  2210. <dd>
  2211. <p>
  2212. Hostname of the server. Required.
  2213. </p>
  2214. </dd>
  2215. <dt class="hdlist1">
  2216. protocol
  2217. </dt>
  2218. <dd>
  2219. <p>
  2220. Protocol for this profile, such as ftp, http. Required.
  2221. </p>
  2222. </dd>
  2223. <dt class="hdlist1">
  2224. dl_speed
  2225. </dt>
  2226. <dd>
  2227. <p>
  2228. The average download speed observed in the previous download in
  2229. bytes per sec. Required.
  2230. </p>
  2231. </dd>
  2232. <dt class="hdlist1">
  2233. sc_avg_speed
  2234. </dt>
  2235. <dd>
  2236. <p>
  2237. The average download speed observed in the previous download in
  2238. bytes per sec. This value is only updated if the download is done in
  2239. single connection environment and only used by
  2240. AdaptiveURISelector. Optional.
  2241. </p>
  2242. </dd>
  2243. <dt class="hdlist1">
  2244. mc_avg_speed
  2245. </dt>
  2246. <dd>
  2247. <p>
  2248. The average download speed observed in the previous download in
  2249. bytes per sec. This value is only updated if the download is done in
  2250. multi connection environment and only used by
  2251. AdaptiveURISelector. Optional.
  2252. </p>
  2253. </dd>
  2254. <dt class="hdlist1">
  2255. counter
  2256. </dt>
  2257. <dd>
  2258. <p>
  2259. How many times the server is used. Currently this value is only used
  2260. by AdaptiveURISelector. Optional.
  2261. </p>
  2262. </dd>
  2263. <dt class="hdlist1">
  2264. last_updated
  2265. </dt>
  2266. <dd>
  2267. <p>
  2268. Last contact time in GMT with this server, specified in the seconds
  2269. from the Epoch. Required.
  2270. </p>
  2271. </dd>
  2272. <dt class="hdlist1">
  2273. status
  2274. </dt>
  2275. <dd>
  2276. <p>
  2277. ERROR is set when server cannot be reached or out-of-service or
  2278. timeout occurred. Otherwise, OK is set.
  2279. </p>
  2280. </dd>
  2281. </dl></div>
  2282. <div class="paragraph"><p>Those fields must exist in one line. The order of the fields is not
  2283. significant. You can put pairs other than the above; they are simply
  2284. ignored.</p></div>
  2285. <div class="paragraph"><p>An example follows:</p></div>
  2286. <div class="listingblock">
  2287. <div class="content">
  2288. <pre><tt>host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
  2289. host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR</tt></pre>
  2290. </div></div>
  2291. </div>
  2292. <h2 id="_example">EXAMPLE</h2>
  2293. <div class="sectionbody">
  2294. <h3 id="_http_ftp_segmented_download">HTTP/FTP Segmented Download</h3><div style="clear:left"></div>
  2295. <h4 id="_download_a_file">Download a file</h4>
  2296. <div class="listingblock">
  2297. <div class="content">
  2298. <pre><tt>aria2c "http://host/file.zip"</tt></pre>
  2299. </div></div>
  2300. <div class="admonitionblock">
  2301. <table><tr>
  2302. <td class="icon">
  2303. <div class="title">Note</div>
  2304. </td>
  2305. <td class="content">aria2 uses 5 connections to download 1 file by default.</td>
  2306. </tr></table>
  2307. </div>
  2308. <h4 id="_download_a_file_using_1_connection">Download a file using 1 connection</h4>
  2309. <div class="listingblock">
  2310. <div class="content">
  2311. <pre><tt>aria2c -s1 "http://host/file.zip"</tt></pre>
  2312. </div></div>
  2313. <div class="admonitionblock">
  2314. <table><tr>
  2315. <td class="icon">
  2316. <div class="title">Note</div>
  2317. </td>
  2318. <td class="content">aria2 uses 5 connections to download 1 file by default.
  2319. -s1 limits the number of connections to just 1.</td>
  2320. </tr></table>
  2321. </div>
  2322. <div class="admonitionblock">
  2323. <table><tr>
  2324. <td class="icon">
  2325. <div class="title">Note</div>
  2326. </td>
  2327. <td class="content">To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory. You can change URLs as long as they are pointing to the same file.</td>
  2328. </tr></table>
  2329. </div>
  2330. <h4 id="_download_a_file_from_2_different_http_servers">Download a file from 2 different HTTP servers</h4>
  2331. <div class="listingblock">
  2332. <div class="content">
  2333. <pre><tt>aria2c "http://host/file.zip" "http://mirror/file.zip"</tt></pre>
  2334. </div></div>
  2335. <h4 id="_download_a_file_from_http_and_ftp_servers">Download a file from HTTP and FTP servers</h4>
  2336. <div class="listingblock">
  2337. <div class="content">
  2338. <pre><tt>aria2c "http://host1/file.zip" "ftp://host2/file.zip"</tt></pre>
  2339. </div></div>
  2340. <h4 id="_download_files_listed_in_a_text_file_concurrently">Download files listed in a text file concurrently</h4>
  2341. <div class="listingblock">
  2342. <div class="content">
  2343. <pre><tt>aria2c -ifiles.txt -j2</tt></pre>
  2344. </div></div>
  2345. <div class="admonitionblock">
  2346. <table><tr>
  2347. <td class="icon">
  2348. <div class="title">Note</div>
  2349. </td>
  2350. <td class="content">-j option specifies the number of parallel downloads.</td>
  2351. </tr></table>
  2352. </div>
  2353. <h4 id="_using_proxy">Using proxy</h4>
  2354. <div class="paragraph"><p>For HTTP:</p></div>
  2355. <div class="listingblock">
  2356. <div class="content">
  2357. <pre><tt>aria2c --http-proxy="http://proxy:8080" "http://host/file"</tt></pre>
  2358. </div></div>
  2359. <div class="paragraph"><p>For FTP:</p></div>
  2360. <div class="listingblock">
  2361. <div class="content">
  2362. <pre><tt>aria2c --ftp-proxy="http://proxy:8080" "ftp://host/file"</tt></pre>
  2363. </div></div>
  2364. <div class="admonitionblock">
  2365. <table><tr>
  2366. <td class="icon">
  2367. <div class="title">Note</div>
  2368. </td>
  2369. <td class="content">See <strong>--http-proxy</strong>, <strong>--https-proxy</strong>, <strong>--ftp-proxy</strong> and <strong>--all-proxy</strong> for
  2370. details.
  2371. You can specify proxy in the environment variables. See <strong>ENVIRONMENT</strong> section.</td>
  2372. </tr></table>
  2373. </div>
  2374. <h4 id="_proxy_with_authorization">Proxy with authorization</h4>
  2375. <div class="listingblock">
  2376. <div class="content">
  2377. <pre><tt>aria2c --http-proxy="http://username:password@proxy:8080" "http://host/file"</tt></pre>
  2378. </div></div>
  2379. <h3 id="_metalink_download">Metalink Download</h3><div style="clear:left"></div>
  2380. <h4 id="_download_files_with_remote_metalink">Download files with remote Metalink</h4>
  2381. <div class="listingblock">
  2382. <div class="content">
  2383. <pre><tt>aria2c --follow-metalink=mem "http://host/file.metalink"</tt></pre>
  2384. </div></div>
  2385. <h4 id="_download_using_a_local_metalink_file">Download using a local metalink file</h4>
  2386. <div class="listingblock">
  2387. <div class="content">
  2388. <pre><tt>aria2c -p --lowest-speed-limit=4000 file.metalink</tt></pre>
  2389. </div></div>
  2390. <div class="admonitionblock">
  2391. <table><tr>
  2392. <td class="icon">
  2393. <div class="title">Note</div>
  2394. </td>
  2395. <td class="content">To pause a download, press Ctrl-C.
  2396. You can resume the transfer by running aria2c with the same argument in the same
  2397. directory.</td>
  2398. </tr></table>
  2399. </div>
  2400. <h4 id="_download_several_local_metalink_files">Download several local metalink files</h4>
  2401. <div class="listingblock">
  2402. <div class="content">
  2403. <pre><tt>aria2c -j2 file1.metalink file2.metalink</tt></pre>
  2404. </div></div>
  2405. <h4 id="_download_only_selected_files_using_index">Download only selected files using index</h4>
  2406. <div class="listingblock">
  2407. <div class="content">
  2408. <pre><tt>aria2c --select-file=1-4,8 file.metalink</tt></pre>
  2409. </div></div>
  2410. <div class="admonitionblock">
  2411. <table><tr>
  2412. <td class="icon">
  2413. <div class="title">Note</div>
  2414. </td>
  2415. <td class="content">The index is printed to the console using -S option.</td>
  2416. </tr></table>
  2417. </div>
  2418. <h4 id="_download_a_file_using_a_local_metalink_file_with_user_preference">Download a file using a local .metalink file with user preference</h4>
  2419. <div class="listingblock">
  2420. <div class="content">
  2421. <pre><tt>aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US file.metalink</tt></pre>
  2422. </div></div>
  2423. <h3 id="_bittorrent_download">BitTorrent Download</h3><div style="clear:left"></div>
  2424. <h4 id="_download_files_from_remote_bittorrent_file">Download files from remote BitTorrent file</h4>
  2425. <div class="listingblock">
  2426. <div class="content">
  2427. <pre><tt>aria2c --follow-torrent=mem "http://host/file.torrent"</tt></pre>
  2428. </div></div>
  2429. <h4 id="_download_using_a_local_torrent_file">Download using a local torrent file</h4>
  2430. <div class="listingblock">
  2431. <div class="content">
  2432. <pre><tt>aria2c --max-upload-limit=40K file.torrent</tt></pre>
  2433. </div></div>
  2434. <div class="admonitionblock">
  2435. <table><tr>
  2436. <td class="icon">
  2437. <div class="title">Note</div>
  2438. </td>
  2439. <td class="content">--max-upload-limit specifies the max of upload rate.</td>
  2440. </tr></table>
  2441. </div>
  2442. <div class="admonitionblock">
  2443. <table><tr>
  2444. <td class="icon">
  2445. <div class="title">Note</div>
  2446. </td>
  2447. <td class="content">To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory.</td>
  2448. </tr></table>
  2449. </div>
  2450. <h4 id="_download_2_torrents">Download 2 torrents</h4>
  2451. <div class="listingblock">
  2452. <div class="content">
  2453. <pre><tt>aria2c -j2 file1.torrent file2.torrent</tt></pre>
  2454. </div></div>
  2455. <h4 id="_download_a_file_using_torrent_and_http_ftp_server">Download a file using torrent and HTTP/FTP server</h4>
  2456. <div class="listingblock">
  2457. <div class="content">
  2458. <pre><tt>aria2c -Ttest.torrent "http://host1/file" "ftp://host2/file"</tt></pre>
  2459. </div></div>
  2460. <div class="admonitionblock">
  2461. <table><tr>
  2462. <td class="icon">
  2463. <div class="title">Note</div>
  2464. </td>
  2465. <td class="content">Downloading multi file torrent with HTTP/FTP is not supported.</td>
  2466. </tr></table>
  2467. </div>
  2468. <h4 id="_download_only_selected_files_using_index_usually_called_selectable_download">Download only selected files using index(usually called "selectable download")</h4>
  2469. <div class="listingblock">
  2470. <div class="content">
  2471. <pre><tt>aria2c --select-file=1-4,8 file.torrent</tt></pre>
  2472. </div></div>
  2473. <div class="admonitionblock">
  2474. <table><tr>
  2475. <td class="icon">
  2476. <div class="title">Note</div>
  2477. </td>
  2478. <td class="content">The index is printed to the console using -S option.</td>
  2479. </tr></table>
  2480. </div>
  2481. <h4 id="_specify_output_filename">Specify output filename</h4>
  2482. <div class="paragraph"><p>To specify output filename for BitTorrent downloads, you need to know
  2483. the index of file in torrent file using <strong>-S</strong> option. For example, the
  2484. output looks like this:</p></div>
  2485. <div class="listingblock">
  2486. <div class="content">
  2487. <pre><tt>idx|path/length
  2488. ===+======================
  2489. 1|dist/base-2.6.18.iso
  2490. |99.9MiB
  2491. ---+----------------------
  2492. 2|dist/driver-2.6.18.iso
  2493. |169.0MiB
  2494. ---+----------------------</tt></pre>
  2495. </div></div>
  2496. <div class="paragraph"><p>To save <em>dist/base-2.6.18.iso</em> in <em>/tmp/mydir/base.iso</em> and
  2497. <em>dist/driver-2.6.18.iso</em> in <em>/tmp/dir/driver.iso</em>, use the following
  2498. command:</p></div>
  2499. <div class="listingblock">
  2500. <div class="content">
  2501. <pre><tt>aria2c --dir=/tmp --index-out=1=mydir/base.iso --index-out=2=dir/driver.iso file.torrent</tt></pre>
  2502. </div></div>
  2503. <h4 id="_change_the_listening_port_for_incoming_peer">Change the listening port for incoming peer</h4>
  2504. <div class="listingblock">
  2505. <div class="content">
  2506. <pre><tt>aria2c --listen-port=7000-7001,8000 file.torrent</tt></pre>
  2507. </div></div>
  2508. <div class="admonitionblock">
  2509. <table><tr>
  2510. <td class="icon">
  2511. <div class="title">Note</div>
  2512. </td>
  2513. <td class="content">Since aria2 doesn&#8217;t configure firewall or router for port forwarding, it&#8217;s up
  2514. to you to do it manually.</td>
  2515. </tr></table>
  2516. </div>
  2517. <h4 id="_specify_the_condition_to_stop_program_after_torrent_download_finished">Specify the condition to stop program after torrent download finished</h4>
  2518. <div class="listingblock">
  2519. <div class="content">
  2520. <pre><tt>aria2c --seed-time=120 --seed-ratio=1.0 file.torrent</tt></pre>
  2521. </div></div>
  2522. <div class="admonitionblock">
  2523. <table><tr>
  2524. <td class="icon">
  2525. <div class="title">Note</div>
  2526. </td>
  2527. <td class="content">In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.</td>
  2528. </tr></table>
  2529. </div>
  2530. <h4 id="_throttle_upload_speed">Throttle upload speed</h4>
  2531. <div class="listingblock">
  2532. <div class="content">
  2533. <pre><tt>aria2c --max-upload-limit=100K file.torrent</tt></pre>
  2534. </div></div>
  2535. <h4 id="_enable_dht">Enable DHT</h4>
  2536. <div class="listingblock">
  2537. <div class="content">
  2538. <pre><tt>aria2c --enable-dht --dht-listen-port=6881 file.torrent</tt></pre>
  2539. </div></div>
  2540. <div class="admonitionblock">
  2541. <table><tr>
  2542. <td class="icon">
  2543. <div class="title">Note</div>
  2544. </td>
  2545. <td class="content">DHT uses udp port. Since aria2 doesn&#8217;t configure firewall or router for port
  2546. forwarding, it&#8217;s up to you to do it manually.</td>
  2547. </tr></table>
  2548. </div>
  2549. <h3 id="_more_advanced_http_features">More advanced HTTP features</h3><div style="clear:left"></div>
  2550. <h4 id="_load_cookies">Load cookies</h4>
  2551. <div class="listingblock">
  2552. <div class="content">
  2553. <pre><tt>aria2c --load-cookies=cookies.txt "http://host/file.zip"</tt></pre>
  2554. </div></div>
  2555. <div class="admonitionblock">
  2556. <table><tr>
  2557. <td class="icon">
  2558. <div class="title">Note</div>
  2559. </td>
  2560. <td class="content">You can use Firefox/Mozilla&#8217;s cookie file without modification.</td>
  2561. </tr></table>
  2562. </div>
  2563. <h4 id="_resume_download_started_by_web_browsers_or_another_programs">Resume download started by web browsers or another programs</h4>
  2564. <div class="listingblock">
  2565. <div class="content">
  2566. <pre><tt>aria2c -c -s2 "http://host/partiallydownloadedfile.zip"</tt></pre>
  2567. </div></div>
  2568. <h4 id="_client_certificate_authorization_for_ssl_tls">Client certificate authorization for SSL/TLS</h4>
  2569. <div class="listingblock">
  2570. <div class="content">
  2571. <pre><tt>aria2c --certificate=/path/to/mycert.pem --private-key=/path/to/mykey.pem https://host/file</tt></pre>
  2572. </div></div>
  2573. <div class="admonitionblock">
  2574. <table><tr>
  2575. <td class="icon">
  2576. <div class="title">Note</div>
  2577. </td>
  2578. <td class="content">The file specified in <strong>--private-key</strong> must be decrypted. The behavior when
  2579. encrypted one is given is undefined.</td>
  2580. </tr></table>
  2581. </div>
  2582. <h4 id="_verify_peer_in_ssl_tls_using_given_ca_certificates">Verify peer in SSL/TLS using given CA certificates</h4>
  2583. <div class="listingblock">
  2584. <div class="content">
  2585. <pre><tt>aria2c --ca-certificate=/path/to/ca-certificates.crt --check-certificate https://host/file</tt></pre>
  2586. </div></div>
  2587. <h3 id="_and_more_advanced_features">And more advanced features</h3><div style="clear:left"></div>
  2588. <h4 id="_throttle_download_speed">Throttle download speed</h4>
  2589. <div class="listingblock">
  2590. <div class="content">
  2591. <pre><tt>aria2c --max-download-limit=100K file.metalink</tt></pre>
  2592. </div></div>
  2593. <h4 id="_repair_a_damaged_download_using_v_option">Repair a damaged download using -V option</h4>
  2594. <div class="listingblock">
  2595. <div class="content">
  2596. <pre><tt>aria2c -V file.metalink</tt></pre>
  2597. </div></div>
  2598. <div class="admonitionblock">
  2599. <table><tr>
  2600. <td class="icon">
  2601. <div class="title">Note</div>
  2602. </td>
  2603. <td class="content">This option is only available used with BitTorrent or metalink with chunk
  2604. checksums.</td>
  2605. </tr></table>
  2606. </div>
  2607. <h4 id="_drop_connection_if_download_speed_is_lower_than_specified_value">Drop connection if download speed is lower than specified value</h4>
  2608. <div class="listingblock">
  2609. <div class="content">
  2610. <pre><tt>aria2c --lowest-speed-limit=10K file.metalink</tt></pre>
  2611. </div></div>
  2612. <h4 id="_parameterized_uri_support">Parameterized URI support</h4>
  2613. <div class="paragraph"><p>You can specify set of parts:</p></div>
  2614. <div class="listingblock">
  2615. <div class="content">
  2616. <pre><tt>aria2c -P "http://{host1,host2,host3}/file.iso"</tt></pre>
  2617. </div></div>
  2618. <div class="paragraph"><p>You can specify numeric sequence:</p></div>
  2619. <div class="listingblock">
  2620. <div class="content">
  2621. <pre><tt>aria2c -Z -P "http://host/image[000-100].png"</tt></pre>
  2622. </div></div>
  2623. <div class="admonitionblock">
  2624. <table><tr>
  2625. <td class="icon">
  2626. <div class="title">Note</div>
  2627. </td>
  2628. <td class="content">-Z option is required if the all URIs don&#8217;t point to the same file, such as the above example.</td>
  2629. </tr></table>
  2630. </div>
  2631. <div class="paragraph"><p>You can specify step counter:</p></div>
  2632. <div class="listingblock">
  2633. <div class="content">
  2634. <pre><tt>aria2c -Z -P "http://host/image[A-Z:2].png"</tt></pre>
  2635. </div></div>
  2636. <h4 id="_parallel_downloads_of_arbitrary_number_of_url_metalink_torrent">Parallel downloads of arbitrary number of URL,metalink,torrent</h4>
  2637. <div class="listingblock">
  2638. <div class="content">
  2639. <pre><tt>aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink</tt></pre>
  2640. </div></div>
  2641. <h4 id="_bittorrent_encryption">BitTorrent Encryption</h4>
  2642. <div class="paragraph"><p>Encrypt whole payload using ARC4:</p></div>
  2643. <div class="listingblock">
  2644. <div class="content">
  2645. <pre><tt>aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent</tt></pre>
  2646. </div></div>
  2647. </div>
  2648. <h2 id="_see_also">SEE ALSO</h2>
  2649. <div class="sectionbody">
  2650. <div class="paragraph"><p>Project Web Site: <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a></p></div>
  2651. <div class="paragraph"><p>aria2 Wiki: <a href="http://apps.sourceforge.net/trac/aria2/wiki">http://apps.sourceforge.net/trac/aria2/wiki</a></p></div>
  2652. <div class="paragraph"><p>Metalink Homepage: <a href="http://www.metalinker.org/">http://www.metalinker.org/</a></p></div>
  2653. </div>
  2654. <h2 id="_copyright">COPYRIGHT</h2>
  2655. <div class="sectionbody">
  2656. <div class="paragraph"><p>Copyright &#169; 2006, 2009 Tatsuhiro Tsujikawa</p></div>
  2657. <div class="paragraph"><p>This program is free software; you can redistribute it and/or modify
  2658. it under the terms of the GNU General Public License as published by
  2659. the Free Software Foundation; either version 2 of the License, or
  2660. (at your option) any later version.</p></div>
  2661. <div class="paragraph"><p>This program is distributed in the hope that it will be useful,
  2662. but WITHOUT ANY WARRANTY; without even the implied warranty of
  2663. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  2664. GNU General Public License for more details.</p></div>
  2665. <div class="paragraph"><p>You should have received a copy of the GNU General Public License
  2666. along with this program; if not, write to the Free Software
  2667. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</p></div>
  2668. <div class="paragraph"><p>In addition, as a special exception, the copyright holders give
  2669. permission to link the code of portions of this program with the
  2670. OpenSSL library under certain conditions as described in each
  2671. individual source file, and distribute linked combinations
  2672. including the two.
  2673. You must obey the GNU General Public License in all respects
  2674. for all of the code used other than OpenSSL. If you modify
  2675. file(s) with this exception, you may extend this exception to your
  2676. version of the file(s), but you are not obligated to do so. If you
  2677. do not wish to do so, delete this exception statement from your
  2678. version. If you delete this exception statement from all source
  2679. files in the program, then also delete it here.</p></div>
  2680. </div>
  2681. <div id="footer">
  2682. <div id="footer-text">
  2683. Last updated 2009-05-13 21:29:04 JST
  2684. </div>
  2685. </div>
  2686. </body>
  2687. </html>