aria2c.1 60 KB

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