README.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  2. "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  6. <meta name="generator" content="AsciiDoc 8.2.7" />
  7. <style type="text/css">
  8. /* Debug borders */
  9. p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10. /*
  11. border: 1px solid red;
  12. */
  13. }
  14. body {
  15. margin: 1em 5% 1em 5%;
  16. }
  17. a {
  18. color: blue;
  19. text-decoration: underline;
  20. }
  21. a:visited {
  22. color: fuchsia;
  23. }
  24. em {
  25. font-style: italic;
  26. color: navy;
  27. }
  28. strong {
  29. font-weight: bold;
  30. color: #083194;
  31. }
  32. tt {
  33. color: navy;
  34. }
  35. h1, h2, h3, h4, h5, h6 {
  36. color: #527bbd;
  37. font-family: sans-serif;
  38. margin-top: 1.2em;
  39. margin-bottom: 0.5em;
  40. line-height: 1.3;
  41. }
  42. h1, h2, h3 {
  43. border-bottom: 2px solid silver;
  44. }
  45. h2 {
  46. padding-top: 0.5em;
  47. }
  48. h3 {
  49. float: left;
  50. }
  51. h3 + * {
  52. clear: left;
  53. }
  54. div.sectionbody {
  55. font-family: serif;
  56. margin-left: 0;
  57. }
  58. hr {
  59. border: 1px solid silver;
  60. }
  61. p {
  62. margin-top: 0.5em;
  63. margin-bottom: 0.5em;
  64. }
  65. ul, ol, li > p {
  66. margin-top: 0;
  67. }
  68. pre {
  69. padding: 0;
  70. margin: 0;
  71. }
  72. span#author {
  73. color: #527bbd;
  74. font-family: sans-serif;
  75. font-weight: bold;
  76. font-size: 1.1em;
  77. }
  78. span#email {
  79. }
  80. span#revision {
  81. font-family: sans-serif;
  82. }
  83. div#footer {
  84. font-family: sans-serif;
  85. font-size: small;
  86. border-top: 2px solid silver;
  87. padding-top: 0.5em;
  88. margin-top: 4.0em;
  89. }
  90. div#footer-text {
  91. float: left;
  92. padding-bottom: 0.5em;
  93. }
  94. div#footer-badges {
  95. float: right;
  96. padding-bottom: 0.5em;
  97. }
  98. div#preamble,
  99. div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
  100. div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
  101. div.admonitionblock {
  102. margin-right: 10%;
  103. margin-top: 1.5em;
  104. margin-bottom: 1.5em;
  105. }
  106. div.admonitionblock {
  107. margin-top: 2.5em;
  108. margin-bottom: 2.5em;
  109. }
  110. div.content { /* Block element content. */
  111. padding: 0;
  112. }
  113. /* Block element titles. */
  114. div.title, caption.title {
  115. color: #527bbd;
  116. font-family: sans-serif;
  117. font-weight: bold;
  118. text-align: left;
  119. margin-top: 1.0em;
  120. margin-bottom: 0.5em;
  121. }
  122. div.title + * {
  123. margin-top: 0;
  124. }
  125. td div.title:first-child {
  126. margin-top: 0.0em;
  127. }
  128. div.content div.title:first-child {
  129. margin-top: 0.0em;
  130. }
  131. div.content + div.title {
  132. margin-top: 0.0em;
  133. }
  134. div.sidebarblock > div.content {
  135. background: #ffffee;
  136. border: 1px solid silver;
  137. padding: 0.5em;
  138. }
  139. div.listingblock {
  140. margin-right: 0%;
  141. }
  142. div.listingblock > div.content {
  143. border: 1px solid silver;
  144. background: #f4f4f4;
  145. padding: 0.5em;
  146. }
  147. div.quoteblock {
  148. padding-left: 2.0em;
  149. }
  150. div.quoteblock > div.attribution {
  151. padding-top: 0.5em;
  152. text-align: right;
  153. }
  154. div.verseblock {
  155. padding-left: 2.0em;
  156. }
  157. div.verseblock > div.content {
  158. white-space: pre;
  159. }
  160. div.verseblock > div.attribution {
  161. padding-top: 0.75em;
  162. text-align: left;
  163. }
  164. /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
  165. div.verseblock + div.attribution {
  166. text-align: left;
  167. }
  168. div.admonitionblock .icon {
  169. vertical-align: top;
  170. font-size: 1.1em;
  171. font-weight: bold;
  172. text-decoration: underline;
  173. color: #527bbd;
  174. padding-right: 0.5em;
  175. }
  176. div.admonitionblock td.content {
  177. padding-left: 0.5em;
  178. border-left: 2px solid silver;
  179. }
  180. div.exampleblock > div.content {
  181. border-left: 2px solid silver;
  182. padding: 0.5em;
  183. }
  184. div.imageblock div.content { padding-left: 0; }
  185. div.imageblock img { border: 1px solid silver; }
  186. span.image img { border-style: none; }
  187. dl {
  188. margin-top: 0.8em;
  189. margin-bottom: 0.8em;
  190. }
  191. dt {
  192. margin-top: 0.5em;
  193. margin-bottom: 0;
  194. font-style: normal;
  195. }
  196. dd > *:first-child {
  197. margin-top: 0.1em;
  198. }
  199. ul, ol {
  200. list-style-position: outside;
  201. }
  202. div.olist > ol {
  203. list-style-type: decimal;
  204. }
  205. div.olist2 > ol {
  206. list-style-type: lower-alpha;
  207. }
  208. div.tableblock > table {
  209. border: 3px solid #527bbd;
  210. }
  211. thead {
  212. font-family: sans-serif;
  213. font-weight: bold;
  214. }
  215. tfoot {
  216. font-weight: bold;
  217. }
  218. div.hlist {
  219. margin-top: 0.8em;
  220. margin-bottom: 0.8em;
  221. }
  222. div.hlist td {
  223. padding-bottom: 15px;
  224. }
  225. td.hlist1 {
  226. vertical-align: top;
  227. font-style: normal;
  228. padding-right: 0.8em;
  229. }
  230. td.hlist2 {
  231. vertical-align: top;
  232. }
  233. @media print {
  234. div#footer-badges { display: none; }
  235. }
  236. div#toctitle {
  237. color: #527bbd;
  238. font-family: sans-serif;
  239. font-size: 1.1em;
  240. font-weight: bold;
  241. margin-top: 1.0em;
  242. margin-bottom: 0.1em;
  243. }
  244. div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  245. margin-top: 0;
  246. margin-bottom: 0;
  247. }
  248. div.toclevel2 {
  249. margin-left: 2em;
  250. font-size: 0.9em;
  251. }
  252. div.toclevel3 {
  253. margin-left: 4em;
  254. font-size: 0.9em;
  255. }
  256. div.toclevel4 {
  257. margin-left: 6em;
  258. font-size: 0.9em;
  259. }
  260. /* Workarounds for IE6's broken and incomplete CSS2. */
  261. div.sidebar-content {
  262. background: #ffffee;
  263. border: 1px solid silver;
  264. padding: 0.5em;
  265. }
  266. div.sidebar-title, div.image-title {
  267. color: #527bbd;
  268. font-family: sans-serif;
  269. font-weight: bold;
  270. margin-top: 0.0em;
  271. margin-bottom: 0.5em;
  272. }
  273. div.listingblock div.content {
  274. border: 1px solid silver;
  275. background: #f4f4f4;
  276. padding: 0.5em;
  277. }
  278. div.quoteblock-attribution {
  279. padding-top: 0.5em;
  280. text-align: right;
  281. }
  282. div.verseblock-content {
  283. white-space: pre;
  284. }
  285. div.verseblock-attribution {
  286. padding-top: 0.75em;
  287. text-align: left;
  288. }
  289. div.exampleblock-content {
  290. border-left: 2px solid silver;
  291. padding-left: 0.5em;
  292. }
  293. /* IE6 sets dynamically generated links as visited. */
  294. div#toc a:visited { color: blue; }
  295. /* Because IE6 child selector is broken. */
  296. div.olist2 ol {
  297. list-style-type: lower-alpha;
  298. }
  299. div.olist2 div.olist ol {
  300. list-style-type: decimal;
  301. }
  302. </style>
  303. <title>aria2 - The ultra fast download utility</title>
  304. </head>
  305. <body>
  306. <div id="header">
  307. <h1>aria2 - The ultra fast download utility</h1>
  308. <span id="author">Tatsuhiro Tsujikawa</span><br />
  309. <span id="email"><tt>&lt;<a href="mailto:tujikawa_at_users_dot_sourceforge_dot_net">tujikawa_at_users_dot_sourceforge_dot_net</a>&gt;</tt></span><br />
  310. </div>
  311. <h2 id="_disclaimer">1. Disclaimer</h2>
  312. <div class="sectionbody">
  313. <div class="para"><p>This program comes with no warranty.
  314. You must use this program at your own risk.</p></div>
  315. </div>
  316. <h2 id="_introduction">2. Introduction</h2>
  317. <div class="sectionbody">
  318. <div class="para"><p>aria2 is a utility for downloading files. The supported protocols are HTTP(S),
  319. FTP, BitTorrent, and Metalink.
  320. It can download a file from multiple sources/protocols and tries to utilize
  321. your maximum download bandwidth.
  322. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same
  323. time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent
  324. swarm.
  325. Using Metalink's chunk checksums, aria2 automatically validates chunks of data
  326. while downloading a file like BitTorrent.</p></div>
  327. <div class="para"><p>Here is a list of features.</p></div>
  328. <div class="ilist"><ul>
  329. <li>
  330. <p>
  331. Command-line interface
  332. </p>
  333. </li>
  334. <li>
  335. <p>
  336. Download files through HTTP(S)/FTP/BitTorrent
  337. </p>
  338. </li>
  339. <li>
  340. <p>
  341. Segmented downloading
  342. </p>
  343. </li>
  344. <li>
  345. <p>
  346. Metalink version 3.0 support(HTTP/FTP/BitTorrent)
  347. </p>
  348. </li>
  349. <li>
  350. <p>
  351. HTTP/1.1 implementation
  352. </p>
  353. </li>
  354. <li>
  355. <p>
  356. HTTP Proxy support
  357. </p>
  358. </li>
  359. <li>
  360. <p>
  361. HTTP BASIC authentication support
  362. </p>
  363. </li>
  364. <li>
  365. <p>
  366. HTTP Proxy authentication support
  367. </p>
  368. </li>
  369. <li>
  370. <p>
  371. HTTP gzip, deflate content encoding support
  372. </p>
  373. </li>
  374. <li>
  375. <p>
  376. Chunked transfer encoding support
  377. </p>
  378. </li>
  379. <li>
  380. <p>
  381. Load Cookies from file using the Firefox3 format and the Mozilla/Firefox
  382. (1.x/2.x)/Netscape format.
  383. </p>
  384. </li>
  385. <li>
  386. <p>
  387. Custom HTTP Header support
  388. </p>
  389. </li>
  390. <li>
  391. <p>
  392. Persistent Connections support
  393. </p>
  394. </li>
  395. <li>
  396. <p>
  397. FTP through HTTP Proxy
  398. </p>
  399. </li>
  400. <li>
  401. <p>
  402. Download/Upload speed throttling
  403. </p>
  404. </li>
  405. <li>
  406. <p>
  407. BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
  408. </p>
  409. </li>
  410. <li>
  411. <p>
  412. Run as a daemon process.
  413. </p>
  414. </li>
  415. <li>
  416. <p>
  417. Selective download in multi-file torrent/Metalink
  418. </p>
  419. </li>
  420. <li>
  421. <p>
  422. Chunk checksum validation in Metalink
  423. </p>
  424. </li>
  425. <li>
  426. <p>
  427. Can disable segmented downloading in Metalink
  428. </p>
  429. </li>
  430. <li>
  431. <p>
  432. Netrc support
  433. </p>
  434. </li>
  435. <li>
  436. <p>
  437. Configuration file support
  438. </p>
  439. </li>
  440. <li>
  441. <p>
  442. Download URIs found in a text file or stdin
  443. </p>
  444. </li>
  445. <li>
  446. <p>
  447. Parameterized URI support
  448. </p>
  449. </li>
  450. </ul></div>
  451. </div>
  452. <h2 id="_dependency">3. Dependency</h2>
  453. <div class="sectionbody">
  454. <div class="tableblock">
  455. <table rules="all"
  456. frame="border"
  457. cellspacing="0" cellpadding="4">
  458. <caption class="title">Table: External Library Dependency</caption>
  459. <col width="240" />
  460. <col width="320" />
  461. <thead>
  462. <tr>
  463. <th align="left">
  464. features
  465. </th>
  466. <th align="left">
  467. dependency
  468. </th>
  469. </tr>
  470. </thead>
  471. <tbody valign="top">
  472. <tr>
  473. <td align="left">
  474. HTTPS
  475. </td>
  476. <td align="left">
  477. GnuTLS or OpenSSL
  478. </td>
  479. </tr>
  480. <tr>
  481. <td align="left">
  482. BitTorrent
  483. </td>
  484. <td align="left">
  485. GnuTLS+Libgcrypt or OpenSSL
  486. </td>
  487. </tr>
  488. <tr>
  489. <td align="left">
  490. Metalink
  491. </td>
  492. <td align="left">
  493. libxml2 or Expat.
  494. </td>
  495. </tr>
  496. <tr>
  497. <td align="left">
  498. Checksum
  499. </td>
  500. <td align="left">
  501. GnuTLS+Libgcrypt or OpenSSL
  502. </td>
  503. </tr>
  504. <tr>
  505. <td align="left">
  506. gzip, deflate in HTTP
  507. </td>
  508. <td align="left">
  509. zlib
  510. </td>
  511. </tr>
  512. <tr>
  513. <td align="left">
  514. Firefox3 cookie
  515. </td>
  516. <td align="left">
  517. libsqlite3
  518. </td>
  519. </tr>
  520. </tbody>
  521. </table>
  522. </div>
  523. <div class="vlist"><dl>
  524. <dt>
  525. Note
  526. </dt>
  527. <dd>
  528. <p>
  529. GNU TLS has precedence over OpenSSL if both libraries are installed.
  530. If you prefer OpenSSL, run configure with "&#8212;without-gnutls".
  531. </p>
  532. </dd>
  533. <dt>
  534. Note
  535. </dt>
  536. <dd>
  537. <p>
  538. libxml2 has precedence over Expat if both libraries are installed.
  539. If you prefer Expat, run configure with "&#8212;without-libxml2".
  540. </p>
  541. </dd>
  542. </dl></div>
  543. <div class="para"><p>You can disable BitTorrent, Metalink support by providing &#8212;disable-bittorrent,
  544. &#8212;disable-metalink respectively to configure script.</p></div>
  545. <div class="para"><p>In order to enable async DNS support, you need c-ares or ares.</p></div>
  546. <div class="ilist"><ul>
  547. <li>
  548. <p>
  549. c-ares: <a href="http://daniel.haxx.se/projects/c-ares/">http://daniel.haxx.se/projects/c-ares/</a>
  550. </p>
  551. </li>
  552. <li>
  553. <p>
  554. ares: <a href="ftp://athena-dist.mit.edu/pub/ATHENA/ares">ftp://athena-dist.mit.edu/pub/ATHENA/ares</a>
  555. </p>
  556. </li>
  557. </ul></div>
  558. </div>
  559. <h2 id="_how_to_build">4. How to build</h2>
  560. <div class="sectionbody">
  561. <div class="para"><p>In order to build aria2 from the source package, you need following development
  562. packages(package name may vary depending on the distribution you use):</p></div>
  563. <div class="ilist"><ul>
  564. <li>
  565. <p>
  566. libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
  567. </p>
  568. </li>
  569. <li>
  570. <p>
  571. libgpg-error-dev (Required for BitTorrent, Checksum support)
  572. </p>
  573. </li>
  574. <li>
  575. <p>
  576. libgcrypt-dev (Required for BitTorrent, Checksum support)
  577. </p>
  578. </li>
  579. <li>
  580. <p>
  581. libares-dev (Required for async DNS support)
  582. </p>
  583. </li>
  584. <li>
  585. <p>
  586. libxml2-dev (Required for Metalink support)
  587. </p>
  588. </li>
  589. <li>
  590. <p>
  591. libz1g-dev (Required for gzip, deflate decoding support in HTTP)
  592. </p>
  593. </li>
  594. <li>
  595. <p>
  596. libsqlite3-dev (Required for Firefox3 cookie support)
  597. </p>
  598. </li>
  599. </ul></div>
  600. <div class="para"><p>You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
  601. <div class="ilist"><ul>
  602. <li>
  603. <p>
  604. libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
  605. </p>
  606. </li>
  607. </ul></div>
  608. <div class="para"><p>You can use libexpat1-dev instead of libxml2-dev:</p></div>
  609. <div class="ilist"><ul>
  610. <li>
  611. <p>
  612. libexpat1-dev (Required for Metalink support)
  613. </p>
  614. </li>
  615. </ul></div>
  616. <div class="para"><p>The build process is fairly standard way for *nix programs:</p></div>
  617. <div class="listingblock">
  618. <div class="content">
  619. <pre><tt>$ ./configure
  620. $ make</tt></pre>
  621. </div></div>
  622. <div class="para"><p>The executable is aria2c in src directory.</p></div>
  623. <div class="para"><p>aria2 uses CppUnit for automated unit testing. To run run the unit test:</p></div>
  624. <div class="listingblock">
  625. <div class="content">
  626. <pre><tt>$ make check</tt></pre>
  627. </div></div>
  628. </div>
  629. <h2 id="_bittorrrent">5. BitTorrrent</h2>
  630. <div class="sectionbody">
  631. <h3 id="_about_filename">5.1. About filename</h3><div style="clear:left"></div>
  632. <div class="para"><p>The filename of the downloaded file is determined as follows:</p></div>
  633. <div class="vlist"><dl>
  634. <dt>
  635. single-file mode
  636. </dt>
  637. <dd>
  638. <p>
  639. If "name" key is present in .torrent file, filename is the value of "name"
  640. key. Otherwise, filename is the basename of .torrent file appended by
  641. ".file". For example, .torrent file is "test.torrrent", then filename is
  642. "test.torrent.file".
  643. The directory to store the downloaded file can be specified by -d option.
  644. </p>
  645. </dd>
  646. <dt>
  647. multi-file mode
  648. </dt>
  649. <dd>
  650. <p>
  651. The complete directory/file structure mentioned in .torrent file is
  652. created.
  653. The directory to store the top directory of downloaded files can be
  654. specified by -d option.
  655. </p>
  656. </dd>
  657. </dl></div>
  658. <div class="para"><p>In the default behavior, before download starts, complete directory structure
  659. is created if needed. By default, aria2 opens at most 100 files mentioned in
  660. .torrent file, directly writes to and reads from these files. The number of
  661. files to open can be controlled by "&#8212;bt-max-open-files" option.</p></div>
  662. <div class="para"><p>If "&#8212;direct-file-mapping" option set to be false, aria2 creates temporary
  663. file in the store directory. The length of this file is the sum of length of
  664. the files in .torrent file, so at least 2 times more disk space than the file
  665. size itself is required. Writing and reading is done against this file.
  666. After download completes, aria2 creates complete directory structure if needed,
  667. and copies whole file or a part of it to the destination.</p></div>
  668. <h3 id="_dht">5.2. DHT</h3><div style="clear:left"></div>
  669. <div class="para"><p>As of release 0.13.0, aria2 supports DHT. By default, the routing table is saved
  670. to $HOME/.aria2/dht.dat.</p></div>
  671. <h3 id="_other_things_should_be_noted">5.3. Other things should be noted</h3><div style="clear:left"></div>
  672. <div class="ilist"><ul>
  673. <li>
  674. <p>
  675. -o option is used to change the filename of .torrent file itself, not a
  676. filename of a file in .torrent file.
  677. </p>
  678. </li>
  679. <li>
  680. <p>
  681. The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP.
  682. </p>
  683. </li>
  684. <li>
  685. <p>
  686. aria2 doesn't configure port-forwarding automatically. Please configure your
  687. router or firewall manually.
  688. </p>
  689. </li>
  690. <li>
  691. <p>
  692. The maximum number of peers is 55. This limit may be exceeded when download
  693. rate is low.
  694. </p>
  695. </li>
  696. <li>
  697. <p>
  698. As of release 0.10.0, aria2 stops sending request message after selective
  699. download completes,
  700. </p>
  701. </li>
  702. </ul></div>
  703. </div>
  704. <h2 id="_metalink">6. Metalink</h2>
  705. <div class="sectionbody">
  706. <div class="para"><p>The current implementation supports HTTP/FTP/BitTorrent.
  707. The other P2P protocols are ignored.</p></div>
  708. <div class="para"><p>For checksum checking, MD5, SHA1, SHA256 are supported. If multiple hash
  709. algorithms are provided, aria2 uses SHA1. If checksum checking is failed, aria2
  710. doesn't retry the download and just exits with non-zero return code.</p></div>
  711. <div class="para"><p>The supported user preferences are version, language, location, protocol and
  712. os.</p></div>
  713. <div class="para"><p>If chunk checksums are provided in Metalink file, aria2 automatically validate
  714. a chunk of file while downloading it. This behavior can be turned off by
  715. a command-line option.</p></div>
  716. <div class="para"><p>If signature is included in a Metalink file, aria2 saves it as a file after the
  717. download completed.
  718. The filename is download filename + ".sig". If same file already exists, the
  719. signature file is not saved.</p></div>
  720. </div>
  721. <h2 id="_netrc">7. netrc</h2>
  722. <div class="sectionbody">
  723. <div class="para"><p>netrc support is enabled by default for HTTP(S)/FTP.
  724. To disable netrc support, specify -n command-line option.
  725. Your .netrc file should have correct permissions(600).</p></div>
  726. </div>
  727. <h2 id="_server_performance_profile">8. SERVER PERFORMANCE PROFILE</h2>
  728. <div class="sectionbody">
  729. <div class="para"><p>This section describes the format of server performance profile.
  730. The file is plain text and each line has several NAME=VALUE pair, delimited by
  731. comma.
  732. Currently following NAMEs are recognized:</p></div>
  733. <div class="vlist"><dl>
  734. <dt>
  735. host
  736. </dt>
  737. <dd>
  738. <p>
  739. Hostname of the server. Required.
  740. </p>
  741. </dd>
  742. <dt>
  743. protocol
  744. </dt>
  745. <dd>
  746. <p>
  747. Protocol for this profile, such as ftp, http. Required.
  748. </p>
  749. </dd>
  750. <dt>
  751. dl_speed
  752. </dt>
  753. <dd>
  754. <p>
  755. The average download speed observed in the previous download in bytes per sec.
  756. Required.
  757. </p>
  758. </dd>
  759. <dt>
  760. last_updated
  761. </dt>
  762. <dd>
  763. <p>
  764. Last contact time in GMT with this server, specified in the seconds from the
  765. Epoch. Required.
  766. </p>
  767. </dd>
  768. <dt>
  769. status
  770. </dt>
  771. <dd>
  772. <p>
  773. ERROR is set when server cannot be reached or out-of-service or timeout
  774. occurred. Otherwise, OK is set.
  775. </p>
  776. </dd>
  777. </dl></div>
  778. <div class="para"><p>Those fields must exist in one line. The order of the fields is not significant.
  779. You can put pairs other than above; they are simply ignored.</p></div>
  780. <div class="para"><p>An example is follow:</p></div>
  781. <div class="listingblock">
  782. <div class="content">
  783. <pre><tt>host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
  784. host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR</tt></pre>
  785. </div></div>
  786. </div>
  787. <h2 id="_configuration_file">9. Configuration file</h2>
  788. <div class="sectionbody">
  789. <div class="para"><p>Configuration file must be placed under $HOME/.aria2 and must be named as
  790. aria2.conf.
  791. In each line, there is 1 parameter whose syntax is name=value pair,
  792. where name is the long command-line option name without <em>&#8212;</em> prefix.
  793. The lines beginning <em>#</em> are treated as comments.</p></div>
  794. <div class="para"><p>Example:</p></div>
  795. <div class="listingblock">
  796. <div class="content">
  797. <pre><tt># sample configuration file for aria2c
  798. file-allocation=prealloc
  799. listen-port=60000
  800. seed-ratio=1.0
  801. max-upload-limit=40K
  802. ftp-pasv=true</tt></pre>
  803. </div></div>
  804. </div>
  805. <div id="footer">
  806. <div id="footer-text">
  807. Last updated 2008-10-13 23:00:33 JST
  808. </div>
  809. </div>
  810. </body>
  811. </html>