diff --git a/ChangeLog b/ChangeLog index 6b29e62c..4d1fbfea 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2009-05-13 Tatsuhiro Tsujikawa + + Documented additional options that can be specified in -i list. + Documented --enable-xml-rpc, --xml-rpc-listen-port, --xml-rpc-user + and --xml-rpc-passwd. Removed --enable-http-server and + --http-server-listen-port. + * doc/aria2c.1.txt + 2009-05-13 Tatsuhiro Tsujikawa Added "downloadSpeed" and uploadSpeed" key in getPeers response. diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 390a3319..7c9138a9 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -1,23 +1,31 @@ +'\" t .\" Title: aria2c -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.2 -.\" Date: 03/30/2009 -.\" Manual: -.\" Source: +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.74.3 +.\" Date: 05/13/2009 +.\" Manual: [FIXME: manual] +.\" Source: [FIXME: source] +.\" Language: English .\" -.TH "ARIA2C" "1" "03/30/2009" "" "" +.TH "ARIA2C" "1" "05/13/2009" "[FIXME: source]" "[FIXME: 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] [\fIURL\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&... -.sp .SH "DESCRIPTION" -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\'s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\&. .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 @@ -90,7 +98,7 @@ Use this proxy server for all protocols\&. You can override this setting and spe \fB\-\-https\-proxy\fR and \fB\-\-ftp\-proxy\fR -options\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] +options\&. This affects all URLs\&. The format of PROXY is [\ehttp://][USER:PASSWORD@]HOST[:PORT] .RE .PP \fB\-\-connect\-timeout\fR=SEC @@ -105,7 +113,7 @@ option is used instead\&. Default: .RS 4 If \fItrue\fR -is given, aria2 just checks whether the remote file is available and doesn\'t download data\&. This option has effect on HTTP/FTP download\&. BitTorrent downloads are canceled if +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 @@ -124,7 +132,7 @@ or .PP \fB\-\-max\-file\-not\-found\fR=NUM .RS 4 -If aria2 receives `file not found\' status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify +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 @@ -147,13 +155,22 @@ Specify comma separated hostnames or domains where proxy should not be used\&. .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 -Note +.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 @@ -241,7 +258,7 @@ 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\'t select anymore mirrors\&. Like +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 @@ -299,14 +316,14 @@ Set HTTP password\&. This affects all URLs\&. .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] +option\&. This affects all URLs\&. The format of PROXY is [\ehttp://][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] +option\&. This affects all URLs\&. The format of PROXY is [\ehttp://][USER:PASSWORD@]HOST[:PORT] .RE .PP \fB\-\-private\-key\fR=FILE @@ -344,13 +361,22 @@ Append HEADER to HTTP request header\&. You can use this option repeatedly to sp .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 -Note -If aria2 is built without libsqlite3, then it doesn\'t support Firefox3 cookie format\&. +.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\-\-use\-head\fR[=\fItrue\fR|\fIfalse\fR] .RS 4 @@ -388,7 +414,7 @@ is given, the active mode will be used\&. Default: .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] +option\&. This affects all URLs\&. The format of PROXY is [\ehttp://][USER:PASSWORD@]HOST[:PORT] .RE .PP \fB\-\-ftp\-type\fR=TYPE @@ -422,13 +448,22 @@ option\&. Multiple indexes can be specified by using ",", for example: \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 -Note +.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 @@ -476,7 +511,7 @@ Set minimum level of encryption method\&. If several encryption methods are prov .PP \fB\-\-bt\-require\-crypto\fR=\fItrue\fR|\fIfalse\fR .RS 4 -If true is given, aria2 doesn\'t accept and establish connection with legacy BitTorrent handshake(\e19BitTorrent protocol)\&. Thus aria2 always uses Obfuscation handshake\&. Default: +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 @@ -521,17 +556,26 @@ Set UDP listening port for DHT\&. Multiple ports can be specified by using ",", \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 -Note +.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\'t use DHT for that download even if +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 @@ -576,13 +620,22 @@ Set TCP port number for BitTorrent downloads\&. Multiple ports can be specified \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 -Note +.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 @@ -612,7 +665,7 @@ option\&. Default: .PP \fB\-\-peer\-id\-prefix\fR=PEERI_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, the random alphabet characters are added to make it\'s length 20 bytes\&. Default: +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\(cqs length 20 bytes\&. Default: \fI\-aria2\-\fR .RE .PP @@ -713,13 +766,44 @@ is given and several protocols are available for a mirror in a metalink file, ar 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\-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\-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, aria2 doesn\'t download a file which already exists but the corresponding \&.aria2 file doesn\'t exist\&. In HTTP(S)/FTP download, if +is given, aria2 doesn\(cqt download a file which already exists but the corresponding \&.aria2 file doesn\(cqt exist\&. In HTTP(S)/FTP download, if \fB\-\-auto\-file\-renaming\fR=\fItrue\fR then, file name will be renamed\&. See \fB\-\-auto\-file\-renaming\fR @@ -773,14 +857,6 @@ Enable directI/O, which lowers cpu usage while allocating/checking files\&. Turn \fItrue\fR .RE .PP -\fB\-\-enable\-http\-server\fR[=\fItrue\fR|\fIfalse\fR] -.RS 4 -Enable the built\-in HTTP server\&. Currently, this is the experimental feature and it just provides the current download progress\&. Use your web browser(console\-based ones, such as elinks, w3m, are recommended) to connect the server and see what\'s what\&. See also -\fB\-\-http\-server\-listen\-port\fR -option\&. Default: -\fIfalse\fR -.RE -.PP \fB\-\-event\-poll\fR=POLL .RS 4 Specify the method for polling events\&. The possible Values are @@ -798,17 +874,17 @@ Specify file allocation method\&. METHOD is either or \fIprealloc\fR\&. \fInone\fR -doesn\'t pre\-allocate file space\&. +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\'t use +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\'t have +may not be available if your system doesn\(cqt have \fBposix_fallocate\fR() function\&. Default: \fIprealloc\fR .RE @@ -832,13 +908,22 @@ Set interval in seconds to output download progress summary\&. Setting 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 -Note +.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 @@ -846,15 +931,6 @@ Fetch URIs in the command\-line sequentially and download each URI in a separate \fIfalse\fR .RE .PP -\fB\-\-http\-server\-listen\-port\fR=PORT -.RS 4 -Specify a port number for the built\-in HTTP Server to listen to\&. See also -\fB\-\-enable\-http\-server\fR -option\&. The possible Values are -\fI1024\fR\-\fI65535\fR\&. Default: -\fI6800\fR -.RE -.PP \fB\-\-max\-overall\-download\-limit\fR=SPEED .RS 4 Set max overall download speed in bytes/sec\&. @@ -899,7 +975,7 @@ or .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: +\fI\ehttp://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 @@ -928,29 +1004,38 @@ is given, this feature is disabled\&. Default: Print the version number, copyright and the configuration information and exit\&. .RE .SS "Options That Take An Optional Argument" -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\&. .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 "URL, 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 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\&. Note that only single file torrent can be integrated with HTTP(S)/FTP\&. +.if n \{\ .sp -.sp +.\} +.RS 4 .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Note -Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell\&. +.ps +1 +\fBNote\fR +.ps -1 +.br .sp +Make sure that URL is quoted with single(\e\') 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)\&. -.sp .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 @@ -996,39 +1081,48 @@ If network problem occurs\&. .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 -Note -An error occurred in a finished download will not be reported as exit status\&. +.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] +http_proxy [\ehttp://][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] +https_proxy [\ehttp://][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] +ftp_proxy [\ehttp://][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] +all_proxy [\ehttp://][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 @@ -1043,12 +1137,14 @@ overrides this value\&. .RE .SH "FILES" .SS "aria2\&.conf" -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\'t want to use the configuraitonf file, use \fB\-\-no\-conf\fR option\&. +.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 -.sp +.if n \{\ .RS 4 +.\} .nf # sample configuration file for aria2c listen\-port=60000 @@ -1057,58 +1153,797 @@ seed\-ratio=1\&.0 max\-upload\-limit=50K ftp\-pasv=true .fi +.if n \{\ .RE +.\} .SS "dht\&.dat" -By default, the routing table of DHT is saved to the path $HOME/\&.aria2/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\'t support resume), a control file is not created\&. +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\&. -.sp .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 -.sp .RS 4 -\h'-04'\(bu\h'+03'out +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +dir .RE .sp .RS 4 -\h'-04'\(bu\h'+03'dir +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +check\-integrity .RE .sp .RS 4 -\h'-04'\(bu\h'+03'select\-file +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +continue .RE .sp .RS 4 -\h'-04'\(bu\h'+03'index\-out +.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 +.\} +retry\-wait +.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\-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 +.\} +peer\-id\-prefix +.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 -.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\&. -.sp .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 @@ -1150,17 +1985,21 @@ 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 -.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 "EXAMPLE" .SS "HTTP/FTP Segmented Download" .sp @@ -1168,148 +2007,227 @@ host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Download a file -.RS -.sp +.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 -.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\&. -.sp -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Download a file using 1 connection -.RS -.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 -.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 limits 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 in the same directory\&. You can change URLs as long as they are pointing to the same file\&. -.sp -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Download a file from 2 different HTTP servers -.RS -.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 -Download a file from HTTP and FTP servers -.RS -.sp +.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 -Download files listed in a text file concurrently -.RS -.sp +.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 -Note +.ps +1 +\fBNote\fR +.ps -1 +.br +.sp \-j option specifies the number of parallel downloads\&. -.sp +.sp .5v +.RE .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Using proxy -.RS +.ps +1 +\fBUsing proxy\fR +.RS 4 +.sp For HTTP: .sp -.sp +.if n \{\ .RS 4 +.\} .nf aria2c \-\-http\-proxy="http://proxy:8080" "http://host/file" .fi +.if n \{\ .RE +.\} +.sp For FTP: .sp -.sp +.if n \{\ .RS 4 +.\} .nf aria2c \-\-ftp\-proxy="http://proxy:8080" "ftp://host/file" .fi +.if n \{\ .RE +.\} +.if n \{\ .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 \fBENVIRONMENT\fR 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 +.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 @@ -1317,86 +2235,127 @@ aria2c \-\-http\-proxy="http://username:password@proxy:8080" "http://host/file" .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Download files with remote Metalink -.RS -.sp +.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 -Download using a local metalink file -.RS -.sp +.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 -.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 in the same directory\&. -.sp -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Download several local metalink files -.RS -.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 -Download only selected files using index -.RS -.sp +.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 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -The index is printed to the console using \-S option\&. -.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 +.\} .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 @@ -1404,114 +2363,174 @@ aria2c \-\-metalink\-location=JP,US \-\-metalink\-version=1\&.1 \-\-metalink\-la .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Download files from remote BitTorrent file -.RS -.sp +.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 -Download using a local torrent file -.RS -.sp +.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 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -\-\-max\-upload\-limit specifies the max of upload rate\&. -.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 in the same directory\&. -.sp -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Download 2 torrents -.RS -.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 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 -Download a file using torrent and HTTP/FTP server -.RS -.sp +.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 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -Downloading multi file torrent with HTTP/FTP is not supported\&. -.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 +.\} .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 -Note +.ps +1 +\fBNote\fR +.ps -1 +.br +.sp The index is printed to the console using \-S option\&. -.sp +.sp .5v +.RE .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Specify output filename -.RS +.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 -.sp +.if n \{\ .RS 4 +.\} .nf idx|path/length ===+====================== @@ -1522,95 +2541,145 @@ idx|path/length |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 -.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 -Change the listening port for incoming peer -.RS -.sp +.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 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\&. -.sp -.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 +.\} .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 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1\&.0\&. -.sp -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Throttle upload speed -.RS -.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 -Enable DHT -.RS -.sp +.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 -Note -DHT uses udp port\&. Since aria2 doesn\'t configure firewall or router for port forwarding, it\'s up to you to do it manually\&. +.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 @@ -1618,72 +2687,108 @@ DHT uses udp port\&. Since aria2 doesn\'t configure firewall or router for port .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Load cookies -.RS -.sp +.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 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -You can use Firefox/Mozilla\'s cookie file without modification\&. -.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 +.\} .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 -Client certificate authorization for SSL/TLS -.RS -.sp +.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 -.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 +.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 @@ -1691,130 +2796,185 @@ aria2c \-\-ca\-certificate=/path/to/ca\-certificates\&.crt \-\-check\-certificat .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Throttle download speed -.RS -.sp +.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 -Repair a damaged download using -V option -.RS -.sp +.ps +1 +\fBRepair a damaged download using -V option\fR .RS 4 +.sp +.if n \{\ +.RS 4 +.\} .nf aria2c \-V file\&.metalink .fi +.if n \{\ .RE +.\} +.if n \{\ .sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -Note -This option is only available used with BitTorrent or metalink with chunk checksums\&. -.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 +.\} .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 -Parameterized URI support -.RS +.ps +1 +\fBParameterized URI support\fR +.RS 4 +.sp You can specify set of parts: .sp -.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 -.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 -Note -\-Z option is required if the all URIs don\'t point to the same file, such as the above example\&. +.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 -.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 -Parallel downloads of arbitrary number of URL,metalink,torrent -.RS -.sp +.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 -BitTorrent Encryption -.RS +.ps +1 +\fBBitTorrent Encryption\fR +.RS 4 +.sp Encrypt whole payload using ARC4: .sp -.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://apps\&.sourceforge\&.net/trac/aria2/wiki .sp Metalink Homepage: http://www\&.metalinker\&.org/ -.sp .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\&. @@ -1824,4 +2984,3 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY 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\&. -.sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 29e7cef7..5b1deb5f 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -3,7 +3,8 @@ - + +ARIA2C(1) -ARIA2C(1)

SYNOPSIS

-

aria2c [OPTIONS] [URL | TORRENT_FILE | METALINK_FILE]…

+

aria2c [OPTIONS] [URL | TORRENT_FILE | METALINK_FILE]…

DESCRIPTION

-

aria2 is a utility for downloading files. The supported protocols are +

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's +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.

OPTIONS

Basic Options

-
-
+
+
-d, --dir=DIR
@@ -398,7 +439,7 @@ downloading a file like BitTorrent.

The directory to store the downloaded file.

-
+
-i, --input-file=FILE
@@ -411,7 +452,7 @@ downloading a file like BitTorrent.

See Input File subsection for details.

-
+
-l, --log=LOG
@@ -420,7 +461,7 @@ downloading a file like BitTorrent.

stdout.

-
+
-j, --max-concurrent-downloads=N
@@ -430,7 +471,7 @@ downloading a file like BitTorrent.

Default: 5

-
+
-V, --check-integrity[=true|false]
@@ -442,7 +483,7 @@ downloading a file like BitTorrent.

Default: false

-
+
-c, --continue
@@ -453,7 +494,7 @@ downloading a file like BitTorrent.

Currently this option is only applicable to HTTP(S)/FTP downloads.

-
+
-h, --help[=CATEGORY]
@@ -470,8 +511,8 @@ downloading a file like BitTorrent.

HTTP/FTP Options

-
-
+
+
--all-proxy=PROXY
@@ -480,10 +521,10 @@ downloading a file like BitTorrent.

You can override this setting and specify a proxy server for a particular protocol using --http-proxy, --https-proxy and --ftp-proxy options. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]

-
+
--connect-timeout=SEC
@@ -494,18 +535,18 @@ downloading a file like BitTorrent.

Default: 60

-
+
--dry-run[=true|false]

If true is given, aria2 just checks whether the remote file is - available and doesn't download data. This option has effect on + available and doesn’t download data. This option has effect on HTTP/FTP download. BitTorrent downloads are canceled if true is specified. Default: false

-
+
--lowest-speed-limit=SPEED
@@ -518,19 +559,19 @@ downloading a file like BitTorrent.

Default: 0

-
+
--max-file-not-found=NUM

- If aria2 receives `file not found' status from the remote HTTP/FTP + If aria2 receives ‘file not found’ status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail. Specify 0 to disable this option. This options is effective only when using HTTP/FTP servers. Default: 0

-
+
-m, --max-tries=N
@@ -539,7 +580,7 @@ downloading a file like BitTorrent.

Default: 5

-
+
--no-proxy=DOMAINS
@@ -548,7 +589,7 @@ downloading a file like BitTorrent.

used.

-
+
-o, --out=FILE
@@ -568,8 +609,8 @@ are done by command line without -i, -Z option aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" -
-
+
+
--proxy-method=METHOD
@@ -580,7 +621,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: get

-
+
-R, --remote-time[=true|false]
@@ -590,7 +631,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: false

-
+
--retry-wait=SEC
@@ -600,7 +641,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: 5

-
+
--server-stat-of=FILE
@@ -610,7 +651,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Server Performance Profile subsection below for file format.

-
+
--server-stat-if=FILE
@@ -621,7 +662,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" subsection below for file format.

-
+
--server-stat-timeout=SEC
@@ -631,7 +672,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: 86400 (24hours)

-
+
-s, --split=N
@@ -647,7 +688,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: 5

-
+
-t, --timeout=SEC
@@ -656,7 +697,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: 60

-
+
--uri-selector=SELECTOR
@@ -672,15 +713,15 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" 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't select anymore + which has to be tested again. Otherwise, it doesn’t select anymore mirrors. Like feedback, it uses a performance profile of servers. Default: feedback

HTTP Specific Options

-
-
+
+
--ca-certificate=FILE
@@ -691,7 +732,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Use --check-certificate option to enable verification.

-
+
--certificate=FILE
@@ -701,7 +742,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" You may use --private-key option to specify the private key.

-
+
--check-certificate[=true|false]
@@ -710,7 +751,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: true

-
+
--http-auth-challenge[=true|false]
@@ -722,7 +763,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" regardless of this option. Default: false

-
+
--http-auth-scheme=SCHEME
@@ -732,7 +773,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: basic

-
+
--http-user=USER
@@ -740,7 +781,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Set HTTP user. This affects all URLs.

-
+
--http-passwd=PASSWD
@@ -748,27 +789,27 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Set HTTP password. This affects all URLs.

-
+
--http-proxy=PROXY

Use this proxy server for HTTP. See also --all-proxy option. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]

-
+
--https-proxy=PROXY

Use this proxy server for HTTPS. See also --all-proxy option. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]

-
+
--private-key=FILE
@@ -779,7 +820,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" See also --certificate option.

-
+
--referer=REFERER
@@ -787,7 +828,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Set Referer. This affects all URLs.

-
+
--enable-http-keep-alive[=true|false]
@@ -796,7 +837,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: true

-
+
--enable-http-pipelining[=true|false]
@@ -805,7 +846,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: false

-
+
--header=HEADER
@@ -815,7 +856,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" aria2c --header="X-A: b78" --header="X-B: 9J1" "http://host/file"

-
+
--load-cookies=FILE
@@ -830,11 +871,11 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
Note
-If aria2 is built without libsqlite3, then it doesn't support Firefox3 cookie format. +If aria2 is built without libsqlite3, then it doesn’t support Firefox3 cookie format.
-
-
+
+
--use-head[=true|false]
@@ -843,7 +884,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: true

-
+
-U, --user-agent=USER_AGENT
@@ -853,8 +894,8 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

FTP Specific Options

-
-
+
+
--ftp-user=USER
@@ -863,7 +904,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: anonymous

-
+
--ftp-passwd=PASSWD
@@ -872,7 +913,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: ARIA2USER@

-
+
-p, --ftp-pasv[=true|false]
@@ -882,17 +923,17 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: true

-
+
--ftp-proxy=PROXY

Use this proxy server for FTP. See also --all-proxy option. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]

-
+
--ftp-type=TYPE
@@ -901,7 +942,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: binary

-
+
--ftp-reuse-connection[=true|false]
@@ -910,7 +951,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Default: true

-
+
-n, --no-netrc
@@ -920,8 +961,8 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

BitTorrent/Metalink Options

-
-
+
+
--select-file=INDEX…
@@ -947,8 +988,8 @@ A single piece may include several files or part of files, and aria2 writes the piece to the appropriate files.
-
-
+
+
-S, --show-files
@@ -960,8 +1001,8 @@ writes the piece to the appropriate files.

BitTorrent Specific Options

-
-
+
+
--bt-external-ip=IPADDRESS
@@ -971,7 +1012,7 @@ writes the piece to the appropriate files. any kind of IP addresses. IPADDRESS must be a numeric IP address.

-
+
--bt-hash-check-seed[=true|false]
@@ -983,7 +1024,7 @@ writes the piece to the appropriate files. Default: true

-
+
--bt-max-open-files=NUM
@@ -992,7 +1033,7 @@ writes the piece to the appropriate files. Default: 100

-
+
--bt-max-peers=NUM
@@ -1002,7 +1043,7 @@ writes the piece to the appropriate files. Default: 55

-
+
--bt-min-crypto-level=plain|arc4
@@ -1013,18 +1054,18 @@ writes the piece to the appropriate files. Default: plain

-
+
--bt-require-crypto=true|false

- If true is given, aria2 doesn't accept and establish connection with legacy + If true is given, aria2 doesn’t accept and establish connection with legacy BitTorrent handshake(\19BitTorrent protocol). Thus aria2 always uses Obfuscation handshake. Default: false

-
+
--bt-request-peer-speed-limit=SPEED
@@ -1037,7 +1078,7 @@ writes the piece to the appropriate files. Default: 50K

-
+
--bt-seed-unverified[=true|false]
@@ -1046,7 +1087,7 @@ writes the piece to the appropriate files. Default: false

-
+
--bt-tracker-interval=SEC
@@ -1058,7 +1099,7 @@ writes the piece to the appropriate files. response of tracker and the download progress. Default: 0

-
+
--dht-entry-point=HOST:PORT
@@ -1066,7 +1107,7 @@ writes the piece to the appropriate files. Set host and port as an entry point to DHT network.

-
+
--dht-file-path=PATH
@@ -1075,7 +1116,7 @@ writes the piece to the appropriate files. Default: $HOME/.aria2/dht.dat

-
+
--dht-listen-port=PORT…
@@ -1096,18 +1137,18 @@ writes the piece to the appropriate files. Make sure that the specified ports are open for incoming UDP traffic.
-
-
+
+
--enable-dht[=true|false]

Enable DHT functionality. If a private flag is set in a torrent, aria2 - doesn't use DHT for that download even if true is given. + doesn’t use DHT for that download even if true is given. Default: false

-
+
--enable-peer-exchange[=true|false]
@@ -1117,7 +1158,7 @@ writes the piece to the appropriate files. Default: true

-
+
--follow-torrent=true|false|mem
@@ -1131,7 +1172,7 @@ writes the piece to the appropriate files. Default: true

-
+
-O, --index-out=INDEX=PATH
@@ -1143,7 +1184,7 @@ writes the piece to the appropriate files. BitTorrent downloads.

-
+
--listen-port=PORT…
@@ -1164,8 +1205,8 @@ writes the piece to the appropriate files. Make sure that the specified ports are open for incoming TCP traffic.
-
-
+
+
--max-overall-upload-limit=SPEED
@@ -1177,7 +1218,7 @@ writes the piece to the appropriate files. Default: 0

-
+
-u, --max-upload-limit=SPEED
@@ -1189,7 +1230,7 @@ writes the piece to the appropriate files. Default: 0

-
+
--peer-id-prefix=PEERI_ID_PREFIX
@@ -1197,11 +1238,11 @@ writes the piece to the appropriate files. 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. + added to make it’s length 20 bytes. Default: -aria2-

-
+
--seed-ratio=RATIO
@@ -1215,7 +1256,7 @@ writes the piece to the appropriate files. Default: 1.0

-
+
--seed-time=MINUTES
@@ -1223,7 +1264,7 @@ writes the piece to the appropriate files. Specify seeding time in minutes. Also see the --seed-ratio option.

-
+
-T, --torrent-file=TORRENT_FILE
@@ -1234,8 +1275,8 @@ writes the piece to the appropriate files.

Metalink Specific Options

-
-
+
+
--follow-metalink=true|false|mem
@@ -1249,7 +1290,7 @@ writes the piece to the appropriate files. Default: true

-
+
-M, --metalink-file=METALINK_FILE
@@ -1258,7 +1299,7 @@ writes the piece to the appropriate files. specify a metalink file without -M.

-
+
-C, --metalink-servers=NUM_SERVERS
@@ -1273,7 +1314,7 @@ writes the piece to the appropriate files. Default: 5

-
+
--metalink-language=LANGUAGE
@@ -1281,7 +1322,7 @@ writes the piece to the appropriate files. The language of the file to download.

-
+
--metalink-location=LOCATION[,…]
@@ -1290,7 +1331,7 @@ writes the piece to the appropriate files. A comma-delimited list of locations is acceptable, for example, JP,US.

-
+
--metalink-os=OS
@@ -1298,7 +1339,7 @@ writes the piece to the appropriate files. The operating system of the file to download.

-
+
--metalink-version=VERSION
@@ -1306,7 +1347,7 @@ writes the piece to the appropriate files. The version of the file to download.

-
+
--metalink-preferred-protocol=PROTO
@@ -1317,7 +1358,7 @@ writes the piece to the appropriate files. Default: none

-
+
--metalink-enable-unique-protocol=true|false
@@ -1330,21 +1371,59 @@ writes the piece to the appropriate files.

+

XML-RPC Options

+
+
+--enable-xml-rpc[=true|false] +
+
+

+ Enable XML-RPC server. It is strongly recommended to set username + and password using --xml-rpc-user and --xml-rpc-passwd + option. See also --xml-rpc-listen-port option. Default: false +

+
+
+--xml-rpc-listen-port=PORT +
+
+

+ Specify a port number for XML-RPC server to listen to. Possible + Values: 1024-65535 Default: 6800 +

+
+
+--xml-rpc-passwd=PASSWD +
+
+

+ Set XML-RPC password. +

+
+
+--xml-rpc-user=USER +
+
+

+ Set XML-RPC user. +

+
+

Advanced Options

-
-
+
+
--allow-overwrite=true|false

- If false is given, aria2 doesn't download a file which already exists but - the corresponding .aria2 file doesn't exist. + If false 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 --auto-file-renaming=true then, file name will be renamed. See --auto-file-renaming for details. Default: false

-
+
--allow-piece-length-change=true|false
@@ -1355,7 +1434,7 @@ writes the piece to the appropriate files. Default: false

-
+
--async-dns[=true|false]
@@ -1364,7 +1443,7 @@ writes the piece to the appropriate files. Default: true

-
+
--auto-file-renaming[=true|false]
@@ -1375,7 +1454,7 @@ writes the piece to the appropriate files. Default: true

-
+
--auto-save-interval=SEC
@@ -1387,7 +1466,7 @@ writes the piece to the appropriate files. Default: 60

-
+
--conf-path=PATH
@@ -1396,7 +1475,7 @@ writes the piece to the appropriate files. Default: $HOME/.aria2/aria2.conf

-
+
-D, --daemon
@@ -1404,7 +1483,7 @@ writes the piece to the appropriate files. Run as daemon.

-
+
--enable-direct-io[=true|false]
@@ -1414,19 +1493,7 @@ writes the piece to the appropriate files. Default: true

-
---enable-http-server[=true|false] -
-
-

- Enable the built-in HTTP server. Currently, this is the experimental - feature and it just provides the current download progress. Use your - web browser(console-based ones, such as elinks, w3m, are - recommended) to connect the server and see what's what. See also - --http-server-listen-port option. Default: false -

-
-
+
--event-poll=POLL
@@ -1437,28 +1504,28 @@ writes the piece to the appropriate files. select.

-
+
--file-allocation=METHOD

Specify file allocation method. METHOD is either none or prealloc. - none doesn't pre-allocate file space. prealloc pre-allocates file space + none doesn’t pre-allocate file space. prealloc 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, falloc is your best choice. It allocates large(few GiB) - files almost instantly. Don't use falloc with + files almost instantly. Don’t use falloc with legacy file systems such as ext3 because it takes almost same time as prealloc and it blocks aria2 entirely until allocation finishes. falloc may - not be available if your system doesn't have + not be available if your system doesn’t have posix_fallocate() function. Default: prealloc

-
+
--log-level=LEVEL
@@ -1468,7 +1535,7 @@ writes the piece to the appropriate files. Default: debug

-
+
--summary-interval=SEC
@@ -1488,8 +1555,8 @@ writes the piece to the appropriate files. are also allocated if they share the same piece.
-
-
+
+
-Z, --force-sequential[=true|false]
@@ -1499,17 +1566,7 @@ are also allocated if they share the same piece. Default: false

-
---http-server-listen-port=PORT -
-
-

- Specify a port number for the built-in HTTP Server to listen to. - See also --enable-http-server option. The possible Values are - 1024-65535. Default: 6800 -

-
-
+
--max-overall-download-limit=SPEED
@@ -1520,7 +1577,7 @@ are also allocated if they share the same piece. option. Default: 0

-
+
--max-download-limit=SPEED
@@ -1531,7 +1588,7 @@ are also allocated if they share the same piece. option. Default: 0

-
+
--no-conf
@@ -1539,7 +1596,7 @@ are also allocated if they share the same piece. Disable loading aria2.conf file.

-
+
--no-file-allocation-limit=SIZE
@@ -1549,7 +1606,7 @@ are also allocated if they share the same piece. Default: 5M

-
+
-P, --parameterized-uri[=true|false]
@@ -1557,14 +1614,14 @@ are also allocated if they share the same piece. Enable parameterized URI support. You can specify set of parts: http://{sv1,sv2,sv3}/foo.iso. Also you can specify numeric sequences with step counter: - http://host/image[000-100:2].img. + \http://host/image[000-100:2].img. 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: false

-
+
-q, --quiet[=true|false]
@@ -1573,7 +1630,7 @@ are also allocated if they share the same piece. Default: false

-
+
--realtime-chunk-checksum=true|false
@@ -1583,7 +1640,7 @@ are also allocated if they share the same piece. Default: true

-
+
--stop=SEC
@@ -1593,7 +1650,7 @@ are also allocated if they share the same piece. Default: 0

-
+
-v, --version
@@ -1604,19 +1661,19 @@ are also allocated if they share the same piece.

Options That Take An Optional Argument

-

The options that have its argument surrounded by square brackets([]) +

The options that have its argument surrounded by square brackets([]) take an optional argument. Usually omiting the argument is evaluated to true. If you use short form of these options(such as -V) and give an argument, then the option name and its argument should be concatenated(e.g. -Vfalse). 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.

URL, TORRENT_FILE, METALINK_FILE

-

You can specify multiple URLs in command-line. +

You can specify multiple URLs in command-line. Unless you specify -Z option, all URLs must point to the same file or downloading will fail.

-

You can also specify arbitrary number of torrent files and metalink files +

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.

-

You can specify both torrent file with -T option and URLs. By doing this, +

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. Note that only single file torrent can be integrated with HTTP(S)/FTP.

@@ -1625,24 +1682,24 @@ only single file torrent can be integrated with HTTP(S)/FTP.

Note
-Make sure that URL is quoted with single(') or double(") quotation if it +Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell.

Resuming Download

-

Usually, you can resume transfer by just issuing same command(aria2c +

Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2.

-

If the previous transfer is made by a browser or wget like sequential +

If the previous transfer is made by a browser or wget like sequential download manager, then use -c option to continue the transfer(aria2c -c URL).

EXIT STATUS

-

Because aria2 can handle multiple downloads at once, it encounters +

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.

-
-
+
+
0
@@ -1650,7 +1707,7 @@ based on the last error encountered.

If all downloads are successful.

-
+
1
@@ -1658,7 +1715,7 @@ based on the last error encountered.

If an unknown error occurs.

-
+
2
@@ -1666,7 +1723,7 @@ based on the last error encountered.

If time out occurs.

-
+
3
@@ -1674,7 +1731,7 @@ based on the last error encountered.

If a resource is not found.

-
+
4
@@ -1683,7 +1740,7 @@ based on the last error encountered.

See --max-file-not-found option).

-
+
5
@@ -1692,7 +1749,7 @@ based on the last error encountered.

See --lowest-speed-limit option)

-
+
6
@@ -1700,7 +1757,7 @@ based on the last error encountered.

If network problem occurs.

-
+
7
@@ -1724,10 +1781,10 @@ as exit status.

ENVIRONMENT

-

aria2 recognizes the following environment variables.

-
-
-http_proxy [http://][USER:PASSWORD@]HOST[:PORT] +

aria2 recognizes the following environment variables.

+
+
+http_proxy [\http://][USER:PASSWORD@]HOST[:PORT]

@@ -1736,8 +1793,8 @@ http_proxy [http://][USER:PASSWORD@]HOST[:PORT] The command-line option --http-proxy overrides this value.

-
-https_proxy [http://][USER:PASSWORD@]HOST[:PORT] +
+https_proxy [\http://][USER:PASSWORD@]HOST[:PORT]

@@ -1746,8 +1803,8 @@ https_proxy [http://][USER:PASSWORD@]HOST[:PORT] The command-line option --https-proxy overrides this value.

-
-ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT] +
+ftp_proxy [\http://][USER:PASSWORD@]HOST[:PORT]

@@ -1756,8 +1813,8 @@ ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT] The command-line option --ftp-proxy overrides this value.

-
-all_proxy [http://][USER:PASSWORD@]HOST[:PORT] +
+all_proxy [\http://][USER:PASSWORD@]HOST[:PORT]

@@ -1766,7 +1823,7 @@ all_proxy [http://][USER:PASSWORD@]HOST[:PORT] The command-line option --all-proxy overrides this value.

-
+
no_proxy [DOMAIN,…]
@@ -1781,11 +1838,11 @@ no_proxy [DOMAIN,…]

FILES

aria2.conf

-

By default, aria2 parses $HOME/.aria2/aria2.conf as a configuraiton +

By default, aria2 parses $HOME/.aria2/aria2.conf as a configuraiton file. You can specify the path to configuration file using ---conf-path option. If you don't want to use the configuraitonf +--conf-path option. If you don’t want to use the configuraitonf file, use --no-conf option.

-

The configuration file is a text file and has 1 option per each +

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 @@ -1800,9 +1857,9 @@ max-upload-limit=50K ftp-pasv=true

dht.dat

-

By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.

+

By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.

Control File

-

aria2 uses a control file to track the progress of a download. A +

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 @@ -1811,23 +1868,73 @@ 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.)

-

Usually a control file is deleted once download completed. If aria2 +

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 +a file from a HTTP server which doesn’t support resume), a control file is not created.

-

Normally if you lose a control file, you cannot resume download. But +

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.

Input File

-

The input file can contain a list of URIs for aria2 to download. You +

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.

-

Each line is treated as if it is provided in command-line argument. +

Each line is treated as if it is provided in command-line argument. Therefore they are affected by -Z and -P options.

-

Additionally, the following options can be specified after each line +

Additionally, the following options can be specified after each line of URIs. These optional lines must start with white space(s).

-
    +
      +
    • +

      +dir +

      +
      • +
    • +

      +check-integrity +

      +
      • +
    • +

      +continue +

      +
      • +
    • +

      +all-proxy +

      +
      • +
    • +

      +connect-timeout +

      +
      • +
    • +

      +dry-run +

      +
      • +
    • +

      +lowest-speed-limit +

      +
      • +
    • +

      +max-file-not-found +

      +
      • +
    • +

      +max-tries +

      +
      • +
    • +

      +no-proxy +

      +

    • out @@ -1835,7 +1942,117 @@ out

    • -dir +proxy-method +

      +
      • +
    • +

      +remote-time +

      +
      • +
    • +

      +retry-wait +

      +
      • +
    • +

      +split +

      +
      • +
    • +

      +timeout +

      +
      • +
    • +

      +http-auth-challenge +

      +
      • +
    • +

      +http-user +

      +
      • +
    • +

      +http-passwd +

      +
      • +
    • +

      +http-proxy +

      +
      • +
    • +

      +https-proxy +

      +
      • +
    • +

      +referer +

      +
      • +
    • +

      +enable-http-keep-alive +

      +
      • +
    • +

      +enable-http-pipelining +

      +
      • +
    • +

      +header +

      +
      • +
    • +

      +use-head +

      +
      • +
    • +

      +user-agent +

      +
      • +
    • +

      +ftp-user +

      +
      • +
    • +

      +ftp-passwd +

      +
      • +
    • +

      +ftp-pasv +

      +
      • +
    • +

      +ftp-proxy +

      +
      • +
    • +

      +ftp-type +

      +
      • +
    • +

      +ftp-reuse-connection +

      +
      • +
    • +

      +no-netrc

    • @@ -1845,13 +2062,173 @@ select-file

    • +bt-external-ip +

      +
      • +
    • +

      +bt-hash-check-seed +

      +
      • +
    • +

      +bt-max-open-files +

      +
      • +
    • +

      +bt-max-peers +

      +
      • +
    • +

      +bt-min-crypto-level +

      +
      • +
    • +

      +bt-require-crypto +

      +
      • +
    • +

      +bt-request-peer-speed-limit +

      +
      • +
    • +

      +bt-seed-unverified +

      +
      • +
    • +

      +bt-tracker-interval +

      +
      • +
    • +

      +enable-peer-exchange +

      +
      • +
    • +

      +follow-torrent +

      +
      • +
    • +

      index-out

      • +
    • +

      +max-upload-limit +

      +
      • +
    • +

      +peer-id-prefix +

      +
      • +
    • +

      +seed-ratio +

      +
      • +
    • +

      +seed-time +

      +
      • +
    • +

      +follow-metalink +

      +
      • +
    • +

      +metalink-servers +

      +
      • +
    • +

      +metalink-language +

      +
      • +
    • +

      +metalink-location +

      +
      • +
    • +

      +metalink-os +

      +
      • +
    • +

      +metalink-version +

      +
      • +
    • +

      +metalink-preferred-protocol +

      +
      • +
    • +

      +metalink-enable-unique-protocol +

      +
      • +
    • +

      +allow-overwrite +

      +
      • +
    • +

      +allow-piece-length-change +

      +
      • +
    • +

      +async-dns +

      +
      • +
    • +

      +auto-file-renaming +

      +
      • +
    • +

      +file-allocation +

      +
      • +
    • +

      +max-download-limit +

      +
      • +
    • +

      +no-file-allocation-limit +

      +
      • +
    • +

      +parameterized-uri +

      +
      • +
    • +

      +realtime-chunk-checksum +

      +
    -

    These options have exactly same meaning of the ones in the +

    These options have exactly same meaning of the ones in the command-line options, but it just applies to the URIs it belongs to.

    -

    For example, the content of uri.txt is

    +

    For example, the content of uri.txt is

    http://server/file.iso http://mirror/file.iso
@@ -1859,18 +2236,18 @@ command-line options, but it just applies to the URIs it belongs to.
    out=file.img http://foo/bar
    -

    If aria2 is executed with -i uri.txt -d /tmp options, then +

    If aria2 is executed with -i uri.txt -d /tmp options, then file.iso is saved as /iso_images/file.img and it is downloaded from http://server/file.iso and http://mirror/file.iso. The file bar is downloaded from http://foo/bar and saved as /tmp/bar.

    -

    In some cases, out parameter has no effect. See note of --out +

    In some cases, out parameter has no effect. See note of --out option for the restrictions.

    Server Performance Profile

    -

    This section describes the format of server performance profile. The +

    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:

    -
    -
    +
    +
    host
    @@ -1878,7 +2255,7 @@ host Hostname of the server. Required.

    -
    +
    protocol
    @@ -1886,7 +2263,7 @@ protocol Protocol for this profile, such as ftp, http. Required.

    -
    +
    dl_speed
    @@ -1895,7 +2272,7 @@ dl_speed bytes per sec. Required.

    -
    +
    sc_avg_speed
    @@ -1906,7 +2283,7 @@ sc_avg_speed AdaptiveURISelector. Optional.

    -
    +
    mc_avg_speed
    @@ -1917,7 +2294,7 @@ mc_avg_speed AdaptiveURISelector. Optional.

    -
    +
    counter
    @@ -1926,7 +2303,7 @@ counter by AdaptiveURISelector. Optional.

    -
    +
    last_updated
    @@ -1935,7 +2312,7 @@ last_updated from the Epoch. Required.

    -
    +
    status
    @@ -1945,10 +2322,10 @@ status

    -

    Those fields must exist in one line. The order of the fields is not +

    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.

    -

    An example follows:

    +

    An example follows:

    host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
@@ -2017,12 +2394,12 @@ host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR<

    Using proxy

    -

    For HTTP:

    +

    For HTTP:

    aria2c --http-proxy="http://proxy:8080" "http://host/file"
    -

    For FTP:

    +

    For FTP:

    aria2c --ftp-proxy="http://proxy:8080" "ftp://host/file"
    @@ -2145,7 +2522,7 @@ directory.

    Specify output filename

    -

    To specify output filename for BitTorrent downloads, you need to know +

    To specify output filename for BitTorrent downloads, you need to know the index of file in torrent file using -S option. For example, the output looks like this:

    @@ -2159,7 +2536,7 @@ output looks like this:

    |169.0MiB ---+----------------------
    -

    To save dist/base-2.6.18.iso in /tmp/mydir/base.iso and +

    To save dist/base-2.6.18.iso in /tmp/mydir/base.iso and dist/driver-2.6.18.iso in /tmp/dir/driver.iso, use the following command:

    @@ -2176,7 +2553,7 @@ command:

    Note
    -Since aria2 doesn't configure firewall or router for port forwarding, it's up +Since aria2 doesn’t configure firewall or router for port forwarding, it’s up to you to do it manually.
    @@ -2208,8 +2585,8 @@ to you to do it manually.
    Note
    -DHT uses udp port. Since aria2 doesn't configure firewall or router for port -forwarding, it's up to you to do it manually. +DHT uses udp port. Since aria2 doesn’t configure firewall or router for port +forwarding, it’s up to you to do it manually.

    More advanced HTTP features

    @@ -2223,7 +2600,7 @@ forwarding, it's up to you to do it manually.
    Note
    -You can use Firefox/Mozilla's cookie file without modification. +You can use Firefox/Mozilla’s cookie file without modification.

    Resume download started by web browsers or another programs

    @@ -2276,12 +2653,12 @@ checksums. 
    aria2c --lowest-speed-limit=10K file.metalink

    Parameterized URI support

    -

    You can specify set of parts:

    +

    You can specify set of parts:

    aria2c -P "http://{host1,host2,host3}/file.iso"
    -

    You can specify numeric sequence:

    +

    You can specify numeric sequence:

    aria2c -Z -P "http://host/image[000-100].png"
    @@ -2291,10 +2668,10 @@ checksums.
    Note
    --Z option is required if the all URIs don't point to the same file, such as the above example. +-Z option is required if the all URIs don’t point to the same file, such as the above example.
    -

    You can specify step counter:

    +

    You can specify step counter:

    aria2c -Z -P "http://host/image[A-Z:2].png"
    @@ -2305,7 +2682,7 @@ checksums. 
    aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink

    BitTorrent Encryption

    -

    Encrypt whole payload using ARC4:

    +

    Encrypt whole payload using ARC4:

    aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent
    @@ -2313,25 +2690,25 @@ checksums.

    SEE ALSO

    -

    Project Web Site: http://aria2.sourceforge.net/

    -

    aria2 Wiki: http://apps.sourceforge.net/trac/aria2/wiki

    -

    Metalink Homepage: http://www.metalinker.org/

    +

    Project Web Site: http://aria2.sourceforge.net/

    +

    aria2 Wiki: http://apps.sourceforge.net/trac/aria2/wiki

    +

    Metalink Homepage: http://www.metalinker.org/

    COPYRIGHT

    -

    Copyright © 2006, 2009 Tatsuhiro Tsujikawa

    -

    This program is free software; you can redistribute it and/or modify +

    Copyright © 2006, 2009 Tatsuhiro Tsujikawa

    +

    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.

    -

    This program is distributed in the hope that it will be useful, +

    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.

    -

    You should have received a copy of the GNU General Public License +

    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

    -

    In addition, as a special exception, the copyright holders give +

    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 @@ -2346,7 +2723,7 @@ files in the program, then also delete it here.

    diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index b841a6c2..fb610370 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -516,6 +516,24 @@ Metalink Specific Options protocol. Default: 'true' +XML-RPC Options +~~~~~~~~~~~~~~~ + +*--enable-xml-rpc*[='true'|'false']:: + Enable XML-RPC server. It is strongly recommended to set username + and password using *--xml-rpc-user* and *--xml-rpc-passwd* + option. See also *--xml-rpc-listen-port* option. Default: 'false' + +*--xml-rpc-listen-port*=PORT:: + Specify a port number for XML-RPC server to listen to. Possible + Values: '1024'-'65535' Default: '6800' + +*--xml-rpc-passwd*=PASSWD:: + Set XML-RPC password. + +*--xml-rpc-user*=USER:: + Set XML-RPC user. + Advanced Options ~~~~~~~~~~~~~~~~ *--allow-overwrite*='true'|'false':: @@ -560,14 +578,6 @@ Advanced Options Turn off if you encounter any error. Default: 'true' - -*--enable-http-server*[='true'|'false']:: - Enable the built-in HTTP server. Currently, this is the experimental - feature and it just provides the current download progress. Use your - web browser(console-based ones, such as elinks, w3m, are - recommended) to connect the server and see what's what. See also - *--http-server-listen-port* option. Default: 'false' - *--event-poll*=POLL:: Specify the method for polling events. The possible Values are 'epoll' and 'select'. If you use recent Linux that has epoll, then @@ -610,11 +620,6 @@ are also allocated if they share the same piece. separate session, like the usual command-line download utilities. Default: 'false' -*--http-server-listen-port*=PORT:: - Specify a port number for the built-in HTTP Server to listen to. - See also *--enable-http-server* option. The possible Values are - '1024'-'65535'. Default: '6800' - *--max-overall-download-limit*=SPEED:: Set max overall download speed in bytes/sec. '0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To @@ -835,10 +840,74 @@ Therefore they are affected by *-Z* and *-P* options. Additionally, the following options can be specified after each line of URIs. These optional lines must start with white space(s). -* out * dir +* check-integrity +* continue +* all-proxy +* connect-timeout +* dry-run +* lowest-speed-limit +* max-file-not-found +* max-tries +* no-proxy +* out +* proxy-method +* remote-time +* retry-wait +* split +* timeout +* http-auth-challenge +* http-user +* http-passwd +* http-proxy +* https-proxy +* referer +* enable-http-keep-alive +* enable-http-pipelining +* header +* use-head +* user-agent +* ftp-user +* ftp-passwd +* ftp-pasv +* ftp-proxy +* ftp-type +* ftp-reuse-connection +* no-netrc * select-file +* bt-external-ip +* bt-hash-check-seed +* bt-max-open-files +* bt-max-peers +* bt-min-crypto-level +* bt-require-crypto +* bt-request-peer-speed-limit +* bt-seed-unverified +* bt-tracker-interval +* enable-peer-exchange +* follow-torrent * index-out +* max-upload-limit +* peer-id-prefix +* seed-ratio +* seed-time +* follow-metalink +* metalink-servers +* metalink-language +* metalink-location +* metalink-os +* metalink-version +* metalink-preferred-protocol +* metalink-enable-unique-protocol +* allow-overwrite +* allow-piece-length-change +* async-dns +* auto-file-renaming +* file-allocation +* max-download-limit +* no-file-allocation-limit +* parameterized-uri +* realtime-chunk-checksum These options have exactly same meaning of the ones in the command-line options, but it just applies to the URIs it belongs to.