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

2010-03-13 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 

Updated doc.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2010-03-12 15:38:08 +00:00
parent 725c46de25
commit 3511e737de
4 changed files with 84 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2010-03-13 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Updated doc.
* doc/aria2c.1.txt
2010-03-13 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 2010-03-13 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented about Metalink4 and LPD in README Documented about Metalink4 and LPD in README

44
doc/aria2c.1
View File

@ -2,12 +2,12 @@
.\" Title: aria2c .\" Title: aria2c
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/12/2010 .\" Date: 03/13/2010
.\" Manual: Aria2 Manual .\" Manual: Aria2 Manual
.\" Source: Aria2 1.9.0 .\" Source: Aria2 1.9.0
.\" Language: English .\" Language: English
.\" .\"
.TH "ARIA2C" "1" "03/12/2010" "Aria2 1\&.9\&.0" "Aria2 Manual" .TH "ARIA2C" "1" "03/13/2010" "Aria2 1\&.9\&.0" "Aria2 Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -65,7 +65,7 @@ is specified, log is written to stdout\&.
.PP .PP
\fB\-j\fR, \fB\-\-max\-concurrent\-downloads\fR=N \fB\-j\fR, \fB\-\-max\-concurrent\-downloads\fR=N
.RS 4 .RS 4
Set maximum number of parallel downloads for every static (HTTP/FTP) URL, torrent and metalink\&. See also Set maximum number of parallel downloads for every static (HTTP/FTP) URI, torrent and metalink\&. See also
\fB\-s\fR \fB\-s\fR
and and
\fB\-C\fR \fB\-C\fR
@ -112,7 +112,7 @@ Use this proxy server for all protocols\&. To erase previously defined proxy, us
\fB\-\-https\-proxy\fR \fB\-\-https\-proxy\fR
and and
\fB\-\-ftp\-proxy\fR \fB\-\-ftp\-proxy\fR
options\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] options\&. This affects all URIs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE .RE
.if n \{\ .if n \{\
.sp .sp
@ -219,7 +219,7 @@ option is used, this option is ignored\&.
.ps -1 .ps -1
.br .br
.sp .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" In Metalink or BitTorrent download you cannot specify file name\&. The file name specified here is only used when the URIs 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 .sp .5v
.RE .RE
.PP .PP
@ -276,7 +276,7 @@ Specifies timeout in seconds to invalidate performance profile of the servers si
.PP .PP
\fB\-s\fR, \fB\-\-split\fR=N \fB\-s\fR, \fB\-\-split\fR=N
.RS 4 .RS 4
Download a file using N connections\&. If more than N URLs are given, first N URLs are used and remaining URLs are used for backup\&. If less than N URLs are given, those URLs are used more than once so that N connections total are made simultaneously\&. Please see Download a file using N connections\&. If more than N URIs are given, first N URIs are used and remaining URIs are used for backup\&. If less than N URIs are given, those URIs are used more than once so that N connections total are made simultaneously\&. Please see
\fB\-j\fR \fB\-j\fR
option too\&. Please note that in Metalink download, this option has no effect and use option too\&. Please note that in Metalink download, this option has no effect and use
\fB\-C\fR \fB\-C\fR
@ -354,19 +354,19 @@ option\&. Default:
.PP .PP
\fB\-\-http\-user\fR=USER \fB\-\-http\-user\fR=USER
.RS 4 .RS 4
Set HTTP user\&. This affects all URLs\&. Set HTTP user\&. This affects all URIs\&.
.RE .RE
.PP .PP
\fB\-\-http\-passwd\fR=PASSWD \fB\-\-http\-passwd\fR=PASSWD
.RS 4 .RS 4
Set HTTP password\&. This affects all URLs\&. Set HTTP password\&. This affects all URIs\&.
.RE .RE
.PP .PP
\fB\-\-http\-proxy\fR=PROXY \fB\-\-http\-proxy\fR=PROXY
.RS 4 .RS 4
Use this proxy server for HTTP\&. To erase previously defined proxy, use ""\&. See also Use this proxy server for HTTP\&. To erase previously defined proxy, use ""\&. See also
\fB\-\-all\-proxy\fR \fB\-\-all\-proxy\fR
option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] option\&. This affects all URIs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE .RE
.PP .PP
\fB\-\-http\-proxy\-passwd\fR=PASSWD \fB\-\-http\-proxy\-passwd\fR=PASSWD
@ -392,7 +392,7 @@ Set user for *\-\-http\-proxy* option\&.
.RS 4 .RS 4
Use this proxy server for HTTPS\&. To erase previously defined proxy, use ""\&. See also Use this proxy server for HTTPS\&. To erase previously defined proxy, use ""\&. See also
\fB\-\-all\-proxy\fR \fB\-\-all\-proxy\fR
option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] option\&. This affects all URIs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE .RE
.PP .PP
\fB\-\-https\-proxy\-passwd\fR=PASSWD \fB\-\-https\-proxy\-passwd\fR=PASSWD
@ -418,7 +418,7 @@ option\&.
.PP .PP
\fB\-\-referer\fR=REFERER \fB\-\-referer\fR=REFERER
.RS 4 .RS 4
Set Referer\&. This affects all URLs\&. Set Referer\&. This affects all URIs\&.
.RE .RE
.PP .PP
\fB\-\-enable\-http\-keep\-alive\fR[=\fItrue\fR|\fIfalse\fR] \fB\-\-enable\-http\-keep\-alive\fR[=\fItrue\fR|\fIfalse\fR]
@ -482,13 +482,13 @@ Set user agent for HTTP(S) downloads\&. Default:
.PP .PP
\fB\-\-ftp\-user\fR=USER \fB\-\-ftp\-user\fR=USER
.RS 4 .RS 4
Set FTP user\&. This affects all URLs\&. Default: Set FTP user\&. This affects all URIs\&. Default:
\fIanonymous\fR \fIanonymous\fR
.RE .RE
.PP .PP
\fB\-\-ftp\-passwd\fR=PASSWD \fB\-\-ftp\-passwd\fR=PASSWD
.RS 4 .RS 4
Set FTP password\&. This affects all URLs\&. If user name is embedded but password is missing in URI, aria2 tries to resolve password using \&.netrc\&. If password is found in \&.netrc, then use it as password\&. If not, use the password specified in this option\&. Default: Set FTP password\&. This affects all URIs\&. If user name is embedded but password is missing in URI, aria2 tries to resolve password using \&.netrc\&. If password is found in \&.netrc, then use it as password\&. If not, use the password specified in this option\&. Default:
\fIARIA2USER@\fR \fIARIA2USER@\fR
.RE .RE
.PP .PP
@ -504,7 +504,7 @@ is given, the active mode will be used\&. Default:
.RS 4 .RS 4
Use this proxy server for FTP\&. To erase previously defined proxy, use ""\&. See also Use this proxy server for FTP\&. To erase previously defined proxy, use ""\&. See also
\fB\-\-all\-proxy\fR \fB\-\-all\-proxy\fR
option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] option\&. This affects all URIs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
.RE .RE
.PP .PP
\fB\-\-ftp\-proxy\-passwd\fR=PASSWD \fB\-\-ftp\-proxy\-passwd\fR=PASSWD
@ -1244,13 +1244,13 @@ Print the version number, copyright and the configuration information and exit\&
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\&. The options that have its argument surrounded by square brackets([]) take an optional argument\&. Usually omiting the argument is evaluated to \fItrue\fR\&. If you use short form of these options(such as \fI\-V\fR) and give an argument, then the option name and its argument should be concatenated(e\&.g\&. \fI\-Vfalse\fR)\&. If any spaces are inserted between the option name and the argument, the argument will be treated as URI and usually this is not what you expect\&.
.SS "URI, MAGNET, TORRENT_FILE, METALINK_FILE" .SS "URI, MAGNET, TORRENT_FILE, METALINK_FILE"
.sp .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\&. You can specify multiple URIs in command\-line\&. Unless you specify \fB\-Z\fR option, all URIs must point to the same file or downloading will fail\&.
.sp .sp
You can specify arbitrary number of BitTorrent Magnet URI\&. Please note that they are always treated as a separate download\&. Both hex encoded 40 characters Info Hash and Base32 encoded 32 characters Info Hash are supported\&. The multiple "tr" parameters are supported\&. Because BitTorrent Magnet URI is likely to contain "&" character, it is highly recommended to always quote URI with single(\*(Aq) or double(") quotation\&. It is strongly recommended to enable DHT especially when "tr" parameter is missing\&. See http://www\&.bittorrent\&.org/beps/bep_0009\&.html for more details about BitTorrent Magnet URI\&. You can specify arbitrary number of BitTorrent Magnet URI\&. Please note that they are always treated as a separate download\&. Both hex encoded 40 characters Info Hash and Base32 encoded 32 characters Info Hash are supported\&. The multiple "tr" parameters are supported\&. Because BitTorrent Magnet URI is likely to contain "&" character, it is highly recommended to always quote URI with single(\*(Aq) or double(") quotation\&. It is strongly recommended to enable DHT especially when "tr" parameter is missing\&. See http://www\&.bittorrent\&.org/beps/bep_0009\&.html for more details about BitTorrent Magnet URI\&.
.sp .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\&. You can also specify arbitrary number of torrent files and Metalink documents stored on a local drive\&. Please note that they are always treated as a separate download\&. Both Metalink4 and Metalink version 3\&.0 are supported\&.
.sp .sp
You can specify both torrent file with \-T option and URLs\&. By doing this, you can download a file from both torrent swarm and HTTP(S)/FTP server at the same time, while the data from HTTP(S)/FTP are uploaded to the torrent swarm\&. For single file torrents, URL can be a complete URL pointing to the resource or if URL ends with /, name in torrent file in torrent is added\&. For multi\-file torrents, name and path are added to form a URL for each file\&. You can specify both torrent file with \-T option and URIs\&. By doing this, you can download a file from both torrent swarm and HTTP(S)/FTP server at the same time, while the data from HTTP(S)/FTP are uploaded to the torrent swarm\&. For single file torrents, URI can be a complete URI pointing to the resource or if URI ends with /, name in torrent file in torrent is added\&. For multi\-file torrents, name and path are added to form a URI for each file\&.
.if n \{\ .if n \{\
.sp .sp
.\} .\}
@ -1264,14 +1264,14 @@ You can specify both torrent file with \-T option and URLs\&. By doing this, you
.ps -1 .ps -1
.br .br
.sp .sp
Make sure that URL is quoted with single(\*(Aq) or double(") quotation if it contains "&" or any characters that have special meaning in shell\&. Make sure that URI is quoted with single(\*(Aq) or double(") quotation if it contains "&" or any characters that have special meaning in shell\&.
.sp .5v .sp .5v
.RE .RE
.SS "Resuming Download" .SS "Resuming Download"
.sp .sp
Usually, you can resume transfer by just issuing same command(aria2c URL) if the previous transfer is made by aria2\&. Usually, you can resume transfer by just issuing same command(aria2c URI) if the previous transfer is made by aria2\&.
.sp .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)\&. 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 URI)\&.
.SH "EXIT STATUS" .SH "EXIT STATUS"
.sp .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\&. 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\&.
@ -2932,7 +2932,7 @@ aria2 uses 5 connections to download 1 file by default\&. \-s1 limits the number
.ps -1 .ps -1
.br .br
.sp .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\&. 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 URIs as long as they are pointing to the same file\&.
.sp .5v .sp .5v
.RE .RE
.RE .RE
@ -3825,7 +3825,7 @@ aria2c \-Z \-P "http://host/image[A\-Z:2]\&.png"
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
.ps +1 .ps +1
\fBParallel downloads of arbitrary number of URL,metalink,torrent\fR \fBParallel downloads of arbitrary number of URI,metalink,torrent\fR
.RS 4 .RS 4
.sp .sp
.if n \{\ .if n \{\

57
doc/aria2c.1.html
View File

@ -627,7 +627,7 @@ downloading a file like BitTorrent.</p></div>
</dt> </dt>
<dd> <dd>
<p> <p>
Set maximum number of parallel downloads for every static (HTTP/FTP) URL, Set maximum number of parallel downloads for every static (HTTP/FTP) URI,
torrent and metalink. See also <strong>-s</strong> and <strong>-C</strong> option. torrent and metalink. See also <strong>-s</strong> and <strong>-C</strong> option.
Default: <em>5</em> Default: <em>5</em>
</p> </p>
@ -681,7 +681,7 @@ downloading a file like BitTorrent.</p></div>
Use this proxy server for all protocols. To erase previously Use this proxy server for all protocols. To erase previously
defined proxy, use "". You can override this setting and specify a defined proxy, use "". You can override this setting and specify a
proxy server for a particular protocol using <strong>--http-proxy</strong>, proxy server for a particular protocol using <strong>--http-proxy</strong>,
<strong>--https-proxy</strong> and <strong>--ftp-proxy</strong> options. This affects all URLs. <strong>--https-proxy</strong> and <strong>--ftp-proxy</strong> options. This affects all URIs.
The format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>] The format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>]
</p> </p>
</dd> </dd>
@ -813,7 +813,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">In Metalink or BitTorrent download you cannot specify file name. <td class="content">In Metalink or BitTorrent download you cannot specify file name.
The file name specified here is only used when the URLs fed to aria2 The file name specified here is only used when the URIs fed to aria2
are done by command line without <strong>-i</strong>, <strong>-Z</strong> option. For example: are done by command line without <strong>-i</strong>, <strong>-Z</strong> option. For example:
aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td> aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
</tr></table> </tr></table>
@ -886,9 +886,9 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
<dd> <dd>
<p> <p>
Download a file using N connections. Download a file using N connections.
If more than N URLs are given, first N URLs are used and remaining URLs are If more than N URIs are given, first N URIs are used and remaining URIs are
used for backup. used for backup.
If less than N URLs are given, those URLs are used more than once so that N If less than N URIs are given, those URIs are used more than once so that N
connections total are made simultaneously. connections total are made simultaneously.
Please see <strong>-j</strong> option too. Please see <strong>-j</strong> option too.
Please note that in Metalink download, this option has no effect and use Please note that in Metalink download, this option has no effect and use
@ -987,7 +987,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Set HTTP user. This affects all URLs. Set HTTP user. This affects all URIs.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -995,7 +995,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Set HTTP password. This affects all URLs. Set HTTP password. This affects all URIs.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -1004,7 +1004,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
<dd> <dd>
<p> <p>
Use this proxy server for HTTP. To erase previously defined proxy, Use this proxy server for HTTP. To erase previously defined proxy,
use "". See also <strong>--all-proxy</strong> option. This affects all URLs. The use "". See also <strong>--all-proxy</strong> option. This affects all URIs. The
format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>] format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>]
</p> </p>
</dd> </dd>
@ -1029,7 +1029,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
<dd> <dd>
<p> <p>
Use this proxy server for HTTPS. To erase previously defined proxy, Use this proxy server for HTTPS. To erase previously defined proxy,
use "". See also <strong>--all-proxy</strong> option. This affects all URLs. The use "". See also <strong>--all-proxy</strong> option. This affects all URIs. The
format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>] format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>]
</p> </p>
</dd> </dd>
@ -1065,7 +1065,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Set Referer. This affects all URLs. Set Referer. This affects all URIs.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -1152,7 +1152,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Set FTP user. This affects all URLs. Set FTP user. This affects all URIs.
Default: <em>anonymous</em> Default: <em>anonymous</em>
</p> </p>
</dd> </dd>
@ -1161,7 +1161,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Set FTP password. This affects all URLs. Set FTP password. This affects all URIs.
If user name is embedded but password is missing in URI, aria2 tries If user name is embedded but password is missing in URI, aria2 tries
to resolve password using .netrc. If password is found in .netrc, to resolve password using .netrc. If password is found in .netrc,
then use it as password. If not, use the password specified in this then use it as password. If not, use the password specified in this
@ -1185,7 +1185,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"</td>
<dd> <dd>
<p> <p>
Use this proxy server for FTP. To erase previously defined proxy, Use this proxy server for FTP. To erase previously defined proxy,
use "". See also <strong>--all-proxy</strong> option. This affects all URLs. The use "". See also <strong>--all-proxy</strong> option. This affects all URIs. The
format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>] format of PROXY is [<a href="http://][USER:PASSWORD@]HOST[:PORT">http://][USER:PASSWORD@]HOST[:PORT</a>]
</p> </p>
</dd> </dd>
@ -2107,8 +2107,8 @@ an argument, then the option name and its argument should be concatenated(e.g.
<em>-Vfalse</em>). If any spaces are inserted between the option name and the argument, <em>-Vfalse</em>). 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.</p></div> the argument will be treated as URI and usually this is not what you expect.</p></div>
<h3 id="_uri_magnet_torrent_file_metalink_file">URI, MAGNET, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div> <h3 id="_uri_magnet_torrent_file_metalink_file">URI, MAGNET, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div>
<div class="paragraph"><p>You can specify multiple URLs in command-line. Unless you specify <div class="paragraph"><p>You can specify multiple URIs in command-line. Unless you specify
<strong>-Z</strong> option, all URLs must point to the same file or downloading will <strong>-Z</strong> option, all URIs must point to the same file or downloading will
fail.</p></div> fail.</p></div>
<div class="paragraph"><p>You can specify arbitrary number of BitTorrent Magnet URI. Please note <div class="paragraph"><p>You can specify arbitrary number of BitTorrent Magnet URI. Please note
that they are always treated as a separate download. Both hex encoded that they are always treated as a separate download. Both hex encoded
@ -2119,31 +2119,32 @@ recommended to always quote URI with single(') or double(") quotation.
It is strongly recommended to enable DHT especially when "tr" It is strongly recommended to enable DHT especially when "tr"
parameter is missing. See <a href="http://www.bittorrent.org/beps/bep_0009.html">http://www.bittorrent.org/beps/bep_0009.html</a> parameter is missing. See <a href="http://www.bittorrent.org/beps/bep_0009.html">http://www.bittorrent.org/beps/bep_0009.html</a>
for more details about BitTorrent Magnet URI.</p></div> for more details about BitTorrent Magnet URI.</p></div>
<div class="paragraph"><p>You can also specify arbitrary number of torrent files and metalink files <div class="paragraph"><p>You can also specify arbitrary number of torrent files and Metalink
stored on a local drive. Please note that they are always treated as a documents stored on a local drive. Please note that they are always
separate download.</p></div> treated as a separate download. Both Metalink4 and Metalink version
<div class="paragraph"><p>You can specify both torrent file with -T option and URLs. By doing 3.0 are supported.</p></div>
<div class="paragraph"><p>You can specify both torrent file with -T option and URIs. By doing
this, you can download a file from both torrent swarm and HTTP(S)/FTP 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 server at the same time, while the data from HTTP(S)/FTP are uploaded
to the torrent swarm. For single file torrents, URL can be a complete to the torrent swarm. For single file torrents, URI can be a complete
URL pointing to the resource or if URL ends with /, name in torrent URI pointing to the resource or if URI ends with /, name in torrent
file in torrent is added. For multi-file torrents, name and path are file in torrent is added. For multi-file torrents, name and path are
added to form a URL for each file.</p></div> added to form a URI for each file.</p></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
<td class="icon"> <td class="icon">
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">Make sure that URL is quoted with single(') or double(") quotation if it <td class="content">Make sure that URI is quoted with single(') or double(") quotation if it
contains "&amp;" or any characters that have special meaning in shell.</td> contains "&amp;" or any characters that have special meaning in shell.</td>
</tr></table> </tr></table>
</div> </div>
<h3 id="_resuming_download">Resuming Download</h3><div style="clear:left"></div> <h3 id="_resuming_download">Resuming Download</h3><div style="clear:left"></div>
<div class="paragraph"><p>Usually, you can resume transfer by just issuing same command(aria2c <div class="paragraph"><p>Usually, you can resume transfer by just issuing same command(aria2c
URL) if the previous transfer is made by aria2.</p></div> URI) if the previous transfer is made by aria2.</p></div>
<div class="paragraph"><p>If the previous transfer is made by a browser or wget like sequential <div class="paragraph"><p>If the previous transfer is made by a browser or wget like sequential
download manager, then use -c option to continue the transfer(aria2c download manager, then use -c option to continue the transfer(aria2c
<strong>-c</strong> URL).</p></div> <strong>-c</strong> URI).</p></div>
</div> </div>
<h2 id="_exit_status">EXIT STATUS</h2> <h2 id="_exit_status">EXIT STATUS</h2>
<div class="sectionbody"> <div class="sectionbody">
@ -3588,7 +3589,7 @@ pprint(r)</tt></pre>
<td class="icon"> <td class="icon">
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">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.</td> <td class="content">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 URIs as long as they are pointing to the same file.</td>
</tr></table> </tr></table>
</div> </div>
<h4 id="_download_a_file_from_2_different_http_servers">Download a file from 2 different HTTP servers</h4> <h4 id="_download_a_file_from_2_different_http_servers">Download a file from 2 different HTTP servers</h4>
@ -3915,7 +3916,7 @@ checksums.</td>
<div class="content"> <div class="content">
<pre><tt>aria2c -Z -P "http://host/image[A-Z:2].png"</tt></pre> <pre><tt>aria2c -Z -P "http://host/image[A-Z:2].png"</tt></pre>
</div></div> </div></div>
<h4 id="_parallel_downloads_of_arbitrary_number_of_url_metalink_torrent">Parallel downloads of arbitrary number of URL,metalink,torrent</h4> <h4 id="_parallel_downloads_of_arbitrary_number_of_uri_metalink_torrent">Parallel downloads of arbitrary number of URI,metalink,torrent</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink</tt></pre> <pre><tt>aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink</tt></pre>
@ -3964,7 +3965,7 @@ files in the program, then also delete it here.</p></div>
<div id="footnotes"><hr /></div> <div id="footnotes"><hr /></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2010-03-12 00:27:52 JST Last updated 2010-03-13 00:35:15 JST
</div> </div>
</div> </div>
</body> </body>

55
doc/aria2c.1.txt
View File

@ -46,7 +46,7 @@ Basic Options
stdout. stdout.
*-j*, *--max-concurrent-downloads*=N:: *-j*, *--max-concurrent-downloads*=N::
Set maximum number of parallel downloads for every static (HTTP/FTP) URL, Set maximum number of parallel downloads for every static (HTTP/FTP) URI,
torrent and metalink. See also *-s* and *-C* option. torrent and metalink. See also *-s* and *-C* option.
Default: '5' Default: '5'
@ -81,7 +81,7 @@ HTTP/FTP Options
Use this proxy server for all protocols. To erase previously Use this proxy server for all protocols. To erase previously
defined proxy, use "". You can override this setting and specify a defined proxy, use "". You can override this setting and specify a
proxy server for a particular protocol using *--http-proxy*, proxy server for a particular protocol using *--http-proxy*,
*--https-proxy* and *--ftp-proxy* options. This affects all URLs. *--https-proxy* and *--ftp-proxy* options. This affects all URIs.
The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
[NOTE] [NOTE]
@ -154,7 +154,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password
[NOTE] [NOTE]
In Metalink or BitTorrent download you cannot specify file name. In Metalink or BitTorrent download you cannot specify file name.
The file name specified here is only used when the URLs fed to aria2 The file name specified here is only used when the URIs fed to aria2
are done by command line without *-i*, *-Z* option. For example: are done by command line without *-i*, *-Z* option. For example:
aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
@ -192,9 +192,9 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
*-s*, *--split*=N:: *-s*, *--split*=N::
Download a file using N connections. Download a file using N connections.
If more than N URLs are given, first N URLs are used and remaining URLs are If more than N URIs are given, first N URIs are used and remaining URIs are
used for backup. used for backup.
If less than N URLs are given, those URLs are used more than once so that N If less than N URIs are given, those URIs are used more than once so that N
connections total are made simultaneously. connections total are made simultaneously.
Please see *-j* option too. Please see *-j* option too.
Please note that in Metalink download, this option has no effect and use Please note that in Metalink download, this option has no effect and use
@ -253,15 +253,15 @@ HTTP Specific Options
using *--header* option. Default: 'true' using *--header* option. Default: 'true'
*--http-user*=USER:: *--http-user*=USER::
Set HTTP user. This affects all URLs. Set HTTP user. This affects all URIs.
*--http-passwd*=PASSWD:: *--http-passwd*=PASSWD::
Set HTTP password. This affects all URLs. Set HTTP password. This affects all URIs.
*--http-proxy*=PROXY:: *--http-proxy*=PROXY::
Use this proxy server for HTTP. To erase previously defined proxy, Use this proxy server for HTTP. To erase previously defined proxy,
use "". See also *--all-proxy* option. This affects all URLs. The use "". See also *--all-proxy* option. This affects all URIs. The
format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
*--http-proxy-passwd*=PASSWD:: *--http-proxy-passwd*=PASSWD::
@ -275,7 +275,7 @@ HTTP Specific Options
*--https-proxy*=PROXY:: *--https-proxy*=PROXY::
Use this proxy server for HTTPS. To erase previously defined proxy, Use this proxy server for HTTPS. To erase previously defined proxy,
use "". See also *--all-proxy* option. This affects all URLs. The use "". See also *--all-proxy* option. This affects all URIs. The
format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
*--https-proxy-passwd*=PASSWD:: *--https-proxy-passwd*=PASSWD::
@ -293,7 +293,7 @@ HTTP Specific Options
See also *--certificate* option. See also *--certificate* option.
*--referer*=REFERER:: *--referer*=REFERER::
Set Referer. This affects all URLs. Set Referer. This affects all URIs.
*--enable-http-keep-alive*[='true'|'false']:: *--enable-http-keep-alive*[='true'|'false']::
Enable HTTP/1.1 persistent connection. Enable HTTP/1.1 persistent connection.
@ -334,11 +334,11 @@ If aria2 is built without libsqlite3, then it doesn't support Firefox3 cookie fo
FTP Specific Options FTP Specific Options
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
*--ftp-user*=USER:: *--ftp-user*=USER::
Set FTP user. This affects all URLs. Set FTP user. This affects all URIs.
Default: 'anonymous' Default: 'anonymous'
*--ftp-passwd*=PASSWD:: *--ftp-passwd*=PASSWD::
Set FTP password. This affects all URLs. Set FTP password. This affects all URIs.
If user name is embedded but password is missing in URI, aria2 tries If user name is embedded but password is missing in URI, aria2 tries
to resolve password using .netrc. If password is found in .netrc, to resolve password using .netrc. If password is found in .netrc,
then use it as password. If not, use the password specified in this then use it as password. If not, use the password specified in this
@ -353,7 +353,7 @@ FTP Specific Options
*--ftp-proxy*=PROXY:: *--ftp-proxy*=PROXY::
Use this proxy server for FTP. To erase previously defined proxy, Use this proxy server for FTP. To erase previously defined proxy,
use "". See also *--all-proxy* option. This affects all URLs. The use "". See also *--all-proxy* option. This affects all URIs. The
format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT]
*--ftp-proxy-passwd*=PASSWD:: *--ftp-proxy-passwd*=PASSWD::
@ -866,8 +866,8 @@ the argument will be treated as URI and usually this is not what you expect.
URI, MAGNET, TORRENT_FILE, METALINK_FILE URI, MAGNET, TORRENT_FILE, METALINK_FILE
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can specify multiple URLs in command-line. Unless you specify You can specify multiple URIs in command-line. Unless you specify
*-Z* option, all URLs must point to the same file or downloading will *-Z* option, all URIs must point to the same file or downloading will
fail. fail.
You can specify arbitrary number of BitTorrent Magnet URI. Please note You can specify arbitrary number of BitTorrent Magnet URI. Please note
@ -880,31 +880,32 @@ It is strongly recommended to enable DHT especially when "tr"
parameter is missing. See http://www.bittorrent.org/beps/bep_0009.html parameter is missing. See http://www.bittorrent.org/beps/bep_0009.html
for more details about BitTorrent Magnet URI. for more details about BitTorrent Magnet URI.
You can also specify arbitrary number of torrent files and metalink files You can also specify arbitrary number of torrent files and Metalink
stored on a local drive. Please note that they are always treated as a documents stored on a local drive. Please note that they are always
separate download. treated as a separate download. Both Metalink4 and Metalink version
3.0 are supported.
You can specify both torrent file with -T option and URLs. By doing You can specify both torrent file with -T option and URIs. By doing
this, you can download a file from both torrent swarm and HTTP(S)/FTP 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 server at the same time, while the data from HTTP(S)/FTP are uploaded
to the torrent swarm. For single file torrents, URL can be a complete to the torrent swarm. For single file torrents, URI can be a complete
URL pointing to the resource or if URL ends with /, name in torrent URI pointing to the resource or if URI ends with /, name in torrent
file in torrent is added. For multi-file torrents, name and path are file in torrent is added. For multi-file torrents, name and path are
added to form a URL for each file. added to form a URI for each file.
[NOTE] [NOTE]
Make sure that URL is quoted with single(') or double(") quotation if it Make sure that URI is quoted with single(') or double(") quotation if it
contains "&" or any characters that have special meaning in shell. contains "&" or any characters that have special meaning in shell.
Resuming Download 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. URI) 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 download manager, then use -c option to continue the transfer(aria2c
*-c* URL). *-c* URI).
EXIT STATUS EXIT STATUS
@ -1769,7 +1770,7 @@ aria2 uses 5 connections to download 1 file by default.
-s1 limits the number of connections to just 1. -s1 limits the number of connections to just 1.
[NOTE] [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. 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 URIs as long as they are pointing to the same file.
Download a file from 2 different HTTP servers Download a file from 2 different HTTP servers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -2040,7 +2041,7 @@ You can specify step counter:
aria2c -Z -P "http://host/image[A-Z:2].png" aria2c -Z -P "http://host/image[A-Z:2].png"
------------------------------------------- -------------------------------------------
Parallel downloads of arbitrary number of URL,metalink,torrent Parallel downloads of arbitrary number of URI,metalink,torrent
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------------------------- --------------------------------------------------------------
aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink aria2c -j3 -Z "http://host/file1" file2.torrent file3.metalink