mirror of https://github.com/aria2/aria2
2008-12-02 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Fixed typos and updated doc. * READMEpull/1/head
parent
56a1eb0691
commit
c674f54cf4
|
@ -1,3 +1,8 @@
|
||||||
|
2008-12-02 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
|
||||||
|
|
||||||
|
Fixed typos and updated doc.
|
||||||
|
* README
|
||||||
|
|
||||||
2008-12-02 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
|
2008-12-02 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
|
||||||
|
|
||||||
Fixed typos
|
Fixed typos
|
||||||
|
|
175
README
175
README
|
@ -10,15 +10,14 @@ You must use this program at your own risk.
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
------------
|
------------
|
||||||
aria2 is a utility for downloading files. The supported protocols are HTTP(S),
|
aria2 is a utility for downloading files. The supported protocols are
|
||||||
FTP, BitTorrent, and Metalink.
|
HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
|
||||||
It can download a file from multiple sources/protocols and tries to utilize
|
multiple sources/protocols and tries to utilize your maximum download
|
||||||
your maximum download bandwidth.
|
bandwidth. It supports downloading a file from HTTP(S)/FTP and
|
||||||
It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same
|
BitTorrent at the same time, while the data downloaded from
|
||||||
time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent
|
HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's
|
||||||
swarm.
|
chunk checksums, aria2 automatically validates chunks of data while
|
||||||
Using Metalink's chunk checksums, aria2 automatically validates chunks of data
|
downloading a file like BitTorrent.
|
||||||
while downloading a file like BitTorrent.
|
|
||||||
|
|
||||||
Here is a list of features.
|
Here is a list of features.
|
||||||
|
|
||||||
|
@ -30,7 +29,11 @@ Here is a list of features.
|
||||||
* HTTP Proxy support
|
* HTTP Proxy support
|
||||||
* HTTP BASIC authentication support
|
* HTTP BASIC authentication support
|
||||||
* HTTP Proxy authentication support
|
* HTTP Proxy authentication support
|
||||||
|
* Well-known environment variables for proxy: http_proxy, https_proxy,
|
||||||
|
ftp_proxy, all_proxy and no_proxy
|
||||||
* HTTP gzip, deflate content encoding support
|
* HTTP gzip, deflate content encoding support
|
||||||
|
* Verify peer using given trusted CA certificate in HTTPS
|
||||||
|
* Client certificate authentication in HTTPS
|
||||||
* Chunked transfer encoding support
|
* Chunked transfer encoding support
|
||||||
* Load Cookies from file using the Firefox3 format and the Mozilla/Firefox
|
* Load Cookies from file using the Firefox3 format and the Mozilla/Firefox
|
||||||
(1.x/2.x)/Netscape format.
|
(1.x/2.x)/Netscape format.
|
||||||
|
@ -39,13 +42,14 @@ Here is a list of features.
|
||||||
* FTP through HTTP Proxy
|
* FTP through HTTP Proxy
|
||||||
* Download/Upload speed throttling
|
* Download/Upload speed throttling
|
||||||
* BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
|
* BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
|
||||||
* Run as a daemon process.
|
* Run as a daemon process
|
||||||
* Selective download in multi-file torrent/Metalink
|
* Selective download in multi-file torrent/Metalink
|
||||||
* Chunk checksum validation in Metalink
|
* Chunk checksum validation in Metalink
|
||||||
* Can disable segmented downloading in Metalink
|
* Can disable segmented downloading in Metalink
|
||||||
* Netrc support
|
* Netrc support
|
||||||
* Configuration file support
|
* Configuration file support
|
||||||
* Download URIs found in a text file or stdin
|
* Download URIs found in a text file or stdin and the destination directory and
|
||||||
|
output filename can be specified optionally
|
||||||
* Parameterized URI support
|
* Parameterized URI support
|
||||||
|
|
||||||
Dependency
|
Dependency
|
||||||
|
@ -73,17 +77,19 @@ Note;;
|
||||||
libxml2 has precedence over Expat if both libraries are installed.
|
libxml2 has precedence over Expat if both libraries are installed.
|
||||||
If you prefer Expat, run configure with "--without-libxml2".
|
If you prefer Expat, run configure with "--without-libxml2".
|
||||||
|
|
||||||
You can disable BitTorrent, Metalink support by providing --disable-bittorrent,
|
You can disable BitTorrent, Metalink support by providing
|
||||||
--disable-metalink respectively to configure script.
|
--disable-bittorrent, --disable-metalink respectively to configure
|
||||||
|
script.
|
||||||
|
|
||||||
In order to enable async DNS support, you need c-ares
|
In order to enable async DNS support, you need c-ares.
|
||||||
|
|
||||||
* c-ares: http://daniel.haxx.se/projects/c-ares/
|
* c-ares: http://daniel.haxx.se/projects/c-ares/
|
||||||
|
|
||||||
How to build
|
How to build
|
||||||
------------
|
------------
|
||||||
In order to build aria2 from the source package, you need following development
|
In order to build aria2 from the source package, you need following
|
||||||
packages(package name may vary depending on the distribution you use):
|
development packages(package name may vary depending on the
|
||||||
|
distribution you use):
|
||||||
|
|
||||||
* libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
|
* libgnutls-dev (Required for HTTPS, BitTorrent, Checksum support)
|
||||||
* libgpg-error-dev (Required for BitTorrent, Checksum support)
|
* libgpg-error-dev (Required for BitTorrent, Checksum support)
|
||||||
|
@ -93,7 +99,8 @@ packages(package name may vary depending on the distribution you use):
|
||||||
* libz1g-dev (Required for gzip, deflate decoding support in HTTP)
|
* libz1g-dev (Required for gzip, deflate decoding support in HTTP)
|
||||||
* libsqlite3-dev (Required for Firefox3 cookie support)
|
* libsqlite3-dev (Required for Firefox3 cookie support)
|
||||||
|
|
||||||
You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev:
|
You can use libssl-dev instead of
|
||||||
|
libgnutls-dev,libgpg-error-dev,libgcrypt-dev:
|
||||||
|
|
||||||
* libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
|
* libssl-dev (Required for HTTPS, BitTorrent, Checksum support)
|
||||||
|
|
||||||
|
@ -123,80 +130,84 @@ About filename
|
||||||
The filename of the downloaded file is determined as follows:
|
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"
|
If "name" key is present in .torrent file, filename is the value
|
||||||
key. Otherwise, filename is the basename of .torrent file appended by
|
of "name" key. Otherwise, filename is the basename of .torrent
|
||||||
".file". For example, .torrent file is "test.torrrent", then filename is
|
file appended by ".file". For example, .torrent file is
|
||||||
"test.torrent.file".
|
"test.torrrent", then filename is "test.torrent.file". The
|
||||||
The directory to store the downloaded file can be specified by -d option.
|
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
|
The complete directory/file structure mentioned in .torrent file
|
||||||
created.
|
is created. The directory to store the top directory of
|
||||||
The directory to store the top directory of downloaded files can be
|
downloaded files can be specified by -d option.
|
||||||
specified by -d option.
|
|
||||||
|
|
||||||
In the default behavior, before download starts, complete directory structure
|
In the default behavior, before download starts, a complete directory
|
||||||
is created if needed. By default, aria2 opens at most 100 files mentioned in
|
structure is created if needed. By default, aria2 opens at most 100
|
||||||
.torrent file, directly writes to and reads from these files. The number of
|
files mentioned in .torrent file, directly writes to and reads from
|
||||||
files to open can be controlled by "--bt-max-open-files" option.
|
these files. The number of files to open simultaneously can be
|
||||||
|
controlled by "--bt-max-open-files" option.
|
||||||
|
|
||||||
If "--direct-file-mapping" option set to be false, aria2 creates temporary
|
If "--direct-file-mapping" option set to be false, aria2 creates
|
||||||
file in the store directory. The length of this file is the sum of length of
|
temporary file in the store directory. The length of this file is the
|
||||||
the files in .torrent file, so at least 2 times more disk space than the file
|
sum of length of the files in .torrent file, so at least 2 times more
|
||||||
size itself is required. Writing and reading is done against this file.
|
disk space than the file size itself is required. Writing and reading
|
||||||
After download completes, aria2 creates complete directory structure if needed,
|
are done against this file. After download completes, aria2 creates
|
||||||
and copies whole file or a part of it to the destination.
|
complete directory structure if needed, and copies whole file or a
|
||||||
|
part of it to the destination.
|
||||||
|
|
||||||
DHT
|
DHT
|
||||||
~~~
|
~~~
|
||||||
As of release 0.13.0, aria2 supports DHT. By default, the routing table is saved
|
As of release 0.13.0, aria2 supports DHT. By default, the routing
|
||||||
to $HOME/.aria2/dht.dat.
|
table is saved to $HOME/.aria2/dht.dat.
|
||||||
|
|
||||||
Other things should be noted
|
Other things should be noted
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
* -o option is used to change the filename of .torrent file itself, not a
|
* -o option is used to change the filename of .torrent file itself,
|
||||||
filename of a file in .torrent file.
|
not a filename of a file in .torrent file.
|
||||||
* The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP.
|
* The port numbers that aria2 uses by default are 6881-6999 for TCP
|
||||||
* aria2 doesn't configure port-forwarding automatically. Please configure your
|
and UDP.
|
||||||
router or firewall manually.
|
* aria2 doesn't configure port-forwarding automatically. Please
|
||||||
* The maximum number of peers is 55. This limit may be exceeded when download
|
configure your router or firewall manually.
|
||||||
rate is low.
|
* The maximum number of peers is 55. This limit may be exceeded when
|
||||||
* As of release 0.10.0, aria2 stops sending request message after selective
|
download rate is low. This download rate can be adjusted using
|
||||||
download completes,
|
--bt-request-peer-speed-limit option.
|
||||||
|
* As of release 0.10.0, aria2 stops sending request message after
|
||||||
|
selective download completes.
|
||||||
|
|
||||||
Metalink
|
Metalink
|
||||||
--------
|
--------
|
||||||
The current implementation supports HTTP/FTP/BitTorrent.
|
The current implementation supports HTTP(S)/FTP/BitTorrent. The other
|
||||||
The other P2P protocols are ignored.
|
P2P protocols are ignored.
|
||||||
|
|
||||||
For checksum checking, MD5, SHA1, SHA256 are supported. If multiple hash
|
For checksum checking, MD5, SHA1, SHA256 are supported. If multiple
|
||||||
algorithms are provided, aria2 uses SHA1. If checksum checking is failed, aria2
|
hash algorithms are provided, aria2 uses SHA1. If checksum checking is
|
||||||
doesn't retry the download and just exits with non-zero return code.
|
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
|
The supported user preferences are version, language, location,
|
||||||
os.
|
protocol and os.
|
||||||
|
|
||||||
If chunk checksums are provided in Metalink file, aria2 automatically validate
|
If chunk checksums are provided in Metalink file, aria2 automatically
|
||||||
a chunk of file while downloading it. This behavior can be turned off by
|
validates chunks of data during download. This behavior can be turned
|
||||||
a command-line option.
|
off by a command-line option.
|
||||||
|
|
||||||
If signature is included in a Metalink file, aria2 saves it as a file after the
|
If signature is included in a Metalink file, aria2 saves it as a file
|
||||||
download completed.
|
after the completion of the download. The filename is download
|
||||||
The filename is download filename + ".sig". If same file already exists, the
|
filename + ".sig". If same file already exists, the signature file is
|
||||||
signature file is not saved.
|
not saved.
|
||||||
|
|
||||||
netrc
|
netrc
|
||||||
-----
|
-----
|
||||||
netrc support is enabled by default for HTTP(S)/FTP.
|
netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
|
||||||
To disable netrc support, specify -n command-line option.
|
support, specify -n command-line option. Your .netrc file should have
|
||||||
Your .netrc file should have correct permissions(600).
|
correct permissions(600).
|
||||||
|
|
||||||
SERVER PERFORMANCE PROFILE
|
SERVER PERFORMANCE PROFILE
|
||||||
--------------------------
|
--------------------------
|
||||||
This section describes the format of server performance profile.
|
This section describes the format of server performance profile. The
|
||||||
The file is plain text and each line has several NAME=VALUE pair, delimited by
|
file is plain text and each line has several NAME=VALUE pair,
|
||||||
comma.
|
delimited by comma. Currently following NAMEs are recognized:
|
||||||
Currently following NAMEs are recognized:
|
|
||||||
|
|
||||||
host::
|
host::
|
||||||
Hostname of the server. Required.
|
Hostname of the server. Required.
|
||||||
|
@ -205,19 +216,20 @@ protocol::
|
||||||
Protocol for this profile, such as ftp, http. Required.
|
Protocol for this profile, such as ftp, http. Required.
|
||||||
|
|
||||||
dl_speed::
|
dl_speed::
|
||||||
The average download speed observed in the previous download in bytes per sec.
|
The average download speed observed in the previous download in
|
||||||
Required.
|
bytes per sec. Required.
|
||||||
|
|
||||||
last_updated::
|
last_updated::
|
||||||
Last contact time in GMT with this server, specified in the seconds from the
|
Last contact time in GMT with this server, specified in the seconds
|
||||||
Epoch. Required.
|
from the Epoch. Required.
|
||||||
|
|
||||||
status::
|
status::
|
||||||
ERROR is set when server cannot be reached or out-of-service or timeout
|
ERROR is set when server cannot be reached or out-of-service or
|
||||||
occurred. Otherwise, OK is set.
|
timeout occurred. Otherwise, OK is set.
|
||||||
|
|
||||||
Those fields must exist in one line. The order of the fields is not significant.
|
Those fields must exist in one line. The order of the fields is not
|
||||||
You can put pairs other than above; they are simply ignored.
|
significant. You can put pairs other than above but they are simply
|
||||||
|
ignored.
|
||||||
|
|
||||||
An example is follow:
|
An example is follow:
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
@ -227,18 +239,15 @@ host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
|
||||||
|
|
||||||
Configuration file
|
Configuration file
|
||||||
------------------
|
------------------
|
||||||
Configuration file must be placed under $HOME/.aria2 and must be named as
|
Configuration file must be placed under $HOME/.aria2 and must be named
|
||||||
aria2.conf.
|
as aria2.conf. In each line, there is 1 parameter whose syntax is
|
||||||
In each line, there is 1 parameter whose syntax is name=value pair,
|
name=value pair, where name is the long command-line option name
|
||||||
where name is the long command-line option name without '--' prefix.
|
without '--' prefix. The lines beginning '#' are treated as comments.
|
||||||
The lines beginning '#' are treated as comments.
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
--------------------------------------
|
--------------------------------------
|
||||||
# sample configuration file for aria2c
|
# sample configuration file for aria2c
|
||||||
file-allocation=prealloc
|
|
||||||
listen-port=60000
|
listen-port=60000
|
||||||
seed-ratio=1.0
|
seed-ratio=1.0
|
||||||
max-upload-limit=40K
|
max-upload-limit=40K
|
||||||
ftp-pasv=true
|
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
|
|
191
README.html
191
README.html
|
@ -354,15 +354,14 @@ You must use this program at your own risk.</p></div>
|
||||||
</div>
|
</div>
|
||||||
<h2 id="_introduction">2. Introduction</h2>
|
<h2 id="_introduction">2. Introduction</h2>
|
||||||
<div class="sectionbody">
|
<div class="sectionbody">
|
||||||
<div class="para"><p>aria2 is a utility for downloading files. The supported protocols are HTTP(S),
|
<div class="para"><p>aria2 is a utility for downloading files. The supported protocols are
|
||||||
FTP, BitTorrent, and Metalink.
|
HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from
|
||||||
It can download a file from multiple sources/protocols and tries to utilize
|
multiple sources/protocols and tries to utilize your maximum download
|
||||||
your maximum download bandwidth.
|
bandwidth. It supports downloading a file from HTTP(S)/FTP and
|
||||||
It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same
|
BitTorrent at the same time, while the data downloaded from
|
||||||
time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent
|
HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's
|
||||||
swarm.
|
chunk checksums, aria2 automatically validates chunks of data while
|
||||||
Using Metalink's chunk checksums, aria2 automatically validates chunks of data
|
downloading a file like BitTorrent.</p></div>
|
||||||
while downloading a file like BitTorrent.</p></div>
|
|
||||||
<div class="para"><p>Here is a list of features.</p></div>
|
<div class="para"><p>Here is a list of features.</p></div>
|
||||||
<div class="ilist"><ul>
|
<div class="ilist"><ul>
|
||||||
<li>
|
<li>
|
||||||
|
@ -407,11 +406,27 @@ HTTP Proxy authentication support
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
|
Well-known environment variables for proxy: http_proxy, https_proxy,
|
||||||
|
ftp_proxy, all_proxy and no_proxy
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
HTTP gzip, deflate content encoding support
|
HTTP gzip, deflate content encoding support
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
|
Verify peer using given trusted CA certificate in HTTPS
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
Client certificate authentication in HTTPS
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
Chunked transfer encoding support
|
Chunked transfer encoding support
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
|
@ -448,7 +463,7 @@ BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
Run as a daemon process.
|
Run as a daemon process
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
|
@ -478,7 +493,8 @@ Configuration file support
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
Download URIs found in a text file or stdin
|
Download URIs found in a text file or stdin and the destination directory and
|
||||||
|
output filename can be specified optionally
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
|
@ -587,9 +603,10 @@ Note
|
||||||
</p>
|
</p>
|
||||||
</dd>
|
</dd>
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="para"><p>You can disable BitTorrent, Metalink support by providing —disable-bittorrent,
|
<div class="para"><p>You can disable BitTorrent, Metalink support by providing
|
||||||
—disable-metalink respectively to configure script.</p></div>
|
—disable-bittorrent, —disable-metalink respectively to configure
|
||||||
<div class="para"><p>In order to enable async DNS support, you need c-ares</p></div>
|
script.</p></div>
|
||||||
|
<div class="para"><p>In order to enable async DNS support, you need c-ares.</p></div>
|
||||||
<div class="ilist"><ul>
|
<div class="ilist"><ul>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
|
@ -600,8 +617,9 @@ c-ares: <a href="http://daniel.haxx.se/projects/c-ares/">http://daniel.haxx.se/p
|
||||||
</div>
|
</div>
|
||||||
<h2 id="_how_to_build">4. How to build</h2>
|
<h2 id="_how_to_build">4. How to build</h2>
|
||||||
<div class="sectionbody">
|
<div class="sectionbody">
|
||||||
<div class="para"><p>In order to build aria2 from the source package, you need following development
|
<div class="para"><p>In order to build aria2 from the source package, you need following
|
||||||
packages(package name may vary depending on the distribution you use):</p></div>
|
development packages(package name may vary depending on the
|
||||||
|
distribution you use):</p></div>
|
||||||
<div class="ilist"><ul>
|
<div class="ilist"><ul>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
|
@ -639,7 +657,8 @@ libsqlite3-dev (Required for Firefox3 cookie support)
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
</ul></div>
|
</ul></div>
|
||||||
<div class="para"><p>You can use libssl-dev instead of libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
|
<div class="para"><p>You can use libssl-dev instead of
|
||||||
|
libgnutls-dev,libgpg-error-dev,libgcrypt-dev:</p></div>
|
||||||
<div class="ilist"><ul>
|
<div class="ilist"><ul>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
|
@ -678,11 +697,12 @@ single-file mode
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p>
|
<p>
|
||||||
If "name" key is present in .torrent file, filename is the value of "name"
|
If "name" key is present in .torrent file, filename is the value
|
||||||
key. Otherwise, filename is the basename of .torrent file appended by
|
of "name" key. Otherwise, filename is the basename of .torrent
|
||||||
".file". For example, .torrent file is "test.torrrent", then filename is
|
file appended by ".file". For example, .torrent file is
|
||||||
"test.torrent.file".
|
"test.torrrent", then filename is "test.torrent.file". The
|
||||||
The directory to store the downloaded file can be specified by -d option.
|
directory to store the downloaded file can be specified by -d
|
||||||
|
option.
|
||||||
</p>
|
</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
|
@ -690,88 +710,91 @@ multi-file mode
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p>
|
<p>
|
||||||
The complete directory/file structure mentioned in .torrent file is
|
The complete directory/file structure mentioned in .torrent file
|
||||||
created.
|
is created. The directory to store the top directory of
|
||||||
The directory to store the top directory of downloaded files can be
|
downloaded files can be specified by -d option.
|
||||||
specified by -d option.
|
|
||||||
</p>
|
</p>
|
||||||
</dd>
|
</dd>
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="para"><p>In the default behavior, before download starts, complete directory structure
|
<div class="para"><p>In the default behavior, before download starts, a complete directory
|
||||||
is created if needed. By default, aria2 opens at most 100 files mentioned in
|
structure is created if needed. By default, aria2 opens at most 100
|
||||||
.torrent file, directly writes to and reads from these files. The number of
|
files mentioned in .torrent file, directly writes to and reads from
|
||||||
files to open can be controlled by "—bt-max-open-files" option.</p></div>
|
these files. The number of files to open simultaneously can be
|
||||||
<div class="para"><p>If "—direct-file-mapping" option set to be false, aria2 creates temporary
|
controlled by "—bt-max-open-files" option.</p></div>
|
||||||
file in the store directory. The length of this file is the sum of length of
|
<div class="para"><p>If "—direct-file-mapping" option set to be false, aria2 creates
|
||||||
the files in .torrent file, so at least 2 times more disk space than the file
|
temporary file in the store directory. The length of this file is the
|
||||||
size itself is required. Writing and reading is done against this file.
|
sum of length of the files in .torrent file, so at least 2 times more
|
||||||
After download completes, aria2 creates complete directory structure if needed,
|
disk space than the file size itself is required. Writing and reading
|
||||||
and copies whole file or a part of it to the destination.</p></div>
|
are 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.</p></div>
|
||||||
<h3 id="_dht">5.2. DHT</h3><div style="clear:left"></div>
|
<h3 id="_dht">5.2. DHT</h3><div style="clear:left"></div>
|
||||||
<div class="para"><p>As of release 0.13.0, aria2 supports DHT. By default, the routing table is saved
|
<div class="para"><p>As of release 0.13.0, aria2 supports DHT. By default, the routing
|
||||||
to $HOME/.aria2/dht.dat.</p></div>
|
table is saved to $HOME/.aria2/dht.dat.</p></div>
|
||||||
<h3 id="_other_things_should_be_noted">5.3. Other things should be noted</h3><div style="clear:left"></div>
|
<h3 id="_other_things_should_be_noted">5.3. Other things should be noted</h3><div style="clear:left"></div>
|
||||||
<div class="ilist"><ul>
|
<div class="ilist"><ul>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
-o option is used to change the filename of .torrent file itself, not a
|
-o option is used to change the filename of .torrent file itself,
|
||||||
filename of a file in .torrent file.
|
not a filename of a file in .torrent file.
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
The port numbers that aria2 uses by default are 6881-6999 for TCP and UDP.
|
The port numbers that aria2 uses by default are 6881-6999 for TCP
|
||||||
|
and UDP.
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
aria2 doesn't configure port-forwarding automatically. Please configure your
|
aria2 doesn't configure port-forwarding automatically. Please
|
||||||
router or firewall manually.
|
configure your router or firewall manually.
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
The maximum number of peers is 55. This limit may be exceeded when download
|
The maximum number of peers is 55. This limit may be exceeded when
|
||||||
rate is low.
|
download rate is low. This download rate can be adjusted using
|
||||||
|
—bt-request-peer-speed-limit option.
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>
|
<p>
|
||||||
As of release 0.10.0, aria2 stops sending request message after selective
|
As of release 0.10.0, aria2 stops sending request message after
|
||||||
download completes,
|
selective download completes.
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
</ul></div>
|
</ul></div>
|
||||||
</div>
|
</div>
|
||||||
<h2 id="_metalink">6. Metalink</h2>
|
<h2 id="_metalink">6. Metalink</h2>
|
||||||
<div class="sectionbody">
|
<div class="sectionbody">
|
||||||
<div class="para"><p>The current implementation supports HTTP/FTP/BitTorrent.
|
<div class="para"><p>The current implementation supports HTTP(S)/FTP/BitTorrent. The other
|
||||||
The other P2P protocols are ignored.</p></div>
|
P2P protocols are ignored.</p></div>
|
||||||
<div class="para"><p>For checksum checking, MD5, SHA1, SHA256 are supported. If multiple hash
|
<div class="para"><p>For checksum checking, MD5, SHA1, SHA256 are supported. If multiple
|
||||||
algorithms are provided, aria2 uses SHA1. If checksum checking is failed, aria2
|
hash algorithms are provided, aria2 uses SHA1. If checksum checking is
|
||||||
doesn't retry the download and just exits with non-zero return code.</p></div>
|
failed, aria2 doesn't retry the download and just exits with non-zero
|
||||||
<div class="para"><p>The supported user preferences are version, language, location, protocol and
|
return code.</p></div>
|
||||||
os.</p></div>
|
<div class="para"><p>The supported user preferences are version, language, location,
|
||||||
<div class="para"><p>If chunk checksums are provided in Metalink file, aria2 automatically validate
|
protocol and os.</p></div>
|
||||||
a chunk of file while downloading it. This behavior can be turned off by
|
<div class="para"><p>If chunk checksums are provided in Metalink file, aria2 automatically
|
||||||
a command-line option.</p></div>
|
validates chunks of data during download. This behavior can be turned
|
||||||
<div class="para"><p>If signature is included in a Metalink file, aria2 saves it as a file after the
|
off by a command-line option.</p></div>
|
||||||
download completed.
|
<div class="para"><p>If signature is included in a Metalink file, aria2 saves it as a file
|
||||||
The filename is download filename + ".sig". If same file already exists, the
|
after the completion of the download. The filename is download
|
||||||
signature file is not saved.</p></div>
|
filename + ".sig". If same file already exists, the signature file is
|
||||||
|
not saved.</p></div>
|
||||||
</div>
|
</div>
|
||||||
<h2 id="_netrc">7. netrc</h2>
|
<h2 id="_netrc">7. netrc</h2>
|
||||||
<div class="sectionbody">
|
<div class="sectionbody">
|
||||||
<div class="para"><p>netrc support is enabled by default for HTTP(S)/FTP.
|
<div class="para"><p>netrc support is enabled by default for HTTP(S)/FTP. To disable netrc
|
||||||
To disable netrc support, specify -n command-line option.
|
support, specify -n command-line option. Your .netrc file should have
|
||||||
Your .netrc file should have correct permissions(600).</p></div>
|
correct permissions(600).</p></div>
|
||||||
</div>
|
</div>
|
||||||
<h2 id="_server_performance_profile">8. SERVER PERFORMANCE PROFILE</h2>
|
<h2 id="_server_performance_profile">8. SERVER PERFORMANCE PROFILE</h2>
|
||||||
<div class="sectionbody">
|
<div class="sectionbody">
|
||||||
<div class="para"><p>This section describes the format of server performance profile.
|
<div class="para"><p>This section describes the format of server performance profile. The
|
||||||
The file is plain text and each line has several NAME=VALUE pair, delimited by
|
file is plain text and each line has several NAME=VALUE pair,
|
||||||
comma.
|
delimited by comma. Currently following NAMEs are recognized:</p></div>
|
||||||
Currently following NAMEs are recognized:</p></div>
|
|
||||||
<div class="vlist"><dl>
|
<div class="vlist"><dl>
|
||||||
<dt>
|
<dt>
|
||||||
host
|
host
|
||||||
|
@ -794,8 +817,8 @@ dl_speed
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p>
|
<p>
|
||||||
The average download speed observed in the previous download in bytes per sec.
|
The average download speed observed in the previous download in
|
||||||
Required.
|
bytes per sec. Required.
|
||||||
</p>
|
</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
|
@ -803,8 +826,8 @@ last_updated
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p>
|
<p>
|
||||||
Last contact time in GMT with this server, specified in the seconds from the
|
Last contact time in GMT with this server, specified in the seconds
|
||||||
Epoch. Required.
|
from the Epoch. Required.
|
||||||
</p>
|
</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
|
@ -812,13 +835,14 @@ status
|
||||||
</dt>
|
</dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p>
|
<p>
|
||||||
ERROR is set when server cannot be reached or out-of-service or timeout
|
ERROR is set when server cannot be reached or out-of-service or
|
||||||
occurred. Otherwise, OK is set.
|
timeout occurred. Otherwise, OK is set.
|
||||||
</p>
|
</p>
|
||||||
</dd>
|
</dd>
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="para"><p>Those fields must exist in one line. The order of the fields is not significant.
|
<div class="para"><p>Those fields must exist in one line. The order of the fields is not
|
||||||
You can put pairs other than above; they are simply ignored.</p></div>
|
significant. You can put pairs other than above but they are simply
|
||||||
|
ignored.</p></div>
|
||||||
<div class="para"><p>An example is follow:</p></div>
|
<div class="para"><p>An example is follow:</p></div>
|
||||||
<div class="listingblock">
|
<div class="listingblock">
|
||||||
<div class="content">
|
<div class="content">
|
||||||
|
@ -828,25 +852,22 @@ host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR<
|
||||||
</div>
|
</div>
|
||||||
<h2 id="_configuration_file">9. Configuration file</h2>
|
<h2 id="_configuration_file">9. Configuration file</h2>
|
||||||
<div class="sectionbody">
|
<div class="sectionbody">
|
||||||
<div class="para"><p>Configuration file must be placed under $HOME/.aria2 and must be named as
|
<div class="para"><p>Configuration file must be placed under $HOME/.aria2 and must be named
|
||||||
aria2.conf.
|
as aria2.conf. In each line, there is 1 parameter whose syntax is
|
||||||
In each line, there is 1 parameter whose syntax is name=value pair,
|
name=value pair, where name is the long command-line option name
|
||||||
where name is the long command-line option name without <em>—</em> prefix.
|
without <em>—</em> prefix. The lines beginning <em>#</em> are treated as comments.</p></div>
|
||||||
The lines beginning <em>#</em> are treated as comments.</p></div>
|
|
||||||
<div class="para"><p>Example:</p></div>
|
<div class="para"><p>Example:</p></div>
|
||||||
<div class="listingblock">
|
<div class="listingblock">
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<pre><tt># sample configuration file for aria2c
|
<pre><tt># sample configuration file for aria2c
|
||||||
file-allocation=prealloc
|
|
||||||
listen-port=60000
|
listen-port=60000
|
||||||
seed-ratio=1.0
|
seed-ratio=1.0
|
||||||
max-upload-limit=40K
|
max-upload-limit=40K</tt></pre>
|
||||||
ftp-pasv=true</tt></pre>
|
|
||||||
</div></div>
|
</div></div>
|
||||||
</div>
|
</div>
|
||||||
<div id="footer">
|
<div id="footer">
|
||||||
<div id="footer-text">
|
<div id="footer-text">
|
||||||
Last updated 2008-11-18 20:19:18 JST
|
Last updated 2008-12-02 01:48:13 JST
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
|
Loading…
Reference in New Issue