2007-01-28 14:18:35 +00:00
. \" Title: aria2c
. \" Author:
2008-06-17 14:22:20 +00:00
. \" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
2008-11-11 11:55:23 +00:00
. \" Date: 11/11/2008
2007-01-28 14:18:35 +00:00
. \" Manual:
. \" Source:
. \"
2008-11-11 11:55:23 +00:00
.TH "ARIA2C" "1" "11/11/2008" "" ""
2007-01-28 14:18:35 +00:00
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
2008-06-17 14:22:20 +00:00
aria2c \- The ultra fast download utility
2007-01-28 14:18:35 +00:00
.SH "SYNOPSIS"
2008-05-21 07:47:32 +00:00
aria2c [\fI OPTIONS\fR ] [\fI URL\fR | \fI TORRENT_FILE\fR | \fI METALINK_FILE\fR ]\& ...
2007-11-18 11:59:42 +00:00
.sp
2007-11-23 13:58:50 +00:00
.SH "DESCRIPTION"
2008-07-08 12:12:21 +00:00
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\& .
2007-01-28 14:18:35 +00:00
.sp
.SH "OPTIONS"
2008-05-12 15:26:43 +00:00
.SS "Basic Options"
2007-03-28 15:08:22 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- d\fR , \fB \- \- dir\fR =DIR
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The directory to store the downloaded file\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- i\fR , \fB \- \- input\- file\fR =FILE
2007-12-08 10:50:08 +00:00
.RS 4
2008-06-17 14:22:20 +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
2008-05-12 15:26:43 +00:00
\fI \- \fR
2008-06-17 14:22:20 +00:00
is specified\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- l\fR , \fB \- \- log\fR =LOG
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The file name of the log file\& . If
2007-01-28 14:18:35 +00:00
\fI \- \fR
2008-06-17 14:22:20 +00:00
is specified, log is written to stdout\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- j\fR , \fB \- \- max\- concurrent\- downloads\fR =N
2007-06-10 08:29:56 +00:00
.RS 4
2008-11-11 11:55:23 +00:00
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:
2008-05-19 12:36:20 +00:00
\fI 5\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- check\- integrity\fR =\fI true\fR |\fI false\fR
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Check file integrity by validating piece hash\& . This option only affects in BitTorrent downloads and Metalink downloads with chunk checksums\& . Use this option to re\- download a damaged portion of a file\& . Default:
2008-05-12 15:26:43 +00:00
\fI false\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- c\fR , \fB \- \- continue\fR
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +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\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- h\fR , \fB \- \- help\fR [=CATEGORY]
2007-06-10 08:29:56 +00:00
.RS 4
2008-09-27 05:33:05 +00:00
Print usage and exit\& . The help messages are classified in several categories\& . For example, type "\fB \- \- help\fR =http" for detailed explanation for the options related to HTTP\& . If no matching category is found, search option name using a given word in middle match and print the result\& . Available Values:
2008-05-12 15:26:43 +00:00
\fI basic\fR ,
\fI advanced\fR ,
\fI http\fR ,
\fI ftp\fR ,
\fI metalink\fR ,
\fI bittorrent\fR ,
\fI all\fR
Default:
\fI basic\fR
.RE
.SS "HTTP/FTP Options"
.PP
2008-11-09 08:59:05 +00:00
\fB \- \- all\- proxy\fR =PROXY
.RS 4
Use this proxy server in the all protocols\& . You can override this setting and specify a proxy server for particular proctol 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
2008-09-27 05:33:05 +00:00
\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:
\fI 60\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- lowest\- speed\- limit\fR =SPEED
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Close connection if download speed is lower than or equal to this value(bytes per sec)\& .
2008-05-12 15:26:43 +00:00
\fI 0\fR
2008-06-17 14:22:20 +00:00
means aria2 does not have a lowest speed limit\& . You can append
2008-05-12 15:26:43 +00:00
\fI K\fR
or
2008-06-17 14:22:20 +00:00
\fI M\fR (1K = 1024, 1M = 1024K)\& . This option does not affect BitTorrent downloads\& . Default:
2008-05-12 15:26:43 +00:00
\fI 0\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-09-27 05:33:05 +00:00
\fB \- \- max\- file\- not\- found\fR =NUM
.RS 4
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
\fI 0\fR
to disable this option\& . This options is only effective only when using HTTP/FTP servers\& . Default:
\fI 0\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- m\fR , \fB \- \- max\- tries\fR =N
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set number of tries\& .
2007-01-28 14:18:35 +00:00
\fI 0\fR
2008-06-17 14:22:20 +00:00
means unlimited\& . Default:
2007-01-28 14:18:35 +00:00
\fI 5\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-11-09 08:59:05 +00:00
\fB \- \- no\- proxy\fR =DOMAINS
.RS 4
Specify comma separated hostnames or domains to which proxy should not be used\& .
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- o\fR , \fB \- \- out\fR =FILE
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The file name of the downloaded file\& .
2007-03-28 15:08:22 +00:00
.RE
2008-11-09 08:59:05 +00:00
.PP
\fB \- \- proxy\- method\fR =METHOD
.RS 4
Set the method to use in proxy request\& .
\fI METHOD\fR
is either
\fI get\fR
or
\fI tunnel\fR \& . Default:
\fI tunnel\fR
.RE
2008-05-12 15:26:43 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
In Metalink, BitTorrent download you cannot specify file name\& . The file name specified here is only used when the URLs fed to aria2 is done by command line without \fB \- i\fR , \fB \- Z\fR option, like this: aria2c \- o myfile\& .zip http://mirror1/file\& .zip http://mirror2/file\& .zip
2007-03-28 15:08:22 +00:00
.PP
2008-09-27 05:33:05 +00:00
\fB \- R\fR , \fB \- \- remote\- time\fR [=\fI true\fR |\fI false\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:
\fI false\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- retry\- wait\fR =SEC
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set the seconds to wait to retry after an error has occured\& . Specify a value between
2008-05-12 15:26:43 +00:00
\fI 0\fR
and
2008-06-17 14:22:20 +00:00
\fI 60\fR \& . Default:
2008-05-12 15:26:43 +00:00
\fI 5\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-09-27 05:33:05 +00:00
\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 SERVER PERFORMANCE PROFILE section 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
\fI feedback\fR \& . See also
\fB \- \- uri\- selector\fR
option\& . See SERVER PERFORMANCE PROFILE section 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:
\fI 86400\fR
(24hours)
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- s\fR , \fB \- \- split\fR =N
2007-06-10 08:29:56 +00:00
.RS 4
2008-07-08 14:23:30 +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\& . 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
2008-05-12 15:26:43 +00:00
\fI 1\fR
and
2008-07-08 14:23:30 +00:00
\fI 16\fR \& . Please see
\fB \- j\fR
2008-11-11 11:55:23 +00:00
option too\& . Please note that in Metalink download, this option has no effect and use
\fB \- C\fR
option instead\& . Default:
2008-06-17 14:22:20 +00:00
\fI 5\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- t\fR , \fB \- \- timeout\fR =SEC
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set timeout in seconds\& . Default:
2008-05-12 15:26:43 +00:00
\fI 60\fR
2007-03-28 15:08:22 +00:00
.RE
2008-09-27 05:33:05 +00:00
.PP
\fB \- \- uri\- selector\fR =SELECTOR
.RS 4
Specify URI selection algorithm\& . Possible values are
\fI inorder\fR
and
\fI feedback\fR \& . If
\fI inorder\fR
is given, URI is tried in the order appeared in the URI list\& . If
\fI feedback\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\& . Default:
\fI inorder\fR
.RE
2008-05-12 15:26:43 +00:00
.SS "HTTP Specific Options"
2007-03-28 15:08:22 +00:00
.PP
2008-11-09 08:59:05 +00:00
\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 [=\fI true\fR |\fI false\fR ]
.RS 4
Verify the peer using certificates specified in
\fB \- \- ca\- certificate\fR
option\& .
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- http\- auth\- scheme\fR =SCHEME
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set HTTP authentication scheme\& . Currently,
2007-01-28 14:18:35 +00:00
\fI basic\fR
2008-06-17 14:22:20 +00:00
is the only supported scheme\& . Default:
2007-01-28 14:18:35 +00:00
\fI basic\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- http\- user\fR =USER
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set HTTP user\& . This affects all URLs\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- http\- passwd\fR =PASSWD
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set HTTP password\& . This affects all URLs\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-11-09 08:59:05 +00:00
\fB \- \- http\- proxy\fR =PROXY
2007-06-10 08:29:56 +00:00
.RS 4
2008-11-09 08:59:05 +00:00
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]
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-11-09 08:59:05 +00:00
\fB \- \- https\- proxy\fR =PROXY
2007-06-10 08:29:56 +00:00
.RS 4
2008-11-09 08:59:05 +00:00
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]
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-11-09 08:59:05 +00:00
\fB \- \- private\- key\fR =FILE
2007-06-10 08:29:56 +00:00
.RS 4
2008-11-09 09:06:25 +00:00
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
2008-11-09 08:59:05 +00:00
\fB \- \- certificate\fR
option\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- referer\fR =REFERER
2007-10-29 12:43:45 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set Referer\& . This affects all URLs\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- enable\- http\- keep\- alive\fR [=\fI true\fR |\fI false\fR ]
2007-11-29 14:22:37 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable HTTP/1\& .1 persistent connection\& . Default:
2008-05-12 15:26:43 +00:00
\fI true\fR
2007-11-29 14:22:37 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- enable\- http\- pipelining\fR [=\fI true\fR |\fI false\fR ]
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable HTTP/1\& .1 pipelining\& . Default:
2007-11-23 13:58:50 +00:00
\fI false\fR
2007-09-03 14:17:10 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- header\fR =HEADER
2007-12-04 14:52:46 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Append HEADER to HTTP request header\& . You can use this option repeatedly to specify more than one header: aria2c
2008-05-21 07:47:32 +00:00
\fB \- \- header\fR ="X\- A: b78"
2008-10-13 13:59:59 +00:00
\fB \- \- header\fR ="X\- B: 9J1"
http://host/file
2007-12-04 14:52:46 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- load\- cookies\fR =FILE
2007-09-03 14:17:10 +00:00
.RS 4
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\& .
2007-09-03 14:17:10 +00:00
.RE
2008-09-27 05:33:05 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
If aria2 is build without libsqlite3, then it doesn\' t support Firefox3 cookie\& .
2007-09-03 14:17:10 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- U\fR , \fB \- \- user\- agent\fR =USER_AGENT
2007-09-03 14:17:10 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set user agent for HTTP(S) downloads\& .
2007-09-03 14:17:10 +00:00
.RE
2008-05-12 15:26:43 +00:00
.SS "FTP Specific Options"
2007-09-03 14:17:10 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- ftp\- user\fR =USER
2007-09-03 14:17:10 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set FTP user\& . This affects all URLs\& . Default:
2008-05-12 15:26:43 +00:00
\fI anonymous\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- ftp\- passwd\fR =PASSWD
2007-11-18 11:59:42 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set FTP password\& . This affects all URLs\& . Default:
2008-05-12 15:26:43 +00:00
\fI ARIA2USER@\fR
2007-11-18 11:59:42 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- p\fR , \fB \- \- ftp\- pasv\fR
2007-11-18 11:59:42 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Use passive mode in FTP\& .
2007-11-18 11:59:42 +00:00
.RE
.PP
2008-11-09 08:59:05 +00:00
\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
2008-05-21 07:47:32 +00:00
\fB \- \- ftp\- type\fR =TYPE
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set FTP transfer type\& . TYPE is either
2008-05-12 15:26:43 +00:00
\fI binary\fR
or
2008-06-17 14:22:20 +00:00
\fI ascii\fR \& . Default:
2008-05-12 15:26:43 +00:00
\fI binary\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- ftp\- reuse\- connection\fR [=\fI true\fR |\fI false\fR ]
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Reuse connection in FTP\& . Default:
2007-11-23 13:58:50 +00:00
\fI true\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- n\fR , \fB \- \- no\- netrc\fR
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Disables netrc support\& . netrc support is enabled by default\& .
2007-03-28 15:08:22 +00:00
.RE
2008-05-12 15:26:43 +00:00
.SS "BitTorrent/Metalink Options"
2007-03-28 15:08:22 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- select\- file\fR =INDEX\& ...
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set file to download by specifing its index\& . You can find the file index using the
2008-05-21 07:47:32 +00:00
\fB \- \- show\- files\fR
2008-06-17 14:22:20 +00:00
option\& . Multiple indexes can be specified by using ",", for example:
\fI 3,6\fR \& . You can also use "\- " to specify a range:
\fI 1\- 5\fR \& . "," and "\- " can be used together:
\fI 1\- 5,8,9\fR \& . When used with the \- M option, index may vary depending on the query (see
\fB \- \- metalink\- \fR * options)\& .
2007-06-10 08:29:56 +00:00
.RE
2008-05-12 15:26:43 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
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\& .
2007-06-10 08:29:56 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- S\fR , \fB \- \- show\- files\fR
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Print file listing of \& .torrent or \& .metalink file and exit\& . In case of \& .torrent file, additional information (infohash, piece length, etc) is also printed\& .
2007-06-10 08:29:56 +00:00
.RE
2008-05-12 15:26:43 +00:00
.SS "BitTorrent Specific Options"
2007-06-10 08:29:56 +00:00
.PP
2008-06-17 14:22:20 +00:00
\fB \- \- bt\- max\- open\- files\fR =NUM
.RS 4
Specify maximum number of files to open in each BitTorrent download\& . Default:
\fI 100\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- bt\- min\- crypto\- level\fR =\fI plain\fR |\fI arc4\fR
2008-02-21 14:23:36 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-12 15:26:43 +00:00
\fI plain\fR
2008-02-21 14:23:36 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- bt\- require\- crypto\fR =\fI true\fR |\fI false\fR
2008-02-21 14:23:36 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
If true is given, aria2 doesn\' t accept and establish connection with legacy BitTorrent handshake(\e 19BitTorrent protocol)\& . Thus aria2 always uses Obfuscation handshake\& . Default:
2008-05-12 15:26:43 +00:00
\fI false\fR
2008-02-21 14:23:36 +00:00
.RE
.PP
2008-06-17 14:22:20 +00:00
\fB \- \- bt\- request\- peer\- speed\- limit\fR =SPEED
.RS 4
In BitTorrent downloads, if the download speed is lower than SPEED, aria2 initiates and accepts connections ignoring max peer cap\& . You can append
\fI K\fR
or
\fI M\fR (1K = 1024, 1M = 1024K)\& . Default:
\fI 51200\fR
.RE
.PP
2008-07-12 13:55:32 +00:00
\fB \- \- bt\- seed\- unverified\fR [=\fI true\fR |\fI false\fR ]
2008-07-08 14:23:30 +00:00
.RS 4
2008-07-12 13:55:32 +00:00
Seed previously downloaded files without verifying piece hashes\& . Default:
2008-07-08 14:23:30 +00:00
\fI false\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- dht\- entry\- point\fR =HOST:PORT
2008-02-21 14:23:36 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set host and port as an entry point to DHT network\& .
2008-02-21 14:23:36 +00:00
.RE
.PP
2008-10-13 13:59:59 +00:00
\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
2008-05-21 07:47:32 +00:00
\fB \- \- dht\- listen\- port\fR =PORT\& ...
2007-07-05 16:06:31 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set UDP listening port for DHT\& . Multiple ports can be specified by using ",", for example:
\fI 6881,6885\fR \& . You can also use "\- " to specify a range:
\fI 6881\- 6999\fR \& . "," and "\- " can be used together\& . Default:
2008-05-12 15:26:43 +00:00
\fI 6881\- 6999\fR
2007-07-05 16:06:31 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- direct\- file\- mapping\fR =\fI true\fR |\fI false\fR
2007-07-05 16:06:31 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-12 15:26:43 +00:00
\fI true\fR
.RE
2007-11-23 13:58:50 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- enable\- dht\fR [=\fI true\fR |\fI false\fR ]
2007-11-21 16:14:40 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable DHT functionality\& . If a private flag is set in a torrent, aria2 doesn\' t use DHT for that download even if
2008-05-12 15:26:43 +00:00
\fI true\fR
2008-06-17 14:22:20 +00:00
is given\& . Default:
2008-05-12 15:26:43 +00:00
\fI false\fR
2007-07-05 16:06:31 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- enable\- peer\- exchange\fR [=\fI true\fR |\fI false\fR ]
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable Peer Exchange extension\& . If a private flag is set in a torrent, this feature is disabled for that download even if
2008-05-12 15:26:43 +00:00
\fI true\fR
2008-06-17 14:22:20 +00:00
is given\& . Default:
2008-05-12 15:26:43 +00:00
\fI true\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- follow\- torrent\fR =\fI true\fR |\fI false\fR |\fI mem\fR
2007-06-10 08:29:56 +00:00
.RS 4
2007-12-12 14:12:06 +00:00
If
\fI true\fR
or
\fI mem\fR
2008-06-17 14:22:20 +00:00
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
2007-12-12 14:12:06 +00:00
\fI mem\fR
2008-06-17 14:22:20 +00:00
is specified, a torrent file is not written to the disk, but is just kept in memory\& . If
2007-12-12 14:12:06 +00:00
\fI false\fR
2008-06-17 14:22:20 +00:00
is specified, the action mentioned above is not taken\& . Default:
2007-12-12 14:12:06 +00:00
\fI true\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- listen\- port\fR =PORT\& ...
2007-11-23 13:58:50 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set TCP port number for BitTorrent downloads\& . Multiple ports can be specified by using ",", for example:
\fI 6881,6885\fR \& . You can also use "\- " to specify a range:
\fI 6881\- 6999\fR \& . "," and "\- " can be used together:
\fI 6881\- 6889,6999\fR \& . Default:
2007-11-23 13:58:50 +00:00
\fI 6881\- 6999\fR
2008-05-12 15:26:43 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2007-12-08 10:50:08 +00:00
Note
2008-06-17 14:22:20 +00:00
Make sure that the specified ports are open for incoming TCP traffic\& .
2007-03-28 15:08:22 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- max\- upload\- limit\fR =SPEED
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set max upload speed in bytes per sec\& .
2007-01-28 14:18:35 +00:00
\fI 0\fR
2008-06-17 14:22:20 +00:00
means unrestricted\& . You can append
2007-01-28 14:18:35 +00:00
\fI K\fR
or
2008-06-17 14:22:20 +00:00
\fI M\fR (1K = 1024, 1M = 1024K)\& . Default:
2007-01-28 14:18:35 +00:00
\fI 0\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- peer\- id\- prefix\fR =PEERI_ID_PREFIX
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-12 15:26:43 +00:00
\fI \- aria2\- \fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- seed\- ratio\fR =RATIO
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Specify share ratio\& . Seed completed torrents until share ratio reaches] RATIO\& . I strongly encourages you to specify equals or more than
\fI 1\& .0\fR
here\& . Specify
\fI 0\& .0\fR
if you intend to do seeding regardless of share ratio\& . If
2008-05-21 07:47:32 +00:00
\fB \- \- seed\- time\fR
2008-06-17 14:22:20 +00:00
option is specified along with this option, seeding ends when at least one of the conditions is satisfied\& . Default:
\fI 1\& .0\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- seed\- time\fR =MINUTES
2007-08-09 15:34:03 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Specify seeding time in minutes\& . Also see the
2008-05-21 07:47:32 +00:00
\fB \- \- seed\- ratio\fR
2008-06-17 14:22:20 +00:00
option\& .
2007-08-09 15:34:03 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- T\fR , \fB \- \- torrent\- file\fR =TORRENT_FILE
2008-02-21 14:23:36 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The path to the \& .torrent file\& . You may not use this option because you can specify torrent file without \- T\& .
2008-02-21 14:23:36 +00:00
.RE
2008-05-12 15:26:43 +00:00
.SS "Metalink Specific Options"
2008-02-21 14:23:36 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- follow\- metalink\fR =\fI true\fR |\fI false\fR |\fI mem\fR
2008-02-21 14:23:36 +00:00
.RS 4
2008-05-12 15:26:43 +00:00
If
2008-02-21 14:23:36 +00:00
\fI true\fR
2008-05-12 15:26:43 +00:00
or
\fI mem\fR
2008-06-17 14:22:20 +00:00
is specified, when a file whose suffix is "\& .metaink" or content type is "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it\& . If
2008-05-12 15:26:43 +00:00
\fI mem\fR
2008-06-17 14:22:20 +00:00
is specified, a metalink file is not written to the disk, but is just kept in memory\& . If
2008-02-21 14:23:36 +00:00
\fI false\fR
2008-06-17 14:22:20 +00:00
is specified, the action mentioned above is not taken\& . Default:
2008-05-12 15:26:43 +00:00
\fI true\fR
2008-02-21 14:23:36 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- M\fR , \fB \- \- metalink\- file\fR =METALINK_FILE
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The file path to \& .metalink file\& . You may not use this option because you can specify metalink file without \- M\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- C\fR , \fB \- \- metalink\- servers\fR =NUM_SERVERS
2007-06-10 08:29:56 +00:00
.RS 4
2008-11-11 11:55:23 +00:00
The number of servers to connect to simultaneously\& . 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
\fB \- s\fR
and
\fB \- j\fR
options\& . Default:
2008-05-19 12:36:20 +00:00
\fI 5\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- language\fR =LANGUAGE
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The language of the file to download\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- location\fR =LOCATION[,\& ...]
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The location of the preferred server\& . A comma\- deliminated list of locations is acceptable, for example,
\fI JP,US\fR \& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- os\fR =OS
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The operating system of the file to download\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- version\fR =VERSION
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
The version of the file to download\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- preferred\- protocol\fR =PROTO
2007-12-12 14:12:06 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Specify preferred protocol\& . The possible values are
2007-12-12 14:12:06 +00:00
\fI http\fR ,
\fI https\fR ,
\fI ftp\fR
and
2008-06-17 14:22:20 +00:00
\fI none\fR \& . Specifiy
2007-12-12 14:12:06 +00:00
\fI none\fR
2008-06-17 14:22:20 +00:00
to disable this feature\& . Default:
2007-12-12 14:12:06 +00:00
\fI none\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- enable\- unique\- protocol\fR =\fI true\fR |\fI false\fR
2007-12-22 06:40:58 +00:00
.RS 4
If
\fI true\fR
2008-06-17 14:22:20 +00:00
is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\& . Use
2008-05-21 07:47:32 +00:00
\fB \- \- metalink\- preferred\- protocol\fR
2008-06-17 14:22:20 +00:00
option to specify the preference of protocol\& . Default:
2008-02-21 14:23:36 +00:00
\fI true\fR
2007-12-22 06:40:58 +00:00
.RE
2008-05-12 15:26:43 +00:00
.SS "Advanced Options"
2007-12-22 06:40:58 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- allow\- overwrite\fR =\fI true\fR |\fI false\fR
2008-05-06 15:43:26 +00:00
.RS 4
2008-05-12 15:26:43 +00:00
If
\fI false\fR
2008-06-17 14:22:20 +00:00
is given, aria2 doesn\' t download a file which already exists but the corresponding \& .aria2 file doesn\' t exist\& . In HTTP(S)/FTP download, if
2008-05-21 07:47:32 +00:00
\fB \- \- auto\- file\- renaming\fR =\fI true\fR
2008-06-17 14:22:20 +00:00
then, file name will be renamed\& . See
2008-05-21 07:47:32 +00:00
\fB \- \- auto\- file\- renaming\fR
2008-06-17 14:22:20 +00:00
for details\& . Default:
2008-05-12 15:26:43 +00:00
\fI false\fR
2008-05-06 15:43:26 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- allow\- piece\- length\- change\fR =\fI true\fR |\fI false\fR
2008-05-06 15:43:26 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-06 15:43:26 +00:00
\fI false\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- async\- dns\fR [=\fI true\fR |\fI false\fR ]
2008-05-09 15:34:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable asynchronous DNS\& . Default:
2008-05-09 15:34:43 +00:00
\fI true\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- auto\- file\- renaming\fR [=\fI true\fR |\fI false\fR ]
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-12 15:26:43 +00:00
\fI true\fR
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-10-13 13:59:59 +00:00
\fB \- \- auto\- save\- interval\fR =SEC
.RS 4
Save a control file(*\& .aria2) every SEC seconds\& . If
\fI 0\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
\fI 0\fR
to
\fI 600\fR \& . Default:
\fI 60\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- conf\- path\fR =PATH
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Change the configuration file path to PATH\& . Default:
\fI $HOME/\& .aria2/aria2\& .conf\fR
2008-05-12 15:26:43 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- D\fR , \fB \- \- daemon\fR
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Run as daemon\& .
2007-03-28 15:08:22 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- enable\- direct\- io\fR [=\fI true\fR |\fI false\fR ]
2007-06-10 08:29:56 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable directI/O, which lowers cpu usage while allocating/checking files\& . Turn off if you encounter any error\& . Default:
2008-05-12 15:26:43 +00:00
\fI false\fR
.RE
2007-12-08 10:50:08 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- file\- allocation\fR =METHOD
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Specify file allocation method\& . METHOD is either
2008-05-12 15:26:43 +00:00
\fI none\fR
or
2008-06-17 14:22:20 +00:00
\fI prealloc\fR \& .
2008-05-12 15:26:43 +00:00
\fI none\fR
2008-06-17 14:22:20 +00:00
doesn\' t pre\- allocate file space\& .
2008-05-12 15:26:43 +00:00
\fI prealloc\fR
2008-06-17 14:22:20 +00:00
pre\- allocates file space before download begins\& . This may take some time depending on the size of the file\& . Default:
2008-05-12 15:26:43 +00:00
\fI prealloc\fR
.RE
2008-05-15 15:57:04 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- log\- level\fR =LEVEL
2008-05-15 15:57:04 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set log level to output\& . LEVEL is either
2008-05-15 15:57:04 +00:00
\fI debug\fR ,
\fI info\fR ,
\fI notice\fR ,
\fI warn\fR
or
2008-06-17 14:22:20 +00:00
\fI error\fR \& . Default:
2008-05-15 15:57:04 +00:00
\fI debug\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- summary\- interval\fR =SEC
2008-05-15 15:57:04 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set interval in seconds to output download progress summary\& . Setting
2008-05-15 15:57:04 +00:00
\fI 0\fR
2008-06-17 14:22:20 +00:00
suppresses the output\& . Default:
2008-05-15 15:57:04 +00:00
\fI 60\fR
.RE
2008-05-12 15:26:43 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2007-12-08 10:50:08 +00:00
Note
2008-06-17 14:22:20 +00:00
In multi file torrent, the files adjacent forward to the specified files are also allocated if they share a same piece\& .
2008-05-12 15:26:43 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- Z\fR , \fB \- \- force\- sequential\fR [=\fI true\fR |\fI false\fR ]
2007-12-08 10:50:08 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-12 15:26:43 +00:00
\fI false\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- max\- download\- limit\fR =SPEED
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Set max download speed in bytes per sec\& .
2008-05-12 15:26:43 +00:00
\fI 0\fR
2008-06-17 14:22:20 +00:00
means unrestricted\& . You can append
2008-05-12 15:26:43 +00:00
\fI K\fR
or
2008-06-17 14:22:20 +00:00
\fI M\fR (1K = 1024, 1M = 1024K)\& . Default:
2008-05-12 15:26:43 +00:00
\fI 0\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- no\- conf\fR
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Disable loading aria2\& .conf file\& .
2008-05-12 15:26:43 +00:00
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- no\- file\- allocation\- limit\fR =SIZE
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
No file allocation is made for files whose size is smaller than SIZE\& . You can append
2008-05-12 15:26:43 +00:00
\fI K\fR
or
2008-06-17 14:22:20 +00:00
\fI M\fR (1K = 1024, 1M = 1024K)\& . Default:
2008-05-12 15:26:43 +00:00
\fI 5M\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- P\fR , \fB \- \- parameterized\- uri\fR [=\fI true\fR |\fI false\fR ]
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Enable parameterized URI support\& . You can specify set of parts:
\fI http://{sv1,sv2,sv3}/foo\& .iso\fR \& . Also you can specify numeric sequences with step counter:
\fI http://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:
2008-05-12 15:26:43 +00:00
\fI false\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- q\fR , \fB \- \- quiet\fR [=\fI true\fR |\fI false\fR ]
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Make aria2 quite (no console output)\& . Default:
2008-05-12 15:26:43 +00:00
\fI false\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- realtime\- chunk\- checksum\fR =\fI true\fR |\fI false\fR
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +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:
2008-05-12 15:26:43 +00:00
\fI true\fR
.RE
.PP
2008-05-21 07:47:32 +00:00
\fB \- \- stop\fR =SEC
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Stop application after SEC seconds has passed\& . If
2008-05-12 15:26:43 +00:00
\fI 0\fR
2008-06-17 14:22:20 +00:00
is given, this feature is disabled\& . Default:
2008-05-12 15:26:43 +00:00
\fI 0\fR
2007-12-08 10:50:08 +00:00
.RE
2008-05-12 15:26:43 +00:00
.PP
2008-05-21 07:47:32 +00:00
\fB \- v\fR , \fB \- \- version\fR
2008-05-12 15:26:43 +00:00
.RS 4
2008-06-17 14:22:20 +00:00
Print the version number, copyright and the configuration information and exit\& .
2007-03-28 15:08:22 +00:00
.RE
2008-05-12 15:26:43 +00:00
.SS "URL, TORRENT_FILE, METALINK_FILE"
2008-06-17 14:22:20 +00:00
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\& .
2008-05-12 15:26:43 +00:00
.sp
2008-06-17 14:22:20 +00:00
You can also specify arbitrary number of torrent files and metalink files stored in a local drive\& . Please note that they are always treated as a separate download\& .
2008-05-12 15:26:43 +00:00
.sp
2008-06-17 14:22:20 +00:00
You can specify both torrent file with \- T option and URLs\& . By doing this, download a file from both torrent swarm and HTTP(S)/FTP server at the same time, while the data from HTTP(S)/FTP are uploaded to the torrent swarm\& . Note that only single file torrent can be integrated with HTTP(S)/FTP\& .
2008-05-12 15:26:43 +00:00
.sp
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
Make sure that URL is quoted with single(\' ) or double(") quotation if it contains "&" or any characters that have special meaning in shell\& .
2008-05-12 15:26:43 +00:00
.sp
2007-01-28 14:18:35 +00:00
.SH "EXAMPLES"
2007-11-23 13:58:50 +00:00
.SS "HTTP/FTP Segmented Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-06-17 14:22:20 +00:00
Download a file
2007-11-23 13:58:50 +00:00
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c http://host/file\& .zip
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
aria2 uses 5 connections to download 1 file by default\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-06-17 14:22:20 +00:00
Download a file using 1 connection
2007-11-23 13:58:50 +00:00
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- s1 http://host/file\& .zip
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2008-06-17 14:22:20 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
aria2 uses 5 connections to download 1 file by default\& . \- s1 limtis the number of connections to just 1\& .
.sp
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
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\& .
.sp
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-04-15 12:37:15 +00:00
Download a file from 2 different HTTP servers
2007-11-23 13:58:50 +00:00
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c http://host/file\& .zip http://mirror/file\& .zip
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-02-21 14:23:36 +00:00
Download a file from HTTP and FTP servers
2007-11-23 13:58:50 +00:00
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c http://host1/file\& .zip ftp://host2/file\& .zip
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download files listed in a file concurrently
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- ifiles\& .txt \- j2
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
\- j option specifies the number of parallel downloads\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
2008-11-09 09:13:57 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Using proxy
.RS
For HTTP:
.sp
.sp
.RS 4
.nf
aria2c \- \- http\- proxy=http://proxy:8080 http://host/file
.fi
.RE
For FTP:
.sp
.sp
.RS 4
.nf
aria2c \- \- ftp\- proxy=http://proxy:8080 ftp://host/file
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
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 ENVIRONMENT section\& .
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Proxy with authorization
.RS
.sp
.RS 4
.nf
aria2c \- \- http\- proxy=http://username:password@proxy:8080 http://host/file
.fi
.RE
.RE
2007-11-23 13:58:50 +00:00
.SS "Metalink Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download files with remote Metalink
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- follow\- metalink=mem http://host/file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download using a local metalink file
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- p \- \- lowest\- speed\- limit=4000 file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-09-03 14:17:10 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
To pause a download, press Ctrl\- C\& . You can resume the transfer by running aria2c with the same argument at the same directory\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-05-09 15:34:43 +00:00
Download several local metalink files
.RS
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- j2 file1\& .metalink file2\& .metalink
2008-05-09 15:34:43 +00:00
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2007-11-23 13:58:50 +00:00
Download only selected files using index
.RS
.sp
2007-09-03 14:17:10 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- select\- file=1\- 4,8 file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-09-03 14:17:10 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
The index is printed to the console using \- S option\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download a file using a local .metalink file with user preference
.RS
.sp
2007-09-03 14:17:10 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- metalink\- location=JP,US \- \- metalink\- version=1\& .1 \- \- metalink\- language=en\- US file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.SS "BitTorrent Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download files from remote BitTorrent file
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-08-14 14:02:18 +00:00
aria2c \- \- follow\- torrent=mem http://host/file\& .torrent
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download using a local torrent file
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- max\- upload\- limit=40K file\& .torrent
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
\- \- max\- upload\- limit specifies the max of upload rate\& .
2007-11-23 13:58:50 +00:00
.sp
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
To pause a download, press Ctrl\- C\& . You can resume the transfer by run aria2c with the same argument at the same directory\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-05-09 15:34:43 +00:00
Download 2 torrents
.RS
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- j2 file1\& .torrent file2\& .torrent
2008-05-09 15:34:43 +00:00
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-02-21 14:23:36 +00:00
Download a file using torrent and HTTP/FTP server
2007-11-23 13:58:50 +00:00
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- Ttest\& .torrent http://host1/file ftp://host2/file
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
Downloading multi file torrent with HTTP/FTP is not supported\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download only selected files using index(usually called "selectable download")
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- select\- file=1\- 4,8 file\& .torrent
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
The index is printed to the console using \- S option\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Change the listening port for incoming peer
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- listen\- port=7000\- 7001,8000 file\& .torrent
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2008-02-21 14:23:36 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
Since aria2 doesn\' t configure firewall or router for port forwarding, it\' s up to you to do it manually\& .
2008-02-21 14:23:36 +00:00
.sp
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Specify the condition to stop program after torrent download finished
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- seed\- time=120 \- \- seed\- ratio=1\& .0 file\& .torrent
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1\& .0\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Throttle upload speed
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- max\- upload\- limit=100K file\& .torrent
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
2008-02-21 14:23:36 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Enable DHT
.RS
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- enable\- dht \- \- dht\- listen\- port=6881 file\& .torrent
2008-02-21 14:23:36 +00:00
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
DHT uses udp port\& . Since aria2 doesn\' t configure firewall or router for port forwarding, it\' s up to you to do it manually\& .
2008-02-21 14:23:36 +00:00
.sp
.RE
2007-11-23 13:58:50 +00:00
.SS "More advanced HTTP features"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Load cookies
.RS
.sp
2007-11-18 11:59:42 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- load\- cookies=cookies\& .txt http://host/file\& .zip
2007-11-23 13:58:50 +00:00
.fi
2007-11-18 11:59:42 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
You can use Firefox/Mozilla\' s cookie file without modification\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Resume download started by web browsers or another programs
.RS
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- c \- s2 http://host/partiallydownloadedfile\& .zip
2007-11-23 13:58:50 +00:00
.fi
2007-03-28 15:08:22 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
2008-11-09 09:06:25 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Client certificate authorization for SSL/TLS
.RS
.sp
.RS 4
.nf
aria2c \- \- certificate=/path/to/mycert\& .pem \- \- private\- key=/path/to/mykey\& .pem https://host/file
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
The file specified in \fB \- \- private\- key\fR must be decrypted\& . The behavior when encrypted one is given is undefined\& .
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Verify peer in SSL/TLS using given CA certificates
.RS
.sp
.RS 4
.nf
aria2c \- \- ca\- certificate=/path/to/ca\- certificates\& .crt \- \- check\- certificate https://host/file
.fi
.RE
.RE
2007-11-23 13:58:50 +00:00
.SS "And more advanced features"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Throttle download speed
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- max\- download\- limit=100K file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Repair a damaged download using --check-integrity option
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- check\- integrity=true file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
This option is only available used with BitTorrent or metalink with chunk checksums\& .
2007-11-23 13:58:50 +00:00
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Drop connection if download speed is lower than specified value
.RS
.sp
2007-07-05 16:06:31 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- lowest\- speed\- limit=10K file\& .metalink
2007-11-23 13:58:50 +00:00
.fi
2007-07-05 16:06:31 +00:00
.RE
2007-11-23 13:58:50 +00:00
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Parameterized URI support
.RS
You can specify set of parts:
.sp
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-11-23 13:58:50 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- P http://{host1,host2,host3}/file\& .iso
2007-11-23 13:58:50 +00:00
.fi
.RE
You can specify numeric sequence:
.sp
2007-03-28 16:13:36 +00:00
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-03-28 16:13:36 +00:00
.nf
2008-06-17 14:22:20 +00:00
aria2c \- Z \- P http://host/image[000\- 100]\& .png
2007-03-28 16:13:36 +00:00
.fi
.RE
.sp
2007-11-23 13:58:50 +00:00
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
2008-06-17 14:22:20 +00:00
\- Z option is required if the all URIs don\' t point to the same file, such as the above example\& .
2007-11-23 13:58:50 +00:00
.sp
You can specify step counter:
.sp
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- Z \- P http://host/image[A\- Z:2]\& .png
2007-11-23 13:58:50 +00:00
.fi
.RE
.RE
2008-02-21 14:23:36 +00:00
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-05-09 15:34:43 +00:00
Parallel downloads of arbitrary number of URL,metalink,torrent
.RS
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- j3 \- Z http://host/file1 file2\& .torrent file3\& .metalink
2008-05-09 15:34:43 +00:00
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
2008-02-21 14:23:36 +00:00
BitTorrent Encryption
.RS
Encrypt whole payload using ARC4:
.sp
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- bt\- min\- crypto\- level=arc4 \- \- bt\- require\- crypto=true file\& .torrent
2008-02-21 14:23:36 +00:00
.fi
.RE
.RE
2007-11-29 14:22:37 +00:00
.SH "RESUME DOWNLOAD"
2008-06-17 14:22:20 +00:00
Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\& .
2007-11-29 14:22:37 +00:00
.sp
2008-06-17 14:22:20 +00:00
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)\& .
2007-11-29 14:22:37 +00:00
.sp
.SH "CONTROL FILE"
2008-06-17 14:22:20 +00:00
aria2 uses a control file to keep track the progress of download\& . A control file is placed at the same directory of the dowloading file and its filename is the filename of downloading file with "\& .aria2" appended\& . For example, if you are downloading file\& .zip, then the control file should be file\& .zip\& .aria2\& . (There is a exception for this naming convention\& . If you are downloading a multi torrent, its control file is the "top directory" name of the torrent with "\& .aria2" appended\& . The "top directory" name is a value of "name" key in "info" directory in a torrent file\& .)
2007-11-29 14:22:37 +00:00
.sp
2008-06-17 14:22:20 +00:00
Usually a control file is deleted once download completed\& . If aria2 decides that download cannot be resumed(for example, when downloading a file from a HTTP server which doesn\' t support resume), a control file is not created\& .
2007-11-29 14:22:37 +00:00
.sp
2008-06-17 14:22:20 +00:00
Normally if you lose a control file, you cannot resume download\& . But if you have a torrent or metalink with chunk checksums for the file, you can resume the download without a control file by giving \- \- check\- integrity=true option to aria2c in command\- line\& .
2007-11-29 14:22:37 +00:00
.sp
.SH "SEEDING DOWNLOADED FILE IN BITTORRENT"
2008-06-17 14:22:20 +00:00
You can seed downloaded file using \- \- check\- integrity=true option\& .
2007-11-29 14:22:37 +00:00
.sp
.sp
.RS 4
.nf
2008-06-17 14:22:20 +00:00
aria2c \- \- check\- integrity=true file\& .torrent
2007-11-29 14:22:37 +00:00
.fi
.RE
2008-09-27 05:33:05 +00:00
.SH "SERVER PERFORMANCE PROFILE"
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
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
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\& .
.sp
An example is follow:
.sp
.sp
.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
.RE
2007-11-23 13:58:50 +00:00
.SH "FILES"
2008-06-17 14:22:20 +00:00
.SS "aria2\&.conf"
User configuration file\& . It must be placed under $HOME/\& .aria2 and must be named as aria2\& .conf\& . In each line, there is 1 parameter whose syntax is name=value pair, where name is the long command\- line option name without \fI \- \- \fR prefix\& . The lines beginning \fI #\fR are treated as comments\& .
2007-11-23 13:58:50 +00:00
.sp
.sp
2007-06-10 08:29:56 +00:00
.RS 4
2007-03-28 16:13:36 +00:00
.nf
# sample configuration file for aria2c
listen\- port=60000
2008-05-12 15:26:43 +00:00
dht\- listen\- port=60000
2008-06-17 14:22:20 +00:00
seed\- ratio=1\& .0
2008-05-09 15:34:43 +00:00
max\- upload\- limit=50K
2007-03-28 16:13:36 +00:00
ftp\- pasv=true
.fi
.RE
2008-06-17 14:22:20 +00:00
.SS "dht\&.dat"
2008-10-13 13:59:59 +00:00
By default, the routing table of DHT is saved to the path $HOME/\& .aria2/dht\& .dat\& .
2008-02-21 14:23:36 +00:00
.sp
2008-11-09 08:59:05 +00:00
.SH "ENVIRONMENT"
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
2007-11-23 13:58:50 +00:00
.SH "RESOURCES"
2008-06-17 14:22:20 +00:00
Project web site: http://aria2\& .sourceforge\& .net/
2007-11-23 13:58:50 +00:00
.sp
2008-06-17 14:22:20 +00:00
metalink: http://www\& .metalinker\& .org/
2007-11-23 13:58:50 +00:00
.sp
2007-01-28 14:18:35 +00:00
.SH "REPORTING BUGS"
2008-10-14 13:16:59 +00:00
Report bugs to Tatsuhiro Tsujikawa <t\- tujikawa at users\& .sourceforge\& .net>
2007-01-28 14:18:35 +00:00
.sp
.SH "AUTHOR"
2008-10-14 13:16:59 +00:00
Tatsuhiro Tsujikawa <t\- tujikawa at users\& .sourceforge\& .net>
2007-01-28 14:18:35 +00:00
.sp
.SH "COPYRIGHT"
2008-02-21 14:23:36 +00:00
Copyright \(co 2006, 2008 Tatsuhiro Tsujikawa
2007-01-28 14:18:35 +00:00
.sp
2008-06-17 14:22:20 +00:00
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\& .
2007-11-23 13:58:50 +00:00
.sp
2008-06-17 14:22:20 +00:00
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\& .
2007-11-23 13:58:50 +00:00
.sp
2008-06-17 14:22:20 +00:00
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
2007-11-23 13:58:50 +00:00
.sp
2008-06-17 14:22:20 +00:00
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\& .
2007-11-23 13:58:50 +00:00
.sp