From c6c3ee4daa82164bbfd57204f3f8a604ade799e7 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sat, 27 Nov 2010 21:59:38 +0900 Subject: [PATCH] Updated doc --- README.asciidoc | 29 +++++++++++++++++++++++++++-- README.html | 48 ++++++++++++++++++++++++++++++++++++------------ 2 files changed, 63 insertions(+), 14 deletions(-) diff --git a/README.asciidoc b/README.asciidoc index d25d0917..ce04c3d4 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -19,7 +19,16 @@ HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent. -Here is a list of features. +The project page is located at http://aria2.sourceforge.net/. + +See http://aria2.sourceforge.net/aria2c.1.html[aria2 Online Manual] +and http://sourceforge.net/apps/trac/aria2/wiki/UsageExample[the usage +example] to learn how to use aria2. + +Features +-------- + +Here is a list of features: * Command-line interface * Download files through HTTP(S)/FTP/BitTorrent @@ -63,6 +72,21 @@ Here is a list of features. * Parameterized URI support * IPv6 support +How to get source code +---------------------- + +We maintain the source code at Github: +http://github.com/tatsuhiro-t/aria2 + +To download the latest source code, run following command: + +------------------------------------------------ +git clone git://github.com/tatsuhiro-t/aria2.git +------------------------------------------------ + +This will create aria2 directory in your current directory and source +files are stored there. + Dependency ---------- @@ -247,7 +271,8 @@ correct permissions(600). References ---------- - * man aria2c + * http://aria2.sourceforge.net/aria2c.1.html[aria2 Online Manual] * http://aria2.sourceforge.net/ * http://sourceforge.net/apps/trac/aria2/wiki + * http://github.com/tatsuhiro-t/aria2 * http://tools.ietf.org/html/rfc5854 diff --git a/README.html b/README.html index 34cedcf6..787eea35 100644 --- a/README.html +++ b/README.html @@ -571,7 +571,14 @@ BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink’s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.

-

Here is a list of features.

+

The project page is located at http://aria2.sourceforge.net/.

+

See aria2 Online Manual +and the usage +example to learn how to use aria2.

+ +

3. Features

+
+

Here is a list of features:

  • @@ -752,7 +759,19 @@ IPv6 support

-

3. Dependency

+

4. How to get source code

+
+

We maintain the source code at Github: +http://github.com/tatsuhiro-t/aria2

+

To download the latest source code, run following command:

+
+
+
git clone git://github.com/tatsuhiro-t/aria2.git
+
+

This will create aria2 directory in your current directory and source +files are stored there.

+
+

5. Dependency

http://daniel.haxx.se/p -

4. How to build

+

6. How to build

In order to build aria2 from the source package, you need following development packages(package name may vary depending on the @@ -928,9 +947,9 @@ validation using --check-certificate=false.

$ make check
-

5. BitTorrrent

+

7. BitTorrrent

-

5.1. About filename

+

7.1. About filename

The filename of the downloaded file is determined as follows:

@@ -962,12 +981,12 @@ needed. By default, aria2 opens at most 100 files mentioned in .torrent file, and directly writes to and reads from these files. The number of files to open simultaneously can be controlled by --bt-max-open-files option.

-

5.2. DHT

+

7.2. DHT

aria2 supports mainline compatible DHT. By default, the routing table for IPv4 DHT is saved to $HOME/.aria2/dht.dat and the routing table for IPv6 DHT is saved to $HOME/.aria2/dht6.dat. aria2 uses same port number to listen on for both IPv4 and IPv6 DHT.

-

5.3. Other things should be noted

+

7.3. Other things should be noted

  • @@ -1003,7 +1022,7 @@ As of release 0.10.0, aria2 stops sending request message after

-

6. Metalink

+

8. Metalink

The current implementation supports HTTP(S)/FTP/BitTorrent. The other P2P protocols are ignored. Both Metalink4 and Metalink version 3.0 @@ -1029,18 +1048,18 @@ This is basically multi-file torrent download with file selection, so the adjacent files which is not in Metalink document but shares same piece with selected file are also created.

-

7. netrc

+

9. netrc

netrc support is enabled by default for HTTP(S)/FTP. To disable netrc support, specify -n command-line option. Your .netrc file should have correct permissions(600).

-

8. References

+

10. References