README.html 18 KB

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