diff --git a/ChangeLog b/ChangeLog index 9e13cc86..af8e9798 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2008-02-26 Tatsuhiro Tsujikawa + + Updated README. Added html version of README and man page. + * README + * README.html + * readme2html: Shell script to generate README.html from README using + asciidoc. + * doc/aria2c.1.html + * doc/makeman: Added the line to generate aria2c.1.html + 2008-02-24 Tatsuhiro Tsujikawa Fixed offset calculation. diff --git a/README b/README index c63b55e7..51f4b984 100644 --- a/README +++ b/README @@ -1,27 +1,29 @@ aria2 - The ultra fast download utility +======================================= +:Author: Tatsuhiro Tsujikawa +:Email: tujikawa_at_users_dot_sourceforge_dot_net -1. Disclaimer -------------- +Disclaimer +---------- This program comes with no warranty. You must use this program at your own risk. -2. About aria2 --------------- -aria2 has segmented downloading engine in its core. By segmented downloading, -it can download files very much faster than ordinary browsers. +Introduction +------------ +aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum. 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's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent. + +Here is a list of features. -aria2 is in very early development stage. Currently it has following features: -* HTTP/HTTPS GET support * HTTP Proxy support * HTTP BASIC authentication support * HTTP Proxy authentication support * FTP support(active, passive mode) * FTP through HTTP proxy(GET command or tunneling) -* Segmented download +* Multi-source/segmented downloading ability * Cookie support * It can load cookies from file whose format is used by Netscape and Mozilla. * It can run as a daemon process. -* BitTorrent protocol support with fast extension. +* BitTorrent protocol support with fast extension, DHT, encryption, PEX enabled. * Selective download in multi-file torrent/metalink. * Metalink version 3.0 support(HTTP/FTP/BitTorrent). * Limits download/upload speed. @@ -32,13 +34,19 @@ aria2 is in very early development stage. Currently it has following features: * Integrates HTTP/FTP/BitTorrent downloads; downloading a file from several different sources. -3. Dependency -------------- -In order to enable HTTPS support, you need GNU TLS or OpenSSL. -In order to enable BitTorrent support, you need GNU TLS+libgcrypt or OpenSSL. -In order to enable Metalink support, you need libxml2 or Expat. Optionally -GNU TLS+libgcrypt or OpenSSL are required for checksum checking support(MD5, -SHA1, SHA256). +Dependency +---------- + +.External Library Dependency +[frame="all", grid="all"] +`---------`--------------------------- +features dependency +-------------------------------------- +HTTPS GnuTLS or OpenSSL +BitTorrent GnuTLS+Libgcrypt or OpenSSL +Metalink libxml2 or Expat. +Checksum GnuTLS+Libgcrypt or OpenSSL +-------------------------------------- Note;; GNU TLS has precedence over OpenSSL if both libraries are installed. @@ -52,44 +60,52 @@ You can disable BitTorrent, Metalink support by providing --disable-bittorrent, --disable-metalink respectively to configure script. In order to enable async DNS support, you need c-ares or ares. -c-ares: http://daniel.haxx.se/projects/c-ares/ -ares: ftp://athena-dist.mit.edu/pub/ATHENA/ares -4. How to build ---------------- +* c-ares: http://daniel.haxx.se/projects/c-ares/ +* ares: ftp://athena-dist.mit.edu/pub/ATHENA/ares + +How to build +------------ In order to build aria2 from the source package, you need following development packages(package name may vary depending on the distribution you use): -* libgnutls-dev (Required for HTTPS, BitTorrent support) -* libgpg-error-dev (Required for BitTorrent support) -* libgcrypt-dev (Required for BitTorrent support) +* libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support) +* libgpg-error-dev (Required for BitTorrent, Checksum support) +* libgcrypt-dev (Required for BitTorrent, Checksum support) * libares-dev (Required for async DNS support) * libxml2-dev (Required for Metalink support) You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev: -* libssl-dev (Required for HTTPS, BitTorrent support) + +* libssl-dev (Required for HTTPS, BitTorrent, Checksum support) You can use libexpat1-dev instead of libxml2-dev: + * libexpat1-dev (Required for Metalink support) The build process is fairly standard way for *nix programs: +------------- $ ./configure $ make +------------- The executable is aria2c in src directory. -5. BitTorrrent --------------- +BitTorrrent +----------- +About filename +~~~~~~~~~~~~~~ The filename of the downloaded file is determined as follows: -single-file mode: +single-file mode:: If "name" key is present in .torrent file, filename is the value of "name" key. Otherwise, filename is the basename of .torrent file appended by ".file". For example, .torrent file is "test.torrrent", then filename is "test.torrent.file". The directory to store the downloaded file can be specified by -d option. -multi-file mode: + +multi-file mode:: The complete directory/file structure mentioned in .torrent file is created. The directory to store the top directory of downloaded files can be @@ -107,16 +123,21 @@ size itself is required. Writing and reading is done against this file. After download completes, aria2 creates complete directory structure if needed, and copies whole file or a part of it to the destination. -Note: -* -o option is used to change the filename of downloaded .torrent file. -* The ports aria2c uses are 6881-6999. +DHT +~~~ +As of release 0.13.0, aria2 supports DHT. The routing table is saved to $HOME/.aria2/dht.dat. + +Note;; +* -o option is used to change the filename of .torrent file itself, not a filename of a file in .torrent file. +* The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP. +* aria2 doesn't configure port-forwarding automatically. Please configure your router or firewall manually. * The maximum number of peers is 55. This limit may be exceeded when download rate is low. * As of release 0.10.0, aria2 stops sending request message after selective download completes, -6. Metalink ------------ +Metalink +-------- The current implementation supports HTTP/FTP/BitTorrent. The other P2P protocols are ignored. @@ -131,24 +152,25 @@ If chunk checksums are provided in Metalink file, aria2 automatically validate a chunk of file while downloading it. This behavior can be turned off by a command-line option. -7. netrc --------- +netrc +----- netrc support is enabled by default in ftp. To disable netrc support, specify -n command-line option. Your .netrc file should have correct permissions(600). -8. Configuration file ---------------------- -Configuration file must be placed under ~/.aria2 and must be named as aria2.conf. +Configuration file +------------------ +Configuration file must be placed under $HOME/.aria2 and must be named as aria2.conf. In each line, there is 1 parameter whose syntax is name=value pair, where name is the long command-line option name without '--' prefix. The lines beginning '#' are treated as comments. Example: - +-------------------------------------- # sample configuration file for aria2c file-allocation=prealloc listen-port=60000 seed-ratio=1.0 max-upload-limit=40K ftp-pasv=true +--------------------------------------- diff --git a/README.html b/README.html new file mode 100644 index 00000000..78dd4caf --- /dev/null +++ b/README.html @@ -0,0 +1,678 @@ + + + + + + +aria2 - The ultra fast download utility + + + +

1. Disclaimer

+
+

This program comes with no warranty. +You must use this program at your own risk.

+
+

2. Introduction

+
+

aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum. 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's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.

+

Here is a list of features.

+
    +
  • +

    +HTTP Proxy support +

    +
    • +
  • +

    +HTTP BASIC authentication support +

    +
    • +
  • +

    +HTTP Proxy authentication support +

    +
    • +
  • +

    +FTP support(active, passive mode) +

    +
    • +
  • +

    +FTP through HTTP proxy(GET command or tunneling) +

    +
    • +
  • +

    +Multi-source/segmented downloading ability +

    +
    • +
  • +

    +Cookie support +

    +
    • +
  • +

    +It can load cookies from file whose format is used by Netscape and Mozilla. +

    +
    • +
  • +

    +It can run as a daemon process. +

    +
    • +
  • +

    +BitTorrent protocol support with fast extension, DHT, encryption, PEX enabled. +

    +
    • +
  • +

    +Selective download in multi-file torrent/metalink. +

    +
    • +
  • +

    +Metalink version 3.0 support(HTTP/FTP/BitTorrent). +

    +
    • +
  • +

    +Limits download/upload speed. +

    +
    • +
  • +

    +Chunk checksum validation in Metalink. +

    +
    • +
  • +

    +netrc support. +

    +
    • +
  • +

    +Configuration file support. +

    +
    • +
  • +

    +Downloads URIs found in a text file or stdin. +

    +
    • +
  • +

    +Integrates HTTP/FTP/BitTorrent downloads; downloading a file from several + different sources. +

    +
    • +
+
+

3. Dependency

+
+
+ + +++ + + + + + + + + + + + + + + + + + + + + + + + +
Table: External Library Dependency
+ features + + dependency +
+ HTTPS + + GnuTLS or OpenSSL +
+ BitTorrent + + GnuTLS+Libgcrypt or OpenSSL +
+ Metalink + + libxml2 or Expat. +
+ Checksum + + GnuTLS+Libgcrypt or OpenSSL +
+
+
+
+Note +
+
+

+ GNU TLS has precedence over OpenSSL if both libraries are installed. + If you prefer OpenSSL, run configure with "—without-gnutls". +

+
+
+Note +
+
+

+ libxml2 has precedence over Expat if both libraries are installed. + If you prefer Expat, run configure with "—without-libxml2". +

+
+
+

You can disable BitTorrent, Metalink support by providing —disable-bittorrent, +—disable-metalink respectively to configure script.

+

In order to enable async DNS support, you need c-ares or ares.

+
    +
  • +

    +c-ares: http://daniel.haxx.se/projects/c-ares/ +

    +
    • +
  • +

    +ares: ftp://athena-dist.mit.edu/pub/ATHENA/ares +

    +
    • +
+
+

4. How to build

+
+

In order to build aria2 from the source package, you need following development +packages(package name may vary depending on the distribution you use):

+
    +
  • +

    +libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support) +

    +
    • +
  • +

    +libgpg-error-dev (Required for BitTorrent, Checksum support) +

    +
    • +
  • +

    +libgcrypt-dev (Required for BitTorrent, Checksum support) +

    +
    • +
  • +

    +libares-dev (Required for async DNS support) +

    +
    • +
  • +

    +libxml2-dev (Required for Metalink support) +

    +
    • +
+

You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev:

+
    +
  • +

    +libssl-dev (Required for HTTPS, BitTorrent, Checksum support) +

    +
    • +
+

You can use libexpat1-dev instead of libxml2-dev:

+
    +
  • +

    +libexpat1-dev (Required for Metalink support) +

    +
    • +
+

The build process is fairly standard way for *nix programs:

+
+
+
$ ./configure
+$ make
+
+

The executable is aria2c in src directory.

+
+

5. BitTorrrent

+
+

5.1. About filename

+

The filename of the downloaded file is determined as follows:

+
+
+single-file mode +
+
+

+ If "name" key is present in .torrent file, filename is the value of "name" + key. Otherwise, filename is the basename of .torrent file appended by + ".file". For example, .torrent file is "test.torrrent", then filename is + "test.torrent.file". + The directory to store the downloaded file can be specified by -d option. +

+
+
+multi-file mode +
+
+

+ The complete directory/file structure mentioned in .torrent file is + created. + The directory to store the top directory of downloaded files can be + specified by -d option. +

+
+
+

In the default behavior, before download starts, complete directory structure +is created if needed. Then aria2 opens all files mentioned in .torrent file, +directly writes to and reads from these files. +NOTE: Even in selective download, all files are opened.

+

If "—direct-file-mapping" option set to be false, aria2 creates temporary +file in the store directory. The length of this file is the sum of length of +the files in .torrent file, so at least 2 times more disk space than the file +size itself is required. Writing and reading is done against this file. +After download completes, aria2 creates complete directory structure if needed, +and copies whole file or a part of it to the destination.

+

5.2. DHT

+

As of release 0.13.0, aria2 supports DHT. The routing table is saved to $HOME/.aria2/dht.dat.

+
+
+Note +
+
+
    +
  • +

    +-o option is used to change the filename of .torrent file itself, not a filename of a file in .torrent file. +

    +
    • +
  • +

    +The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP. +

    +
    • +
  • +

    +aria2 doesn't configure port-forwarding automatically. Please configure your router or firewall manually. +

    +
    • +
  • +

    +The maximum number of peers is 55. This limit may be exceeded when download +rate is low. +

    +
    • +
  • +

    +As of release 0.10.0, aria2 stops sending request message after selective + download completes, +

    +
    • +
+
+
+
+

6. Metalink

+
+

The current implementation supports HTTP/FTP/BitTorrent. +The other P2P protocols are ignored.

+

For checksum checking, MD5, SHA1, SHA256 are supported. If multiple hash +algorithms are provided, aria2 uses SHA1. If checksum checking is failed, aria2 +doesn't retry the download and just exits with non-zero return code.

+

The supported user preferences are version, language, location, protocol and +os.

+

If chunk checksums are provided in Metalink file, aria2 automatically validate +a chunk of file while downloading it. This behavior can be turned off by +a command-line option.

+
+

7. netrc

+
+

netrc support is enabled by default in ftp. +To disable netrc support, specify -n command-line option. +Your .netrc file should have correct permissions(600).

+
+

8. Configuration file

+
+

Configuration file must be placed under $HOME/.aria2 and must be named as aria2.conf. +In each line, there is 1 parameter whose syntax is name=value pair, +where name is the long command-line option name without — prefix. +The lines beginning # are treated as comments.

+

Example:

+
+
+
# sample configuration file for aria2c
+file-allocation=prealloc
+listen-port=60000
+seed-ratio=1.0
+max-upload-limit=40K
+ftp-pasv=true
+
+
+ + + diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html new file mode 100644 index 00000000..d4d51eb0 --- /dev/null +++ b/doc/aria2c.1.html @@ -0,0 +1,1467 @@ + + + + + + +ARIA2C(1) + + + +

NAME

+
+

aria2c - The ultra fast download utility

+
+

SYNOPSIS

+
+

aria2c [OPTIONS] URL …

+

aria2c [OPTIONS] -T TORRENT_FILE [URL …]

+

aria2c [OPTIONS] -M METALINK_FILE

+
+

DESCRIPTION

+
+

aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum. 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's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.

+
+

OPTIONS

+
+
+
+-d, —dir=DIR +
+
+

+ The directory to store the downloaded file. +

+
+
+-o, —out=FILE +
+
+

+ The file name of the downloaded file. +

+
+
+Note +
+
+

+ In Metalink, BitTorrent download you cannot specify file name. + The file name specified here is only used when the URLs fed to aria2 + is done by command line without -i option, like this: + aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip +

+
+
+
+
+-l, —log=LOG +
+
+

+ The file name of the log file. If - is specified, log is written to + stdout. +

+
+
+-D, —daemon +
+
+

+ Run as daemon. +

+
+
+-s, —split=N +
+
+

+ Download a file using N connections. N must be between 1 and 5. + This option affects all URLs. Thus, aria2 connects to each URL with N + connections. + Default: 1 +

+
+
+—retry-wait=SEC +
+
+

+ Set the seconds to wait to retry after an error has occured. + Specify a value between 0 and 60. + Default: 5 +

+
+
+-t, —timeout=SEC +
+
+

+ Set timeout in seconds. + Default: 60 +

+
+
+-m, —max-tries=N +
+
+

+ Set number of tries. 0 means unlimited. + Default: 5 +

+
+
+—http-proxy=HOST:PORT +
+
+

+ Use HTTP proxy server. This affects all URLs. +

+
+
+—http-user=USER +
+
+

+ Set HTTP user. This affects all URLs. +

+
+
+—http-passwd=PASSWD +
+
+

+ Set HTTP password. This affects all URLs. +

+
+
+—http-proxy-user=USER +
+
+

+ Set HTTP proxy user. This affects all URLs. +

+
+
+—http-proxy-passwd=PASSWD +
+
+

+ Set HTTP proxy password. This affects all URLs. +

+
+
+—http-proxy-method=METHOD +
+
+

+ Set the method to use in proxy request. + METHOD is either get or tunnel. + Default: tunnel +

+
+
+—http-auth-scheme=SCHEME +
+
+

+ Set HTTP authentication scheme. + Currently, basic is the only supported scheme. + Default: basic +

+
+
+—referer=REFERER +
+
+

+ Set Referer. This affects all URLs. +

+
+
+—ftp-user=USER +
+
+

+ Set FTP user. This affects all URLs. + Default: anonymous +

+
+
+—ftp-passwd=PASSWD +
+
+

+ Set FTP password. This affects all URLs. + Default: ARIA2USER@ +

+
+
+—ftp-type=TYPE +
+
+

+ Set FTP transfer type. TYPE is either binary or ascii. + Default: binary +

+
+
+-p, —ftp-pasv +
+
+

+ Use passive mode in FTP. +

+
+
+—ftp-via-http-proxy=METHOD +
+
+

+ Use HTTP proxy in FTP. METHOD is either get or tunnel. + Default: tunnel +

+
+
+—lowest-speed-limit=SPEED +
+
+

+ Close connection if download speed is lower than or equal to this + value(bytes per sec). + 0 means aria2 does not have a lowest speed limit. + You can append K or M(1K = 1024, 1M = 1024K). + This option does not affect BitTorrent downloads. + Default: 0 +

+
+
+—max-download-limit=SPEED +
+
+

+ Set max download speed in bytes per sec. 0 means unrestricted. + You can append K or M(1K = 1024, 1M = 1024K). + Default: 0 +

+
+
+—file-allocation=METHOD +
+
+

+ Specify file allocation method. METHOD is either none or prealloc. + none doesn't pre-allocate file space. prealloc pre-allocates file space + before download begins. This may take some time depending on the size of the + file. + Default: prealloc +

+
+
+Note +
+
+

+ In multi file torrent, the files adjacent forward to the specified files + are also allocated if they share a same piece. +

+
+
+
+
+—no-file-allocation-limit=SIZE +
+
+

+ No file allocation is made for files whose size is smaller than SIZE. + You can append K or M(1K = 1024, 1M = 1024K). + Default: 5M +

+
+
+—enable-direct-io[=true|false] +
+
+

+ Enable directI/O, which lowers cpu usage while allocating/checking files. + Turn off if you encounter any error. + Default: false +

+
+
+—allow-overwrite=true|false +
+
+

+ If false is given, aria2 doesn't download a file which already exists but + the corresponding .aria2 file doesn't exist. + In HTTP(S)/FTP download, if —auto-file-renaming=true then, + file name will be renamed. See —auto-file-renaming for details. + Default: false +

+
+
+—allow-piece-length-change=true|false +
+
+

+ 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: false +

+
+
+-Z, —force-sequential[=true|false] +
+
+

+ Fetch URIs in the command-line sequentially and download each URI in a + separate session, like the usual command-line download utilities. + Default: false +

+
+
+—auto-file-renaming[=true|false] +
+
+

+ 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: true +

+
+
+-P, —parameterized-uri[=true|false] +
+
+

+ Enable parameterized URI support. + You can specify set of parts: http://{sv1,sv2,sv3}/foo.iso. + Also you can specify numeric sequences with step counter: + http://host/image[000-100:2].img. + 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: false +

+
+
+—enable-http-keep-alive[=true|false] +
+
+

+ Enable HTTP/1.1 persistent connection. + Default: false +

+
+
+—enable-http-pipelining[=true|false] +
+
+

+ Enable HTTP/1.1 pipelining. + Default: false +

+
+
+—check-integrity=true|false +
+
+

+ Check file integrity by validating piece hash. + This option only affects in BitTorrent downloads and Metalink downloads with + chunk checksums. + Use this option to re-download a damaged portion of a file. + Default: false +

+
+
+—realtime-chunk-checksum=true|false +
+
+

+ Validate chunk of data by calculating checkusm while download a file if + chunk checksums are provided. Currently Metalink is the only way to to + provide chunk checksums. + Default: true +

+
+
+-c, —continue +
+
+

+ 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. +

+
+
+-U, —user-agent=USER_AGENT +
+
+

+ Set user agent for HTTP(S) downloads. +

+
+
+-n, —no-netrc +
+
+

+ Disables netrc support. netrc support is enabled by default. +

+
+
+-i, —input-file=FILE +
+
+

+ 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 - is specified. +

+
+
+-j, —max-concurrent-downloads=N +
+
+

+ Set maximum number of concurrent downloads. + It should be used with the -i option. + Default: 5 +

+
+
+—load-cookies=FILE +
+
+

+ Load cookies from FILE. + The format of FILE is the same used by Netscape and Mozilla. +

+
+
+—no-conf +
+
+

+ Disable loading aria2.conf file. +

+
+
+—conf-path=PATH +
+
+

+ Change the configuration file path to PATH. + Default: $HOME/.aria2/aria2.conf +

+
+
+—stop=SEC +
+
+

+ Stop application after SEC seconds has passed. + If 0 is given, this feature is disabled. + Default: 0 +

+
+
+-S, —show-files +
+
+

+ Print file listing of .torrent or .metalink file and exit. + In case of .torrent file, additional information + (infohash, piece length, etc) is also printed. +

+
+
+—select-file=INDEX… +
+
+

+ Set file to download by specifing its index. + You can find the file index using the —show-files option. + Multiple indexes can be specified by using ",", for example: 3,6. + You can also use "-" to specify a range: 1-5. + "," and "-" can be used together: 1-5,8,9. + When used with the -M option, index may vary depending on the query + (see —metalink-* options). +

+
+
+Note +
+
+

+ 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. +

+
+
+
+
+-T, —torrent-file=TORRENT_FILE +
+
+

+ The path to the .torrent file. +

+
+
+—follow-torrent=true|false|mem +
+
+

+ If true or mem 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 mem is specified, a torrent file is not written to the disk, but is just + kept in memory. + If false is specified, the action mentioned above is not taken. + Default: true +

+
+
+—direct-file-mapping=true|false +
+
+

+ Directly read from and write to each file mentioned in .torrent file. + Use this option if lots of files are listed in .torrent file and aria2 + complains it cannot open files anymore. + Default: true +

+
+
+—listen-port=PORT… +
+
+

+ Set TCP port number for BitTorrent downloads. + Multiple ports can be specified by using ",", for example: 6881,6885. + You can also use "-" to specify a range: 6881-6999. + "," and "-" can be used together: 6881-6889,6999. + Default: 6881-6999 +

+
+
+Note +
+
+

+ Make sure that the specified ports are open for incoming TCP traffic. +

+
+
+
+
+—max-upload-limit=SPEED +
+
+

+ Set max upload speed in bytes per sec. 0 means unrestricted. + You can append K or M(1K = 1024, 1M = 1024K). + Default: 0 +

+
+
+—seed-time=MINUTES +
+
+

+ Specify seeding time in minutes. Also see the —seed-ratio option. +

+
+
+—seed-ratio=RATIO +
+
+

+ Specify share ratio. Seed completed torrents until share ratio reaches] + RATIO. + I strongly encourages you to specify equals or more than 1.0 here. + Specify 0.0 if you intend to do seeding regardless of share ratio. + If —seed-time option is specified along with this option, seeding ends when + at least one of the conditions is satisfied. + Default: 1.0 +

+
+
+—peer-id-prefix=PEERI_ID_PREFIX +
+
+

+ 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's length 20 bytes. + Default: -aria2- +

+
+
+—enable-peer-exchange[=true|false] +
+
+

+ Enable Peer Exchange extension. If a private flag is set in a torrent, this + feature is disabled for that download even if true is given. + Default: true +

+
+
+—enable-dht[=true|false] +
+
+

+ Enable DHT functionality. If a private flag is set in a torrent, aria2 + doesn't use DHT for that download even if true is given. + Default: false +

+
+
+—dht-listen-port=PORT… +
+
+

+ Set UDP listening port for DHT. + Multiple ports can be specified by using ",", for example: 6881,6885. + You can also use "-" to specify a range: 6881-6999. "," and "-" can be used + together. + Default: 6881-6999 +

+
+
+—dht-entry-point=HOST:PORT +
+
+

+ Set host and port as an entry point to DHT network. +

+
+
+—bt-min-crypto-level=plain|arc4 +
+
+

+ Set minimum level of encryption method. + If several encryption methods are provided by a peer, aria2 chooses a lowest + one which satisfies the given level. + Default: plain +

+
+
+—bt-require-crypto=true|false +
+
+

+ If true is given, aria2 doesn't accept and establish connection with legacy + BitTorrent handshake(\19BitTorrent protocol). + Thus aria2 always uses Obfuscation handshake. + Default: false +

+
+
+-M, —metalink-file=METALINK_FILE +
+
+

+ The file path to .metalink file. +

+
+
+-C, —metalink-servers=NUM_SERVERS +
+
+

+ The number of servers to connect to simultaneously. + Some metalinks regulates the number of servers to connect. + aria2 respects them. + Default: 5 +

+
+
+—metalink-version=VERSION +
+
+

+ The version of the file to download. +

+
+
+—metalink-language=LANGUAGE +
+
+

+ The language of the file to download. +

+
+
+—metalink-os=OS +
+
+

+ The operating system of the file to download. +

+
+
+—metalink-location=LOCATION[,…] +
+
+

+ The location of the preferred server. + A comma-deliminated list of locations is acceptable, for example, JP,US. +

+
+
+—metalink-preferred-protocol=PROTO +
+
+

+ Specify preferred protocol. + The possible values are http, https, ftp and none. + Specifiy none to disable this feature. + Default: none +

+
+
+—follow-metalink=true|false|mem +
+
+

+ If true or mem is specified, when a file whose suffix is ".metaink" or content + type is "application/metalink+xml" is downloaded, aria2 parses it as a metalink + file and downloads files mentioned in it. + If mem is specified, a metalink file is not written to the disk, but is just + kept in memory. + If false is specified, the action mentioned above is not taken. + Default: true +

+
+
+—metalink-enable-unique-protocol=true|false +
+
+

+ If true is given and several protocols are available for a mirror in a + metalink file, aria2 uses one of them. + Use —metalink-preferred-protocol option to specify the preference of + protocol. + Default: true +

+
+
+-v, —version +
+
+

+ Print the version number, copyright and the configuration information and + exit. +

+
+
+-h, —help[=CATEGORY] +
+
+

+ Print usage and exit. + The help messages are classified in several categories. + For example, type "—help=http" for detailed explanation for the options + related to HTTP. If no matching category is found, search option name using + a given word in forward match and print the result. + Available Values: basic, advanced, http, ftp, metalink, + bittorrent, all + Default: basic +

+
+
+URL +
+
+

+ You can specify multiple URLs. Unless you specify -Z option, all URLs must + point to the same file or downloading will fail. + You can specify both torrent file with -T option and URLs. By doing this, + 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. +

+
+
+Note +
+
+

+ Make sure that URL is quoted with single(') or double(") quotation if it + contains "&" or any characters that have special meaning in shell. +

+
+
+
+
+
+

EXAMPLES

+
+

HTTP/FTP Segmented Download

+

Download a file using 1 connection

+
+
+
aria2c http://host/file.zip
+
+
+ + + +
+
Note
+		To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory. You can change URLs as long as they are pointing to the same file.
+
+

Download a file using 2 connections

+
+
+
aria2c -s2 http://host/file.zip
+
+

Download a file from 2 difference HTTP servers

+
+
+
aria2c http://host1/file.zip ftp://host2/file.zip
+
+

Download a file from HTTP and FTP servers

+
+
+
aria2c http://host1/file.zip ftp://host2/file.zip
+
+

Download files listed in a file concurrently

+
+
+
aria2c -ifiles.txt -j5
+
+
+ + + +
+
Note
+		-j option specifies the number of concurrent downloads.
+
+

Metalink Download

+

Download files with remote Metalink

+
+
+
aria2c --follow-metalink=mem http://host/file.metalink
+
+

Download using a local metalink file

+
+
+
aria2c -p -t10 --lowest-speed-limit=4000 -Mtest.metalink
+
+
+ + + +
+
Note
+		To pause a download, press Ctrl-C. +You can resume the transfer by run aria2c with the same argument at the same +directory.
+
+

Download only selected files using index

+
+
+
aria2c -Mtest.metalink --select-file=1-4,8
+
+
+ + + +
+
Note
+		The index is printed to the console using -S option.
+
+

Download a file using a local .metalink file with user preference

+
+
+
aria2c -Mtest.metalink --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US
+
+

BitTorrent Download

+

Download files from remote BitTorrent file

+
+
+
aria2c --follow-bittorrent=mem http://host/file.torrent
+
+

Download using a local torrent file

+
+
+
aria2c --max-upload-limit=40K -Tfile.torrent
+
+
+ + + +
+
Note
+		—max-upload-limit specifies the max of upload rate.
+
+
+ + + +
+
Note
+		To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.
+
+

Download a file using torrent and HTTP/FTP server

+
+
+
aria2c -Ttest.torrent http://host1/file ftp://host2/file
+
+
+ + + +
+
Note
+		Downloading multi file torrent with HTTP/FTP is not supported.
+
+

Download only selected files using index(usually called "selectable download")

+
+
+
aria2c -Ttest.torrent --select-file=1-4,8
+
+
+ + + +
+
Note
+		The index is printed to the console using -S option.
+
+

Change the listening port for incoming peer

+
+
+
aria2c -Ttest.torrent --listen-port=7000-7001,8000
+
+
+ + + +
+
Note
+		Since aria2 doesn't configure firewall or router for port forwarding, it's up +to you to do it manually.
+
+

Specify the condition to stop program after torrent download finished

+
+
+
aria2c -Ttest.torrent --seed-time=120 --seed-ratio=1.0
+
+
+ + + +
+
Note
+		In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.
+
+

Throttle upload speed

+
+
+
aria2c -Ttest.torrent --max-upload-limit=100K
+
+

Enable DHT

+
+
+
aria2c -Ttest.torrent --enable-dht --dht-listen-port=6881
+
+
+ + + +
+
Note
+		DHT uses udp port. Since aria2 doesn't configure firewall or router for port +forwarding, it's up to you to do it manually.
+
+

More advanced HTTP features

+

Load cookies

+
+
+
aria2c --load-cookies=cookies.txt http://host/file.zip
+
+
+ + + +
+
Note
+		You can use Firefox/Mozilla's cookie file without modification.
+
+

Resume download started by web browsers or another programs

+
+
+
aria2c -c -s2 http://host/partiallydownloadedfile.zip
+
+

And more advanced features

+

Throttle download speed

+
+
+
aria2c -Mtest.metalink --max-download-limit=100K
+
+

Repair a damaged download using —check-integrity option

+
+
+
aria2c -Mtest.metalink --check-integrity=true
+
+
+ + + +
+
Note
+		This option is only available used with BitTorrent or metalink with chunk +checksums.
+
+

Drop connection if download speed is lower than specified value

+
+
+
aria2c -Mtest.metalink --lowest-speed-limit=10K
+
+

Parameterized URI support

+

You can specify set of parts:

+
+
+
aria2c -P http://{host1,host2,host3}/file.iso
+
+

You can specify numeric sequence:

+
+
+
aria2c -Z -P http://host/image[000-100].png
+
+
+ + + +
+
Note
+		-Z option is required if the all URIs don't point to the same file, such as the above example.
+
+

You can specify step counter:

+
+
+
aria2c -Z -P http://host/image[A-Z:2].png
+
+

BitTorrent Encryption

+

Encrypt whole payload using ARC4:

+
+
+
aria2c -Tfile.torrent --bt-min-crypto-level=arc4 --bt-require-crypto=true
+
+
+

RESUME DOWNLOAD

+
+

Usually, you can resume transfer by just issuing same command(aria2c URL) +if the previous transfer is made by aria2.

+

If the previous transfer is made by a browser or wget like sequencial +download manager, then use -c option to continue the transfer(aria2c -c URL).

+
+

CONTROL FILE

+
+

aria2 uses a control file to keep track the progress of download. +A control file is placed at the same directory of the dowloading 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.)

+

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't support resume), a control file is +not created.

+

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 +—check-integrity=true option to aria2c in command-line.

+
+

SEEDING DOWNLOADED FILE IN BITTORRENT

+
+

You can seed downloaded file using —check-integrity=true option.

+
+
+
aria2c --check-integrity=true -T file.torrent
+
+
+

FILES

+
+

aria2.conf

+

User configuration file. +It must be placed under $HOME/.aria2 and must be named as aria2.conf. +In each line, there is 1 parameter whose syntax is name=value pair, +where name is the long command-line option name without — prefix. +The lines beginning # are treated as comments.

+
+
+
# sample configuration file for aria2c
+file-allocation=prealloc
+listen-port=60000
+seed-ratio=1.0
+max-upload-limit=100K
+ftp-pasv=true
+
+

dht.dat

+

The routing table of DHT is saved to the path $HOME/.aria2/dht.dat.

+
+

RESOURCES

+
+

Project web site: http://aria2.sourceforge.net/

+

metalink: http://www.metalinker.org/

+
+

REPORTING BUGS

+
+

Report bugs to Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

+
+

AUTHOR

+
+

Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

+
+

COPYRIGHT

+
+

Copyright © 2006, 2008 Tatsuhiro Tsujikawa

+

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.

+

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.

+

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

+

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.

+
+ + + diff --git a/doc/makeman b/doc/makeman index 738abdaf..86cec761 100755 --- a/doc/makeman +++ b/doc/makeman @@ -2,6 +2,4 @@ a2x -f manpage aria2c.1.txt -#sed 's/\(.\)\.sp/\1\n\.sp/g' aria2c.1 > aria2c.1.tmp - -#mv aria2c.1.tmp aria2c.1 +asciidoc -d article -b xhtml11 aria2c.1.txt diff --git a/readme2xhtml b/readme2xhtml new file mode 100755 index 00000000..3a976f3b --- /dev/null +++ b/readme2xhtml @@ -0,0 +1,3 @@ +#!/bin/sh + +/usr/bin/asciidoc -d article -b xhtml11 -n README