github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity

2007-11-23 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 

Corrected typo. Examples are removed since they are available in 
man
	page.
	* src/version_usage.cc

	Updated man page.
	* doc/aria2c.1
	* doc/aria2c.1.txt
	* doc/makeman: Commented out sed command.
pull/1/head
Tatsuhiro Tsujikawa 2007-11-23 13:58:50 +00:00
parent aff049ce8d
commit 83ac8a80e6
4 changed files with 998 additions and 569 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

778
doc/aria2c.1
View File

@ -1,11 +1,11 @@
.\" Title: aria2c .\" Title: aria2c
.\" Author: .\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
.\" Date: 11/22/2007 .\" Date: 11/23/2007
.\" Manual: .\" Manual:
.\" Source: .\" Source:
.\" .\"
.TH "ARIA2C" "1" "11/22/2007" "" "" .TH "ARIA2C" "1" "11/23/2007" "" ""
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
@ -13,20 +13,16 @@
.SH "NAME" .SH "NAME"
aria2c - The ultra fast download utility aria2c - The ultra fast download utility
.SH "SYNOPSIS" .SH "SYNOPSIS"
\fIaria2c\fR [OPTIONS] URL \&...
.sp
\fIaria2c\fR [OPTIONS] \-T TORRENT_FILE [URL \&...]
.sp
\fIaria2c\fR [OPTIONS] \-M METALINK_FILE
.sp .sp
.RS 4
.nf
aria2c [OPTIONS] URL \.\.\.
aria2c [OPTIONS] \-T TORRENT_FILE URL \.\.\.
aria2c [OPTIONS] \-M METALINK_FILE
.fi
.RE
.SH "DESCRIPTION" .SH "DESCRIPTION"
aria2 is a utility for downloading files\. The supporting protocols are http(s)/ftp/BitTorrent/Metalink\. aria2 has powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols, utilizing your download bandwidth to the max\. It even supports downloading a file from http/ftp and BitTorrent at the same time, while the data downloaded form http/ftp is uploaded to BitTorrent swarm\. aria2 is a utility for downloading files\. The supporting protocols are http(s)/ftp/BitTorrent/Metalink\. aria2 has powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols, utilizing your download bandwidth to the max\. It even supports downloading a file from http(s)/ftp and BitTorrent at the same time, while the data downloaded form http(s)/ftp is uploaded to BitTorrent swarm\.
.sp .sp
aria2 also provides most reliable http/ftp downloading experience ever\. Using Metalink\'s chunk checksums, aria2 automatically validates chunk of data while downloading like BitTorrent\. aria2 also provides most reliable http(s)/ftp downloading experience ever\. Using Metalink\'s chunk checksums, aria2 automatically validates chunk of data while downloading like BitTorrent\.
.sp
Please visit the project web site at http://aria2\.sourceforge\.net/
.sp .sp
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
@ -54,27 +50,26 @@ Run as daemon\.
.PP .PP
\-s, \-\-split=N \-s, \-\-split=N
.RS 4 .RS 4
Download a file using Download a file using N connections\. N must be between
\fIN\fR
connections\.
\fIN\fR
must be between
\fI1\fR \fI1\fR
and and
\fI5\fR\. This option affects all URLs\. Thus, aria2 connects to each URL with \fI5\fR\. This option affects all URLs\. Thus, aria2 connects to each URL with N connections\. Default:
\fIN\fR
connections\. Default:
\fI1\fR \fI1\fR
.RE .RE
.PP .PP
\-\-retry\-wait=SEC \-\-retry\-wait=SEC
.RS 4 .RS 4
Set the seconds to wait to retry after an error has occured\. Specify a value between 0 and 60\. Default: 5 Set the seconds to wait to retry after an error has occured\. Specify a value between
\fI0\fR
and
\fI60\fR\. Default:
\fI5\fR
.RE .RE
.PP .PP
\-t, \-\-timeout=SEC \-t, \-\-timeout=SEC
.RS 4 .RS 4
Set timeout in seconds\. Default: 60 Set timeout in seconds\. Default:
\fI60\fR
.RE .RE
.PP .PP
\-m, \-\-max\-tries=N \-m, \-\-max\-tries=N
@ -136,12 +131,14 @@ Set Referer\. This affects all URLs\.
.PP .PP
\-\-ftp\-user=USER \-\-ftp\-user=USER
.RS 4 .RS 4
Set FTP user\. This affects all URLs\. Default: anonymous Set FTP user\. This affects all URLs\. Default:
\fIanonymous\fR
.RE .RE
.PP .PP
\-\-ftp\-passwd=PASSWD \-\-ftp\-passwd=PASSWD
.RS 4 .RS 4
Set FTP password\. This affects all URLs\. Default: ARIA2USER@ Set FTP password\. This affects all URLs\. Default:
\fIARIA2USER@\fR
.RE .RE
.PP .PP
\-\-ftp\-type=TYPE \-\-ftp\-type=TYPE
@ -172,7 +169,13 @@ or
.PP .PP
\-\-lowest\-speed\-limit=SPEED \-\-lowest\-speed\-limit=SPEED
.RS 4 .RS 4
Close connection if download speed is lower than or equal to this value(bytes per sec)\. 0 means aria2 does not have a lowest speed limit\. You can append K or M(1K = 1024, 1M = 1024K)\. This option does not affect BitTorrent downloads\. Default: 0 Close connection if download speed is lower than or equal to this value(bytes per sec)\.
\fI0\fR
means aria2 does not have a lowest speed limit\. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\. This option does not affect BitTorrent downloads\. Default:
\fI0\fR
.RE .RE
.PP .PP
\-\-max\-download\-limit=SPEED \-\-max\-download\-limit=SPEED
@ -195,81 +198,75 @@ or
\fInone\fR \fInone\fR
doesn\'t pre\-allocate file space\. doesn\'t pre\-allocate file space\.
\fIprealloc\fR \fIprealloc\fR
pre\-allocates file space before download begins\. This may take some time depending on the size of the file\. Default: prealloc pre\-allocates file space before download begins\. This may take some time depending on the size of the file\. Default:
\fIprealloc\fR
.PP
Note
.RS 4
In multi file torrent, the files adjacent forward to the specified files are also allocated if they share a same piece\.
.RE
.RE .RE
.PP .PP
\-\-no\-file\-allocation\-limit=SIZE \-\-no\-file\-allocation\-limit=SIZE
.RS 4 .RS 4
No file allocation is made for files whose size is smaller than SIZE\. You can append K or M(1K = 1024, 1M = 1024K)\. Default: 5M No file allocation is made for files whose size is smaller than SIZE\. You can append
\fIK\fR
or
\fIM\fR(1K = 1024, 1M = 1024K)\. Default:
\fI5M\fR
.RE .RE
.PP .PP
\-\-allow\-overwrite=true|false \-\-allow\-overwrite=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
If false, aria2 doesn\'t download a file which already exists but the corresponding \.aria2 file doesn\'t exist\. Default: false 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 \-\-auto\-file\-renaming=\fItrue\fR
then, file name will be renamed\. See \-\-auto\-file\-renaming for details\. Default:
\fIfalse\fR
.RE .RE
.PP .PP
\-Z, \-\-force\-sequential[=true|false] \-Z, \-\-force\-sequential[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\. Default: false Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\. Default:
\fIfalse\fR
.RE .RE
.PP .PP
\-\-auto\-file\-renaming[=true|false] \-\-auto\-file\-renaming[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
Rename file name if the same file already exists\. This option works only in http(s)/ftp download\. The new file name has a dot and a number(1\.\.9999) appended\. Default: true Rename file name if the same file already exists\. This option works only in http(s)/ftp download\. The new file name has a dot and a number(1\.\.9999) appended\. Default:
\fItrue\fR
.RE .RE
.PP .PP
\-P, \-\-parameterized\-uri[=true|false] \-P, \-\-parameterized\-uri[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
Enable parameterized URI support\. You can specify set of parts: Enable parameterized URI support\. You can specify set of parts:
.RE \fI\ehttp://{sv1,sv2,sv3}/foo\.iso\fR\. Also you can specify numeric sequences with step counter:
.sp \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:
.RS 4 \fIfalse\fR
.nf
http://{sv1,sv2,sv3}/foo\.iso
.fi
.RE
.sp
.RS 4
.nf
Also you can specify numeric sequences with step
counter:
.fi
.RE
.sp
.RS 4
.nf
http://host/image[000\-100:2]\.img
.fi
.RE
.sp
.RS 4
.nf
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
.fi
.RE .RE
.PP .PP
\-\-enable\-http\-keep\-alive[=true|false] \-\-enable\-http\-keep\-alive[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
Enable HTTP/1\.1 persistent connection\. Default: false Enable HTTP/1\.1 persistent connection\. Default:
\fIfalse\fR
.RE .RE
.PP .PP
\-\-enable\-http\-pipelining[=true|false] \-\-enable\-http\-pipelining[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
Enable HTTP/1\.1 pipelining\. Default: false Enable HTTP/1\.1 pipelining\. Default:
\fIfalse\fR
.RE .RE
.PP .PP
\-\-check\-integrity=true|false \-\-check\-integrity=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
Check file integrity by validating piece hash\. This option only affects in BitTorrent downloads and Metalink downloads with chunk checksums\. Use this option to re\-download a damaged portion of a file\. Default: false Check file integrity by validating piece hash\. This option only affects in BitTorrent downloads and Metalink downloads with chunk checksums\. Use this option to re\-download a damaged portion of a file\. Default:
\fIfalse\fR
.RE .RE
.PP .PP
\-\-realtime\-chunk\-checksum=true|false \-\-realtime\-chunk\-checksum=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
Validate chunk checksum while downloading a file in Metalink mode\. This option on affects Metalink mode with chunk checksums\. Default: true Validate chunk of data by calculating checkusm while download a file if chunk checksums are provided\. Currently Metalink is the only way to to provide chunk checksums\. Default:
\fItrue\fR
.RE .RE
.PP .PP
\-c, \-\-continue \-c, \-\-continue
@ -284,7 +281,7 @@ Set user agent for http(s) downloads\.
.PP .PP
\-n, \-\-no\-netrc \-n, \-\-no\-netrc
.RS 4 .RS 4
Disables netrc support\. Disables netrc support\. netrc support is enabled by default\.
.RE .RE
.PP .PP
\-i, \-\-input\-file=FILE \-i, \-\-input\-file=FILE
@ -296,7 +293,8 @@ is specified\.
.PP .PP
\-j, \-\-max\-concurrent\-downloads=N \-j, \-\-max\-concurrent\-downloads=N
.RS 4 .RS 4
Set maximum number of concurrent downloads\. It should be used with the \-i option\. Default: 5 Set maximum number of concurrent downloads\. It should be used with the \-i option\. Default:
\fI5\fR
.RE .RE
.PP .PP
\-\-load\-cookies=FILE \-\-load\-cookies=FILE
@ -306,27 +304,19 @@ Load cookies from FILE\. The format of FILE is the same used by Netscape and Moz
.PP .PP
\-S, \-\-show\-files \-S, \-\-show\-files
.RS 4 .RS 4
Print file listing of \.torrent or \.metalink file and exit\. Print file listing of \.torrent or \.metalink file and exit\. In case of \.torrent file, additional information (infohash, piece length, etc) is also printed\.
.RE .RE
.PP .PP
\-\-select\-file=INDEX\&... \-\-select\-file=INDEX\&...
.RS 4 .RS 4
Set file to download by specifing its index\. You can find the file index using the \-\-show\-files option\. Multiple indexes can be specified by using Set file to download by specifing its index\. You can find the file index using the \-\-show\-files option\. Multiple indexes can be specified by using ",", for example:
\fI,\fR, for example: "3,6"\. You can also use \fI3,6\fR\. You can also use "\-" to specify a range:
\fI\-\fR \fI1\-5\fR\. "," and "\-" can be used together:
to specify a range: "1\-5"\. \fI1\-5,8,9\fR\. When used with the \-M option, index may vary depending on the query (see \-\-metalink\-* options)\.
\fI,\fR .PP
and Note
\fI\-\fR
can be used together\. When used with the \-M option, index may vary depending on the query(see \-\-metalink\-* options)\.
.sp
.RS 4 .RS 4
.nf 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\.
Note: In multi file torrent, it seems that adjacent files specified
by this option are 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\.
.fi
.RE .RE
.RE .RE
.PP .PP
@ -335,27 +325,27 @@ and aria2 writes the piece to the appropriate files\.
The path to the \.torrent file\. The path to the \.torrent file\.
.RE .RE
.PP .PP
\-\-follow\-torrent=true|false \-\-follow\-torrent=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
Set to false to prevent aria2 from entering BitTorrent mode even if the filename of the downloaded file ends with \.torrent\. Default: true Set to
\fIfalse\fR
to prevent aria2 from entering BitTorrent mode even if the filename of the downloaded file ends with \.torrent\. Default:
\fItrue\fR
.RE .RE
.PP .PP
\-\-direct\-file\-mapping=true|false \-\-direct\-file\-mapping=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
Directly read from and write to each file mentioned in \.torrent file\. Default: Directly read from and write to each file mentioned in \.torrent file\. Use this option if lots of files are listed in \.torrent file and aria2 complains it cannot open files anymore\. Default:
\fItrue\fR \fItrue\fR
.sp
.RS 4
.nf
\-\-listen\-port=PORT\.\.\.
Set TCP port number for BitTorrent downloads\.
Multiple values can be specified by using \',\',
for example: "6881,6885"\.
You can also use \'\-\' to specify a range: "6881\-6999"\.
\',\' and \'\-\' can be used together\.
Default: 6881\-6999
.fi
.RE .RE
.PP
\-\-listen\-port=PORT\&...
.RS 4
Set TCP port number for BitTorrent downloads\. Multiple ports can be specified by using ",", for example:
\fI6881,6885\fR\. You can also use "\-" to specify a range:
\fI6881\-6999\fR\. "," and "\-" can be used together:
\fI6881\-6889,6999\fR\. Default:
\fI6881\-6999\fR
.RE .RE
.PP .PP
\-\-max\-upload\-limit=SPEED \-\-max\-upload\-limit=SPEED
@ -376,12 +366,18 @@ Specify seeding time in minutes\. Also see the \-\-seed\-ratio option\.
.PP .PP
\-\-seed\-ratio=RATIO \-\-seed\-ratio=RATIO
.RS 4 .RS 4
Specify share ratio\. Seed completed torrents until share ratio reaches RATIO\. 1\.0 is encouraged\. Specify 0\.0 if you intend to do seeding regardless of share ratio\. If \-\-seed\-time option is specified along with this option, seeding ends when at least one of the conditions is satisfied\. Default: 1\.0 Specify share ratio\. Seed completed torrents until share ratio reaches] RATIO\. I strongly encourages you to specify equals or more than
\fI1\.0\fR
here\. Specify
\fI0\.0\fR
if you intend to do seeding regardless of share ratio\. If \-\-seed\-time option is specified along with this option, seeding ends when at least one of the conditions is satisfied\. Default:
\fI1\.0\fR
.RE .RE
.PP .PP
\-\-peer\-id\-prefix=PEERI_ID_PREFIX \-\-peer\-id\-prefix=PEERI_ID_PREFIX
.RS 4 .RS 4
Specify the prefix of peer ID\. The peer ID in 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: \-aria2\- 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:
\fI\-aria2\-\fR
.RE .RE
.PP .PP
\-M, \-\-metalink\-file=METALINK_FILE \-M, \-\-metalink\-file=METALINK_FILE
@ -391,7 +387,7 @@ The file path to \.metalink file\.
.PP .PP
\-C, \-\-metalink\-servers=NUM_SERVERS \-C, \-\-metalink\-servers=NUM_SERVERS
.RS 4 .RS 4
The number of servers to connect to simultaneously\. Default: The number of servers to connect to simultaneously\. Some metalinks regulates the number of servers to connect\. aria2 respects them\. Default:
\fI5\fR \fI5\fR
.RE .RE
.PP .PP
@ -412,17 +408,19 @@ The operating system of the file to download\.
.PP .PP
\-\-metalink\-location=LOCATION[,\&...] \-\-metalink\-location=LOCATION[,\&...]
.RS 4 .RS 4
The location of the preferred server\. A comma\-deliminated list of locations is acceptable\. The location of the preferred server\. A comma\-deliminated list of locations is acceptable, for example,
\fIJP,US\fR\.
.RE .RE
.PP .PP
\-\-follow\-metalink=true|false \-\-follow\-metalink=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
Set to false to prevent aria2 from entering Metalink mode even if the filename of the downloaded file ends with \.metalink\. Default: true Set to false to prevent aria2 from entering Metalink mode even if the filename of the downloaded file ends with \.metalink\. Default:
\fItrue\fR
.RE .RE
.PP .PP
\-v, \-\-version \-v, \-\-version
.RS 4 .RS 4
Print the version number and exit\. Print the version number, copyright and the configuration information and exit\.
.RE .RE
.PP .PP
\-h, \-\-help \-h, \-\-help
@ -432,130 +430,442 @@ Print this message and exit\.
.PP .PP
URL URL
.RS 4 .RS 4
You can specify multiple URLs\. Unless you specify \-Z option, all URLs must point to the same file or downloading will fail\. You can specify both torrent file with \-T option and URLs\. By doing this, download a file from both torrent swarm and http/ftp server at the same time, while the data from http/ftp are uploaded to the torrent swarm\. Note that only single file torrent can be integrated with http/ftp\. You can specify multiple URLs\. Unless you specify \-Z option, all URLs must point to the same file or downloading will fail\. You can specify both torrent file with \-T option and URLs\. By doing this, download a file from both torrent swarm and http(s)/ftp server at the same time, while the data from http(s)/ftp are uploaded to the torrent swarm\. Note that only single file torrent can be integrated with http(s)/ftp\.
.RE .RE
.SH "EXAMPLES" .SH "EXAMPLES"
.PP .SS "HTTP/FTP Segmented Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download a file using 1 connection Download a file using 1 connection
.RS 4 .RS
aria2c http://AAA\.BBB\.CCC/file\.zip
.RE
.PP
Download a file using 2 connections
.RS 4
aria2c \-s 2 http://AAA\.BBB\.CCC/file\.zip
.RE
.PP
Download a file using 2 connections, each connects to a different server
.RS 4
aria2c http://AAA\.BBB\.CCC/file\.zip http://DDD\.EEE\.FFF/GGG/file\.zip
.RE
.PP
You can mix up different protocols
.RS 4
aria2c http://AAA\.BBB\.CCC/file\.zip ftp://DDD\.EEE\.FFF/GGG/file\.zip
.RE
.PP
Download files listed in a text file\. 5 files are downloaded concurrently
.RS 4
aria2c \-i uris\.txt \-j 5
.RE
.PP
Download files passed through stdin
.RS 4
cat uris\.txt | aria2c \-i \-
.RE
.PP
Download a file using local cookies
.RS 4
aria2c \-\-load\-cookies cookies\.txt http://AAA\.BBB\.CCC/file\.zip
.RE
.PP
Parameterized URI
.RS 4
aria2c \-P http://{server1,server2,server3}/file\.iso
.RE
.PP
Parameterized URI\. \-Z option is required in this case
.RS 4
aria2c \-P \-Z http://host/file[001\-100:2]\.img
.RE
.PP
Download a torrent
.RS 4
aria2c \-o test\.torrent http://AAA\.BBB\.CCC/file\.torrent
.RE
.PP
Download a torrent using a local \.torrent file
.RS 4
aria2c \-T test\.torrent
.RE
.PP
Download only selected files
.RS 4
aria2c \-T test\.torrent dir/file1\.zip dir/file2\.zip
.RE
.PP
Download only selected files using index
.RS 4
aria2c \-T test\.torrent \-\-select\-file 1,3\-5
.RE
.PP
Print file listing of \.torrent file
.RS 4
aria2c \-T test\.torrent \-S Download a file using torrent and http/ftp server aria2c \-T test\.torrent http://host1/file ftp://host2/file
.RE
.PP
Metalink downloading
.RS 4
aria2c \-\-lowest\-speed\-limit 10K http://AAA\.BBB\.CCC/file\.metalink
.RE
.PP
Download a file using a local \.metalink file
.RS 4
aria2c \-M test\.metalink
.RE
.PP
Download a file using a local \.metalink file with preferred server locations
.RS 4
aria2c \-M test\.metalink \-\-metalink\-location=JP,US
.RE
.PP
Metalink downloading with preferences
.RS 4
aria2c \-M test\.metalink \-\-metalink\-version=1\.1\.1 \-\-metalink\-language=en\-US
.RE
.PP
Download only selected files
.RS 4
aria2c \-M test\.metalink \-\-metalink\-language=en\-US dir/file1\.zip dir/file2\.zip
.RE
.PP
Download only selected files using index
.RS 4
aria2c \-M test\.metalink \-\-metalink\-language=en\-US \-\-select\-file 1,3\-5
.RE
.PP
Print file listing of \.metalink file
.RS 4
aria2c \-M test\.metalink \-S \-\-metalink\-language=en\-US
.RE
.SH "FILES"
.PP
aria2\.conf
.RS 4
User configuration file\. It must be placed under ~/\.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\.
.sp .sp
.RS 4 .RS 4
.nf .nf
Example: aria2c http://host/file\.zip
.fi .fi
.RE .RE
.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 run aria2c with the same argument at 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 using 2 connections
.RS
.sp
.RS 4
.nf
aria2c \-s 2 http://host/file\.zip
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download a file from 2 difference http servers
.RS
.sp
.RS 4
.nf
aria2c http://host1/file\.zip ftp://host2/file\.zip
.fi
.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
.RS 4
.nf
aria2c http://host1/file\.zip ftp://host2/file\.zip
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download files listed in a file concurrently
.RS
.sp
.RS 4
.nf
aria2c \-i files\.txt \-j 5
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
\-j option specifies the number of concurrent downloads\.
.sp
.RE
.SS "Metalink Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download files with remote Metalink
.RS
.sp
.RS 4
.nf
aria2c http://host/file\.metalink
.fi
.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
.RS 4
.nf
aria2c \-p \-t 10 \-\-lowest\-speed\-limit 4000 \-M test\.metalink
.fi
.RE
.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 run aria2c with the same argument at the same directory\.
.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
.RS
.sp
.RS 4
.nf
aria2c \-M test\.metalink \-\-select\-file 1\-4,8
.fi
.RE
.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
.nf
aria2c \-M test\.metalink \-\-metalink\-location=JP,US \-\-metalink\-version=1\.1 \-\-metalink\-language=en\-US
.fi
.RE
.RE
.SS "BitTorrent Download"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download files from remote BitTorrent file
.RS
.sp
.RS 4
.nf
aria2c \-o test\.torrent http://host/file\.torrent
.fi
.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
.RS 4
.nf
aria2c \-\-max\-upload\-limit 40K \-T file\.torrent
.fi
.RE
.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 run aria2c with the same argument at the same directory\.
.sp
.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
.RS 4
.nf
aria2c \-T test\.torrent http://host1/file ftp://host2/file
.fi
.RE
.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
.nf
aria2c \-T test\.torrent \-\-select\-file 1\-4,8
.fi
.RE
.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
Change the listening port for incoming peer
.RS
.sp
.RS 4
.nf
aria2c \-T test\.torrent \-\-listen\-port 7000\-7001,8000
.fi
.RE
.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
.nf
aria2c \-T test\.torrent \-\-seed\-time 120 \-\-seed\-ratio 1\.0
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
In the above example, the program exists 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
.nf
aria2c \-T test\.torrent \-\-max\-upload\-limit 100K
.fi
.RE
.RE
.SS "More advanced HTTP features"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Load cookies
.RS
.sp
.RS 4
.nf
aria2c \-\-load\-cookies cookies\.txt http://host/file\.zip
.fi
.RE
.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
.nf
aria2c \-c \-s 2 http://host/partiallydownloadedfile\.zip
.fi
.RE
.RE
.SS "And more advanced features"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Throttle download speed
.RS
.sp
.RS 4
.nf
aria2c \-M test\.metalink \-\-max\-download\-limit 100K
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Repair a damaged download using --check-integrity option
.RS
.sp
.RS 4
.nf
aria2c \-M test\.metalink \-\-check\-integrity=true
.fi
.RE
.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
.nf
aria2c \-M test\.metalink \-\-lowest\-speed\-limit 10K
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Parameterized URI support
.RS
You can specify set of parts:
.sp
.sp
.RS 4
.nf
aria2c \-P http://{host1,host2,host3}/file\.iso
.fi
.RE
You can specify numeric sequence:
.sp
.sp
.RS 4
.nf
aria2c \-Z \-P http://host/image[000\-100]\.png
.fi
.RE
.sp
.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\.
.sp
You can specify step counter:
.sp
.sp
.RS 4
.nf
aria2c \-Z \-P http://host/image[A\-Z:2]\.png
.fi
.RE
.RE
.SH "FILES"
.SS "aria2\.conf"
User configuration file\. It must be placed under ~/\.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\.
.sp
.sp
.RS 4 .RS 4
.nf .nf
# sample configuration file for aria2c # sample configuration file for aria2c
@ -566,7 +876,11 @@ max\-upload\-limit=40K
ftp\-pasv=true ftp\-pasv=true
.fi .fi
.RE .RE
.RE .SH "RESOURCES"
Project web site: http://aria2\.sourceforge\.net/
.sp
metalink: http://www\.metalinker\.org/
.sp
.SH "REPORTING BUGS" .SH "REPORTING BUGS"
Report bugs to Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net> Report bugs to Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net>
.sp .sp
@ -576,3 +890,11 @@ Tatsuhiro Tsujikawa <t\-tujikawa@users\.sourceforge\.net>
.SH "COPYRIGHT" .SH "COPYRIGHT"
Copyright \(co 2006, 2007 Tatsuhiro Tsujikawa Copyright \(co 2006, 2007 Tatsuhiro Tsujikawa
.sp .sp
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\.
.sp
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\. See the GNU General Public License for more details\.
.sp
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc\., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA
.sp
In addition, as a special exception, the copyright holders give permission to link the code of portions of this program with the OpenSSL library under certain conditions as described in each individual source file, and distribute linked combinations including the two\. You must obey the GNU General Public License in all respects for all of the code used other than OpenSSL\. If you modify file(s) with this exception, you may extend this exception to your version of the file(s), but you are not obligated to do so\. If you do not wish to do so, delete this exception statement from your version\. If you delete this exception statement from all source files in the program, then also delete it here\.
.sp

738
doc/aria2c.1.txt
View File

@ -8,11 +8,11 @@ aria2c - The ultra fast download utility
SYNOPSIS SYNOPSIS
-------- --------
----------------------------------------- 'aria2c' [OPTIONS] URL ...
aria2c [OPTIONS] URL ...
aria2c [OPTIONS] -T TORRENT_FILE URL ... 'aria2c' [OPTIONS] -T TORRENT_FILE [URL ...]
aria2c [OPTIONS] -M METALINK_FILE
----------------------------------------- 'aria2c' [OPTIONS] -M METALINK_FILE
DESCRIPTION DESCRIPTION
----------- -----------
@ -20,388 +20,511 @@ aria2 is a utility for downloading files.
The supporting protocols are http(s)/ftp/BitTorrent/Metalink. The supporting protocols are http(s)/ftp/BitTorrent/Metalink.
aria2 has powerful segmented downloading ability, downloading a file aria2 has powerful segmented downloading ability, downloading a file
from multiple sources and multiple protocols, utilizing your download bandwidth to the max. from multiple sources and multiple protocols, utilizing your download bandwidth to the max.
It even supports downloading a file from http/ftp and BitTorrent at the same time, while the data downloaded form http/ftp is uploaded to BitTorrent swarm. It even supports downloading a file from http(s)/ftp and BitTorrent at the same time, while the data downloaded form http(s)/ftp is uploaded to BitTorrent swarm.
aria2 also provides most reliable http/ftp downloading experience ever. aria2 also provides most reliable http(s)/ftp downloading experience ever.
Using Metalink's chunk checksums, aria2 automatically validates chunk of data Using Metalink's chunk checksums, aria2 automatically validates chunk of data
while downloading like BitTorrent. while downloading like BitTorrent.
Please visit the project web site at http://aria2.sourceforge.net/
OPTIONS OPTIONS
------- -------
-d, --dir=DIR:: -d, --dir=DIR::
The directory to store the downloaded file. The directory to store the downloaded file.
-o, --out=FILE:: -o, --out=FILE::
The file name of the downloaded file. The file name of the downloaded file.
-l, --log=LOG:: -l, --log=LOG::
The file name of the log file. If '-' is specified, log is written to stdout. The file name of the log file. If '-' is specified, log is written to
stdout.
-D, --daemon:: -D, --daemon::
Run as daemon. Run as daemon.
-s, --split=N:: -s, --split=N::
Download a file using 'N' connections. 'N' must be between '1' and '5'. Download a file using N connections. N must be between '1' and '5'.
This option affects all URLs. Thus, aria2 connects to each URL with 'N' This option affects all URLs. Thus, aria2 connects to each URL with N
connections. connections.
Default: '1' Default: '1'
--retry-wait=SEC:: --retry-wait=SEC::
Set the seconds to wait to retry after an error Set the seconds to wait to retry after an error has occured.
has occured. Specify a value between 0 and 60. Specify a value between '0' and '60'.
Default: 5 Default: '5'
-t, --timeout=SEC:: -t, --timeout=SEC::
Set timeout in seconds. Default: 60 Set timeout in seconds.
Default: '60'
-m, --max-tries=N:: -m, --max-tries=N::
Set number of tries. '0' means unlimited. Set number of tries. '0' means unlimited.
Default: '5' Default: '5'
--http-proxy=HOST:PORT:: --http-proxy=HOST:PORT::
Use HTTP proxy server. This affects all URLs. Use HTTP proxy server. This affects all URLs.
--http-user=USER:: --http-user=USER::
Set HTTP user. This affects all URLs. Set HTTP user. This affects all URLs.
--http-passwd=PASSWD:: --http-passwd=PASSWD::
Set HTTP password. This affects all URLs. Set HTTP password. This affects all URLs.
--http-proxy-user=USER:: --http-proxy-user=USER::
Set HTTP proxy user. This affects all URLs. Set HTTP proxy user. This affects all URLs.
--http-proxy-passwd=PASSWD:: --http-proxy-passwd=PASSWD::
Set HTTP proxy password. This affects all URLs. Set HTTP proxy password. This affects all URLs.
--http-proxy-method=METHOD:: --http-proxy-method=METHOD::
Set the method to use in proxy request. Set the method to use in proxy request.
'METHOD' is either 'get' or 'tunnel'. 'METHOD' is either 'get' or 'tunnel'.
Default: 'tunnel' Default: 'tunnel'
--http-auth-scheme=SCHEME:: --http-auth-scheme=SCHEME::
Set HTTP authentication scheme. Currently, 'basic' Set HTTP authentication scheme.
is the only supported scheme. Currently, 'basic' is the only supported scheme.
Default: 'basic' Default: 'basic'
--referer=REFERER:: --referer=REFERER::
Set Referer. This affects all URLs. Set Referer. This affects all URLs.
--ftp-user=USER:: --ftp-user=USER::
Set FTP user. This affects all URLs. Set FTP user. This affects all URLs.
Default: anonymous Default: 'anonymous'
--ftp-passwd=PASSWD:: --ftp-passwd=PASSWD::
Set FTP password. This affects all URLs. Set FTP password. This affects all URLs.
Default: ARIA2USER@ Default: 'ARIA2USER@'
--ftp-type=TYPE:: --ftp-type=TYPE::
Set FTP transfer type. TYPE is either 'binary' Set FTP transfer type. TYPE is either 'binary' or 'ascii'.
or 'ascii'. Default: 'binary'
Default: 'binary'
-p, --ftp-pasv:: -p, --ftp-pasv::
Use passive mode in FTP. Use passive mode in FTP.
--ftp-via-http-proxy=METHOD:: --ftp-via-http-proxy=METHOD::
Use HTTP proxy in 'FTP'. 'METHOD' is either 'get' or Use HTTP proxy in 'FTP'. 'METHOD' is either 'get' or 'tunnel'.
'tunnel'. Default: 'tunnel'
Default: 'tunnel'
--lowest-speed-limit=SPEED:: --lowest-speed-limit=SPEED::
Close connection if download speed is lower than Close connection if download speed is lower than or equal to this
or equal to this value(bytes per sec). value(bytes per sec).
0 means aria2 does not have a lowest speed limit. '0' means aria2 does not have a lowest speed limit.
You can append K or M(1K = 1024, 1M = 1024K). You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
This option does not affect BitTorrent downloads. This option does not affect BitTorrent downloads.
Default: 0 Default: '0'
--max-download-limit=SPEED:: --max-download-limit=SPEED::
Set max download speed in bytes per sec. Set max download speed in bytes per sec. '0' means unrestricted.
'0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
You can append 'K' or 'M'(1K = 1024, 1M = 1024K). Default: '0'
Default: '0'
--file-allocation=METHOD:: --file-allocation=METHOD::
Specify file allocation method. METHOD is either Specify file allocation method. METHOD is either 'none' or 'prealloc'.
'none' or 'prealloc'. 'none' doesn't pre-allocate 'none' doesn't pre-allocate file space. 'prealloc' pre-allocates file space
file space. 'prealloc' pre-allocates file space before download begins. This may take some time depending on the size of the
before download begins. This may take some time file.
depending on the size of the file. Default: 'prealloc'
Default: prealloc Note;;
In multi file torrent, the files adjacent forward to the specified files
are also allocated if they share a same piece.
--no-file-allocation-limit=SIZE:: --no-file-allocation-limit=SIZE::
No file allocation is made for files whose No file allocation is made for files whose size is smaller than SIZE.
size is smaller than SIZE. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
You can append K or M(1K = 1024, 1M = 1024K). Default: '5M'
Default: 5M
--allow-overwrite=true|false:: --allow-overwrite='true'|'false'::
If false, aria2 doesn't download a file which If 'false' is given, aria2 doesn't download a file which already exists but
already exists but the corresponding .aria2 file the corresponding .aria2 file doesn't exist.
doesn't exist. In http(s)/ftp download, if --auto-file-renaming='true' then,
Default: false file name will be renamed. See --auto-file-renaming for details.
Default: 'false'
-Z, --force-sequential[=true|false]:: -Z, --force-sequential[='true'|'false']::
Fetch URIs in the command-line sequentially Fetch URIs in the command-line sequentially and download each URI in a
and download each URI in a separate session, like separate session, like the usual command-line download utilities.
the usual command-line download utilities. Default: 'false'
Default: false
--auto-file-renaming[=true|false]:: --auto-file-renaming[='true'|'false']::
Rename file name if the same file already Rename file name if the same file already exists.
exists. This option works only in http(s)/ftp This option works only in http(s)/ftp download.
download. The new file name has a dot and a number(1..9999) appended.
The new file name has a dot and a number(1..9999) Default: 'true'
appended.
Default: true -P, --parameterized-uri[='true'|'false']::
-P, --parameterized-uri[=true|false]::
Enable parameterized URI support. Enable parameterized URI support.
You can specify set of parts: You can specify set of parts: '\http://{sv1,sv2,sv3}/foo.iso'.
---------------------------- Also you can specify numeric sequences with step counter:
http://{sv1,sv2,sv3}/foo.iso '\http://host/image[000-100:2].img'.
---------------------------- A step counter can be omitted.
Also you can specify numeric sequences with step If all URIs do not point to the same file, such as the second example above,
counter: -Z option is required.
-------------------------------- Default: 'false'
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
--enable-http-keep-alive[=true|false]:: --enable-http-keep-alive[='true'|'false']::
Enable HTTP/1.1 persistent connection. Enable HTTP/1.1 persistent connection.
Default: false Default: 'false'
--enable-http-pipelining[=true|false]:: --enable-http-pipelining[='true'|'false']::
Enable HTTP/1.1 pipelining. Enable HTTP/1.1 pipelining.
Default: false Default: 'false'
--check-integrity=true|false:: --check-integrity='true'|'false'::
Check file integrity by validating piece hash. Check file integrity by validating piece hash.
This option only affects in BitTorrent downloads This option only affects in BitTorrent downloads and Metalink downloads with
and Metalink downloads with chunk checksums. chunk checksums.
Use this option to re-download a damaged portion Use this option to re-download a damaged portion of a file.
of a file. Default: 'false'
Default: false
--realtime-chunk-checksum=true|false:: --realtime-chunk-checksum='true'|'false'::
Validate chunk checksum while Validate chunk of data by calculating checkusm while download a file if
downloading a file in Metalink mode. This option chunk checksums are provided. Currently Metalink is the only way to to
on affects Metalink mode with chunk checksums. provide chunk checksums.
Default: true Default: 'true'
-c, --continue:: -c, --continue::
Continue downloading a partially downloaded Continue downloading a partially downloaded file.
file. Use this option to resume a download Use this option to resume a download started by a web browser or another
started by a web browser or another program program which downloads files sequentially from the beginning.
which downloads files sequentially from the Currently this option is only applicable to http(s)/ftp downloads.
beginning. Currently this option is only
applicable to http(s)/ftp downloads.
-U, --user-agent=USER_AGENT:: -U, --user-agent=USER_AGENT::
Set user agent for http(s) downloads. Set user agent for http(s) downloads.
-n, --no-netrc:: -n, --no-netrc::
Disables netrc support. Disables netrc support. netrc support is enabled by default.
-i, --input-file=FILE:: -i, --input-file=FILE::
Downloads URIs found in FILE. You can specify Downloads URIs found in FILE. You can specify multiple URIs for a single
multiple URIs for a single entity: separate entity: separate URIs on a single line using the TAB character.
URIs on a single line using the TAB character. Reads input from stdin when '-' is specified.
Reads input from stdin when '-' is specified.
-j, --max-concurrent-downloads=N:: -j, --max-concurrent-downloads=N::
Set maximum number of concurrent downloads. Set maximum number of concurrent downloads.
It should be used with the -i option. It should be used with the -i option.
Default: 5 Default: '5'
--load-cookies=FILE:: --load-cookies=FILE::
Load cookies from FILE. The format of FILE is Load cookies from FILE.
the same used by Netscape and Mozilla. The format of FILE is the same used by Netscape and Mozilla.
-S, --show-files:: -S, --show-files::
Print file listing of .torrent or .metalink file Print file listing of .torrent or .metalink file and exit.
and exit. In case of .torrent file, additional information
(infohash, piece length, etc) is also printed.
--select-file=INDEX...:: --select-file=INDEX...::
Set file to download by specifing its index. Set file to download by specifing its index.
You can find the file index using the You can find the file index using the --show-files option.
--show-files option. Multiple indexes can be Multiple indexes can be specified by using ",", for example: '3,6'.
specified by using ',', for example: "3,6". You can also use "-" to specify a range: '1-5'.
You can also use '-' to specify a range: "1-5". "," and "-" can be used together: '1-5,8,9'.
',' and '-' can be used together. When used with the -M option, index may vary depending on the query
When used with the -M option, index may vary (see --metalink-* options).
depending on the query(see --metalink-* options). Note;;
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.
Note: In multi file torrent, it seems that adjacent files specified -T, --torrent-file=TORRENT_FILE::
by this option are 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.
-T, --torrent-file=TORRENT_FILE::
The path to the .torrent file. The path to the .torrent file.
--follow-torrent=true|false:: --follow-torrent='true'|'false'::
Set to false to prevent aria2 from Set to 'false' to prevent aria2 from entering BitTorrent mode even if the
entering BitTorrent mode even if the filename of filename of the downloaded file ends with .torrent.
the downloaded file ends with .torrent. Default: 'true'
Default: true
--direct-file-mapping=true|false:: --direct-file-mapping='true'|'false'::
Directly read from and write to each file Directly read from and write to each file mentioned in .torrent file.
mentioned in .torrent file. Use this option if lots of files are listed in .torrent file and aria2
Default: 'true' complains it cannot open files anymore.
Default: 'true'
--listen-port=PORT... --listen-port=PORT...::
Set TCP port number for BitTorrent downloads. Set TCP port number for BitTorrent downloads.
Multiple values can be specified by using ',', Multiple ports can be specified by using ",", for example: '6881,6885'.
for example: "6881,6885". You can also use "-" to specify a range: '6881-6999'.
You can also use '-' to specify a range: "6881-6999". "," and "-" can be used together: '6881-6889,6999'.
',' and '-' can be used together. Default: '6881-6999'
Default: 6881-6999
--max-upload-limit=SPEED:: --max-upload-limit=SPEED::
Set max upload speed in bytes per sec. Set max upload speed in bytes per sec. '0' means unrestricted.
'0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
You can append 'K' or 'M'(1K = 1024, 1M = 1024K). Default: '0'
Default: '0'
--seed-time=MINUTES:: --seed-time=MINUTES::
Specify seeding time in minutes. Also see the Specify seeding time in minutes. Also see the --seed-ratio option.
--seed-ratio option.
--seed-ratio=RATIO:: --seed-ratio=RATIO::
Specify share ratio. Seed completed torrents Specify share ratio. Seed completed torrents until share ratio reaches]
until share ratio reaches RATIO. 1.0 is RATIO.
encouraged. Specify 0.0 if you intend to do I strongly encourages you to specify equals or more than '1.0' here.
seeding regardless of share ratio. Specify '0.0' if you intend to do seeding regardless of share ratio.
If --seed-time option is specified along with If --seed-time option is specified along with this option, seeding ends when
this option, seeding ends when at least one of at least one of the conditions is satisfied.
the conditions is satisfied. Default: '1.0'
Default: 1.0
--peer-id-prefix=PEERI_ID_PREFIX:: --peer-id-prefix=PEERI_ID_PREFIX::
Specify the prefix of peer ID. The peer ID in Specify the prefix of peer ID. The peer ID in BitTorrent is 20 byte length.
in BitTorrent is 20 byte length. If more than 20 If more than 20 bytes are specified, only first 20 bytes are used.
bytes are specified, only first 20 If less than 20 bytes are specified, the random alphabet characters are
bytes are used. If less than 20 bytes are added to make it's length 20 bytes.
specified, the random alphabet characters are Default: '-aria2-'
added to make it's length 20 bytes.
Default: -aria2-
-M, --metalink-file=METALINK_FILE:: -M, --metalink-file=METALINK_FILE::
The file path to .metalink file. The file path to .metalink file.
-C, --metalink-servers=NUM_SERVERS:: -C, --metalink-servers=NUM_SERVERS::
The number of servers to connect to The number of servers to connect to simultaneously.
simultaneously. Some metalinks regulates the number of servers to connect.
Default: '5' aria2 respects them.
Default: '5'
--metalink-version=VERSION:: --metalink-version=VERSION::
The version of the file to download. The version of the file to download.
--metalink-language=LANGUAGE:: --metalink-language=LANGUAGE::
The language of the file to download. The language of the file to download.
--metalink-os=OS:: --metalink-os=OS::
The operating system of the file to download. The operating system of the file to download.
--metalink-location=LOCATION[,...]:: --metalink-location=LOCATION[,...]::
The location of the preferred server. The location of the preferred server.
A comma-deliminated list of locations is acceptable. A comma-deliminated list of locations is acceptable, for example, 'JP,US'.
--follow-metalink=true|false:: --follow-metalink='true'|'false'::
Set to false to prevent aria2 from Set to false to prevent aria2 from entering Metalink mode even if the
entering Metalink mode even if the filename of filename of the downloaded file ends with .metalink.
the downloaded file ends with .metalink. Default: 'true'
Default: true
-v, --version:: -v, --version::
Print the version number and exit. Print the version number, copyright and the configuration information and
exit.
-h, --help:: -h, --help::
Print this message and exit. Print this message and exit.
URL:: URL::
You can specify multiple URLs. Unless you specify -Z option, all URLs must You can specify multiple URLs. Unless you specify -Z option, all URLs must
point to the same file or downloading will fail. point to the same file or downloading will fail.
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,
download a file from both torrent swarm and http/ftp server at the same time, download a file from both torrent swarm and http(s)/ftp server at the same time,
while the data from http/ftp are uploaded to the torrent swarm. Note that while the data from http(s)/ftp are uploaded to the torrent swarm. Note that
only single file torrent can be integrated with http/ftp. only single file torrent can be integrated with http(s)/ftp.
EXAMPLES EXAMPLES
-------- --------
HTTP/FTP Segmented Download
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download a file using 1 connection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------------
aria2c http://host/file.zip
----------------------------------
[NOTE]
To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory. You can change URLs as long as they are pointing to the same file.
Download a file using 1 connection:: Download a file using 2 connections
aria2c http://AAA.BBB.CCC/file.zip ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Download a file using 2 connections:: --------------------------------
aria2c -s 2 http://AAA.BBB.CCC/file.zip aria2c -s 2 http://host/file.zip
Download a file using 2 connections, each connects to a different server:: --------------------------------
aria2c http://AAA.BBB.CCC/file.zip http://DDD.EEE.FFF/GGG/file.zip
You can mix up different protocols::
aria2c http://AAA.BBB.CCC/file.zip ftp://DDD.EEE.FFF/GGG/file.zip
Download files listed in a text file. 5 files are downloaded concurrently::
aria2c -i uris.txt -j 5
Download files passed through stdin::
cat uris.txt | aria2c -i -
Download a file using local cookies::
aria2c --load-cookies cookies.txt http://AAA.BBB.CCC/file.zip
Parameterized URI::
aria2c -P http://{server1,server2,server3}/file.iso
Parameterized URI. -Z option is required in this case::
aria2c -P -Z \http://host/file[001-100:2].img
Download a torrent:: Download a file from 2 difference http servers
aria2c -o test.torrent http://AAA.BBB.CCC/file.torrent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Download a torrent using a local .torrent file:: -------------------------------------------------
aria2c -T test.torrent aria2c http://host1/file.zip ftp://host2/file.zip
Download only selected files:: -------------------------------------------------
aria2c -T test.torrent dir/file1.zip dir/file2.zip
Download only selected files using index::
aria2c -T test.torrent --select-file 1,3-5
Print file listing of .torrent file::
aria2c -T test.torrent -S
Download a file using torrent and http/ftp server
aria2c -T test.torrent http://host1/file ftp://host2/file
Metalink downloading:: Download a file from http and ftp servers
aria2c --lowest-speed-limit 10K http://AAA.BBB.CCC/file.metalink ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Download a file using a local .metalink file:: -------------------------------------------------
aria2c -M test.metalink aria2c http://host1/file.zip ftp://host2/file.zip
Download a file using a local .metalink file with preferred server locations:: -------------------------------------------------
aria2c -M test.metalink --metalink-location=JP,US
Metalink downloading with preferences:: Download files listed in a file concurrently
aria2c -M test.metalink --metalink-version=1.1.1 --metalink-language=en-US ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Download only selected files:: ------------------------
aria2c -M test.metalink --metalink-language=en-US dir/file1.zip dir/file2.zip aria2c -i files.txt -j 5
Download only selected files using index:: ------------------------
aria2c -M test.metalink --metalink-language=en-US --select-file 1,3-5 [NOTE]
Print file listing of .metalink file:: -j option specifies the number of concurrent downloads.
aria2c -M test.metalink -S --metalink-language=en-US
Metalink Download
~~~~~~~~~~~~~~~~~
Download files with remote Metalink
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--------------------------------
aria2c http://host/file.metalink
--------------------------------
Download using a local metalink file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------------------------------------
aria2c -p -t 10 --lowest-speed-limit 4000 -M test.metalink
----------------------------------------------------------
[NOTE]
To pause a download, press Ctrl-C.
You can resume the transfer by run aria2c with the same argument at the same
directory.
Download only selected files using index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------
aria2c -M test.metalink --select-file 1-4,8
-------------------------------------------
[NOTE]
The index is printed to the console using -S option.
Download a file using a local .metalink file with user preference
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------------------------------------
aria2c -M test.metalink --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US
------------------------------------------------------------------------------
BitTorrent Download
~~~~~~~~~~~~~~~~~~~
Download files from remote BitTorrent file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-----------------------------------------------
aria2c -o test.torrent http://host/file.torrent
-----------------------------------------------
Download using a local torrent file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------
aria2c --max-upload-limit 40K -T file.torrent
---------------------------------------------
[NOTE]
--max-upload-limit specifies the max of upload rate.
[NOTE]
To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.
Download a file using torrent and http/ftp server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-----------------------------------------------------------
aria2c -T test.torrent http://host1/file ftp://host2/file
-----------------------------------------------------------
[NOTE]
Downloading multi file torrent with http/ftp is not supported.
Download only selected files using index(usually called "selectable download")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------
aria2c -T test.torrent --select-file 1-4,8
------------------------------------------
[NOTE]
The index is printed to the console using -S option.
Change the listening port for incoming peer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------------
aria2c -T test.torrent --listen-port 7000-7001,8000
---------------------------------------------------
Specify the condition to stop program after torrent download finished
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------------------
aria2c -T test.torrent --seed-time 120 --seed-ratio 1.0
-------------------------------------------------------
[NOTE]
In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.
Throttle upload speed
^^^^^^^^^^^^^^^^^^^^^
----------------------------------------------
aria2c -T test.torrent --max-upload-limit 100K
----------------------------------------------
More advanced HTTP features
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Load cookies
^^^^^^^^^^^^
------------------------------------------------------
aria2c --load-cookies cookies.txt http://host/file.zip
------------------------------------------------------
[NOTE]
You can use Firefox/Mozilla's cookie file without modification.
Resume download started by web browsers or another programs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------------
aria2c -c -s 2 http://host/partiallydownloadedfile.zip
---------------------------------------------------
And more advanced features
~~~~~~~~~~~~~~~~~~~~~~~~~~
Throttle download speed
^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------------
aria2c -M test.metalink --max-download-limit 100K
-------------------------------------------------
Repair a damaged download using --check-integrity option
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------------------------
aria2c -M test.metalink --check-integrity=true
----------------------------------------------
[NOTE]
This option is only available used with BitTorrent or metalink with chunk
checksums.
Drop connection if download speed is lower than specified value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------
aria2c -M test.metalink --lowest-speed-limit 10K
------------------------------------------------
Parameterized URI support
^^^^^^^^^^^^^^^^^^^^^^^^^
You can specify set of parts:
---------------------------------------------
aria2c -P http://{host1,host2,host3}/file.iso
---------------------------------------------
You can specify numeric sequence:
-------------------------------------------
aria2c -Z -P http://host/image[000-100].png
-------------------------------------------
[NOTE]
-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:
-----------------------------------------
aria2c -Z -P http://host/image[A-Z:2].png
-----------------------------------------
FILES FILES
----- -----
aria2.conf:: aria2.conf
User configuration file. ~~~~~~~~~~
It must be placed under ~/.aria2 and must be named as aria2.conf. User configuration file.
In each line, there is 1 parameter whose syntax is name=value pair, It must be placed under ~/.aria2 and must be named as aria2.conf.
where name is the long command-line option name without '--' prefix. In each line, there is 1 parameter whose syntax is name=value pair,
The lines beginning '#' are treated as comments. where name is the long command-line option name without '--' prefix.
The lines beginning '#' are treated as comments.
Example: --------------------------------------
# sample configuration file for aria2c
file-allocation=prealloc
listen-port=60000
seed-ratio=1.0
max-upload-limit=40K
ftp-pasv=true
--------------------------------------
# sample configuration file for aria2c RESOURCES
file-allocation=prealloc ---------
listen-port=60000 Project web site: http://aria2.sourceforge.net/[]
seed-ratio=1.0
max-upload-limit=40K metalink: http://www.metalinker.org/[]
ftp-pasv=true
REPORTING BUGS REPORTING BUGS
-------------- --------------
@ -414,3 +537,30 @@ Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
COPYRIGHT COPYRIGHT
--------- ---------
Copyright (C) 2006, 2007 Tatsuhiro Tsujikawa Copyright (C) 2006, 2007 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,
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
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
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.

4
doc/makeman
View File

@ -2,6 +2,6 @@
a2x -f manpage aria2c.1.txt a2x -f manpage aria2c.1.txt
sed 's/\(.\)\.sp/\1\n\.sp/g' aria2c.1 > aria2c.1.tmp #sed 's/\(.\)\.sp/\1\n\.sp/g' aria2c.1 > aria2c.1.tmp
mv aria2c.1.tmp aria2c.1 #mv aria2c.1.tmp aria2c.1

47
src/version_usage.cc
View File

@ -263,7 +263,7 @@ void showUsage() {
" the conditions is satisfied.\n" " the conditions is satisfied.\n"
" Default: 1.0") << endl; " Default: 1.0") << endl;
cout << _(" --peer-id-prefix=PEERI_ID_PREFIX Specify the prefix of peer ID. The peer ID in\n" cout << _(" --peer-id-prefix=PEERI_ID_PREFIX Specify the prefix of peer ID. The peer ID in\n"
" in BitTorrent is 20 byte length. If more than 20\n" " BitTorrent is 20 byte length. If more than 20\n"
" bytes are specified, only first 20\n" " bytes are specified, only first 20\n"
" bytes are used. If less than 20 bytes are\n" " bytes are used. If less than 20 bytes are\n"
" specified, the random alphabet characters are\n" " specified, the random alphabet characters are\n"
@ -297,50 +297,7 @@ void showUsage() {
" while the data from http/ftp are uploaded to the torrent swarm. Note that\n" " while the data from http/ftp are uploaded to the torrent swarm. Note that\n"
" only single file torrent can be integrated with http/ftp.") << endl; " only single file torrent can be integrated with http/ftp.") << endl;
cout << endl; cout << endl;
cout << _("Examples:") << endl; cout << _("Refer to man page for some examples.") << endl;
cout << _(" Download a file using 1 connection:") << endl;
cout << " aria2c http://AAA.BBB.CCC/file.zip" << endl;
cout << _(" Download a file using 2 connections:") << endl;
cout << " aria2c -s 2 http://AAA.BBB.CCC/file.zip" << endl;
cout << _(" Download a file using 2 connections, each connects to a different server:") << endl;
cout << " aria2c http://AAA.BBB.CCC/file.zip http://DDD.EEE.FFF/GGG/file.zip" << endl;
cout << _(" You can mix up different protocols:") << endl;
cout << " aria2c http://AAA.BBB.CCC/file.zip ftp://DDD.EEE.FFF/GGG/file.zip" << endl;
cout << _(" Parameterized URI:") << endl;
cout << " aria2c -P http://{server1,server2,server3}/file.iso" << endl;
cout << _(" Parameterized URI. -Z option is required in this case:") << endl;
cout << " aria2c -P -Z http://host/file[001-100:2].img" << endl;
#ifdef ENABLE_BITTORRENT
cout << endl;
cout << _(" Download a torrent:") << endl;
cout << " aria2c -o test.torrent http://AAA.BBB.CCC/file.torrent" << endl;
cout << _(" Download a torrent using a local .torrent file:") << endl;
cout << " aria2c -T test.torrent" << endl;
cout << _(" Download only selected files:") << endl;
cout << " aria2c -T test.torrent dir/file1.zip dir/file2.zip" << endl;
cout << _(" Print file listing of .torrent file:") << endl;
cout << " aria2c -T test.torrent -S" << endl;
cout << _(" Download a file using torrent and http/ftp server") << endl;
cout << " aria2c -T test.torrent http://host1/file ftp://host2/file" << endl;
#endif // ENABLE_BITTORRENT
#ifdef ENABLE_METALINK
cout << endl;
cout << _(" Metalink downloading:") << endl;
cout << " aria2c http://AAA.BBB.CCC/file.metalink" << endl;
cout << _(" Download a file using local .metalink file:") << endl;
cout << " aria2c -M test.metalink" << endl;
cout << _(" Download a file using a local .metalink file with preferred server locations:") << endl;
cout << " aria2c -M test.metalink --metalink-location=JP,US" << endl;
cout << _(" Metalink downloading with preferences:") << endl;
cout << " aria2c -M test.metalink --metalink-version=1.1.1 --metalink-language=en-US" << endl;
cout << _(" Download only selected files:") << endl;
cout << " aria2c -M test.metalink --metalink-language=en-US dir/file1.zip dir/file2.zip" << endl;
cout << _(" Download only selected files using index:") << endl;
cout << " aria2c -M test.metalink --metalink-language=en-US --select-file 1,3-5" << endl;
cout << _(" Print file listing of .metalink file:") << endl;
cout << " aria2c -M test.metalink -S --metalink-language=en-US" << endl;
#endif // ENABLE_METALINK
cout << endl; cout << endl;
printf(_("Report bugs to %s"), "<tujikawa at users dot sourceforge dot net>"); printf(_("Report bugs to %s"), "<tujikawa at users dot sourceforge dot net>");
cout << endl; cout << endl;