diff --git a/ChangeLog b/ChangeLog index 40c7bdc1..324f8e99 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2008-09-27 Tatsuhiro Tsujikawa + + Updated man page. + * doc/aria2c.1.txt + 2008-09-27 Tatsuhiro Tsujikawa When error occurred while aria2 was parsing an .aria2.conf file, print diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 197b7e03..c6211514 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -1,11 +1,11 @@ .\" Title: aria2c .\" Author: .\" Generator: DocBook XSL Stylesheets v1.73.2 -.\" Date: 08/14/2008 +.\" Date: 09/27/2008 .\" Manual: .\" Source: .\" -.TH "ARIA2C" "1" "08/14/2008" "" "" +.TH "ARIA2C" "1" "09/27/2008" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -59,7 +59,7 @@ Continue downloading a partially downloaded file\&. Use this option to resume a .PP \fB\-h\fR, \fB\-\-help\fR[=CATEGORY] .RS 4 -Print usage and exit\&. The help messages are classified in several categories\&. For example, type "\fB\-\-help\fR=http" for detailed explanation for the options related to HTTP\&. If no matching category is found, search option name using a given word in forward match and print the result\&. Available Values: +Print usage and exit\&. The help messages are classified in several categories\&. For example, type "\fB\-\-help\fR=http" for detailed explanation for the options related to HTTP\&. If no matching category is found, search option name using a given word in middle match and print the result\&. Available Values: \fIbasic\fR, \fIadvanced\fR, \fIhttp\fR, @@ -72,6 +72,14 @@ Default: .RE .SS "HTTP/FTP Options" .PP +\fB\-\-connect\-timeout\fR=SEC +.RS 4 +Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server\&. After the connection is established, this option makes no effect and +\fB\-\-timeout\fR +option is used instead\&. Default: +\fI60\fR +.RE +.PP \fB\-\-lowest\-speed\-limit\fR=SPEED .RS 4 Close connection if download speed is lower than or equal to this value(bytes per sec)\&. @@ -83,6 +91,14 @@ or \fI0\fR .RE .PP +\fB\-\-max\-file\-not\-found\fR=NUM +.RS 4 +If aria2 recieves `file not found\' status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify +\fI0\fR +to disable this option\&. This options is only effective only when using HTTP/FTP servers\&. Default: +\fI0\fR +.RE +.PP \fB\-m\fR, \fB\-\-max\-tries\fR=N .RS 4 Set number of tries\&. @@ -103,6 +119,12 @@ The file name of the downloaded file\&. Note In Metalink, BitTorrent download you cannot specify file name\&. The file name specified here is only used when the URLs fed to aria2 is done by command line without \fB\-i\fR, \fB\-Z\fR option, like this: aria2c \-o myfile\&.zip http://mirror1/file\&.zip http://mirror2/file\&.zip .PP +\fB\-R\fR, \fB\-\-remote\-time\fR[=\fItrue\fR|\fIfalse\fR] +.RS 4 +Retrieve timestamp of the remote file from the remote HTTP/FTP server and if it is available, apply it to the local file\&. Default: +\fIfalse\fR +.RE +.PP \fB\-\-retry\-wait\fR=SEC .RS 4 Set the seconds to wait to retry after an error has occured\&. Specify a value between @@ -112,6 +134,28 @@ and \fI5\fR .RE .PP +\fB\-\-server\-stat\-of\fR=FILE +.RS 4 +Specify the filename to which performance profile of the servers is saved\&. You can load saved data using +\fB\-\-server\-stat\-if\fR +option\&. See SERVER PERFORMANCE PROFILE section below for file format\&. +.RE +.PP +\fB\-\-server\-stat\-if\fR=FILE +.RS 4 +Specify the filename to load performance profile of the servers\&. The loaded data will be used in some URI selector such as +\fIfeedback\fR\&. See also +\fB\-\-uri\-selector\fR +option\&. See SERVER PERFORMANCE PROFILE section below for file format\&. +.RE +.PP +\fB\-\-server\-stat\-timeout\fR=SEC +.RS 4 +Specifies timeout in seconds to invalidate performance profile of the servers since the last contact to them\&. Default: +\fI86400\fR +(24hours) +.RE +.PP \fB\-s\fR, \fB\-\-split\fR=N .RS 4 Download a file using N connections\&. If more than N URLs are given, first N URLs are used and remaining URLs are used for backup\&. If less than N URLs are given, those URLs are used more than once so that N connections total are made simultaneously\&. N must be between @@ -128,6 +172,23 @@ option too\&. Default: Set timeout in seconds\&. Default: \fI60\fR .RE +.PP +\fB\-\-uri\-selector\fR=SELECTOR +.RS 4 +Specify URI selection algorithm\&. Possible values are +\fIinorder\fR +and +\fIfeedback\fR\&. If +\fIinorder\fR +is given, URI is tried in the order appeared in the URI list\&. If +\fIfeedback\fR +is given, aria2 uses download speed observed in the previous downloads and choose fastest server in the URI list\&. This also effectively skips dead mirrors\&. The observed download speed is a part of performance profile of servers mentioned in +\fB\-\-server\-stat\-of\fR +and +\fB\-\-server\-stat\-if\fR +options\&. Default: +\fIinorder\fR +.RE .SS "HTTP Specific Options" .PP \fB\-\-http\-auth\-scheme\fR=SCHEME @@ -200,8 +261,15 @@ Append HEADER to HTTP request header\&. You can use this option repeatedly to sp .PP \fB\-\-load\-cookies\fR=FILE .RS 4 -Load Cookies from FILE using the Mozilla/Firefox(1\&.x/2\&.x) and Netscape format\&. +Load Cookies from FILE using the Firefox3 format(SQLite3) and the Mozilla/Firefox(1\&.x/2\&.x)/Netscape format\&. .RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +Note +If aria2 is build without libsqlite3, then it doesn\'t support Firefox3 cookie\&. .PP \fB\-U\fR, \fB\-\-user\-agent\fR=USER_AGENT .RS 4 @@ -1209,6 +1277,44 @@ You can seed downloaded file using \-\-check\-integrity=true option\&. aria2c \-\-check\-integrity=true file\&.torrent .fi .RE +.SH "SERVER PERFORMANCE PROFILE" +This section describes the format of server performance profile\&. The file is plain text and each line has several NAME=VALUE pair, delimited by comma\&. Currently following NAMEs are recognized: +.PP +host +.RS 4 +Hostname of the server\&. Required\&. +.RE +.PP +protocol +.RS 4 +Protocol for this profile, such as ftp, http\&. Required\&. +.RE +.PP +dl_speed +.RS 4 +The average download speed observed in the previous download in bytes per sec\&. Required\&. +.RE +.PP +last_updated +.RS 4 +Last contact time in GMT with this server, specified in the seconds from the Epoch\&. Required\&. +.RE +.PP +status +.RS 4 +ERROR is set when server cannot be reached or out\-of\-service or timeout occurred\&. Otherwise, OK is set\&. +.RE +Those fields must exist in one line\&. The order of the fields is not significant\&.You can put pairs other than above; they are simply ignored\&. +.sp +An example is follow: +.sp +.sp +.RS 4 +.nf +host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK +host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR +.fi +.RE .SH "FILES" .SS "aria2\&.conf" User configuration file\&. It must be placed under $HOME/\&.aria2 and must be named as aria2\&.conf\&. In each line, there is 1 parameter whose syntax is name=value pair, where name is the long command\-line option name without \fI\-\-\fR prefix\&. The lines beginning \fI#\fR are treated as comments\&. diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index bfef653c..bb1ac447 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -415,7 +415,7 @@ div.olist2 div.olist ol { The help messages are classified in several categories. For example, type "—help=http" for detailed explanation for the options related to HTTP. If no matching category is found, search option name using - a given word in forward match and print the result. + a given word in middle match and print the result. Available Values: basic, advanced, http, ftp, metalink, bittorrent, all Default: basic @@ -425,6 +425,17 @@ div.olist2 div.olist ol {

HTTP/FTP Options

+—connect-timeout=SEC +
+
+

+ Set the connect timeout in seconds to establish connection to + HTTP/FTP/proxy server. After the connection is established, this + option makes no effect and —timeout option is used instead. + Default: 60 +

+
+
—lowest-speed-limit=SPEED
@@ -438,6 +449,18 @@ div.olist2 div.olist ol {

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

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

+
+
-m, —max-tries=N
@@ -468,6 +491,16 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip
+-R, —remote-time[=true|false] +
+
+

+ Retrieve timestamp of the remote file from the remote HTTP/FTP + server and if it is available, apply it to the local file. + Default: false +

+
+
—retry-wait=SEC
@@ -478,6 +511,37 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip

+—server-stat-of=FILE +
+
+

+ Specify the filename to which performance profile of the servers is + saved. You can load saved data using —server-stat-if option. See + SERVER PERFORMANCE PROFILE section below for file format. +

+
+
+—server-stat-if=FILE +
+
+

+ Specify the filename to load performance profile of the servers. The + loaded data will be used in some URI selector such as feedback. + See also —uri-selector option. See SERVER PERFORMANCE PROFILE + section below for file format. +

+
+
+—server-stat-timeout=SEC +
+
+

+ Specifies timeout in seconds to invalidate performance profile of + the servers since the last contact to them. + Default: 86400 (24hours) +

+
+
-s, —split=N
@@ -500,6 +564,22 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip Default: 60

+
+—uri-selector=SELECTOR +
+
+

+ Specify URI selection algorithm. Possible values are inorder and + feedback. If inorder is given, URI is tried in the order + appeared in the URI list. If feedback is given, aria2 uses + download speed observed in the previous downloads and choose fastest + server in the URI list. This also effectively skips dead + mirrors. The observed download speed is a part of performance + profile of servers mentioned in —server-stat-of and + —server-stat-if options. + Default: inorder +

+

HTTP Specific Options

@@ -604,9 +684,20 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip

- Load Cookies from FILE using the Mozilla/Firefox(1.x/2.x) and Netscape format. + Load Cookies from FILE using the Firefox3 format(SQLite3) and the + Mozilla/Firefox(1.x/2.x)/Netscape format.

+
+
+ + + +
+
Note
+		If aria2 is build without libsqlite3, then it doesn't support Firefox3 cookie.
+
+
-U, —user-agent=USER_AGENT
@@ -1559,6 +1650,65 @@ you can resume the download without a control file by giving 
aria2c --check-integrity=true file.torrent
+

SERVER PERFORMANCE PROFILE

+
+

This section describes the format of server performance profile. +The file is plain text and each line has several NAME=VALUE pair, delimited by +comma. +Currently following NAMEs are recognized:

+
+
+host +
+
+

+ Hostname of the server. Required. +

+
+
+protocol +
+
+

+ Protocol for this profile, such as ftp, http. Required. +

+
+
+dl_speed +
+
+

+ The average download speed observed in the previous download in bytes per sec. + Required. +

+
+
+last_updated +
+
+

+ Last contact time in GMT with this server, specified in the seconds from the + Epoch. Required. +

+
+
+status +
+
+

+ ERROR is set when server cannot be reached or out-of-service or timeout + occurred. Otherwise, OK is set. +

+
+
+

Those fields must exist in one line. The order of the fields is not significant.You can put pairs other than above; they are simply ignored.

+

An example is follow:

+
+
+
host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
+host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
+
+

FILES

aria2.conf

@@ -1621,7 +1771,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index b643f3c4..1fc7ebe9 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -54,13 +54,19 @@ Basic Options The help messages are classified in several categories. For example, type "*--help*=http" for detailed explanation for the options related to HTTP. If no matching category is found, search option name using - a given word in forward match and print the result. + a given word in middle match and print the result. Available Values: 'basic', 'advanced', 'http', 'ftp', 'metalink', 'bittorrent', 'all' Default: 'basic' HTTP/FTP Options ~~~~~~~~~~~~~~~~ +*--connect-timeout*=SEC:: + Set the connect timeout in seconds to establish connection to + HTTP/FTP/proxy server. After the connection is established, this + option makes no effect and *--timeout* option is used instead. + Default: '60' + *--lowest-speed-limit*=SPEED:: Close connection if download speed is lower than or equal to this value(bytes per sec). @@ -69,6 +75,13 @@ HTTP/FTP Options This option does not affect BitTorrent downloads. Default: '0' +*--max-file-not-found*=NUM:: + If aria2 recieves `file not found' status from the remote HTTP/FTP + servers NUM times without getting a single byte, then force the + download to fail. Specify '0' to disable this option. This options is + only effective only when using HTTP/FTP servers. + Default: '0' + *-m*, *--max-tries*=N:: Set number of tries. '0' means unlimited. Default: '5' @@ -82,11 +95,32 @@ The file name specified here is only used when the URLs fed to aria2 is done by command line without *-i*, *-Z* option, like this: aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip +*-R*, *--remote-time*[='true'|'false']:: + Retrieve timestamp of the remote file from the remote HTTP/FTP + server and if it is available, apply it to the local file. + Default: 'false' + *--retry-wait*=SEC:: Set the seconds to wait to retry after an error has occured. Specify a value between '0' and '60'. Default: '5' +*--server-stat-of*=FILE:: + Specify the filename to which performance profile of the servers is + saved. You can load saved data using *--server-stat-if* option. See + SERVER PERFORMANCE PROFILE section below for file format. + +*--server-stat-if*=FILE:: + Specify the filename to load performance profile of the servers. The + loaded data will be used in some URI selector such as 'feedback'. + See also *--uri-selector* option. See SERVER PERFORMANCE PROFILE + section below for file format. + +*--server-stat-timeout*=SEC:: + Specifies timeout in seconds to invalidate performance profile of + the servers since the last contact to them. + Default: '86400' (24hours) + *-s*, *--split*=N:: Download a file using N connections. If more than N URLs are given, first N URLs are used and remaining URLs are @@ -100,6 +134,17 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip Set timeout in seconds. Default: '60' +*--uri-selector*=SELECTOR:: + Specify URI selection algorithm. Possible values are 'inorder' and + 'feedback'. If 'inorder' is given, URI is tried in the order + appeared in the URI list. If 'feedback' is given, aria2 uses + download speed observed in the previous downloads and choose fastest + server in the URI list. This also effectively skips dead + mirrors. The observed download speed is a part of performance + profile of servers mentioned in *--server-stat-of* and + *--server-stat-if* options. + Default: 'inorder' + HTTP Specific Options ~~~~~~~~~~~~~~~~~~~~~ *--http-auth-scheme*=SCHEME:: @@ -144,7 +189,11 @@ HTTP Specific Options aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" http://host/file *--load-cookies*=FILE:: - Load Cookies from FILE using the Mozilla/Firefox(1.x/2.x) and Netscape format. + Load Cookies from FILE using the Firefox3 format(SQLite3) and the + Mozilla/Firefox(1.x/2.x)/Netscape format. + +[NOTE] +If aria2 is build without libsqlite3, then it doesn't support Firefox3 cookie. *-U*, *--user-agent*=USER_AGENT:: Set user agent for HTTP(S) downloads. @@ -735,6 +784,39 @@ You can seed downloaded file using --check-integrity=true option. aria2c --check-integrity=true file.torrent --------------------------------------------- +SERVER PERFORMANCE PROFILE +-------------------------- +This section describes the format of server performance profile. +The file is plain text and each line has several NAME=VALUE pair, delimited by +comma. +Currently following NAMEs are recognized: + +host:: + Hostname of the server. Required. + +protocol:: + Protocol for this profile, such as ftp, http. Required. + +dl_speed:: + The average download speed observed in the previous download in bytes per sec. + Required. + +last_updated:: + Last contact time in GMT with this server, specified in the seconds from the + Epoch. Required. + +status:: + ERROR is set when server cannot be reached or out-of-service or timeout + occurred. Otherwise, OK is set. + +Those fields must exist in one line. The order of the fields is not significant.You can put pairs other than above; they are simply ignored. + +An example is follow: +-------------------------------------------------------------------------------- +host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK +host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR +-------------------------------------------------------------------------------- + FILES ----- aria2.conf