aria2/doc/aria2c.1

'\" t
.\"     Title: aria2c
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 11/29/2009
.\"    Manual: Aria2 Manual
.\"    Source: Aria2
.\"  Language: English
.\"
.TH "ARIA2C" "1" "11/29/2009" "Aria2" "Aria2 Manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
aria2c \- The ultra fast download utility
.SH "SYNOPSIS"
.sp
aria2c [\fIOPTIONS\fR] [\fIURI\fR | \fIMAGNET\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&...
.SH "DESCRIPTION"
.sp
aria2 is a utility for downloading files\&. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\&. aria2 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\(cqs chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\&.
.SH "OPTIONS"
.SS "Basic Options"
.PP
\fB\-d\fR, \fB\-\-dir\fR=DIR
.RS 4
The directory to store the downloaded file\&.
.RE
.PP
\fB\-i\fR, \fB\-\-input\-file\fR=FILE
.RS 4
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
\fI\-\fR
is specified\&. The additional
\fBout\fR
and
\fBdir\fR
options can be specified after each line of URIs\&. This optional line must start with white space(s)\&. See
\fBInput File\fR
subsection for details\&.
.RE
.PP
\fB\-l\fR, \fB\-\-log\fR=LOG
.RS 4
The file name of the log file\&. If
\fI\-\fR
is specified, log is written to stdout\&.
.RE
.PP
\fB\-j\fR, \fB\-\-max\-concurrent\-downloads\fR=N
.RS 4
Set maximum number of parallel downloads for every static (HTTP/FTP) URL, torrent and metalink\&. See also
\fB\-s\fR
and
\fB\-C\fR
option\&. Default:
\fI5\fR
.RE
.PP
\fB\-V\fR, \fB\-\-check\-integrity\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Check file integrity by validating piece hashes\&. This option has effect only in BitTorrent and Metalink downloads with chunk checksums\&. Use this option to re\-download a damaged portion of a file\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-c\fR, \fB\-\-continue\fR
.RS 4
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\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR[=TAG|KEYWORD]
.RS 4
The help messages are classified with tags\&. A tag starts with "#"\&. For example, type "\-\-help=#http" to get the usage for the options tagged with "#http"\&. If non\-tag word is given, print the usage for the options whose name includes that word\&. Available Values:
\fI#basic\fR,
\fI#advanced\fR,
\fI#http\fR,
\fI#https\fR,
\fI#ftp\fR,
\fI#metalink\fR,
\fI#bittorrent\fR,
\fI#cookie\fR,
\fI#hook\fR,
\fI#file\fR,
\fI#xml\-rpc\fR,
\fI#experimental\fR,
\fI#all\fR
Default:
\fI#basic\fR
.RE
.SS "HTTP/FTP Options"
.PP
\fB\-\-all\-proxy\fR=PROXY
.RS 4
Use this proxy server for all protocols\&. You can override this setting and specify a proxy server for a particular protocol using
\fB\-\-http\-proxy\fR,
\fB\-\-https\-proxy\fR
and
\fB\-\-ftp\-proxy\fR
options\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE
.PP
\fB\-\-connect\-timeout\fR=SEC
.RS 4
Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server\&. After the connection is established, this option makes no effect and
\fB\-\-timeout\fR
option is used instead\&. Default:
\fI60\fR
.RE
.PP
\fB\-\-dry\-run\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
If
\fItrue\fR
is given, aria2 just checks whether the remote file is available and doesn\(cqt download data\&. This option has effect on HTTP/FTP download\&. BitTorrent downloads are canceled if
\fItrue\fR
is specified\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-lowest\-speed\-limit\fR=SPEED
.RS 4
Close connection if download speed is lower than or equal to this value(bytes per sec)\&.
\fI0\fR
means aria2 does not have a lowest speed limit\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. This option does not affect BitTorrent downloads\&. Default:
\fI0\fR
.RE
.PP
\fB\-\-max\-file\-not\-found\fR=NUM
.RS 4
If aria2 receives \(oqfile not found\(cq status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify
\fI0\fR
to disable this option\&. This options is effective only when using HTTP/FTP servers\&. Default:
\fI0\fR
.RE
.PP
\fB\-m\fR, \fB\-\-max\-tries\fR=N
.RS 4
Set number of tries\&.
\fI0\fR
means unlimited\&. Default:
\fI5\fR
.RE
.PP
\fB\-n\fR, \fB\-\-no\-netrc\fR
.RS 4
Disables netrc support\&. netrc support is enabled by default\&.
.RE
.PP
\fB\-\-no\-proxy\fR=DOMAINS
.RS 4
Specify comma separated hostnames or domains where proxy should not be used\&.
.RE
.PP
\fB\-o\fR, \fB\-\-out\fR=FILE
.RS 4
The file name of the downloaded file\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In Metalink or BitTorrent download you cannot specify file name\&. The file name specified here is only used when the URLs fed to aria2 are done by command line without \fB\-i\fR, \fB\-Z\fR option\&. For example: aria2c \-o myfile\&.zip "http://mirror1/file\&.zip" "http://mirror2/file\&.zip"
.sp .5v
.RE
.PP
\fB\-\-proxy\-method\fR=METHOD
.RS 4
Set the method to use in proxy request\&.
\fIMETHOD\fR
is either
\fIget\fR
or
\fItunnel\fR\&. HTTPS downloads always use
\fItunnel\fR
regardless of this option\&. Default:
\fIget\fR
.RE
.PP
\fB\-R\fR, \fB\-\-remote\-time\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Retrieve timestamp of the remote file from the remote HTTP/FTP server and if it is available, apply it to the local file\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-server\-stat\-of\fR=FILE
.RS 4
Specify the filename to which performance profile of the servers is saved\&. You can load saved data using
\fB\-\-server\-stat\-if\fR
option\&. See
\fBServer Performance Profile\fR
subsection below for file format\&.
.RE
.PP
\fB\-\-server\-stat\-if\fR=FILE
.RS 4
Specify the filename to load performance profile of the servers\&. The loaded data will be used in some URI selector such as
\fIfeedback\fR\&. See also
\fB\-\-uri\-selector\fR
option\&. See
\fBServer Performance Profile\fR
subsection below for file format\&.
.RE
.PP
\fB\-\-server\-stat\-timeout\fR=SEC
.RS 4
Specifies timeout in seconds to invalidate performance profile of the servers since the last contact to them\&. Default:
\fI86400\fR
(24hours)
.RE
.PP
\fB\-s\fR, \fB\-\-split\fR=N
.RS 4
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\&. If less than N URLs are given, those URLs are used more than once so that N connections total are made simultaneously\&. Please see
\fB\-j\fR
option too\&. Please note that in Metalink download, this option has no effect and use
\fB\-C\fR
option instead\&. Default:
\fI5\fR
.RE
.PP
\fB\-t\fR, \fB\-\-timeout\fR=SEC
.RS 4
Set timeout in seconds\&. Default:
\fI60\fR
.RE
.PP
\fB\-\-uri\-selector\fR=SELECTOR
.RS 4
Specify URI selection algorithm\&. The possible values are
\fIinorder\fR,
\fIfeedback\fR
and
\fIadaptive\fR\&. If
\fIinorder\fR
is given, URI is tried in the order appeared in the URI list\&. If
\fIfeedback\fR
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 profile of servers mentioned in
\fB\-\-server\-stat\-of\fR
and
\fB\-\-server\-stat\-if\fR
options\&. If
\fIadaptive\fR
is given, selects one of the best mirrors for the first and reserved connections\&. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mirrors which has to be tested again\&. Otherwise, it doesn\(cqt select anymore mirrors\&. Like
\fIfeedback\fR, it uses a performance profile of servers\&. Default:
\fIfeedback\fR
.RE
.SS "HTTP Specific Options"
.PP
\fB\-\-ca\-certificate\fR=FILE
.RS 4
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
\fB\-\-check\-certificate\fR
option to enable verification\&.
.RE
.PP
\fB\-\-certificate\fR=FILE
.RS 4
Use the client certificate in FILE\&. The certificate must be in PEM format\&. You may use
\fB\-\-private\-key\fR
option to specify the private key\&.
.RE
.PP
\fB\-\-check\-certificate\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Verify the peer using certificates specified in
\fB\-\-ca\-certificate\fR
option\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-http\-auth\-challenge\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Send HTTP authorization header only when it is requested by the server\&. If
\fIfalse\fR
is set, then authorization header is always sent to the server\&. There is an exception: if username and password are embedded in URI, authorization header is always sent to the server regardless of this option\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-http\-auth\-scheme\fR=SCHEME
.RS 4
Set HTTP authentication scheme\&. Currently,
\fIbasic\fR
is the only supported scheme\&. Default:
\fIbasic\fR
.RE
.PP
\fB\-\-http\-user\fR=USER
.RS 4
Set HTTP user\&. This affects all URLs\&.
.RE
.PP
\fB\-\-http\-passwd\fR=PASSWD
.RS 4
Set HTTP password\&. This affects all URLs\&.
.RE
.PP
\fB\-\-http\-proxy\fR=PROXY
.RS 4
Use this proxy server for HTTP\&. See also
\fB\-\-all\-proxy\fR
option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE
.PP
\fB\-\-https\-proxy\fR=PROXY
.RS 4
Use this proxy server for HTTPS\&. See also
\fB\-\-all\-proxy\fR
option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE
.PP
\fB\-\-private\-key\fR=FILE
.RS 4
Use the private key in FILE\&. The private key must be decrypted and in PEM format\&. The behavior when encrypted one is given is undefined\&. See also
\fB\-\-certificate\fR
option\&.
.RE
.PP
\fB\-\-referer\fR=REFERER
.RS 4
Set Referer\&. This affects all URLs\&.
.RE
.PP
\fB\-\-enable\-http\-keep\-alive\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable HTTP/1\&.1 persistent connection\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-enable\-http\-pipelining\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable HTTP/1\&.1 pipelining\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-header\fR=HEADER
.RS 4
Append HEADER to HTTP request header\&. You can use this option repeatedly to specify more than one header: aria2c
\fB\-\-header\fR="X\-A: b78"
\fB\-\-header\fR="X\-B: 9J1" "http://host/file"
.RE
.PP
\fB\-\-load\-cookies\fR=FILE
.RS 4
Load Cookies from FILE using the Firefox3 format (SQLite3) and the Mozilla/Firefox(1\&.x/2\&.x)/Netscape format\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
If aria2 is built without libsqlite3, then it doesn\(cqt support Firefox3 cookie format\&.
.sp .5v
.RE
.PP
\fB\-\-save\-cookies\fR=FILE
.RS 4
Save Cookies to FILE in Mozilla/Firefox(1\&.x/2\&.x)/ Netscape format\&. If FILE already exists, it is overwritten\&. Session Cookies are also saved and their expiry values are treated as 0\&. Possible Values:
\fI/path/to/file\fR
.RE
.PP
\fB\-\-use\-head\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Use HEAD method for the first request to the HTTP server\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-U\fR, \fB\-\-user\-agent\fR=USER_AGENT
.RS 4
Set user agent for HTTP(S) downloads\&. Default:
\fIaria2/$VERSION\fR, $VERSION is replaced by package version\&.
.RE
.SS "FTP Specific Options"
.PP
\fB\-\-ftp\-user\fR=USER
.RS 4
Set FTP user\&. This affects all URLs\&. Default:
\fIanonymous\fR
.RE
.PP
\fB\-\-ftp\-passwd\fR=PASSWD
.RS 4
Set FTP password\&. This affects all URLs\&. If user name is embedded but password is missing in URI, aria2 tries to resolve password using \&.netrc\&. If password is found in \&.netrc, then use it as password\&. If not, use the password specified in this option\&. Default:
\fIARIA2USER@\fR
.RE
.PP
\fB\-p\fR, \fB\-\-ftp\-pasv\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Use the passive mode in FTP\&. If
\fIfalse\fR
is given, the active mode will be used\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-ftp\-proxy\fR=PROXY
.RS 4
Use this proxy server for FTP\&. See also
\fB\-\-all\-proxy\fR
option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE
.PP
\fB\-\-ftp\-type\fR=TYPE
.RS 4
Set FTP transfer type\&. TYPE is either
\fIbinary\fR
or
\fIascii\fR\&. Default:
\fIbinary\fR
.RE
.PP
\fB\-\-ftp\-reuse\-connection\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Reuse connection in FTP\&. Default:
\fItrue\fR
.RE
.SS "BitTorrent/Metalink Options"
.PP
\fB\-\-select\-file\fR=INDEX\&...
.RS 4
Set file to download by specifying its index\&. You can find the file index using the
\fB\-\-show\-files\fR
option\&. Multiple indexes can be specified by using ",", for example:
\fI3,6\fR\&. You can also use "\-" to specify a range:
\fI1\-5\fR\&. "," and "\-" can be used together:
\fI1\-5,8,9\fR\&. When used with the \-M option, index may vary depending on the query (see
\fB\-\-metalink\-\fR* options)\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
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\&.
.sp .5v
.RE
.PP
\fB\-S\fR, \fB\-\-show\-files\fR
.RS 4
Print file listing of \&.torrent or \&.metalink file and exit\&. In case of \&.torrent file, additional information (infohash, piece length, etc) is also printed\&.
.RE
.SS "BitTorrent Specific Options"
.PP
\fB\-\-bt\-external\-ip\fR=IPADDRESS
.RS 4
Specify the external IP address to report to a BitTorrent tracker\&. Although this function is named "external", it can accept any kind of IP addresses\&. IPADDRESS must be a numeric IP address\&.
.RE
.PP
\fB\-\-bt\-hash\-check\-seed\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
If
\fItrue\fR
is given, after hash check using
\fB\-\-check\-integrity\fR
option and file is complete, continue to seed file\&. If you want to check file and download it only when it is damaged or incomplete, set this option to
\fIfalse\fR\&. This option has effect only on BitTorrent download\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-bt\-max\-open\-files\fR=NUM
.RS 4
Specify maximum number of files to open in each BitTorrent download\&. Default:
\fI100\fR
.RE
.PP
\fB\-\-bt\-max\-peers\fR=NUM
.RS 4
Specify the maximum number of peers per torrent\&.
\fI0\fR
means unlimited\&. See also
\fB\-\-bt\-request\-peer\-speed\-limit\fR
option\&. Default:
\fI55\fR
.RE
.PP
\fB\-\-bt\-min\-crypto\-level\fR=\fIplain\fR|\fIarc4\fR
.RS 4
Set minimum level of encryption method\&. If several encryption methods are provided by a peer, aria2 chooses the lowest one which satisfies the given level\&. Default:
\fIplain\fR
.RE
.PP
\fB\-\-bt\-prioritize\-piece\fR=\fIhead\fR[=SIZE],\fItail\fR[=SIZE]
.RS 4
Try to download first and last pieces of each file first\&. The argument can contain 2 keywords:
\fIhead\fR
and
\fItail\fR\&. To include both keywords, they must be separated by comma\&. These keywords can take one parameter, SIZE\&. For example , if
\fIhead\fR=SIZE is specified, pieces in the range of first SIZE bytes of each file get higher priority\&.
\fItail\fR=SIZE means the range of last SIZE bytes of each file\&. SIZE can include
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&.
.RE
.PP
\fB\-\-bt\-require\-crypto\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If true is given, aria2 doesn\(cqt accept and establish connection with legacy BitTorrent handshake(\e19BitTorrent protocol)\&. Thus aria2 always uses Obfuscation handshake\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-bt\-request\-peer\-speed\-limit\fR=SPEED
.RS 4
If the whole download speed of every torrent is lower than SPEED, aria2 temporarily increases the number of peers to try for more download speed\&. Configuring this option with your preferred download speed can increase your download speed in some cases\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
\fI50K\fR
.RE
.PP
\fB\-\-bt\-seed\-unverified\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Seed previously downloaded files without verifying piece hashes\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-bt\-stop\-timeout\fR=SEC
.RS 4
Stop BitTorrent download if download speed is 0 in consecutive SEC seconds\&. If
\fI0\fR
is given, this feature is disabled\&. Default:
\fI0\fR
.RE
.PP
\fB\-\-bt\-tracker\-interval\fR=SEC
.RS 4
Set the interval in seconds between tracker requests\&. This completely overrides interval value and aria2 just uses this value and ignores the min interval and interval value in the response of tracker\&. If
\fI0\fR
is set, aria2 determines interval based on the response of tracker and the download progress\&. Default:
\fI0\fR
.RE
.PP
\fB\-\-dht\-entry\-point\fR=HOST:PORT
.RS 4
Set host and port as an entry point to DHT network\&.
.RE
.PP
\fB\-\-dht\-file\-path\fR=PATH
.RS 4
Change the DHT routing table file to PATH\&. Default:
\fI$HOME/\&.aria2/dht\&.dat\fR
.RE
.PP
\fB\-\-dht\-listen\-port\fR=PORT\&...
.RS 4
Set UDP listening port for DHT\&. Multiple ports can be specified by using ",", for example:
\fI6881,6885\fR\&. You can also use "\-" to specify a range:
\fI6881\-6999\fR\&. "," and "\-" can be used together\&. Default:
\fI6881\-6999\fR
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Make sure that the specified ports are open for incoming UDP traffic\&.
.sp .5v
.RE
.PP
\fB\-\-enable\-dht\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\(cqt use DHT for that download even if
\fItrue\fR
is given\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-enable\-peer\-exchange\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable Peer Exchange extension\&. If a private flag is set in a torrent, this feature is disabled for that download even if
\fItrue\fR
is given\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-follow\-torrent\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
.RS 4
If
\fItrue\fR
or
\fImem\fR
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
\fImem\fR
is specified, a torrent file is not written to the disk, but is just kept in memory\&. If
\fIfalse\fR
is specified, the action mentioned above is not taken\&. Default:
\fItrue\fR
.RE
.PP
\fB\-O\fR, \fB\-\-index\-out\fR=INDEX=PATH
.RS 4
Set file path for file with index=INDEX\&. You can find the file index using the
\fB\-\-show\-files\fR
option\&. PATH is a relative path to the path specified in
\fB\-\-dir\fR
option\&. You can use this option multiple times\&. Using this option, you can specify the output filenames of BitTorrent downloads\&.
.RE
.PP
\fB\-\-listen\-port\fR=PORT\&...
.RS 4
Set TCP port number for BitTorrent downloads\&. Multiple ports can be specified by using ",", for example:
\fI6881,6885\fR\&. You can also use "\-" to specify a range:
\fI6881\-6999\fR\&. "," and "\-" can be used together:
\fI6881\-6889,6999\fR\&. Default:
\fI6881\-6999\fR
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Make sure that the specified ports are open for incoming TCP traffic\&.
.sp .5v
.RE
.PP
\fB\-\-max\-overall\-upload\-limit\fR=SPEED
.RS 4
Set max overall upload speed in bytes/sec\&.
\fI0\fR
means unrestricted\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. To limit the upload speed per torrent, use
\fB\-\-max\-upload\-limit\fR
option\&. Default:
\fI0\fR
.RE
.PP
\fB\-u\fR, \fB\-\-max\-upload\-limit\fR=SPEED
.RS 4
Set max upload speed per each torrent in bytes/sec\&.
\fI0\fR
means unrestricted\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. To limit the overall upload speed, use
\fB\-\-max\-overall\-upload\-limit\fR
option\&. Default:
\fI0\fR
.RE
.PP
\fB\-\-peer\-id\-prefix\fR=PEER_ID_PREFIX
.RS 4
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, random byte data are added to make its length 20 bytes\&. Default:
\fIaria2/$VERSION\-\fR, $VERSION is replaced by package version\&.
.RE
.PP
\fB\-\-seed\-ratio\fR=RATIO
.RS 4
Specify share ratio\&. Seed completed torrents until share ratio reaches RATIO\&. You are strongly encouraged to specify equals or more than
\fI1\&.0\fR
here\&. Specify
\fI0\&.0\fR
if you intend to do seeding regardless of share ratio\&. If
\fB\-\-seed\-time\fR
option is specified along with this option, seeding ends when at least one of the conditions is satisfied\&. Default:
\fI1\&.0\fR
.RE
.PP
\fB\-\-seed\-time\fR=MINUTES
.RS 4
Specify seeding time in minutes\&. Also see the
\fB\-\-seed\-ratio\fR
option\&.
.RE
.PP
\fB\-T\fR, \fB\-\-torrent\-file\fR=TORRENT_FILE
.RS 4
The path to the \&.torrent file\&. You are not required to use this option because you can specify a torrent file without \-T\&.
.RE
.SS "Metalink Specific Options"
.PP
\fB\-\-follow\-metalink\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
.RS 4
If
\fItrue\fR
or
\fImem\fR
is specified, when a file whose suffix is "\&.metalink" or content type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it\&. If
\fImem\fR
is specified, a metalink file is not written to the disk, but is just kept in memory\&. If
\fIfalse\fR
is specified, the action mentioned above is not taken\&. Default:
\fItrue\fR
.RE
.PP
\fB\-M\fR, \fB\-\-metalink\-file\fR=METALINK_FILE
.RS 4
The file path to \&.metalink file\&. You are not required to use this option because you can specify a metalink file without \-M\&.
.RE
.PP
\fB\-C\fR, \fB\-\-metalink\-servers\fR=NUM_SERVERS
.RS 4
The number of servers to connect to simultaneously\&. Some Metalinks regulate 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
\fB\-s\fR
and
\fB\-j\fR
options\&. Default:
\fI5\fR
.RE
.PP
\fB\-\-metalink\-language\fR=LANGUAGE
.RS 4
The language of the file to download\&.
.RE
.PP
\fB\-\-metalink\-location\fR=LOCATION[,\&...]
.RS 4
The location of the preferred server\&. A comma\-delimited list of locations is acceptable, for example,
\fIJP,US\fR\&.
.RE
.PP
\fB\-\-metalink\-os\fR=OS
.RS 4
The operating system of the file to download\&.
.RE
.PP
\fB\-\-metalink\-version\fR=VERSION
.RS 4
The version of the file to download\&.
.RE
.PP
\fB\-\-metalink\-preferred\-protocol\fR=PROTO
.RS 4
Specify preferred protocol\&. The possible values are
\fIhttp\fR,
\fIhttps\fR,
\fIftp\fR
and
\fInone\fR\&. Specify
\fInone\fR
to disable this feature\&. Default:
\fInone\fR
.RE
.PP
\fB\-\-metalink\-enable\-unique\-protocol\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If
\fItrue\fR
is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\&. Use
\fB\-\-metalink\-preferred\-protocol\fR
option to specify the preference of protocol\&. Default:
\fItrue\fR
.RE
.SS "XML\-RPC Options"
.PP
\fB\-\-enable\-xml\-rpc\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable XML\-RPC server\&. It is strongly recommended to set username and password using
\fB\-\-xml\-rpc\-user\fR
and
\fB\-\-xml\-rpc\-passwd\fR
option\&. See also
\fB\-\-xml\-rpc\-listen\-port\fR
option\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-xml\-rpc\-listen\-all\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Listen incoming XML\-RPC requests on all network interfaces\&. If false is given, listen only on local loopback interface\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-xml\-rpc\-listen\-port\fR=PORT
.RS 4
Specify a port number for XML\-RPC server to listen to\&. Possible Values:
\fI1024\fR\-\fI65535\fR
Default:
\fI6800\fR
.RE
.PP
\fB\-\-xml\-rpc\-max\-request\-size\fR=SIZE
.RS 4
Set max size of XML\-RPC request\&. If aria2 detects the request is more than SIZE bytes, it drops connection\&. Default:
\fI2M\fR
.RE
.PP
\fB\-\-xml\-rpc\-passwd\fR=PASSWD
.RS 4
Set XML\-RPC password\&.
.RE
.PP
\fB\-\-xml\-rpc\-user\fR=USER
.RS 4
Set XML\-RPC user\&.
.RE
.SS "Advanced Options"
.PP
\fB\-\-allow\-overwrite\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If
\fIfalse\fR
is given, and a file already exists but the corresponding control file (filename\&.aria2) doesn\(cqt exist, then aria2 will not re\-download the file\&. See also
\fB\-\-auto\-file\-renaming\fR
option\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-allow\-piece\-length\-change\fR=\fItrue\fR|\fIfalse\fR
.RS 4
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:
\fIfalse\fR
.RE
.PP
\fB\-\-async\-dns\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable asynchronous DNS\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-auto\-file\-renaming\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
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:
\fItrue\fR
.RE
.PP
\fB\-\-auto\-save\-interval\fR=SEC
.RS 4
Save a control file(*\&.aria2) every SEC seconds\&. If
\fI0\fR
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
\fI0\fR
to
\fI600\fR\&. Default:
\fI60\fR
.RE
.PP
\fB\-\-conf\-path\fR=PATH
.RS 4
Change the configuration file path to PATH\&. Default:
\fI$HOME/\&.aria2/aria2\&.conf\fR
.RE
.PP
\fB\-D\fR, \fB\-\-daemon\fR
.RS 4
Run as daemon\&. The current working directory will be changed to
\fI/\fR
and standard input, standard output and standard error will be redirected to
\fI/dev/null\fR\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-enable\-direct\-io\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable directI/O, which lowers cpu usage while allocating/checking files\&. Turn off if you encounter any error\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-event\-poll\fR=POLL
.RS 4
Specify the method for polling events\&. The possible Values are
\fIepoll\fR
and
\fIselect\fR\&. If you use recent Linux that has epoll, then the default value is
\fIepoll\fR\&. Otherwise, the default value is
\fIselect\fR\&.
.RE
.PP
\fB\-\-file\-allocation\fR=METHOD
.RS 4
Specify file allocation method\&.
\fInone\fR
doesn\(cqt pre\-allocate file space\&.
\fIprealloc\fR
pre\-allocates file space before download begins\&. This may take some time depending on the size of the file\&. If you are using newer file systems such as ext4 (with extents support), btrfs or xfs,
\fIfalloc\fR
is your best choice\&. It allocates large(few GiB) files almost instantly\&. Don\(cqt use
\fIfalloc\fR
with legacy file systems such as ext3 because it takes almost same time as
\fIprealloc\fR
and it blocks aria2 entirely until allocation finishes\&.
\fIfalloc\fR
may not be available if your system doesn\(cqt have
\fBposix_fallocate\fR() function\&. Possible Values:
\fInone\fR,
\fIprealloc\fR,
\fIfalloc\fR
Default:
\fIprealloc\fR
.RE
.PP
\fB\-\-log\-level\fR=LEVEL
.RS 4
Set log level to output\&. LEVEL is either
\fIdebug\fR,
\fIinfo\fR,
\fInotice\fR,
\fIwarn\fR
or
\fIerror\fR\&. Default:
\fIdebug\fR
.RE
.PP
\fB\-\-on\-download\-complete\fR=COMMAND
.RS 4
Set the command to be executed when download completes\&. See
\fB\-\-on\-download\-start\fR
option for the requirement of COMMAND\&. See also
\fB\-\-on\-download\-stop\fR
option\&. Possible Values:
\fI/path/to/command\fR
.RE
.PP
\fB\-\-on\-download\-error\fR=COMMAND
.RS 4
Set the command to be executed when download aborts due to error\&. See
\fB\-\-on\-download\-start\fR
option for the requirement of COMMAND\&. See also
\fB\-\-on\-download\-stop\fR
option\&. Possible Values:
\fI/path/to/command\fR
.RE
.PP
\fB\-\-on\-download\-start\fR=COMMAND
.RS 4
Set the command to be executed when download starts up\&. COMMAND must take just one argument and GID is passed to COMMAND as a first argument\&. Possible Values:
\fI/path/to/command\fR
.RE
.PP
\fB\-\-on\-download\-stop\fR=COMMAND
.RS 4
Set the command to be executed when download stops\&. You can override the command to be executed for particular download result using
\fB\-\-on\-download\-complete\fR
and
\fB\-\-on\-download\-error\fR\&. If they are specified, command specified in this option is not executed\&. See
\fB\-\-on\-download\-start\fR
option for the requirement of COMMAND\&. Possible Values:
\fI/path/to/command\fR
.RE
.PP
\fB\-\-summary\-interval\fR=SEC
.RS 4
Set interval in seconds to output download progress summary\&. Setting
\fI0\fR
suppresses the output\&. Default:
\fI60\fR
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In multi file torrent downloads, the files adjacent forward to the specified files are also allocated if they share the same piece\&.
.sp .5v
.RE
.PP
\fB\-Z\fR, \fB\-\-force\-sequential\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-max\-overall\-download\-limit\fR=SPEED
.RS 4
Set max overall download speed in bytes/sec\&.
\fI0\fR
means unrestricted\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. To limit the download speed per download, use
\fB\-\-max\-download\-limit\fR
option\&. Default:
\fI0\fR
.RE
.PP
\fB\-\-max\-download\-limit\fR=SPEED
.RS 4
Set max download speed per each download in bytes/sec\&.
\fI0\fR
means unrestricted\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. To limit the overall download speed, use
\fB\-\-max\-overall\-download\-limit\fR
option\&. Default:
\fI0\fR
.RE
.PP
\fB\-\-no\-conf\fR
.RS 4
Disable loading aria2\&.conf file\&.
.RE
.PP
\fB\-\-no\-file\-allocation\-limit\fR=SIZE
.RS 4
No file allocation is made for files whose size is smaller than SIZE\&. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\&. Default:
\fI5M\fR
.RE
.PP
\fB\-P\fR, \fB\-\-parameterized\-uri\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable parameterized URI support\&. You can specify set of parts:
\fIhttp://{sv1,sv2,sv3}/foo\&.iso\fR\&. Also you can specify numeric sequences with step counter:
\fIhttp://host/image[000\-100:2]\&.img\fR\&. 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:
\fIfalse\fR
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Make aria2 quiet (no console output)\&. Default:
\fIfalse\fR
.RE
.PP
\fB\-\-realtime\-chunk\-checksum\fR=\fItrue\fR|\fIfalse\fR
.RS 4
Validate chunk of data by calculating checksum while downloading a file if chunk checksums are provided\&. Default:
\fItrue\fR
.RE
.PP
\fB\-\-stop\fR=SEC
.RS 4
Stop application after SEC seconds has passed\&. If
\fI0\fR
is given, this feature is disabled\&. Default:
\fI0\fR
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Print the version number, copyright and the configuration information and exit\&.
.RE
.SS "Options That Take An Optional Argument"
.sp
The options that have its argument surrounded by square brackets([]) take an optional argument\&. Usually omiting the argument is evaluated to \fItrue\fR\&. If you use short form of these options(such as \fI\-V\fR) and give an argument, then the option name and its argument should be concatenated(e\&.g\&. \fI\-Vfalse\fR)\&. 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\&.
.SS "URI, MAGNET, TORRENT_FILE, METALINK_FILE"
.sp
You can specify multiple URLs in command\-line\&. Unless you specify \fB\-Z\fR option, all URLs must point to the same file or downloading will fail\&.
.sp
You can specify arbitrary number of BitTorrent Magnet URI\&. Please note that they are always treated as a separate download\&. Both hex encoded 40 characters Info Hash and Base32 encoded 32 characters Info Hash are supported\&. The multiple "tr" paramters are supported\&. Because BitTorrent Magnet URI is likely to contain "&" character, it is highly recommended to always quote URI with single(\') or double(") quotation\&. See http://www\&.bittorrent\&.org/beps/bep_0009\&.html for more details about BitTorrent Magnet URI\&.
.sp
You can also specify arbitrary number of torrent files and metalink files stored on a local drive\&. Please note that they are always treated as a separate download\&.
.sp
You can specify both torrent file with \-T option and URLs\&. By doing this, you can 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\&. For single file torrents, URL can be a complete URL pointing to the resource or if URL ends with /, name in torrent file in torrent is added\&. For multi\-file torrents, name and path are added to form a URL for each file\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell\&.
.sp .5v
.RE
.SS "Resuming Download"
.sp
Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\&.
.sp
If the previous transfer is made by a browser or wget like sequential download manager, then use \-c option to continue the transfer(aria2c \fB\-c\fR URL)\&.
.SH "EXIT STATUS"
.sp
Because aria2 can handle multiple downloads at once, it encounters lots of errors in a session\&. aria2 returns the following exit status based on the last error encountered\&.
.PP
\fB0\fR
.RS 4
If all downloads are successful\&.
.RE
.PP
\fB1\fR
.RS 4
If an unknown error occurs\&.
.RE
.PP
\fB2\fR
.RS 4
If time out occurs\&.
.RE
.PP
\fB3\fR
.RS 4
If a resource is not found\&.
.RE
.PP
\fB4\fR
.RS 4
If aria2 sees the specfied number of "resource not found" error\&. See
\fB\-\-max\-file\-not\-found\fR
option)\&.
.RE
.PP
\fB5\fR
.RS 4
If a download aborts because download speed is too slow\&. See
\fB\-\-lowest\-speed\-limit\fR
option)
.RE
.PP
\fB6\fR
.RS 4
If network problem occurs\&.
.RE
.PP
\fB7\fR
.RS 4
If there are unfinished downloads\&. This error is only reported if all finished downloads are successful and there are unfinished downloads in a queue when aria2 exits by pressing Ctrl\-C by an user or sending TERM or INT signal\&.
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
An error occurred in a finished download will not be reported as exit status\&.
.sp .5v
.RE
.SH "ENVIRONMENT"
.sp
aria2 recognizes the following environment variables\&.
.PP
http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
.RS 4
Specify proxy server for use in HTTP\&. Overrides http\-proxy value in configuration file\&. The command\-line option
\fB\-\-http\-proxy\fR
overrides this value\&.
.RE
.PP
https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
.RS 4
Specify proxy server for use in HTTPS\&. Overrides https\-proxy value in configuration file\&. The command\-line option
\fB\-\-https\-proxy\fR
overrides this value\&.
.RE
.PP
ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
.RS 4
Specify proxy server for use in FTP\&. Overrides ftp\-proxy value in configuration file\&. The command\-line option
\fB\-\-ftp\-proxy\fR
overrides this value\&.
.RE
.PP
all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
.RS 4
Specify proxy server for use if no protocol\-specific proxy is specified\&. Overrides all\-proxy value in configuration file\&. The command\-line option
\fB\-\-all\-proxy\fR
overrides this value\&.
.RE
.PP
no_proxy [DOMAIN,\&...]
.RS 4
Specify comma\-separated hostname or domains to which proxy should not be used\&. Overrides no\-proxy value in configuration file\&. The command\-line option
\fB\-\-no\-proxy\fR
overrides this value\&.
.RE
.SH "FILES"
.SS "aria2\&.conf"
.sp
By default, aria2 parses \fI$HOME/\&.aria2/aria2\&.conf\fR as a configuraiton file\&. You can specify the path to configuration file using \fB\-\-conf\-path\fR option\&. If you don\(cqt want to use the configuraitonf file, use \fB\-\-no\-conf\fR option\&.
.sp
The configuration file is a text file and has 1 option per each line\&. In each line, you can specify name\-value pair in the format: NAME=VALUE, where name is the long command\-line option name without "\-\-" prefix\&. You can use same syntax for the command\-line option\&. The lines beginning "#" are treated as comments\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# sample configuration file for aria2c
listen\-port=60000
dht\-listen\-port=60000
seed\-ratio=1\&.0
max\-upload\-limit=50K
ftp\-pasv=true
.fi
.if n \{\
.RE
.\}
.SS "dht\&.dat"
.sp
By default, the routing table of DHT is saved to the path $HOME/\&.aria2/dht\&.dat\&.
.SS "Control File"
.sp
aria2 uses a control file to track the progress of a download\&. A control file is placed in the same directory as the downloading 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\&.)
.sp
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\(cqt support resume), a control file is not created\&.
.sp
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 \-V option to aria2c in command\-line\&.
.SS "Input File"
.sp
The input file can contain a list of URIs for aria2 to download\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&.
.sp
Each line is treated as if it is provided in command\-line argument\&. Therefore they are affected by \fB\-Z\fR and \fB\-P\fR options\&.
.sp
Additionally, the following options can be specified after each line of URIs\&. These optional lines must start with white space(s)\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
dir
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
check\-integrity
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
continue
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
all\-proxy
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
connect\-timeout
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
dry\-run
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
lowest\-speed\-limit
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
max\-file\-not\-found
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
max\-tries
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
no\-proxy
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
out
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
proxy\-method
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
remote\-time
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
split
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
timeout
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
http\-auth\-challenge
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
http\-user
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
http\-passwd
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
http\-proxy
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
https\-proxy
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
referer
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
enable\-http\-keep\-alive
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
enable\-http\-pipelining
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
header
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
use\-head
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
user\-agent
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ftp\-user
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ftp\-passwd
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ftp\-pasv
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ftp\-proxy
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ftp\-type
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ftp\-reuse\-connection
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
no\-netrc
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
select\-file
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-external\-ip
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-hash\-check\-seed
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-max\-open\-files
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-max\-peers
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-min\-crypto\-level
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-require\-crypto
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-request\-peer\-speed\-limit
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-seed\-unverified
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-stop\-timeout
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bt\-tracker\-interval
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
enable\-peer\-exchange
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
follow\-torrent
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
index\-out
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
max\-upload\-limit
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
seed\-ratio
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
seed\-time
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
follow\-metalink
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-servers
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-language
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-location
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-os
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-version
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-preferred\-protocol
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
metalink\-enable\-unique\-protocol
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
allow\-overwrite
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
allow\-piece\-length\-change
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
async\-dns
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
auto\-file\-renaming
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
file\-allocation
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
max\-download\-limit
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
no\-file\-allocation\-limit
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
parameterized\-uri
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
realtime\-chunk\-checksum
.RE
.sp
These options have exactly same meaning of the ones in the command\-line options, but it just applies to the URIs it belongs to\&.
.sp
For example, the content of uri\&.txt is
.sp
.if n \{\
.RS 4
.\}
.nf
http://server/file\&.iso http://mirror/file\&.iso
  dir=/iso_images
  out=file\&.img
http://foo/bar
.fi
.if n \{\
.RE
.\}
.sp
If aria2 is executed with \fB\-i\fR uri\&.txt \fB\-d\fR /tmp options, then \fIfile\&.iso\fR is saved as \fI/iso_images/file\&.img\fR and it is downloaded from http://server/file\&.iso and http://mirror/file\&.iso\&. The file \fIbar\fR is downloaded from http://foo/bar and saved as \fI/tmp/bar\fR\&.
.sp
In some cases, \fBout\fR parameter has no effect\&. See note of \fB\-\-out\fR option for the restrictions\&.
.SS "Server Performance Profile"
.sp
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:
.PP
host
.RS 4
Hostname of the server\&. Required\&.
.RE
.PP
protocol
.RS 4
Protocol for this profile, such as ftp, http\&. Required\&.
.RE
.PP
dl_speed
.RS 4
The average download speed observed in the previous download in bytes per sec\&. Required\&.
.RE
.PP
sc_avg_speed
.RS 4
The average download speed observed in the previous download in bytes per sec\&. This value is only updated if the download is done in single connection environment and only used by AdaptiveURISelector\&. Optional\&.
.RE
.PP
mc_avg_speed
.RS 4
The average download speed observed in the previous download in bytes per sec\&. This value is only updated if the download is done in multi connection environment and only used by AdaptiveURISelector\&. Optional\&.
.RE
.PP
counter
.RS 4
How many times the server is used\&. Currently this value is only used by AdaptiveURISelector\&. Optional\&.
.RE
.PP
last_updated
.RS 4
Last contact time in GMT with this server, specified in the seconds from the Epoch\&. Required\&.
.RE
.PP
status
.RS 4
ERROR is set when server cannot be reached or out\-of\-service or timeout occurred\&. Otherwise, OK is set\&.
.RE
.sp
Those fields must exist in one line\&. The order of the fields is not significant\&. You can put pairs other than the above; they are simply ignored\&.
.sp
An example follows:
.sp
.if n \{\
.RS 4
.\}
.nf
host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
.fi
.if n \{\
.RE
.\}
.SH "XML-RPC INTERFACE"
.SS "Terminology"
.PP
GID
.RS 4
GID(or gid) is the key to manage each download\&. Each download has an unique GID\&. Currently GID looks like an integer, but don\(cqt treat it as integer because it may be changed to another type in the future release\&.
.RE
.SS "Methods"
.sp
\fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR
.sp
This method adds new HTTP(S)/FTP/BitTorrent Magnet URI with this method\&. \fIuris\fR is of type array and its element is URI which is of type string\&. For BitTorrent Magnet URI, \fIuris\fR must have one element only and it should be BitTorrent Magnet URI\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
.sp
\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR
.sp
This method adds BitTorrent download by uploading \&.torrent file\&. \fItorrent\fR is of type base64 which contains Base64\-encoded \&.torrent file\&. \fIuris\fR is of type array and its element is URI which is of type string\&. \fIuris\fR is used for Web\-seeding\&. For single file torrents, URI can be a complete URI pointing to the resource or if URI ends with /, name in torrent file is added\&. For multi\-file torrents, name and path in torrent are added to form a URI for each file\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
.sp
\fBaria2\&.addMetalink\fR \fImetalink[, options[, position]]\fR
.sp
This method adds Metalink download by uploading \&.metalink file\&. \fImetalink\fR is of type base64 which contains Base64\-encoded \&.metalink file\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns array of GID of registered download\&.
.sp
\fBaria2\&.remove\fR \fIgid\fR
.sp
This method removes the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. If specified download is in progress, it is stopped at first\&. The status of removed download becomes "removed"\&. This method returns GID of removed download\&.
.sp
\fBaria2\&.tellStatus\fR \fIgid\fR
.sp
This method returns download progress of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type struct and it contains following keys\&. The value type is string\&.
.PP
gid
.RS 4
GID of this download\&.
.RE
.PP
status
.RS 4
"active" for currently downloading/seeding entry\&. "waiting" for the entry in the queue; download is not started\&. "error" for the stopped download because of error\&. "complete" for the stopped and completed download\&. "removed" for the download removed by user\&.
.RE
.PP
totalLength
.RS 4
Total length of this download in bytes\&.
.RE
.PP
completedLength
.RS 4
Completed length of this download in bytes\&.
.RE
.PP
uploadLength
.RS 4
Uploaded length of this download in bytes\&.
.RE
.PP
bitfield
.RS 4
Hexadecimal representation of the download progress\&. The highest bit corresponds to piece index 0\&. The set bits indicate the piece is available and unset bits indicate the piece is missing\&. The spare bits at the end are set to zero\&.
.RE
.PP
downloadSpeed
.RS 4
Download speed of this download measured in bytes/sec\&.
.RE
.PP
uploadSpeed
.RS 4
Upload speed of this download measured in bytes/sec\&.
.RE
.PP
infoHash
.RS 4
InfoHash\&. BitTorrent only\&.
.RE
.PP
numSeeders
.RS 4
The number of seeders the client has connected to\&. BitTorrent only\&.
.RE
.PP
pieceLength
.RS 4
Piece length in bytes\&.
.RE
.PP
numPieces
.RS 4
The number of pieces\&.
.RE
.PP
connections
.RS 4
The number of peers/servers the client has connected to\&.
.RE
.PP
errorCode
.RS 4
The last error code occurred in this download\&. The value is of type string\&. The error codes are defined in EXIT STATUS section\&. This value is only available for stopped/completed downloads\&.
.RE
.sp
\fBaria2\&.getUris\fR \fIgid\fR
.sp
This method returns URIs used in the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.
.PP
uri
.RS 4
URI
.RE
.sp
\fBaria2\&.getFiles\fR \fIgid\fR
.sp
This method returns file list of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.
.PP
index
.RS 4
Index of file\&. Starting with 1\&. This is the same order with the files in multi\-file torrent\&.
.RE
.PP
path
.RS 4
File path\&.
.RE
.PP
length
.RS 4
File size in bytes\&.
.RE
.PP
selected
.RS 4
"true" if this file is selected by
\fB\-\-select\-file\fR
option\&. If
\fB\-\-select\-file\fR
is not specified or this is single torrent or no torrent download, this value is always "true"\&. Otherwise "false"\&.
.RE
.sp
\fBaria2\&.getPeers\fR \fIgid\fR
.sp
This method returns peer list of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. This method is for BitTorrent only\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.
.PP
peerId
.RS 4
Percent\-encoded peer ID\&.
.RE
.PP
ip
.RS 4
IP address of the peer\&.
.RE
.PP
port
.RS 4
Port number of the peer\&.
.RE
.PP
bitfield
.RS 4
Hexadecimal representation of the download progress of the peer\&. The highest bit corresponds to piece index 0\&. The set bits indicate the piece is available and unset bits indicate the piece is missing\&. The spare bits at the end are set to zero\&.
.RE
.PP
amChoking
.RS 4
"true" if this client is choking the peer\&. Otherwise "false"\&.
.RE
.PP
peerChoking
.RS 4
"true" if the peer is choking this client\&. Otherwise "false"\&.
.RE
.PP
downloadSpeed
.RS 4
Download speed (byte/sec) that this client obtains from the peer\&.
.RE
.PP
uploadSpeed
.RS 4
Upload speed(byte/sec) that this client uploads to the peer\&.
.RE
.PP
seeder
.RS 4
"true" is this client is a seeder\&. Otherwise "false"\&.
.RE
.sp
\fBaria2\&.tellActive\fR
.sp
This method returns the list of active downloads\&. The respose is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.
.sp
\fBaria2\&.tellWaiting\fR \fIoffset, num\fR
.sp
This method returns the list of waiting download in the range of [\fIoffset\fR, \fIoffset\fR+\fInum\fR)\&. \fIoffset\fR is of type integer and specifies the offset from the download waiting at the front\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. For example, imagine that three downloads "A","B" and "C" are waiting in this order\&. aria2\&.tellWaiting(0, 1) returns "A"\&. aria2\&.tellWaiting(1, 2) returns "B" and "C"\&. The respose is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.
.sp
\fBaria2\&.changeOption\fR \fIgid, options\fR
.sp
This method changes options of the download denoted by \fIgid\fR dynamically\&. \fIgid\fR is of type string\&. \fIoptions\fR is of type struct and the available options are: \fBbt\-max\-peers\fR, \fBbt\-request\-peer\-speed\-limit\fR, \fBmax\-download\-limit\fR and \fBmax\-upload\-limit\fR\&. This method returns "OK" for success\&.
.sp
\fBaria2\&.changeGlobalOption\fR \fIoptions\fR
.sp
This method changes global options dynamically\&. \fIoptions\fR is of type struct and the available options are \fBmax\-concurrent\-downloads\fR, \fBmax\-overall\-download\-limit\fR and \fBmax\-overall\-upload\-limit\fR\&. This method returns "OK" for success\&.
.sp
\fBaria2\&.purgeDownloadResult\fR
.sp
This method purges completed/error/removed downloads to free memory\&. This method returns "OK"\&.
.sp
\fBaria2\&.getVersion\fR
.sp
This method returns version of the program and the list of enabled features\&. The response is of type struct and contains following keys\&.
.PP
version
.RS 4
Version number of the program in string\&.
.RE
.PP
enabledFeatures
.RS 4
List of enabled features\&. Each feature name is of type string\&.
.RE
.SS "Error Handling"
.sp
In case of error, aria2 returns faultCode=1 and the error message in faultString\&.
.SS "Options"
.sp
Same options for \fB\-i\fR list are available\&. See \fBInput File\fR subsection for complete list of options\&.
.sp
In the option struct, name element is option name(without preceeding "\-\-") and value element is argument as string\&.
.sp
.if n \{\
.RS 4
.\}
.nf
<struct>
  <member>
    <name>split</name>
    <value><string>1</string></value>
  </member>
  <member>
    <name>http\-proxy</name>
    <value><string>http://proxy/</string></value>
  </member>
</struct>
.fi
.if n \{\
.RE
.\}
.sp
\fBheader\fR and \fBindex\-out\fR option are allowed multiple times in command\-line\&. Since name should be unique in struct(many XML\-RPC library implementation uses hash or dict for struct), single string is not enough\&. To overcome this situation, they can take array as value as well as string\&.
.sp
.if n \{\
.RS 4
.\}
.nf
<struct>
  <member>
    <name>header</name>
    <value>
      <array>
        <data>
          <value><string>Accept\-Language: ja</string></value>
          <value><string>Accept\-Charset: utf\-8</string></value>
        </data>
      </array>
    </value>
  </member>
</struct>
.fi
.if n \{\
.RE
.\}
.SS "Sample XML\-RPC Client Code"
.sp
The following Ruby script adds \fIhttp://localhost/aria2\&.tar\&.bz2\fR to aria2c operated on localhost with option \fB\-\-dir\fR=\fI/downloads\fR and prints its reponse\&.
.sp
.if n \{\
.RS 4
.\}
.nf
#!/usr/bin/env ruby

require \'xmlrpc/client\'
require \'pp\'

client=XMLRPC::Client\&.new2("http://localhost:6800/rpc")

options={ "dir" => "/downloads" }
result=client\&.call("aria2\&.addUri", [ "http://localhost/aria2\&.tar\&.bz2" ], options)

pp result
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE"
.SS "HTTP/FTP Segmented Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload a file\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c "http://host/file\&.zip"
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
aria2 uses 5 connections to download 1 file by default\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload a file using 1 connection\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-s1 "http://host/file\&.zip"
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
aria2 uses 5 connections to download 1 file by default\&. \-s1 limits the number of connections to just 1\&.
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument in the same directory\&. You can change URLs as long as they are pointing to the same file\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload a file from 2 different HTTP servers\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c "http://host/file\&.zip" "http://mirror/file\&.zip"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload a file from HTTP and FTP servers\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c "http://host1/file\&.zip" "ftp://host2/file\&.zip"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload files listed in a text file concurrently\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-ifiles\&.txt \-j2
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
\-j option specifies the number of parallel downloads\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBUsing proxy\fR
.RS 4
.sp
For HTTP:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-http\-proxy="http://proxy:8080" "http://host/file"
.fi
.if n \{\
.RE
.\}
.sp
For FTP:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-ftp\-proxy="http://proxy:8080" "ftp://host/file"
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
See \fB\-\-http\-proxy\fR, \fB\-\-https\-proxy\fR, \fB\-\-ftp\-proxy\fR and \fB\-\-all\-proxy\fR for details\&. You can specify proxy in the environment variables\&. See \fBENVIRONMENT\fR section\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBProxy with authorization\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-http\-proxy="http://username:password@proxy:8080" "http://host/file"
.fi
.if n \{\
.RE
.\}
.RE
.SS "Metalink Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload files with remote Metalink\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-follow\-metalink=mem "http://host/file\&.metalink"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload using a local metalink file\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-p \-\-lowest\-speed\-limit=4000 file\&.metalink
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument in the same directory\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload several local metalink files\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-j2 file1\&.metalink file2\&.metalink
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload only selected files using index\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-select\-file=1\-4,8 file\&.metalink
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
The index is printed to the console using \-S option\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload a file using a local .metalink file with user preference\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-metalink\-location=JP,US \-\-metalink\-version=1\&.1 \-\-metalink\-language=en\-US file\&.metalink
.fi
.if n \{\
.RE
.\}
.RE
.SS "BitTorrent Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload files from remote BitTorrent file\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-follow\-torrent=mem "http://host/file\&.torrent"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload using a local torrent file\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-max\-upload\-limit=40K file\&.torrent
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
\-\-max\-upload\-limit specifies the max of upload rate\&.
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument in the same directory\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload using BitTorrent Magnet URI\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c "magnet:?xt=urn:btih:248d0a1cd08284299de78d5c1ed359bb46717d8c&dn=aria2"
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Don\(cqt forget to quote BitTorrent Magnet URI which includes "&" character with single(\') or double(") quotation\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload 2 torrents\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-j2 file1\&.torrent file2\&.torrent
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload a file using torrent and HTTP/FTP server\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-Ttest\&.torrent "http://host1/file" "ftp://host2/file"
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Downloading multi file torrent with HTTP/FTP is not supported\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload only selected files using index(usually called "selectable download")\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-select\-file=1\-4,8 file\&.torrent
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
The index is printed to the console using \-S option\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSpecify output filename\fR
.RS 4
.sp
To specify output filename for BitTorrent downloads, you need to know the index of file in torrent file using \fB\-S\fR option\&. For example, the output looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
idx|path/length
===+======================
  1|dist/base\-2\&.6\&.18\&.iso
   |99\&.9MiB
\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
  2|dist/driver\-2\&.6\&.18\&.iso
   |169\&.0MiB
\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.fi
.if n \{\
.RE
.\}
.sp
To save \fIdist/base\-2\&.6\&.18\&.iso\fR in \fI/tmp/mydir/base\&.iso\fR and \fIdist/driver\-2\&.6\&.18\&.iso\fR in \fI/tmp/dir/driver\&.iso\fR, use the following command:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-dir=/tmp \-\-index\-out=1=mydir/base\&.iso \-\-index\-out=2=dir/driver\&.iso file\&.torrent
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBChange the listening port for incoming peer\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-listen\-port=7000\-7001,8000 file\&.torrent
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
Since aria2 doesn\(cqt configure firewall or router for port forwarding, it\(cqs up to you to do it manually\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSpecify the condition to stop program after torrent download finished\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-seed\-time=120 \-\-seed\-ratio=1\&.0 file\&.torrent
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1\&.0\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBThrottle upload speed\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-max\-upload\-limit=100K file\&.torrent
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBEnable DHT\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-enable\-dht \-\-dht\-listen\-port=6881 file\&.torrent
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
DHT uses udp port\&. Since aria2 doesn\(cqt configure firewall or router for port forwarding, it\(cqs up to you to do it manually\&.
.sp .5v
.RE
.RE
.SS "More advanced HTTP features"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBLoad cookies\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-load\-cookies=cookies\&.txt "http://host/file\&.zip"
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
You can use Firefox/Mozilla\(cqs cookie file without modification\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBResume download started by web browsers or another programs\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-c \-s2 "http://host/partiallydownloadedfile\&.zip"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBClient certificate authorization for SSL/TLS\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-certificate=/path/to/mycert\&.pem \-\-private\-key=/path/to/mykey\&.pem https://host/file
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
The file specified in \fB\-\-private\-key\fR must be decrypted\&. The behavior when encrypted one is given is undefined\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBVerify peer in SSL/TLS using given CA certificates\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-ca\-certificate=/path/to/ca\-certificates\&.crt \-\-check\-certificate https://host/file
.fi
.if n \{\
.RE
.\}
.RE
.SS "And more advanced features"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBThrottle download speed\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-max\-download\-limit=100K file\&.metalink
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBRepair a damaged download\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-V file\&.metalink
.fi
.if n \{\
.RE
.\}
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
This option is only available used with BitTorrent or metalink with chunk checksums\&.
.sp .5v
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDrop connection if download speed is lower than specified value\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-lowest\-speed\-limit=10K file\&.metalink
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBParameterized URI support\fR
.RS 4
.sp
You can specify set of parts:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-P "http://{host1,host2,host3}/file\&.iso"
.fi
.if n \{\
.RE
.\}
.sp
You can specify numeric sequence:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-Z \-P "http://host/image[000\-100]\&.png"
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
\-Z option is required if the all URIs don\(cqt point to the same file, such as the above example\&.
.sp .5v
.RE
.sp
You can specify step counter:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-Z \-P "http://host/image[A\-Z:2]\&.png"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBParallel downloads of arbitrary number of URL,metalink,torrent\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-j3 \-Z "http://host/file1" file2\&.torrent file3\&.metalink
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBBitTorrent Encryption\fR
.RS 4
.sp
Encrypt whole payload using ARC4:
.sp
.if n \{\
.RS 4
.\}
.nf
aria2c \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true file\&.torrent
.fi
.if n \{\
.RE
.\}
.RE
.SH "SEE ALSO"
.sp
Project Web Site: http://aria2\&.sourceforge\&.net/
.sp
aria2 Wiki: http://sourceforge\&.net/apps/trac/aria2/wiki
.sp
Metalink Homepage: http://www\&.metalinker\&.org/
.SH "COPYRIGHT"
.sp
Copyright \(co 2006, 2009 Tatsuhiro Tsujikawa
.sp
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\&.
.sp
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\&.
.sp
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
.sp
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\&.