github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity
aria2/doc/aria2c.1.html

1521 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>ARIA2C(1)</title>
</head>
<body>
<div id="header">
<h1>ARIA2C(1)</h1>
<span id="author">Tatsuhiro Tsujikawa</span><br />
<span id="email"><tt>&lt;<a href="mailto:t-tujikawa@users.sourceforge.net">t-tujikawa@users.sourceforge.net</a>&gt;</tt></span><br />
</div>
<h2>NAME</h2>
<div class="sectionbody">
<p>aria2c - The ultra fast download utility</p>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>aria2c</em> [OPTIONS] URL|TORRENT_FILE|METALINK_FILE &#8230;</p>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<p>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.</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
<dl>
<dt>
-d, &#8212;dir=DIR
</dt>
<dd>
<p>
The directory to store the downloaded file.
</p>
</dd>
<dt>
-o, &#8212;out=FILE
</dt>
<dd>
<p>
The file name of the downloaded file.
</p>
<dl>
<dt>
Note
</dt>
<dd>
<p>
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
</p>
</dd>
</dl>
</dd>
<dt>
-l, &#8212;log=LOG
</dt>
<dd>
<p>
The file name of the log file. If <em>-</em> is specified, log is written to
stdout.
</p>
</dd>
<dt>
-D, &#8212;daemon
</dt>
<dd>
<p>
Run as daemon.
</p>
</dd>
<dt>
-s, &#8212;split=N
</dt>
<dd>
<p>
Download a file using N connections. N must be between <em>1</em> and <em>5</em>.
This option affects all URLs. Thus, aria2 connects to each URL with N
connections.
Default: <em>1</em>
</p>
</dd>
<dt>
&#8212;retry-wait=SEC
</dt>
<dd>
<p>
Set the seconds to wait to retry after an error has occured.
Specify a value between <em>0</em> and <em>60</em>.
Default: <em>5</em>
</p>
</dd>
<dt>
-t, &#8212;timeout=SEC
</dt>
<dd>
<p>
Set timeout in seconds.
Default: <em>60</em>
</p>
</dd>
<dt>
-m, &#8212;max-tries=N
</dt>
<dd>
<p>
Set number of tries. <em>0</em> means unlimited.
Default: <em>5</em>
</p>
</dd>
<dt>
&#8212;http-proxy=HOST:PORT
</dt>
<dd>
<p>
Use HTTP proxy server. This affects all URLs.
</p>
</dd>
<dt>
&#8212;http-user=USER
</dt>
<dd>
<p>
Set HTTP user. This affects all URLs.
</p>
</dd>
<dt>
&#8212;http-passwd=PASSWD
</dt>
<dd>
<p>
Set HTTP password. This affects all URLs.
</p>
</dd>
<dt>
&#8212;http-proxy-user=USER
</dt>
<dd>
<p>
Set HTTP proxy user. This affects all URLs.
</p>
</dd>
<dt>
&#8212;http-proxy-passwd=PASSWD
</dt>
<dd>
<p>
Set HTTP proxy password. This affects all URLs.
</p>
</dd>
<dt>
&#8212;http-proxy-method=METHOD
</dt>
<dd>
<p>
Set the method to use in proxy request.
<em>METHOD</em> is either <em>get</em> or <em>tunnel</em>.
Default: <em>tunnel</em>
</p>
</dd>
<dt>
&#8212;http-auth-scheme=SCHEME
</dt>
<dd>
<p>
Set HTTP authentication scheme.
Currently, <em>basic</em> is the only supported scheme.
Default: <em>basic</em>
</p>
</dd>
<dt>
&#8212;referer=REFERER
</dt>
<dd>
<p>
Set Referer. This affects all URLs.
</p>
</dd>
<dt>
&#8212;ftp-user=USER
</dt>
<dd>
<p>
Set FTP user. This affects all URLs.
Default: <em>anonymous</em>
</p>
</dd>
<dt>
&#8212;ftp-passwd=PASSWD
</dt>
<dd>
<p>
Set FTP password. This affects all URLs.
Default: <em>ARIA2USER@</em>
</p>
</dd>
<dt>
&#8212;ftp-type=TYPE
</dt>
<dd>
<p>
Set FTP transfer type. TYPE is either <em>binary</em> or <em>ascii</em>.
Default: <em>binary</em>
</p>
</dd>
<dt>
-p, &#8212;ftp-pasv
</dt>
<dd>
<p>
Use passive mode in FTP.
</p>
</dd>
<dt>
&#8212;ftp-via-http-proxy=METHOD
</dt>
<dd>
<p>
Use HTTP proxy in FTP. METHOD is either <em>get</em> or <em>tunnel</em>.
Default: <em>tunnel</em>
</p>
</dd>
<dt>
&#8212;ftp-reuse-connection[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Reuse connection in FTP.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;lowest-speed-limit=SPEED
</dt>
<dd>
<p>
Close connection if download speed is lower than or equal to this
value(bytes per sec).
<em>0</em> means aria2 does not have a lowest speed limit.
You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
This option does not affect BitTorrent downloads.
Default: <em>0</em>
</p>
</dd>
<dt>
&#8212;max-download-limit=SPEED
</dt>
<dd>
<p>
Set max download speed in bytes per sec. <em>0</em> means unrestricted.
You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
Default: <em>0</em>
</p>
</dd>
<dt>
&#8212;file-allocation=METHOD
</dt>
<dd>
<p>
Specify file allocation method. METHOD is either <em>none</em> or <em>prealloc</em>.
<em>none</em> doesn't pre-allocate file space. <em>prealloc</em> pre-allocates file space
before download begins. This may take some time depending on the size of the
file.
Default: <em>prealloc</em>
</p>
<dl>
<dt>
Note
</dt>
<dd>
<p>
In multi file torrent, the files adjacent forward to the specified files
are also allocated if they share a same piece.
</p>
</dd>
</dl>
</dd>
<dt>
&#8212;no-file-allocation-limit=SIZE
</dt>
<dd>
<p>
No file allocation is made for files whose size is smaller than SIZE.
You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
Default: <em>5M</em>
</p>
</dd>
<dt>
&#8212;enable-direct-io[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable directI/O, which lowers cpu usage while allocating/checking files.
Turn off if you encounter any error.
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;allow-overwrite=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
If <em>false</em> 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 &#8212;auto-file-renaming=<em>true</em> then,
file name will be renamed. See &#8212;auto-file-renaming for details.
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;allow-piece-length-change=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
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: <em>false</em>
</p>
</dd>
<dt>
-Z, &#8212;force-sequential[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Fetch URIs in the command-line sequentially and download each URI in a
separate session, like the usual command-line download utilities.
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;auto-file-renaming[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
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: <em>true</em>
</p>
</dd>
<dt>
-P, &#8212;parameterized-uri[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable parameterized URI support.
You can specify set of parts: <em>http://{sv1,sv2,sv3}/foo.iso</em>.
Also you can specify numeric sequences with step counter:
<em>http://host/image[000-100:2].img</em>.
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: <em>false</em>
</p>
</dd>
<dt>
&#8212;enable-http-keep-alive[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable HTTP/1.1 persistent connection.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;enable-http-pipelining[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable HTTP/1.1 pipelining.
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;check-integrity=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
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: <em>false</em>
</p>
</dd>
<dt>
&#8212;realtime-chunk-checksum=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
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: <em>true</em>
</p>
</dd>
<dt>
-c, &#8212;continue
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
-U, &#8212;user-agent=USER_AGENT
</dt>
<dd>
<p>
Set user agent for HTTP(S) downloads.
</p>
</dd>
<dt>
-n, &#8212;no-netrc
</dt>
<dd>
<p>
Disables netrc support. netrc support is enabled by default.
</p>
</dd>
<dt>
-i, &#8212;input-file=FILE
</dt>
<dd>
<p>
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 <em>-</em> is specified.
</p>
</dd>
<dt>
-j, &#8212;max-concurrent-downloads=N
</dt>
<dd>
<p>
Set maximum number of parallel downloads.
Default: <em>1</em>
</p>
</dd>
<dt>
&#8212;load-cookies=FILE
</dt>
<dd>
<p>
Load cookies from FILE.
The format of FILE is the same used by Netscape and Mozilla.
</p>
</dd>
<dt>
&#8212;no-conf
</dt>
<dd>
<p>
Disable loading aria2.conf file.
</p>
</dd>
<dt>
&#8212;conf-path=PATH
</dt>
<dd>
<p>
Change the configuration file path to PATH.
Default: <em>$HOME/.aria2/aria2.conf</em>
</p>
</dd>
<dt>
&#8212;stop=SEC
</dt>
<dd>
<p>
Stop application after SEC seconds has passed.
If <em>0</em> is given, this feature is disabled.
Default: <em>0</em>
</p>
</dd>
<dt>
-S, &#8212;show-files
</dt>
<dd>
<p>
Print file listing of .torrent or .metalink file and exit.
In case of .torrent file, additional information
(infohash, piece length, etc) is also printed.
</p>
</dd>
<dt>
&#8212;select-file=INDEX&#8230;
</dt>
<dd>
<p>
Set file to download by specifing its index.
You can find the file index using the &#8212;show-files option.
Multiple indexes can be specified by using ",", for example: <em>3,6</em>.
You can also use "-" to specify a range: <em>1-5</em>.
"," and "-" can be used together: <em>1-5,8,9</em>.
When used with the -M option, index may vary depending on the query
(see &#8212;metalink-* options).
</p>
<dl>
<dt>
Note
</dt>
<dd>
<p>
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.
</p>
</dd>
</dl>
</dd>
<dt>
-T, &#8212;torrent-file=TORRENT_FILE
</dt>
<dd>
<p>
The path to the .torrent file.
You may not use this option because you can specify torrent file without -T.
</p>
</dd>
<dt>
&#8212;follow-torrent=<em>true</em>|<em>false</em>|<em>mem</em>
</dt>
<dd>
<p>
If <em>true</em> or <em>mem</em> 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 <em>mem</em> is specified, a torrent file is not written to the disk, but is just
kept in memory.
If <em>false</em> is specified, the action mentioned above is not taken.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;direct-file-mapping=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
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: <em>true</em>
</p>
</dd>
<dt>
&#8212;listen-port=PORT&#8230;
</dt>
<dd>
<p>
Set TCP port number for BitTorrent downloads.
Multiple ports can be specified by using ",", for example: <em>6881,6885</em>.
You can also use "-" to specify a range: <em>6881-6999</em>.
"," and "-" can be used together: <em>6881-6889,6999</em>.
Default: <em>6881-6999</em>
</p>
<dl>
<dt>
Note
</dt>
<dd>
<p>
Make sure that the specified ports are open for incoming TCP traffic.
</p>
</dd>
</dl>
</dd>
<dt>
&#8212;max-upload-limit=SPEED
</dt>
<dd>
<p>
Set max upload speed in bytes per sec. <em>0</em> means unrestricted.
You can append <em>K</em> or <em>M</em>(1K = 1024, 1M = 1024K).
Default: <em>0</em>
</p>
</dd>
<dt>
&#8212;seed-time=MINUTES
</dt>
<dd>
<p>
Specify seeding time in minutes. Also see the &#8212;seed-ratio option.
</p>
</dd>
<dt>
&#8212;seed-ratio=RATIO
</dt>
<dd>
<p>
Specify share ratio. Seed completed torrents until share ratio reaches]
RATIO.
I strongly encourages you to specify equals or more than <em>1.0</em> here.
Specify <em>0.0</em> if you intend to do seeding regardless of share ratio.
If &#8212;seed-time option is specified along with this option, seeding ends when
at least one of the conditions is satisfied.
Default: <em>1.0</em>
</p>
</dd>
<dt>
&#8212;peer-id-prefix=PEERI_ID_PREFIX
</dt>
<dd>
<p>
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: <em>-aria2-</em>
</p>
</dd>
<dt>
&#8212;enable-peer-exchange[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable Peer Exchange extension. If a private flag is set in a torrent, this
feature is disabled for that download even if <em>true</em> is given.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;enable-dht[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable DHT functionality. If a private flag is set in a torrent, aria2
doesn't use DHT for that download even if <em>true</em> is given.
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;dht-listen-port=PORT&#8230;
</dt>
<dd>
<p>
Set UDP listening port for DHT.
Multiple ports can be specified by using ",", for example: <em>6881,6885</em>.
You can also use "-" to specify a range: <em>6881-6999</em>. "," and "-" can be used
together.
Default: <em>6881-6999</em>
</p>
</dd>
<dt>
&#8212;dht-entry-point=HOST:PORT
</dt>
<dd>
<p>
Set host and port as an entry point to DHT network.
</p>
</dd>
<dt>
&#8212;bt-min-crypto-level=<em>plain</em>|<em>arc4</em>
</dt>
<dd>
<p>
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: <em>plain</em>
</p>
</dd>
<dt>
&#8212;bt-require-crypto=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
If true is given, aria2 doesn't accept and establish connection with legacy
BitTorrent handshake(\19BitTorrent protocol).
Thus aria2 always uses Obfuscation handshake.
Default: <em>false</em>
</p>
</dd>
<dt>
-M, &#8212;metalink-file=METALINK_FILE
</dt>
<dd>
<p>
The file path to .metalink file. You may not use this option because you can
specify metalink file without -M.
</p>
</dd>
<dt>
-C, &#8212;metalink-servers=NUM_SERVERS
</dt>
<dd>
<p>
The number of servers to connect to simultaneously.
Some metalinks regulates the number of servers to connect.
aria2 respects them.
Default: <em>1</em>
</p>
</dd>
<dt>
&#8212;metalink-version=VERSION
</dt>
<dd>
<p>
The version of the file to download.
</p>
</dd>
<dt>
&#8212;metalink-language=LANGUAGE
</dt>
<dd>
<p>
The language of the file to download.
</p>
</dd>
<dt>
&#8212;metalink-os=OS
</dt>
<dd>
<p>
The operating system of the file to download.
</p>
</dd>
<dt>
&#8212;metalink-location=LOCATION[,&#8230;]
</dt>
<dd>
<p>
The location of the preferred server.
A comma-deliminated list of locations is acceptable, for example, <em>JP,US</em>.
</p>
</dd>
<dt>
&#8212;metalink-preferred-protocol=PROTO
</dt>
<dd>
<p>
Specify preferred protocol.
The possible values are <em>http</em>, <em>https</em>, <em>ftp</em> and <em>none</em>.
Specifiy <em>none</em> to disable this feature.
Default: <em>none</em>
</p>
</dd>
<dt>
&#8212;follow-metalink=<em>true</em>|<em>false</em>|<em>mem</em>
</dt>
<dd>
<p>
If <em>true</em> or <em>mem</em> 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 <em>mem</em> is specified, a metalink file is not written to the disk, but is just
kept in memory.
If <em>false</em> is specified, the action mentioned above is not taken.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;metalink-enable-unique-protocol=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
If <em>true</em> is given and several protocols are available for a mirror in a
metalink file, aria2 uses one of them.
Use &#8212;metalink-preferred-protocol option to specify the preference of
protocol.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;header=HEADER
</dt>
<dd>
<p>
Append HEADER to HTTP request header.
You can use this option repeatedly to specify more than one header:
aria2c &#8212;header="X-A: b78" &#8212;header="X-B: 9J1" http://host/file
</p>
</dd>
<dt>
-q, &#8212;quiet[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Make aria2 quite (no console output).
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;async-dns[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable asynchronous DNS.
Default: <em>true</em>
</p>
</dd>
<dt>
-v, &#8212;version
</dt>
<dd>
<p>
Print the version number, copyright and the configuration information and
exit.
</p>
</dd>
<dt>
-h, &#8212;help[=CATEGORY]
</dt>
<dd>
<p>
Print usage and exit.
The help messages are classified in several categories.
For example, type "&#8212;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: <em>basic</em>, <em>advanced</em>, <em>http</em>, <em>ftp</em>, <em>metalink</em>,
<em>bittorrent</em>, <em>all</em>
Default: <em>basic</em>
</p>
</dd>
<dt>
URL, TORRENT_FILE, METALINK_FILE
</dt>
<dd>
<p>
You can specify multiple URLs. Unless you specify -Z option, all URLs must
point to the same file or downloading will fail.
You can also specify arbitrary number of torrent files and metalink files
stored in a local drive. Please note that they are always treated as a
separate download.
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.
</p>
<dl>
<dt>
Note
</dt>
<dd>
<p>
Make sure that URL is quoted with single(') or double(") quotation if it
contains "&amp;" or any characters that have special meaning in shell.
</p>
</dd>
</dl>
</dd>
</dl>
</div>
<h2>EXAMPLES</h2>
<div class="sectionbody">
<h3>HTTP/FTP Segmented Download</h3>
<h4>Download a file using 1 connection</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c http://host/file.zip</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">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.</td>
</tr></table>
</div>
<h4>Download a file using 2 connections</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -s2 http://host/file.zip</tt></pre>
</div></div>
<h4>Download a file from 2 different HTTP servers</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c http://host/file.zip http://mirror/file.zip</tt></pre>
</div></div>
<h4>Download a file from HTTP and FTP servers</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c http://host1/file.zip ftp://host2/file.zip</tt></pre>
</div></div>
<h4>Download files listed in a file concurrently</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -ifiles.txt -j2</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">-j option specifies the number of parallel downloads.</td>
</tr></table>
</div>
<h3>Metalink Download</h3>
<h4>Download files with remote Metalink</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --follow-metalink=mem http://host/file.metalink</tt></pre>
</div></div>
<h4>Download using a local metalink file</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -p --lowest-speed-limit=4000 file.metalink</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">To pause a download, press Ctrl-C.
You can resume the transfer by run aria2c with the same argument at the same
directory.</td>
</tr></table>
</div>
<h4>Download several local metalink files</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -j2 file1.metalink file2.metalink</tt></pre>
</div></div>
<h4>Download only selected files using index</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --select-file=1-4,8 file.metalink</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">The index is printed to the console using -S option.</td>
</tr></table>
</div>
<h4>Download a file using a local .metalink file with user preference</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US -C2 file.metalink</tt></pre>
</div></div>
<h3>BitTorrent Download</h3>
<h4>Download files from remote BitTorrent file</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --follow-bittorrent=mem http://host/file.torrent</tt></pre>
</div></div>
<h4>Download using a local torrent file</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --max-upload-limit=40K file.torrent</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">&#8212;max-upload-limit specifies the max of upload rate.</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.</td>
</tr></table>
</div>
<h4>Download 2 torrents</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -j2 file1.torrent file2.torrent</tt></pre>
</div></div>
<h4>Download a file using torrent and HTTP/FTP server</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -Ttest.torrent http://host1/file ftp://host2/file</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">Downloading multi file torrent with HTTP/FTP is not supported.</td>
</tr></table>
</div>
<h4>Download only selected files using index(usually called "selectable download")</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --select-file=1-4,8 file.torrent</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">The index is printed to the console using -S option.</td>
</tr></table>
</div>
<h4>Change the listening port for incoming peer</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --listen-port=7000-7001,8000 file.torrent</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">Since aria2 doesn't configure firewall or router for port forwarding, it's up
to you to do it manually.</td>
</tr></table>
</div>
<h4>Specify the condition to stop program after torrent download finished</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --seed-time=120 --seed-ratio=1.0 file.torrent</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.</td>
</tr></table>
</div>
<h4>Throttle upload speed</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --max-upload-limit=100K file.torrent</tt></pre>
</div></div>
<h4>Enable DHT</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --enable-dht --dht-listen-port=6881 file.torrent</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">DHT uses udp port. Since aria2 doesn't configure firewall or router for port
forwarding, it's up to you to do it manually.</td>
</tr></table>
</div>
<h3>More advanced HTTP features</h3>
<h4>Load cookies</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --load-cookies=cookies.txt http://host/file.zip</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">You can use Firefox/Mozilla's cookie file without modification.</td>
</tr></table>
</div>
<h4>Resume download started by web browsers or another programs</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -c -s2 http://host/partiallydownloadedfile.zip</tt></pre>
</div></div>
<h3>And more advanced features</h3>
<h4>Throttle download speed</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --max-download-limit=100K file.metalink</tt></pre>
</div></div>
<h4>Repair a damaged download using &#8212;check-integrity option</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --check-integrity=true file.metalink</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">This option is only available used with BitTorrent or metalink with chunk
checksums.</td>
</tr></table>
</div>
<h4>Drop connection if download speed is lower than specified value</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --lowest-speed-limit=10K file.metalink</tt></pre>
</div></div>
<h4>Parameterized URI support</h4>
<p>You can specify set of parts:</p>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -P http://{host1,host2,host3}/file.iso</tt></pre>
</div></div>
<p>You can specify numeric sequence:</p>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -Z -P http://host/image[000-100].png</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">-Z option is required if the all URIs don't point to the same file, such as the above example.</td>
</tr></table>
</div>
<p>You can specify step counter:</p>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -Z -P http://host/image[A-Z:2].png</tt></pre>
</div></div>
<h4>Parallel downloads of arbitrary number of URL,metalink,torrent</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -j3 -Z http://host/file1 file2.torrent file3.metalink</tt></pre>
</div></div>
<h4>BitTorrent Encryption</h4>
<p>Encrypt whole payload using ARC4:</p>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent</tt></pre>
</div></div>
</div>
<h2>RESUME DOWNLOAD</h2>
<div class="sectionbody">
<p>Usually, you can resume transfer by just issuing same command(aria2c URL)
if the previous transfer is made by aria2.</p>
<p>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).</p>
</div>
<h2>CONTROL FILE</h2>
<div class="sectionbody">
<p>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.)</p>
<p>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.</p>
<p>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
&#8212;check-integrity=true option to aria2c in command-line.</p>
</div>
<h2>SEEDING DOWNLOADED FILE IN BITTORRENT</h2>
<div class="sectionbody">
<p>You can seed downloaded file using &#8212;check-integrity=true option.</p>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c --check-integrity=true file.torrent</tt></pre>
</div></div>
</div>
<h2>FILES</h2>
<div class="sectionbody">
<h3>aria2.conf</h3>
<p>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 <em>&#8212;</em> prefix.
The lines beginning <em>#</em> are treated as comments.</p>
<div class="listingblock">
<div class="content">
<pre><tt># sample configuration file for aria2c
listen-port=60000
seed-ratio=1.0
max-upload-limit=50K
ftp-pasv=true</tt></pre>
</div></div>
<h3>dht.dat</h3>
<p>The routing table of DHT is saved to the path $HOME/.aria2/dht.dat.</p>
</div>
<h2>RESOURCES</h2>
<div class="sectionbody">
<p>Project web site: <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a></p>
<p>metalink: <a href="http://www.metalinker.org/">http://www.metalinker.org/</a></p>
</div>
<h2>REPORTING BUGS</h2>
<div class="sectionbody">
<p>Report bugs to Tatsuhiro Tsujikawa &lt;t-tujikawa@users.sourceforge.net&gt;</p>
</div>
<h2>AUTHOR</h2>
<div class="sectionbody">
<p>Tatsuhiro Tsujikawa &lt;t-tujikawa@users.sourceforge.net&gt;</p>
</div>
<h2>COPYRIGHT</h2>
<div class="sectionbody">
<p>Copyright &#169; 2006, 2008 Tatsuhiro Tsujikawa</p>
<p>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.</p>
<p>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.</p>
<p>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</p>
<p>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.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 10-May-2008 00:23:19 JST
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink