2008-02-26 12:38:45 +00:00
< !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" / >
2008-10-13 13:59:59 +00:00
< meta name = "generator" content = "AsciiDoc 8.2.7" / >
2008-02-26 12:38:45 +00:00
< 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;
2008-07-08 12:12:21 +00:00
color: navy;
2008-02-26 12:38:45 +00:00
}
strong {
font-weight: bold;
2008-07-08 12:12:21 +00:00
color: #083194;
2008-02-26 12:38:45 +00:00
}
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;
}
2008-06-17 14:22:20 +00:00
h1, h2, h3 {
2008-02-26 12:38:45 +00:00
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
2008-06-17 14:22:20 +00:00
h3 {
float: left;
}
h3 + * {
clear: left;
}
2008-02-26 12:38:45 +00:00
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
2008-07-08 12:12:21 +00:00
ul, ol, li > p {
margin-top: 0;
}
2008-02-26 12:38:45 +00:00
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 {
2008-07-08 12:12:21 +00:00
color: #527bbd;
2008-02-26 12:38:45 +00:00
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;
}
2008-10-13 13:59:59 +00:00
div.quoteblock {
2008-02-26 12:38:45 +00:00
padding-left: 2.0em;
}
2008-10-13 13:59:59 +00:00
div.quoteblock > div.attribution {
padding-top: 0.5em;
2008-02-26 12:38:45 +00:00
text-align: right;
}
2008-10-13 13:59:59 +00:00
div.verseblock {
padding-left: 2.0em;
}
div.verseblock > div.content {
white-space: pre;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
2008-02-26 12:38:45 +00:00
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.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;
2008-07-08 12:12:21 +00:00
font-style: normal;
2008-02-26 12:38:45 +00:00
}
dd > *:first-child {
2008-07-08 12:12:21 +00:00
margin-top: 0.1em;
2008-02-26 12:38:45 +00:00
}
ul, ol {
list-style-position: outside;
}
2008-07-08 12:12:21 +00:00
div.olist > ol {
list-style-type: decimal;
}
div.olist2 > ol {
2008-02-26 12:38:45 +00:00
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 {
2008-07-08 12:12:21 +00:00
padding-bottom: 15px;
2008-02-26 12:38:45 +00:00
}
td.hlist1 {
vertical-align: top;
2008-07-08 12:12:21 +00:00
font-style: normal;
2008-02-26 12:38:45 +00:00
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;
}
2008-10-13 13:59:59 +00:00
/* Overrides for manpage documents */
h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
h2 {
border-style: none;
}
div.sectionbody {
margin-left: 5%;
}
@media print {
div#toc { display: none; }
}
2008-02-26 12:38:45 +00:00
/* 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 {
2008-07-08 12:12:21 +00:00
color: #527bbd;
2008-02-26 12:38:45 +00:00
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;
}
2008-10-13 13:59:59 +00:00
div.quoteblock-attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock-content {
white-space: pre;
}
div.verseblock-attribution {
padding-top: 0.75em;
text-align: left;
2008-02-26 12:38:45 +00:00
}
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; }
2008-07-08 12:12:21 +00:00
/* Because IE6 child selector is broken. */
div.olist2 ol {
list-style-type: lower-alpha;
}
div.olist2 div.olist ol {
list-style-type: decimal;
}
2008-02-26 12:38:45 +00:00
< / style >
< title > ARIA2C(1)< / title >
< / head >
< body >
< div id = "header" >
2008-10-13 13:59:59 +00:00
< h1 >
ARIA2C(1) Manual Page
< / h1 >
< h2 > NAME< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-10-13 13:59:59 +00:00
< p > aria2c -
The ultra fast download utility
< / p >
< / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-10-13 13:59:59 +00:00
< h2 > SYNOPSIS< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > aria2c [< em > OPTIONS< / em > ] [< em > URL< / em > | < em > TORRENT_FILE< / em > | < em > METALINK_FILE< / em > ]… < / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_description" > DESCRIPTION< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-07-08 12:12:21 +00:00
< div class = "para" > < p > aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth. 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 >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_options" > OPTIONS< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< h3 id = "_basic_options" > Basic Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > -d< / strong > , < strong > --dir< / strong > =DIR
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
The directory to store the downloaded file.
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -i< / strong > , < strong > --input-file< / strong > =FILE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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.
2008-11-13 15:32:21 +00:00
The additional < strong > out< / strong > and < strong > dir< / strong > options can be specified after each line of
URIs. This optional line must start with white space(s).
See INPUT FILE section for details.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -l< / strong > , < strong > --log< / strong > =LOG
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
The file name of the log file. If < em > -< / em > is specified, log is written to
stdout.
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -j< / strong > , < strong > --max-concurrent-downloads< / strong > =N
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-07-08 14:23:30 +00:00
Set maximum number of parallel downloads for every static (HTTP/FTP) URL,
2008-11-11 11:55:23 +00:00
torrent and metalink. See also < strong > -s< / strong > and < strong > -C< / strong > option.
2008-05-19 12:36:20 +00:00
Default: < em > 5< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-16 08:06:56 +00:00
< strong > -V< / strong > , < strong > --check-integrity< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-16 08:06:56 +00:00
Check file integrity by validating piece hashes.
This option has effect only in BitTorrent and Metalink downloads with
2008-05-12 15:26:43 +00:00
chunk checksums.
Use this option to re-download a damaged portion of a file.
Default: < em > false< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -c< / strong > , < strong > --continue< / strong >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -h< / strong > , < strong > --help< / strong > [=CATEGORY]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Print usage and exit.
The help messages are classified in several categories.
2008-10-13 13:59:59 +00:00
For example, type "< strong > --help< / strong > =http" for detailed explanation for the options
2008-05-12 15:26:43 +00:00
related to HTTP. If no matching category is found, search option name using
2008-09-27 05:33:05 +00:00
a given word in middle match and print the result.
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_http_ftp_options" > HTTP/FTP Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-11-09 08:59:05 +00:00
< strong > --all-proxy< / strong > =PROXY
< / dt >
< dd >
< p >
Use this proxy server in the all protocols.
You can override this setting and specify a proxy server for particular
proctol using < strong > --http-proxy< / strong > , < strong > --https-proxy< / strong > and < strong > --ftp-proxy< / strong > options.
This affects all URLs.
The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --connect-timeout< / strong > =SEC
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
Set the connect timeout in seconds to establish connection to
HTTP/FTP/proxy server. After the connection is established, this
2008-10-13 13:59:59 +00:00
option makes no effect and < strong > --timeout< / strong > option is used instead.
2008-09-27 05:33:05 +00:00
Default: < em > 60< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --lowest-speed-limit< / strong > =SPEED
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --max-file-not-found< / strong > =NUM
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
If aria2 recieves `file not found' status from the remote HTTP/FTP
servers NUM times without getting a single byte, then force the
download to fail. Specify < em > 0< / em > to disable this option. This options is
only effective only when using HTTP/FTP servers.
Default: < em > 0< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -m< / strong > , < strong > --max-tries< / strong > =N
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set number of tries. < em > 0< / em > means unlimited.
Default: < em > 5< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --no-proxy< / strong > =DOMAINS
< / dt >
< dd >
< p >
Specify comma separated hostnames or domains to which proxy should not be
used.
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -o< / strong > , < strong > --out< / strong > =FILE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The file name of the downloaded file.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
2008-05-12 15:26:43 +00:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > In Metalink, BitTorrent download you cannot specify file name.
The file name specified here is only used when the URLs fed to aria2
2008-11-13 15:11:44 +00:00
is done by command line without < strong > -i< / strong > , < strong > -Z< / strong > option. For example:
2008-11-13 15:32:21 +00:00
aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip< / td >
2008-05-12 15:26:43 +00:00
< / tr > < / table >
< / div >
2008-06-17 14:22:20 +00:00
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-11-13 15:11:44 +00:00
< strong > --proxy-method< / strong > =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 >
2008-10-13 13:59:59 +00:00
< strong > -R< / strong > , < strong > --remote-time< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
Retrieve timestamp of the remote file from the remote HTTP/FTP
server and if it is available, apply it to the local file.
Default: < em > false< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --retry-wait< / strong > =SEC
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --server-stat-of< / strong > =FILE
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
Specify the filename to which performance profile of the servers is
2008-10-13 13:59:59 +00:00
saved. You can load saved data using < strong > --server-stat-if< / strong > option. See
2008-09-27 05:33:05 +00:00
SERVER PERFORMANCE PROFILE section below for file format.
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --server-stat-if< / strong > =FILE
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
Specify the filename to load performance profile of the servers. The
loaded data will be used in some URI selector such as < em > feedback< / em > .
2008-10-13 13:59:59 +00:00
See also < strong > --uri-selector< / strong > option. See SERVER PERFORMANCE PROFILE
2008-09-27 05:33:05 +00:00
section below for file format.
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --server-stat-timeout< / strong > =SEC
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
Specifies timeout in seconds to invalidate performance profile of
the servers since the last contact to them.
Default: < em > 86400< / em > (24hours)
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -s< / strong > , < strong > --split< / strong > =N
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-06-17 14:22:20 +00:00
Download a file using N connections.
If more than N URLs are given, first N URLs are used and remaining URLs are
used for backup.
2008-07-08 14:23:30 +00:00
If less than N URLs are given, those URLs are used more than once so that N
connections total are made simultaneously.
N must be between < em > 1< / em > and < em > 16< / em > . Please see < strong > -j< / strong > option too.
2008-11-11 11:55:23 +00:00
Please note that in Metalink download, this option has no effect and use
< strong > -C< / strong > option instead.
2008-06-17 14:22:20 +00:00
Default: < em > 5< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -t< / strong > , < strong > --timeout< / strong > =SEC
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set timeout in seconds.
Default: < em > 60< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-09-27 05:33:05 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --uri-selector< / strong > =SELECTOR
2008-09-27 05:33:05 +00:00
< / dt >
< dd >
< p >
Specify URI selection algorithm. Possible values are < em > inorder< / em > and
< em > feedback< / em > . If < em > inorder< / em > is given, URI is tried in the order
appeared in the URI list. If < em > feedback< / em > is given, aria2 uses
download speed observed in the previous downloads and choose fastest
server in the URI list. This also effectively skips dead
mirrors. The observed download speed is a part of performance
2008-10-13 13:59:59 +00:00
profile of servers mentioned in < strong > --server-stat-of< / strong > and
< strong > --server-stat-if< / strong > options.
2008-09-27 05:33:05 +00:00
Default: < em > inorder< / em >
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_http_specific_options" > HTTP Specific Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-11-09 08:59:05 +00:00
< strong > --ca-certificate< / strong > =FILE
< / dt >
< dd >
< p >
Use the certificate authorities in FILE to verify the peers.
The certificate file must be in PEM format and can contain multiple CA
certificates.
Use < strong > --check-certificate< / strong > option to enable verification.
< / p >
< / dd >
< dt >
< strong > --certificate< / strong > =FILE
< / dt >
< dd >
< p >
Use the client certificate in FILE.
The certificate must be in PEM format.
You may use < strong > --private-key< / strong > option to specify the private key.
< / p >
< / dd >
< dt >
< strong > --check-certificate< / strong > [=< em > true< / em > |< em > false< / em > ]
< / dt >
< dd >
< p >
Verify the peer using certificates specified in < strong > --ca-certificate< / strong > option.
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --http-auth-scheme< / strong > =SCHEME
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
Set HTTP authentication scheme.
Currently, < em > basic< / em > is the only supported scheme.
Default: < em > basic< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --http-user< / strong > =USER
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set HTTP user. This affects all URLs.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --http-passwd< / strong > =PASSWD
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set HTTP password. This affects all URLs.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --http-proxy< / strong > =PROXY
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-09 08:59:05 +00:00
Use this proxy server for HTTP. See also < strong > --all-proxy< / strong > option.
This affects all URLs.
The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --https-proxy< / strong > =PROXY
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-09 08:59:05 +00:00
Use this proxy server for HTTPS. See also < strong > --all-proxy< / strong > option.
This affects all URLs.
The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --private-key< / strong > =FILE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-09 08:59:05 +00:00
Use the private key in FILE.
The private key must be decrypted and in PEM format.
2008-11-09 09:06:25 +00:00
The behavior when encrypted one is given is undefined.
2008-11-09 08:59:05 +00:00
See also < strong > --certificate< / strong > option.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --referer< / strong > =REFERER
2008-05-09 15:34:43 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set Referer. This affects all URLs.
2008-05-09 15:34:43 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --enable-http-keep-alive< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Enable HTTP/1.1 persistent connection.
Default: < em > true< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --enable-http-pipelining< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Enable HTTP/1.1 pipelining.
Default: < em > false< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --header< / strong > =HEADER
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Append HEADER to HTTP request header.
You can use this option repeatedly to specify more than one header:
2008-11-13 15:32:21 +00:00
aria2c < strong > --header< / strong > ="X-A: b78" < strong > --header< / strong > ="X-B: 9J1" http://host/file
2008-02-26 12:38:45 +00:00
< / p >
2008-05-12 15:26:43 +00:00
< / dd >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --load-cookies< / strong > =FILE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-09-27 05:33:05 +00:00
Load Cookies from FILE using the Firefox3 format(SQLite3) and the
Mozilla/Firefox(1.x/2.x)/Netscape format.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-09-27 05:33:05 +00:00
< / dl > < / div >
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > If aria2 is build without libsqlite3, then it doesn't support Firefox3 cookie.< / td >
< / tr > < / table >
< / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > -U< / strong > , < strong > --user-agent< / strong > =USER_AGENT
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set user agent for HTTP(S) downloads.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_ftp_specific_options" > FTP Specific Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --ftp-user< / strong > =USER
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set FTP user. This affects all URLs.
Default: < em > anonymous< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --ftp-passwd< / strong > =PASSWD
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set FTP password. This affects all URLs.
Default: < em > ARIA2USER@< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-16 04:41:07 +00:00
< strong > -p< / strong > , < strong > --ftp-pasv< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-16 04:41:07 +00:00
Use the passive mode in FTP.
If < em > false< / em > is given, the active mode will be used.
Default: < em > true< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --ftp-proxy< / strong > =PROXY
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-09 08:59:05 +00:00
Use this proxy server for FTP. See also < strong > --all-proxy< / strong > option.
This affects all URLs.
The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --ftp-type< / strong > =TYPE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-09 08:59:05 +00:00
Set FTP transfer type. TYPE is either < em > binary< / em > or < em > ascii< / em > .
Default: < em > binary< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-11-09 08:59:05 +00:00
< strong > --ftp-reuse-connection< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-11-09 08:59:05 +00:00
Reuse connection in FTP.
Default: < em > true< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -n< / strong > , < strong > --no-netrc< / strong >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Disables netrc support. netrc support is enabled by default.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_bittorrent_metalink_options" > BitTorrent/Metalink Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --select-file< / strong > =INDEX…
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set file to download by specifing its index.
2008-10-13 13:59:59 +00:00
You can find the file index using the < strong > --show-files< / strong > option.
2008-05-12 15:26:43 +00:00
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
2008-10-13 13:59:59 +00:00
(see < strong > --metalink-< / strong > * options).
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
2008-05-12 15:26:43 +00:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > 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.< / td >
< / tr > < / table >
< / div >
2008-06-17 14:22:20 +00:00
< div class = "vlist" > < dl >
2008-05-12 15:26:43 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > -S< / strong > , < strong > --show-files< / strong >
2008-05-12 15:26:43 +00:00
< / 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.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_bittorrent_specific_options" > BitTorrent Specific Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --bt-max-open-files< / strong > =NUM
2008-06-17 14:22:20 +00:00
< / dt >
< dd >
< p >
Specify maximum number of files to open in each BitTorrent download.
Default: < em > 100< / em >
< / p >
< / dd >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --bt-min-crypto-level< / strong > =< em > plain< / em > |< em > arc4< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --bt-require-crypto< / strong > =< em > true< / em > |< em > false< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --bt-request-peer-speed-limit< / strong > =SPEED
2008-06-17 14:22:20 +00:00
< / dt >
< dd >
< p >
In BitTorrent downloads, if the download speed is lower than SPEED,
aria2 initiates and accepts connections ignoring max peer cap.
You can append < em > K< / em > or < em > M< / em > (1K = 1024, 1M = 1024K).
Default: < em > 51200< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --bt-seed-unverified< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-07-08 14:23:30 +00:00
< / dt >
< dd >
< p >
2008-07-12 13:55:32 +00:00
Seed previously downloaded files without verifying piece hashes.
2008-07-08 14:23:30 +00:00
Default: < em > false< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --dht-entry-point< / strong > =HOST:PORT
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Set host and port as an entry point to DHT network.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --dht-file-path< / strong > =PATH
< / dt >
< dd >
< p >
Change the DHT routing table file to PATH.
Default: < em > $HOME/.aria2/dht.dat< / em >
< / p >
< / dd >
< dt >
< strong > --dht-listen-port< / strong > =PORT…
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --direct-file-mapping< / strong > =< em > true< / em > |< em > false< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --enable-dht< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --enable-peer-exchange< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --follow-torrent< / strong > =< em > true< / em > |< em > false< / em > |< em > mem< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --listen-port< / strong > =PORT…
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
2008-05-12 15:26:43 +00:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > Make sure that the specified ports are open for incoming TCP traffic.< / td >
< / tr > < / table >
< / div >
2008-06-17 14:22:20 +00:00
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-11-16 08:13:51 +00:00
< strong > -u< / strong > , < strong > --max-upload-limit< / strong > =SPEED
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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).
2008-02-26 12:38:45 +00:00
Default: < em > 0< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --peer-id-prefix< / strong > =PEERI_ID_PREFIX
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --seed-ratio< / strong > =RATIO
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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.
2008-10-13 13:59:59 +00:00
If < strong > --seed-time< / strong > option is specified along with this option, seeding ends when
2008-05-12 15:26:43 +00:00
at least one of the conditions is satisfied.
Default: < em > 1.0< / em >
2008-02-26 12:38:45 +00:00
< / p >
2008-05-12 15:26:43 +00:00
< / dd >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --seed-time< / strong > =MINUTES
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-10-13 13:59:59 +00:00
Specify seeding time in minutes. Also see the < strong > --seed-ratio< / strong > option.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -T< / strong > , < strong > --torrent-file< / strong > =TORRENT_FILE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
The path to the .torrent file.
2008-05-09 15:34:43 +00:00
You may not use this option because you can specify torrent file without -T.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_metalink_specific_options" > Metalink Specific Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --follow-metalink< / strong > =< em > true< / em > |< em > false< / em > |< em > mem< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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
2008-02-26 12:38:45 +00:00
file and downloads files mentioned in it.
2008-05-12 15:26:43 +00:00
If < em > mem< / em > is specified, a metalink file is not written to the disk, but is just
2008-02-26 12:38:45 +00:00
kept in memory.
If < em > false< / em > is specified, the action mentioned above is not taken.
Default: < em > true< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -M< / strong > , < strong > --metalink-file< / strong > =METALINK_FILE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The file path to .metalink file. You may not use this option because you can
specify metalink file without -M.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -C< / strong > , < strong > --metalink-servers< / strong > =NUM_SERVERS
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The number of servers to connect to simultaneously.
2008-11-11 11:55:23 +00:00
Some Metalinks regulates the number of servers to connect.
aria2 strictly respects them.
This means that if Metalink defines the maxconnections attribute lower
than NUM_SERVERS, then aria2 uses the value of maxconnections attribute
instead of NUM_SERVERS.
See also < strong > -s< / strong > and < strong > -j< / strong > options.
2008-05-19 12:36:20 +00:00
Default: < em > 5< / em >
2008-02-26 12:38:45 +00:00
< / p >
2008-05-12 15:26:43 +00:00
< / dd >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --metalink-language< / strong > =LANGUAGE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The language of the file to download.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --metalink-location< / strong > =LOCATION[,… ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The location of the preferred server.
A comma-deliminated list of locations is acceptable, for example, < em > JP,US< / em > .
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --metalink-os< / strong > =OS
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The operating system of the file to download.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --metalink-version< / strong > =VERSION
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
The version of the file to download.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --metalink-preferred-protocol< / strong > =PROTO
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --metalink-enable-unique-protocol< / strong > =< em > true< / em > |< em > false< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
If < em > true< / em > is given and several protocols are available for a mirror in a
metalink file, aria2 uses one of them.
2008-10-13 13:59:59 +00:00
Use < strong > --metalink-preferred-protocol< / strong > option to specify the preference of
2008-05-12 15:26:43 +00:00
protocol.
2008-02-26 12:38:45 +00:00
Default: < em > true< / em >
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
< h3 id = "_advanced_options" > Advanced Options< / h3 > < div style = "clear:left" > < / div >
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --allow-overwrite< / strong > =< em > true< / em > |< em > false< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
If < em > false< / em > is given, aria2 doesn't download a file which already exists but
the corresponding .aria2 file doesn't exist.
2008-10-13 13:59:59 +00:00
In HTTP(S)/FTP download, if < strong > --auto-file-renaming< / strong > =< em > true< / em > then,
file name will be renamed. See < strong > --auto-file-renaming< / strong > for details.
2008-02-26 12:38:45 +00:00
Default: < em > false< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --allow-piece-length-change< / strong > =< em > true< / em > |< em > false< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --async-dns< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Enable asynchronous DNS.
Default: < em > true< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --auto-file-renaming< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --auto-save-interval< / strong > =SEC
< / dt >
< dd >
< p >
Save a control file(*.aria2) every SEC seconds.
If < em > 0< / em > is given, a control file is not saved during download. aria2 saves a
control file when it stops regardless of the value.
The possible values are between < em > 0< / em > to < em > 600< / em > .
Default: < em > 60< / em >
< / p >
< / dd >
< dt >
< strong > --conf-path< / strong > =PATH
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Change the configuration file path to PATH.
Default: < em > $HOME/.aria2/aria2.conf< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -D< / strong > , < strong > --daemon< / strong >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Run as daemon.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --enable-direct-io< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Enable directI/O, which lowers cpu usage while allocating/checking files.
Turn off if you encounter any error.
2008-11-15 14:47:26 +00:00
Default: < em > true< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --file-allocation< / strong > =METHOD
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-05-15 15:57:04 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > --log-level< / strong > =LEVEL
2008-05-15 15:57:04 +00:00
< / dt >
< dd >
< p >
Set log level to output.
LEVEL is either < em > debug< / em > , < em > info< / em > , < em > notice< / em > , < em > warn< / em > or < em > error< / em > .
Default: < em > debug< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --summary-interval< / strong > =SEC
2008-05-15 15:57:04 +00:00
< / dt >
< dd >
< p >
Set interval in seconds to output download progress summary.
Setting < em > 0< / em > suppresses the output.
Default: < em > 60< / em >
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
2008-05-12 15:26:43 +00:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > In multi file torrent, the files adjacent forward to the specified files
are also allocated if they share a same piece.< / td >
< / tr > < / table >
< / div >
2008-06-17 14:22:20 +00:00
< div class = "vlist" > < dl >
2008-02-26 12:38:45 +00:00
< dt >
2008-10-13 13:59:59 +00:00
< strong > -Z< / strong > , < strong > --force-sequential< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --max-download-limit< / strong > =SPEED
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --no-conf< / strong >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Disable loading aria2.conf file.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --no-file-allocation-limit< / strong > =SIZE
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -P< / strong > , < strong > --parameterized-uri< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-05-06 15:43:26 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-05-06 15:43:26 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -q< / strong > , < strong > --quiet< / strong > [=< em > true< / em > |< em > false< / em > ]
2008-05-06 15:43:26 +00:00
< / dt >
< dd >
< p >
Make aria2 quite (no console output).
Default: < em > false< / em >
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --realtime-chunk-checksum< / strong > =< em > true< / em > |< em > false< / em >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
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 >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > --stop< / strong > =SEC
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Stop application after SEC seconds has passed.
If < em > 0< / em > is given, this feature is disabled.
Default: < em > 0< / em >
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
< dt >
2008-10-13 13:59:59 +00:00
< strong > -v< / strong > , < strong > --version< / strong >
2008-02-26 12:38:45 +00:00
< / dt >
< dd >
< p >
2008-05-12 15:26:43 +00:00
Print the version number, copyright and the configuration information and
exit.
2008-02-26 12:38:45 +00:00
< / p >
< / dd >
2008-06-17 14:22:20 +00:00
< / dl > < / div >
2008-11-20 12:21:39 +00:00
< h3 id = "_options_that_take_an_optional_argument" > OPTIONS THAT TAKE AN OPTIONAL ARGUMENT< / h3 > < div style = "clear:left" > < / div >
< div class = "para" > < p > The options that have its argument surrounded by square brackets([])
take an optional argument. Usually ommiting the argument is evaluated to < em > true< / em > .
If you use short form of these options(such as < em > -V< / em > ) and give
an arugment, then the option name and its argument should be concatenated(e.g.
< em > -Vfalse< / em > ). If any spaces are inserted between the option name and the argument,
the argument will be treated as URI and usually this is not what you expect.< / p > < / div >
2008-06-17 14:22:20 +00:00
< h3 id = "_url_torrent_file_metalink_file" > URL, TORRENT_FILE, METALINK_FILE< / h3 > < div style = "clear:left" > < / div >
< div class = "para" > < p > You can specify multiple URLs in command-line.
Unless you specify < strong > -Z< / strong > option, all URLs must point to the same file or downloading will fail.< / p > < / div >
< div class = "para" > < p > You can also specify arbitrary number of torrent files and metalink files
2008-05-12 15:26:43 +00:00
stored in a local drive. Please note that they are always treated as a
2008-06-17 14:22:20 +00:00
separate download.< / p > < / div >
< div class = "para" > < p > You can specify both torrent file with -T option and URLs. By doing this,
2008-05-12 15:26:43 +00:00
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
2008-06-17 14:22:20 +00:00
only single file torrent can be integrated with HTTP(S)/FTP.< / p > < / div >
2008-05-12 15:26:43 +00:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > Make sure that URL is quoted with single(') or double(") quotation if it
contains "& " or any characters that have special meaning in shell.< / td >
< / tr > < / table >
< / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_examples" > EXAMPLES< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< h3 id = "_http_ftp_segmented_download" > HTTP/FTP Segmented Download< / h3 > < div style = "clear:left" > < / div >
< h4 id = "_download_a_file" > Download a file< / h4 >
2008-02-26 12:38:45 +00:00
< 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 >
2008-06-17 14:22:20 +00:00
< td class = "content" > aria2 uses 5 connections to download 1 file by default.< / td >
2008-02-26 12:38:45 +00:00
< / tr > < / table >
< / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_a_file_using_1_connection" > Download a file using 1 connection< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-06-17 14:22:20 +00:00
< pre > < tt > aria2c -s1 http://host/file.zip< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-06-17 14:22:20 +00:00
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > aria2 uses 5 connections to download 1 file by default.
-s1 limtis the number of connections to just 1.< / 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 running 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 id = "_download_a_file_from_2_different_http_servers" > Download a file from 2 different HTTP servers< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-04-15 12:37:15 +00:00
< pre > < tt > aria2c http://host/file.zip http://mirror/file.zip< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_a_file_from_http_and_ftp_servers" > Download a file from HTTP and FTP servers< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c http://host1/file.zip ftp://host2/file.zip< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_files_listed_in_a_file_concurrently" > Download files listed in a file concurrently< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c -ifiles.txt -j2< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
2008-05-09 15:34:43 +00:00
< td class = "content" > -j option specifies the number of parallel downloads.< / td >
2008-02-26 12:38:45 +00:00
< / tr > < / table >
< / div >
2008-11-09 09:13:57 +00:00
< h4 id = "_using_proxy" > Using proxy< / h4 >
< div class = "para" > < p > For HTTP:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c --http-proxy=http://proxy:8080 http://host/file< / tt > < / pre >
< / div > < / div >
< div class = "para" > < p > For FTP:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c --ftp-proxy=http://proxy:8080 ftp://host/file< / tt > < / pre >
< / div > < / div >
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > See < strong > --http-proxy< / strong > , < strong > --https-proxy< / strong > , < strong > --ftp-proxy< / strong > and < strong > --all-proxy< / strong > for
details.
You can specify proxy in the environment variables. See ENVIRONMENT section.< / td >
< / tr > < / table >
< / div >
< h4 id = "_proxy_with_authorization" > Proxy with authorization< / h4 >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c --http-proxy=http://username:password@proxy:8080 http://host/file< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h3 id = "_metalink_download" > Metalink Download< / h3 > < div style = "clear:left" > < / div >
< h4 id = "_download_files_with_remote_metalink" > Download files with remote Metalink< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c --follow-metalink=mem http://host/file.metalink< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_using_a_local_metalink_file" > Download using a local metalink file< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c -p --lowest-speed-limit=4000 file.metalink< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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.
2008-05-12 15:26:43 +00:00
You can resume the transfer by running aria2c with the same argument at the same
2008-02-26 12:38:45 +00:00
directory.< / td >
< / tr > < / table >
< / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_several_local_metalink_files" > Download several local metalink files< / h4 >
2008-05-09 15:34:43 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c -j2 file1.metalink file2.metalink< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_only_selected_files_using_index" > Download only selected files using index< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --select-file=1-4,8 file.metalink< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_a_file_using_a_local_metalink_file_with_user_preference" > Download a file using a local .metalink file with user preference< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-19 12:36:20 +00:00
< pre > < tt > aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US file.metalink< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h3 id = "_bittorrent_download" > BitTorrent Download< / h3 > < div style = "clear:left" > < / div >
< h4 id = "_download_files_from_remote_bittorrent_file" > Download files from remote BitTorrent file< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-08-14 14:02:18 +00:00
< pre > < tt > aria2c --follow-torrent=mem http://host/file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_using_a_local_torrent_file" > Download using a local torrent file< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --max-upload-limit=40K file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
2008-10-13 13:59:59 +00:00
< td class = "content" > --max-upload-limit specifies the max of upload rate.< / td >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_2_torrents" > Download 2 torrents< / h4 >
2008-05-09 15:34:43 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c -j2 file1.torrent file2.torrent< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_a_file_using_torrent_and_http_ftp_server" > Download a file using torrent and HTTP/FTP server< / h4 >
2008-02-26 12:38:45 +00:00
< 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_download_only_selected_files_using_index_usually_called_selectable_download" > Download only selected files using index(usually called "selectable download")< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --select-file=1-4,8 file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_change_the_listening_port_for_incoming_peer" > Change the listening port for incoming peer< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --listen-port=7000-7001,8000 file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_specify_the_condition_to_stop_program_after_torrent_download_finished" > Specify the condition to stop program after torrent download finished< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --seed-time=120 --seed-ratio=1.0 file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_throttle_upload_speed" > Throttle upload speed< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --max-upload-limit=100K file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_enable_dht" > Enable DHT< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --enable-dht --dht-listen-port=6881 file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h3 id = "_more_advanced_http_features" > More advanced HTTP features< / h3 > < div style = "clear:left" > < / div >
< h4 id = "_load_cookies" > Load cookies< / h4 >
2008-02-26 12:38:45 +00:00
< 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_resume_download_started_by_web_browsers_or_another_programs" > Resume download started by web browsers or another programs< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c -c -s2 http://host/partiallydownloadedfile.zip< / tt > < / pre >
< / div > < / div >
2008-11-09 09:06:25 +00:00
< h4 id = "_client_certificate_authorization_for_ssl_tls" > Client certificate authorization for SSL/TLS< / h4 >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c --certificate=/path/to/mycert.pem --private-key=/path/to/mykey.pem https://host/file< / tt > < / pre >
< / div > < / div >
< div class = "admonitionblock" >
< table > < tr >
< td class = "icon" >
< div class = "title" > Note< / div >
< / td >
< td class = "content" > The file specified in < strong > --private-key< / strong > must be decrypted. The behavior when
encrypted one is given is undefined.< / td >
< / tr > < / table >
< / div >
< h4 id = "_verify_peer_in_ssl_tls_using_given_ca_certificates" > Verify peer in SSL/TLS using given CA certificates< / h4 >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c --ca-certificate=/path/to/ca-certificates.crt --check-certificate https://host/file< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h3 id = "_and_more_advanced_features" > And more advanced features< / h3 > < div style = "clear:left" > < / div >
< h4 id = "_throttle_download_speed" > Throttle download speed< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --max-download-limit=100K file.metalink< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-11-16 08:06:56 +00:00
< h4 id = "_repair_a_damaged_download_using_v_option" > Repair a damaged download using -V option< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-11-16 08:06:56 +00:00
< pre > < tt > aria2c -V file.metalink< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / 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 >
2008-06-17 14:22:20 +00:00
< h4 id = "_drop_connection_if_download_speed_is_lower_than_specified_value" > Drop connection if download speed is lower than specified value< / h4 >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --lowest-speed-limit=10K file.metalink< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_parameterized_uri_support" > Parameterized URI support< / h4 >
< div class = "para" > < p > You can specify set of parts:< / p > < / div >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c -P http://{host1,host2,host3}/file.iso< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > You can specify numeric sequence:< / p > < / div >
2008-02-26 12:38:45 +00:00
< 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 >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > You can specify step counter:< / p > < / div >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c -Z -P http://host/image[A-Z:2].png< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_parallel_downloads_of_arbitrary_number_of_url_metalink_torrent" > Parallel downloads of arbitrary number of URL,metalink,torrent< / h4 >
2008-05-09 15:34:43 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > aria2c -j3 -Z http://host/file1 file2.torrent file3.metalink< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h4 id = "_bittorrent_encryption" > BitTorrent Encryption< / h4 >
< div class = "para" > < p > Encrypt whole payload using ARC4:< / p > < / div >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-05-09 15:34:43 +00:00
< pre > < tt > aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_resume_download" > RESUME DOWNLOAD< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > Usually, you can resume transfer by just issuing same command(aria2c URL)
if the previous transfer is made by aria2.< / p > < / div >
< div class = "para" > < 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 >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_control_file" > CONTROL FILE< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > aria2 uses a control file to keep track the progress of download.
2008-02-26 12:38:45 +00:00
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.
2008-06-17 14:22:20 +00:00
The "top directory" name is a value of "name" key in "info" directory in a torrent file.)< / p > < / div >
< div class = "para" > < p > Usually a control file is deleted once download completed.
2008-02-26 12:38:45 +00:00
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
2008-06-17 14:22:20 +00:00
not created.< / p > < / div >
< div class = "para" > < p > Normally if you lose a control file, you cannot resume download.
2008-02-26 12:38:45 +00:00
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
2008-11-16 08:06:56 +00:00
-V option to aria2c in command-line.< / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_seeding_downloaded_file_in_bittorrent" > SEEDING DOWNLOADED FILE IN BITTORRENT< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-11-16 08:06:56 +00:00
< div class = "para" > < p > You can seed downloaded file using -V option.< / p > < / div >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
2008-11-16 08:06:56 +00:00
< pre > < tt > aria2c -V file.torrent< / tt > < / pre >
2008-02-26 12:38:45 +00:00
< / div > < / div >
< / div >
2008-11-13 15:32:21 +00:00
< h2 id = "_input_file" > INPUT FILE< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > The input file can contain list of URIs to feed them into aria2.
You can specify multiple URIs for a single entity:
separate URIs on a single line using the TAB character.< / p > < / div >
< div class = "para" > < p > Each line is treated as if it is provided in command-line argument.
Therefore they are affected by < strong > -Z< / strong > and < strong > -P< / strong > options.
The additional < strong > out< / strong > and < strong > dir< / strong > options can be specified after each line of
URIs. This optional line must start with white space(s).< / p > < / div >
2008-11-18 11:36:24 +00:00
< div class = "para" > < p > For example, let the content of uri.txt be< / p > < / div >
2008-11-13 15:32:21 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > http://server/file.iso http://mirror/file.iso
dir=/iso_images
out=file.img
http://foo/bar< / tt > < / pre >
< / div > < / div >
2008-11-18 11:36:24 +00:00
< div class = "para" > < p > If aria2 is executed with < strong > -i< / strong > uri.txt < strong > -d< / strong > /tmp options,
then < em > file.iso< / em > is saved as < em > /iso_images/file.img< / em > and it is downloaded from
2008-11-13 15:32:21 +00:00
http://server/file.iso and http://mirror/file.iso.
2008-11-18 11:36:24 +00:00
The file < em > bar< / em > is downloaded from http://foo/bar and saved as < em > /tmp/bar< / em > .< / p > < / div >
< div class = "para" > < p > In some cases, < strong > out< / strong > parameter has no effect.
See note of < strong > --out< / strong > option for the restrictions.< / p > < / div >
2008-11-13 15:32:21 +00:00
< / div >
2008-09-27 05:33:05 +00:00
< h2 id = "_server_performance_profile" > SERVER PERFORMANCE PROFILE< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > This section describes the format of server performance profile.
The file is plain text and each line has several NAME=VALUE pair, delimited by
comma.
Currently following NAMEs are recognized:< / p > < / div >
< div class = "vlist" > < dl >
< dt >
host
< / dt >
< dd >
< p >
Hostname of the server. Required.
< / p >
< / dd >
< dt >
protocol
< / dt >
< dd >
< p >
Protocol for this profile, such as ftp, http. Required.
< / p >
< / dd >
< dt >
dl_speed
< / dt >
< dd >
< p >
The average download speed observed in the previous download in bytes per sec.
Required.
< / p >
< / dd >
< dt >
last_updated
< / dt >
< dd >
< p >
Last contact time in GMT with this server, specified in the seconds from the
Epoch. Required.
< / p >
< / dd >
< dt >
status
< / dt >
< dd >
< p >
ERROR is set when server cannot be reached or out-of-service or timeout
occurred. Otherwise, OK is set.
< / p >
< / dd >
< / dl > < / div >
< div class = "para" > < p > Those fields must exist in one line. The order of the fields is not significant.You can put pairs other than above; they are simply ignored.< / p > < / div >
< div class = "para" > < p > An example is follow:< / p > < / div >
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR< / tt > < / pre >
< / div > < / div >
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_files" > FILES< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< h3 id = "_aria2_conf" > aria2.conf< / h3 > < div style = "clear:left" > < / div >
< div class = "para" > < p > User configuration file.
2008-02-26 12:38:45 +00:00
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,
2008-10-13 13:59:59 +00:00
where name is the long command-line option name without < em > --< / em > prefix.
2008-06-17 14:22:20 +00:00
The lines beginning < em > #< / em > are treated as comments.< / p > < / div >
2008-02-26 12:38:45 +00:00
< div class = "listingblock" >
< div class = "content" >
< pre > < tt > # sample configuration file for aria2c
listen-port=60000
2008-05-12 15:26:43 +00:00
dht-listen-port=60000
2008-02-26 12:38:45 +00:00
seed-ratio=1.0
2008-05-09 15:34:43 +00:00
max-upload-limit=50K
2008-02-26 12:38:45 +00:00
ftp-pasv=true< / tt > < / pre >
< / div > < / div >
2008-06-17 14:22:20 +00:00
< h3 id = "_dht_dat" > dht.dat< / h3 > < div style = "clear:left" > < / div >
2008-10-13 13:59:59 +00:00
< div class = "para" > < p > By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.< / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-11-09 08:59:05 +00:00
< h2 id = "_environment" > ENVIRONMENT< / h2 >
< div class = "sectionbody" >
< div class = "para" > < p > aria2 recognizes the following environment variables.< / p > < / div >
< div class = "vlist" > < dl >
< dt >
http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
< / dt >
< dd >
< p >
Specify proxy server for use in HTTP.
Overrides http-proxy value in configuration file.
The command-line option < strong > --http-proxy< / strong > overrides this value.
< / p >
< / dd >
< dt >
https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
< / dt >
< dd >
< p >
Specify proxy server for use in HTTPS.
Overrides https-proxy value in configuration file.
The command-line option < strong > --https-proxy< / strong > overrides this value.
< / p >
< / dd >
< dt >
ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
< / dt >
< dd >
< p >
Specify proxy server for use in FTP.
Overrides ftp-proxy value in configuration file.
The command-line option < strong > --ftp-proxy< / strong > overrides this value.
< / p >
< / dd >
< dt >
all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
< / dt >
< dd >
< p >
Specify proxy server for use if no protocol-specific proxy is specified.
Overrides all-proxy value in configuration file.
The command-line option < strong > --all-proxy< / strong > overrides this value.
< / p >
< / dd >
< dt >
no_proxy [DOMAIN,… ]
< / dt >
< dd >
< p >
Specify comma-separated hostname or domains to which proxy should not be used.
Overrides no-proxy value in configuration file.
The command-line option < strong > --no-proxy< / strong > overrides this value.
< / p >
< / dd >
< / dl > < / div >
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_resources" > RESOURCES< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > Project web site: < a href = "http://aria2.sourceforge.net/" > http://aria2.sourceforge.net/< / a > < / p > < / div >
< div class = "para" > < p > metalink: < a href = "http://www.metalinker.org/" > http://www.metalinker.org/< / a > < / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_reporting_bugs" > REPORTING BUGS< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-10-14 13:16:59 +00:00
< div class = "para" > < p > Report bugs to Tatsuhiro Tsujikawa < t-tujikawa at users.sourceforge.net> < / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_author" > AUTHOR< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-10-14 13:16:59 +00:00
< div class = "para" > < p > Tatsuhiro Tsujikawa < t-tujikawa at users.sourceforge.net> < / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
2008-06-17 14:22:20 +00:00
< h2 id = "_copyright" > COPYRIGHT< / h2 >
2008-02-26 12:38:45 +00:00
< div class = "sectionbody" >
2008-06-17 14:22:20 +00:00
< div class = "para" > < p > Copyright © 2006, 2008 Tatsuhiro Tsujikawa< / p > < / div >
< div class = "para" > < p > This program is free software; you can redistribute it and/or modify
2008-02-26 12:38:45 +00:00
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
2008-06-17 14:22:20 +00:00
(at your option) any later version.< / p > < / div >
< div class = "para" > < p > This program is distributed in the hope that it will be useful,
2008-02-26 12:38:45 +00:00
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2008-06-17 14:22:20 +00:00
GNU General Public License for more details.< / p > < / div >
< div class = "para" > < p > You should have received a copy of the GNU General Public License
2008-02-26 12:38:45 +00:00
along with this program; if not, write to the Free Software
2008-06-17 14:22:20 +00:00
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA< / p > < / div >
< div class = "para" > < p > In addition, as a special exception, the copyright holders give
2008-02-26 12:38:45 +00:00
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
2008-06-17 14:22:20 +00:00
files in the program, then also delete it here.< / p > < / div >
2008-02-26 12:38:45 +00:00
< / div >
< div id = "footer" >
< div id = "footer-text" >
2008-11-20 12:21:39 +00:00
Last updated 2008-11-20 21:02:18 JST
2008-02-26 12:38:45 +00:00
< / div >
< / div >
< / body >
< / html >
