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

2008-05-10 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 

Updated man page: --async-dns and --ftp-reuse-connection were 
added.
	Changed -j option's default value from 5 to 1.
	Added new examples using protocol auto detection feature.
	Removed -T, -M usage where it can be omitted.
	* doc/aria2c.1.txt
	* doc/aria2c.1.html
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2008-05-09 15:34:43 +00:00
parent 7956dab9c3
commit 698d2889ca
4 changed files with 206 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
ChangeLog
View File

@ -1,3 +1,13 @@
2008-05-10 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com>
Updated man page: --async-dns and --ftp-reuse-connection were added.
Changed -j option's default value from 5 to 1.
Added new examples using protocol auto detection feature.
Removed -T, -M usage where it can be omitted.
* doc/aria2c.1.txt
* doc/aria2c.1.html
* doc/aria2c.1.txt
2008-05-10 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2008-05-10 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com>
Updated command-line usage text, so that it tells users that they Updated command-line usage text, so that it tells users that they

111
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: 05/07/2008 .\" Date: 05/10/2008
.\" Manual: .\" Manual:
.\" Source: .\" Source:
.\" .\"
.TH "ARIA2C" "1" "05/07/2008" "" "" .TH "ARIA2C" "1" "05/10/2008" "" ""
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
@ -13,11 +13,7 @@
.SH "NAME" .SH "NAME"
aria2c - The ultra fast download utility aria2c - The ultra fast download utility
.SH "SYNOPSIS" .SH "SYNOPSIS"
\fIaria2c\fR [OPTIONS] URL \&... \fIaria2c\fR [OPTIONS] URL|TORRENT_FILE|METALINK_FILE \&...
.sp
\fIaria2c\fR [OPTIONS] \-T TORRENT_FILE [URL \&...]
.sp
\fIaria2c\fR [OPTIONS] \-M METALINK_FILE
.sp .sp
.SH "DESCRIPTION" .SH "DESCRIPTION"
aria2 is a utility for downloading files\. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum\. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm\. Using Metalink\'s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\. aria2 is a utility for downloading files\. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\. It has a powerful segmented downloading ability, downloading a file from multiple sources and multiple protocols and utilizing your download bandwidth to the maximum\. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm\. Using Metalink\'s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\.
@ -167,6 +163,12 @@ or
\fItunnel\fR \fItunnel\fR
.RE .RE
.PP .PP
\-\-ftp\-reuse\-connection[=\fItrue\fR|\fIfalse\fR]
.RS 4
Reuse connection in FTP\. Default:
\fItrue\fR
.RE
.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)\. Close connection if download speed is lower than or equal to this value(bytes per sec)\.
@ -305,8 +307,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: Set maximum number of parallel downloads\. Default:
\fI5\fR \fI1\fR
.RE .RE
.PP .PP
\-\-load\-cookies=FILE \-\-load\-cookies=FILE
@ -353,7 +355,7 @@ In multi file torrent, the adjacent files specified by this option may also be d
.PP .PP
\-T, \-\-torrent\-file=TORRENT_FILE \-T, \-\-torrent\-file=TORRENT_FILE
.RS 4 .RS 4
The path to the \.torrent file\. The path to the \.torrent file\. You may not use this option because you can specify torrent file without \-T\.
.RE .RE
.PP .PP
\-\-follow\-torrent=\fItrue\fR|\fIfalse\fR|\fImem\fR \-\-follow\-torrent=\fItrue\fR|\fIfalse\fR|\fImem\fR
@ -465,7 +467,7 @@ If true is given, aria2 doesn\'t accept and establish connection with legacy Bit
.PP .PP
\-M, \-\-metalink\-file=METALINK_FILE \-M, \-\-metalink\-file=METALINK_FILE
.RS 4 .RS 4
The file path to \.metalink file\. The file path to \.metalink file\. You may not use this option because you can specify metalink file without \-M\.
.RE .RE
.PP .PP
\-C, \-\-metalink\-servers=NUM_SERVERS \-C, \-\-metalink\-servers=NUM_SERVERS
@ -541,6 +543,12 @@ Make aria2 quite (no console output)\. Default:
\fIfalse\fR \fIfalse\fR
.RE .RE
.PP .PP
\-\-async\-dns[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable asynchronous DNS\. Default:
\fItrue\fR
.RE
.PP
\-v, \-\-version \-v, \-\-version
.RS 4 .RS 4
Print the version number, copyright and the configuration information and exit\. Print the version number, copyright and the configuration information and exit\.
@ -560,9 +568,9 @@ Default:
\fIbasic\fR \fIbasic\fR
.RE .RE
.PP .PP
URL URL, TORRENT_FILE, METALINK_FILE
.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(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\. You can specify multiple URLs\. Unless you specify \-Z option, all URLs must point to the same file or downloading will fail\. You can also specify arbitrary number of torrent files and metalink files stored in a local drive\. Please note that they are always treated as a separate download\. You can specify both torrent file with \-T option and URLs\. By doing this, 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\.
.PP .PP
Note Note
.RS 4 .RS 4
@ -645,7 +653,7 @@ Download files listed in a file concurrently
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-ifiles\.txt \-j5 aria2c \-ifiles\.txt \-j2
.fi .fi
.RE .RE
.sp .sp
@ -654,7 +662,7 @@ aria2c \-ifiles\.txt \-j5
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
\-j option specifies the number of concurrent downloads\. \-j option specifies the number of parallel downloads\.
.sp .sp
.RE .RE
.SS "Metalink Download" .SS "Metalink Download"
@ -682,7 +690,7 @@ Download using a local metalink file
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-p \-t10 \-\-lowest\-speed\-limit=4000 \-Mtest\.metalink aria2c \-p \-\-lowest\-speed\-limit=4000 file\.metalink
.fi .fi
.RE .RE
.sp .sp
@ -699,12 +707,26 @@ To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c w
.nr an-no-space-flag 1 .nr an-no-space-flag 1
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Download several local metalink files
.RS
.sp
.RS 4
.nf
aria2c \-j2 file1\.metalink file2\.metalink
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download only selected files using index Download only selected files using index
.RS .RS
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Mtest\.metalink \-\-select\-file=1\-4,8 aria2c \-\-select\-file=1\-4,8 file\.metalink
.fi .fi
.RE .RE
.sp .sp
@ -726,7 +748,7 @@ Download a file using a local .metalink file with user preference
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Mtest\.metalink \-\-metalink\-location=JP,US \-\-metalink\-version=1\.1 \-\-metalink\-language=en\-US aria2c \-\-metalink\-location=JP,US \-\-metalink\-version=1\.1 \-\-metalink\-language=en\-US \-C2 file\.metalink
.fi .fi
.RE .RE
.RE .RE
@ -755,7 +777,7 @@ Download using a local torrent file
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-\-max\-upload\-limit=40K \-Tfile\.torrent aria2c \-\-max\-upload\-limit=40K file\.torrent
.fi .fi
.RE .RE
.sp .sp
@ -780,6 +802,20 @@ To pause a download, press Ctrl\-C\. You can resume the transfer by run aria2c w
.nr an-no-space-flag 1 .nr an-no-space-flag 1
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Download 2 torrents
.RS
.sp
.RS 4
.nf
aria2c \-j2 file1\.torrent file2\.torrent
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Download a file using torrent and HTTP/FTP server Download a file using torrent and HTTP/FTP server
.RS .RS
.sp .sp
@ -807,7 +843,7 @@ Download only selected files using index(usually called "selectable download")
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Ttest\.torrent \-\-select\-file=1\-4,8 aria2c \-\-select\-file=1\-4,8 file\.torrent
.fi .fi
.RE .RE
.sp .sp
@ -829,7 +865,7 @@ Change the listening port for incoming peer
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Ttest\.torrent \-\-listen\-port=7000\-7001,8000 aria2c \-\-listen\-port=7000\-7001,8000 file\.torrent
.fi .fi
.RE .RE
.sp .sp
@ -851,7 +887,7 @@ Specify the condition to stop program after torrent download finished
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Ttest\.torrent \-\-seed\-time=120 \-\-seed\-ratio=1\.0 aria2c \-\-seed\-time=120 \-\-seed\-ratio=1\.0 file\.torrent
.fi .fi
.RE .RE
.sp .sp
@ -873,7 +909,7 @@ Throttle upload speed
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Ttest\.torrent \-\-max\-upload\-limit=100K aria2c \-\-max\-upload\-limit=100K file\.torrent
.fi .fi
.RE .RE
.RE .RE
@ -887,7 +923,7 @@ Enable DHT
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Ttest\.torrent \-\-enable\-dht \-\-dht\-listen\-port=6881 aria2c \-\-enable\-dht \-\-dht\-listen\-port=6881 file\.torrent
.fi .fi
.RE .RE
.sp .sp
@ -947,7 +983,7 @@ Throttle download speed
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Mtest\.metalink \-\-max\-download\-limit=100K aria2c \-\-max\-download\-limit=100K file\.metalink
.fi .fi
.RE .RE
.RE .RE
@ -961,7 +997,7 @@ Repair a damaged download using --check-integrity option
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Mtest\.metalink \-\-check\-integrity=true aria2c \-\-check\-integrity=true file\.metalink
.fi .fi
.RE .RE
.sp .sp
@ -983,7 +1019,7 @@ Drop connection if download speed is lower than specified value
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Mtest\.metalink \-\-lowest\-speed\-limit=10K aria2c \-\-lowest\-speed\-limit=10K file\.metalink
.fi .fi
.RE .RE
.RE .RE
@ -1033,6 +1069,20 @@ aria2c \-Z \-P http://host/image[A\-Z:2]\.png
.nr an-no-space-flag 1 .nr an-no-space-flag 1
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Parallel downloads of arbitrary number of URL,metalink,torrent
.RS
.sp
.RS 4
.nf
aria2c \-j3 \-Z http://host/file1 file2\.torrent file3\.metalink
.fi
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
BitTorrent Encryption BitTorrent Encryption
.RS .RS
Encrypt whole payload using ARC4: Encrypt whole payload using ARC4:
@ -1040,7 +1090,7 @@ Encrypt whole payload using ARC4:
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-Tfile\.torrent \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true aria2c \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true file\.torrent
.fi .fi
.RE .RE
.RE .RE
@ -1062,7 +1112,7 @@ You can seed downloaded file using \-\-check\-integrity=true option\.
.sp .sp
.RS 4 .RS 4
.nf .nf
aria2c \-\-check\-integrity=true \-T file\.torrent aria2c \-\-check\-integrity=true file\.torrent
.fi .fi
.RE .RE
.SH "FILES" .SH "FILES"
@ -1073,10 +1123,9 @@ User configuration file\. It must be placed under $HOME/\.aria2 and must be name
.RS 4 .RS 4
.nf .nf
# sample configuration file for aria2c # sample configuration file for aria2c
file\-allocation=prealloc
listen\-port=60000 listen\-port=60000
seed\-ratio=1\.0 seed\-ratio=1\.0
max\-upload\-limit=100K max\-upload\-limit=50K
ftp\-pasv=true ftp\-pasv=true
.fi .fi
.RE .RE

88
doc/aria2c.1.html
View File

@ -312,9 +312,7 @@ div#toc a:visited { color: blue; }
</div> </div>
<h2>SYNOPSIS</h2> <h2>SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<p><em>aria2c</em> [OPTIONS] URL &#8230;</p> <p><em>aria2c</em> [OPTIONS] URL|TORRENT_FILE|METALINK_FILE &#8230;</p>
<p><em>aria2c</em> [OPTIONS] -T TORRENT_FILE [URL &#8230;]</p>
<p><em>aria2c</em> [OPTIONS] -M METALINK_FILE</p>
</div> </div>
<h2>DESCRIPTION</h2> <h2>DESCRIPTION</h2>
<div class="sectionbody"> <div class="sectionbody">
@ -521,6 +519,15 @@ Note
</p> </p>
</dd> </dd>
<dt> <dt>
&#8212;ftp-reuse-connection[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Reuse connection in FTP.
Default: <em>true</em>
</p>
</dd>
<dt>
&#8212;lowest-speed-limit=SPEED &#8212;lowest-speed-limit=SPEED
</dt> </dt>
<dd> <dd>
@ -728,9 +735,8 @@ Note
</dt> </dt>
<dd> <dd>
<p> <p>
Set maximum number of concurrent downloads. Set maximum number of parallel downloads.
It should be used with the -i option. Default: <em>1</em>
Default: <em>5</em>
</p> </p>
</dd> </dd>
<dt> <dt>
@ -812,6 +818,7 @@ Note
<dd> <dd>
<p> <p>
The path to the .torrent file. The path to the .torrent file.
You may not use this option because you can specify torrent file without -T.
</p> </p>
</dd> </dd>
<dt> <dt>
@ -972,7 +979,8 @@ Note
</dt> </dt>
<dd> <dd>
<p> <p>
The file path to .metalink file. The file path to .metalink file. You may not use this option because you can
specify metalink file without -M.
</p> </p>
</dd> </dd>
<dt> <dt>
@ -1076,6 +1084,15 @@ Note
</p> </p>
</dd> </dd>
<dt> <dt>
&#8212;async-dns[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
Enable asynchronous DNS.
Default: <em>true</em>
</p>
</dd>
<dt>
-v, &#8212;version -v, &#8212;version
</dt> </dt>
<dd> <dd>
@ -1100,12 +1117,15 @@ Note
</p> </p>
</dd> </dd>
<dt> <dt>
URL URL, TORRENT_FILE, METALINK_FILE
</dt> </dt>
<dd> <dd>
<p> <p>
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 also specify arbitrary number of torrent files and metalink files
stored in a local drive. Please note that they are always treated as a
separate download.
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(S)/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(S)/FTP are uploaded to the torrent swarm. Note that while the data from HTTP(S)/FTP are uploaded to the torrent swarm. Note that
@ -1159,14 +1179,14 @@ Note
<h4>Download files listed in a file concurrently</h4> <h4>Download files listed in a file concurrently</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -ifiles.txt -j5</tt></pre> <pre><tt>aria2c -ifiles.txt -j2</tt></pre>
</div></div> </div></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">-j option specifies the number of concurrent downloads.</td> <td class="content">-j option specifies the number of parallel downloads.</td>
</tr></table> </tr></table>
</div> </div>
<h3>Metalink Download</h3> <h3>Metalink Download</h3>
@ -1178,7 +1198,7 @@ Note
<h4>Download using a local metalink file</h4> <h4>Download using a local metalink file</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -p -t10 --lowest-speed-limit=4000 -Mtest.metalink</tt></pre> <pre><tt>aria2c -p --lowest-speed-limit=4000 file.metalink</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1190,10 +1210,15 @@ You can resume the transfer by run aria2c with the same argument at the same
directory.</td> directory.</td>
</tr></table> </tr></table>
</div> </div>
<h4>Download several local metalink files</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -j2 file1.metalink file2.metalink</tt></pre>
</div></div>
<h4>Download only selected files using index</h4> <h4>Download only selected files using index</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Mtest.metalink --select-file=1-4,8</tt></pre> <pre><tt>aria2c --select-file=1-4,8 file.metalink</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1206,7 +1231,7 @@ directory.</td>
<h4>Download a file using a local .metalink file with user preference</h4> <h4>Download a file using a local .metalink file with user preference</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Mtest.metalink --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US</tt></pre> <pre><tt>aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US -C2 file.metalink</tt></pre>
</div></div> </div></div>
<h3>BitTorrent Download</h3> <h3>BitTorrent Download</h3>
<h4>Download files from remote BitTorrent file</h4> <h4>Download files from remote BitTorrent file</h4>
@ -1217,7 +1242,7 @@ directory.</td>
<h4>Download using a local torrent file</h4> <h4>Download using a local torrent file</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c --max-upload-limit=40K -Tfile.torrent</tt></pre> <pre><tt>aria2c --max-upload-limit=40K file.torrent</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1235,6 +1260,11 @@ directory.</td>
<td class="content">To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.</td> <td class="content">To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.</td>
</tr></table> </tr></table>
</div> </div>
<h4>Download 2 torrents</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -j2 file1.torrent file2.torrent</tt></pre>
</div></div>
<h4>Download a file using torrent and HTTP/FTP server</h4> <h4>Download a file using torrent and HTTP/FTP server</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
@ -1251,7 +1281,7 @@ directory.</td>
<h4>Download only selected files using index(usually called "selectable download")</h4> <h4>Download only selected files using index(usually called "selectable download")</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Ttest.torrent --select-file=1-4,8</tt></pre> <pre><tt>aria2c --select-file=1-4,8 file.torrent</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1264,7 +1294,7 @@ directory.</td>
<h4>Change the listening port for incoming peer</h4> <h4>Change the listening port for incoming peer</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Ttest.torrent --listen-port=7000-7001,8000</tt></pre> <pre><tt>aria2c --listen-port=7000-7001,8000 file.torrent</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1278,7 +1308,7 @@ to you to do it manually.</td>
<h4>Specify the condition to stop program after torrent download finished</h4> <h4>Specify the condition to stop program after torrent download finished</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Ttest.torrent --seed-time=120 --seed-ratio=1.0</tt></pre> <pre><tt>aria2c --seed-time=120 --seed-ratio=1.0 file.torrent</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1291,12 +1321,12 @@ to you to do it manually.</td>
<h4>Throttle upload speed</h4> <h4>Throttle upload speed</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Ttest.torrent --max-upload-limit=100K</tt></pre> <pre><tt>aria2c --max-upload-limit=100K file.torrent</tt></pre>
</div></div> </div></div>
<h4>Enable DHT</h4> <h4>Enable DHT</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Ttest.torrent --enable-dht --dht-listen-port=6881</tt></pre> <pre><tt>aria2c --enable-dht --dht-listen-port=6881 file.torrent</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1330,12 +1360,12 @@ forwarding, it's up to you to do it manually.</td>
<h4>Throttle download speed</h4> <h4>Throttle download speed</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Mtest.metalink --max-download-limit=100K</tt></pre> <pre><tt>aria2c --max-download-limit=100K file.metalink</tt></pre>
</div></div> </div></div>
<h4>Repair a damaged download using &#8212;check-integrity option</h4> <h4>Repair a damaged download using &#8212;check-integrity option</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Mtest.metalink --check-integrity=true</tt></pre> <pre><tt>aria2c --check-integrity=true file.metalink</tt></pre>
</div></div> </div></div>
<div class="admonitionblock"> <div class="admonitionblock">
<table><tr> <table><tr>
@ -1349,7 +1379,7 @@ checksums.</td>
<h4>Drop connection if download speed is lower than specified value</h4> <h4>Drop connection if download speed is lower than specified value</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Mtest.metalink --lowest-speed-limit=10K</tt></pre> <pre><tt>aria2c --lowest-speed-limit=10K file.metalink</tt></pre>
</div></div> </div></div>
<h4>Parameterized URI support</h4> <h4>Parameterized URI support</h4>
<p>You can specify set of parts:</p> <p>You can specify set of parts:</p>
@ -1375,11 +1405,16 @@ 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>Parallel downloads of arbitrary number of URL,metalink,torrent</h4>
<div class="listingblock">
<div class="content">
<pre><tt>aria2c -j3 -Z http://host/file1 file2.torrent file3.metalink</tt></pre>
</div></div>
<h4>BitTorrent Encryption</h4> <h4>BitTorrent Encryption</h4>
<p>Encrypt whole payload using ARC4:</p> <p>Encrypt whole payload using ARC4:</p>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -Tfile.torrent --bt-min-crypto-level=arc4 --bt-require-crypto=true</tt></pre> <pre><tt>aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent</tt></pre>
</div></div> </div></div>
</div> </div>
<h2>RESUME DOWNLOAD</h2> <h2>RESUME DOWNLOAD</h2>
@ -1414,7 +1449,7 @@ you can resume the download without a control file by giving
<p>You can seed downloaded file using &#8212;check-integrity=true option.</p> <p>You can seed downloaded file using &#8212;check-integrity=true option.</p>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c --check-integrity=true -T file.torrent</tt></pre> <pre><tt>aria2c --check-integrity=true file.torrent</tt></pre>
</div></div> </div></div>
</div> </div>
<h2>FILES</h2> <h2>FILES</h2>
@ -1428,10 +1463,9 @@ The lines beginning <em>#</em> are treated as comments.</p>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt># sample configuration file for aria2c <pre><tt># sample configuration file for aria2c
file-allocation=prealloc
listen-port=60000 listen-port=60000
seed-ratio=1.0 seed-ratio=1.0
max-upload-limit=100K max-upload-limit=50K
ftp-pasv=true</tt></pre> ftp-pasv=true</tt></pre>
</div></div> </div></div>
<h3>dht.dat</h3> <h3>dht.dat</h3>
@ -1479,7 +1513,7 @@ files in the program, then also delete it here.</p>
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 07-May-2008 00:39:10 JST Last updated 10-May-2008 00:23:19 JST
</div> </div>
</div> </div>
</body> </body>

85
doc/aria2c.1.txt
View File

@ -8,11 +8,7 @@ aria2c - The ultra fast download utility
SYNOPSIS SYNOPSIS
-------- --------
'aria2c' [OPTIONS] URL ... 'aria2c' [OPTIONS] URL|TORRENT_FILE|METALINK_FILE ...
'aria2c' [OPTIONS] -T TORRENT_FILE [URL ...]
'aria2c' [OPTIONS] -M METALINK_FILE
DESCRIPTION DESCRIPTION
----------- -----------
@ -104,6 +100,10 @@ OPTIONS
Use HTTP proxy in FTP. METHOD is either 'get' or 'tunnel'. Use HTTP proxy in FTP. METHOD is either 'get' or 'tunnel'.
Default: 'tunnel' Default: 'tunnel'
--ftp-reuse-connection[='true'|'false']::
Reuse connection in FTP.
Default: 'true'
--lowest-speed-limit=SPEED:: --lowest-speed-limit=SPEED::
Close connection if download speed is lower than or equal to this Close connection if download speed is lower than or equal to this
value(bytes per sec). value(bytes per sec).
@ -210,9 +210,8 @@ OPTIONS
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 parallel downloads.
It should be used with the -i option. Default: '1'
Default: '5'
--load-cookies=FILE:: --load-cookies=FILE::
Load cookies from FILE. Load cookies from FILE.
@ -251,6 +250,7 @@ OPTIONS
-T, --torrent-file=TORRENT_FILE:: -T, --torrent-file=TORRENT_FILE::
The path to the .torrent file. The path to the .torrent file.
You may not use this option because you can specify torrent file without -T.
--follow-torrent='true'|'false'|'mem':: --follow-torrent='true'|'false'|'mem'::
If 'true' or 'mem' is specified, when a file whose suffix is ".torrent" or content If 'true' or 'mem' is specified, when a file whose suffix is ".torrent" or content
@ -333,7 +333,8 @@ OPTIONS
Default: 'false' Default: 'false'
-M, --metalink-file=METALINK_FILE:: -M, --metalink-file=METALINK_FILE::
The file path to .metalink file. The file path to .metalink file. You may not use this option because you can
specify metalink file without -M.
-C, --metalink-servers=NUM_SERVERS:: -C, --metalink-servers=NUM_SERVERS::
The number of servers to connect to simultaneously. The number of servers to connect to simultaneously.
@ -385,6 +386,10 @@ OPTIONS
Make aria2 quite (no console output). Make aria2 quite (no console output).
Default: 'false' Default: 'false'
--async-dns[='true'|'false']::
Enable asynchronous DNS.
Default: 'true'
-v, --version:: -v, --version::
Print the version number, copyright and the configuration information and Print the version number, copyright and the configuration information and
exit. exit.
@ -399,9 +404,12 @@ OPTIONS
'bittorrent', 'all' 'bittorrent', 'all'
Default: 'basic' Default: 'basic'
URL:: URL, TORRENT_FILE, METALINK_FILE::
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 also specify arbitrary number of torrent files and metalink files
stored in a local drive. Please note that they are always treated as a
separate download.
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(S)/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(S)/FTP are uploaded to the torrent swarm. Note that while the data from HTTP(S)/FTP are uploaded to the torrent swarm. Note that
@ -443,10 +451,10 @@ aria2c http://host1/file.zip ftp://host2/file.zip
Download files listed in a file concurrently Download files listed in a file concurrently
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------ ------------------------
aria2c -ifiles.txt -j5 aria2c -ifiles.txt -j2
------------------------ ------------------------
[NOTE] [NOTE]
-j option specifies the number of concurrent downloads. -j option specifies the number of parallel downloads.
Metalink Download Metalink Download
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -459,17 +467,23 @@ aria2c --follow-metalink=mem http://host/file.metalink
Download using a local metalink file Download using a local metalink file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------------------- ----------------------------------------------------------
aria2c -p -t10 --lowest-speed-limit=4000 -Mtest.metalink aria2c -p --lowest-speed-limit=4000 file.metalink
---------------------------------------------------------- ----------------------------------------------------------
[NOTE] [NOTE]
To pause a download, press Ctrl-C. To pause a download, press Ctrl-C.
You can resume the transfer by run aria2c with the same argument at the same You can resume the transfer by run aria2c with the same argument at the same
directory. directory.
Download several local metalink files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------------------
aria2c -j2 file1.metalink file2.metalink
----------------------------------------
Download only selected files using index Download only selected files using index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------- -------------------------------------------
aria2c -Mtest.metalink --select-file=1-4,8 aria2c --select-file=1-4,8 file.metalink
------------------------------------------- -------------------------------------------
[NOTE] [NOTE]
The index is printed to the console using -S option. The index is printed to the console using -S option.
@ -477,7 +491,7 @@ The index is printed to the console using -S option.
Download a file using a local .metalink file with user preference Download a file using a local .metalink file with user preference
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
aria2c -Mtest.metalink --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US aria2c --metalink-location=JP,US --metalink-version=1.1 --metalink-language=en-US -C2 file.metalink
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
BitTorrent Download BitTorrent Download
@ -491,7 +505,7 @@ aria2c --follow-bittorrent=mem http://host/file.torrent
Download using a local torrent file Download using a local torrent file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--------------------------------------------- ---------------------------------------------
aria2c --max-upload-limit=40K -Tfile.torrent aria2c --max-upload-limit=40K file.torrent
--------------------------------------------- ---------------------------------------------
[NOTE] [NOTE]
--max-upload-limit specifies the max of upload rate. --max-upload-limit specifies the max of upload rate.
@ -499,6 +513,12 @@ aria2c --max-upload-limit=40K -Tfile.torrent
[NOTE] [NOTE]
To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory. To pause a download, press Ctrl-C. You can resume the transfer by run aria2c with the same argument at the same directory.
Download 2 torrents
^^^^^^^^^^^^^^^^^^^
--------------------------------------
aria2c -j2 file1.torrent file2.torrent
--------------------------------------
Download a file using torrent and HTTP/FTP server Download a file using torrent and HTTP/FTP server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------------------------------------- -----------------------------------------------------------
@ -509,16 +529,16 @@ Downloading multi file torrent with HTTP/FTP is not supported.
Download only selected files using index(usually called "selectable download") Download only selected files using index(usually called "selectable download")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------ ---------------------------------------
aria2c -Ttest.torrent --select-file=1-4,8 aria2c --select-file=1-4,8 file.torrent
------------------------------------------ ---------------------------------------
[NOTE] [NOTE]
The index is printed to the console using -S option. The index is printed to the console using -S option.
Change the listening port for incoming peer Change the listening port for incoming peer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--------------------------------------------------- ---------------------------------------------------
aria2c -Ttest.torrent --listen-port=7000-7001,8000 aria2c --listen-port=7000-7001,8000 file.torrent
--------------------------------------------------- ---------------------------------------------------
[NOTE] [NOTE]
Since aria2 doesn't configure firewall or router for port forwarding, it's up Since aria2 doesn't configure firewall or router for port forwarding, it's up
@ -527,7 +547,7 @@ to you to do it manually.
Specify the condition to stop program after torrent download finished Specify the condition to stop program after torrent download finished
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------------- -------------------------------------------------------
aria2c -Ttest.torrent --seed-time=120 --seed-ratio=1.0 aria2c --seed-time=120 --seed-ratio=1.0 file.torrent
------------------------------------------------------- -------------------------------------------------------
[NOTE] [NOTE]
@ -536,13 +556,13 @@ In the above example, the program exists when the 120 minutes has elapsed since
Throttle upload speed Throttle upload speed
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------- ----------------------------------------------
aria2c -Ttest.torrent --max-upload-limit=100K aria2c --max-upload-limit=100K file.torrent
---------------------------------------------- ----------------------------------------------
Enable DHT Enable DHT
^^^^^^^^^^ ^^^^^^^^^^
--------------------------------------------------------- ---------------------------------------------------------
aria2c -Ttest.torrent --enable-dht --dht-listen-port=6881 aria2c --enable-dht --dht-listen-port=6881 file.torrent
--------------------------------------------------------- ---------------------------------------------------------
[NOTE] [NOTE]
DHT uses udp port. Since aria2 doesn't configure firewall or router for port DHT uses udp port. Since aria2 doesn't configure firewall or router for port
@ -569,13 +589,13 @@ And more advanced features
Throttle download speed Throttle download speed
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------- -------------------------------------------------
aria2c -Mtest.metalink --max-download-limit=100K aria2c --max-download-limit=100K file.metalink
------------------------------------------------- -------------------------------------------------
Repair a damaged download using --check-integrity option Repair a damaged download using --check-integrity option
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------- ----------------------------------------------
aria2c -Mtest.metalink --check-integrity=true aria2c --check-integrity=true file.metalink
---------------------------------------------- ----------------------------------------------
[NOTE] [NOTE]
This option is only available used with BitTorrent or metalink with chunk This option is only available used with BitTorrent or metalink with chunk
@ -584,7 +604,7 @@ checksums.
Drop connection if download speed is lower than specified value Drop connection if download speed is lower than specified value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------ ------------------------------------------------
aria2c -Mtest.metalink --lowest-speed-limit=10K aria2c --lowest-speed-limit=10K file.metalink
------------------------------------------------ ------------------------------------------------
Parameterized URI support Parameterized URI support
@ -607,11 +627,17 @@ 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------------------------------
aria2c -j3 -Z http://host/file1 file2.torrent file3.metalink
------------------------------------------------------------
BitTorrent Encryption BitTorrent Encryption
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Encrypt whole payload using ARC4: Encrypt whole payload using ARC4:
------------------------------------------------------------------------- -------------------------------------------------------------------------
aria2c -Tfile.torrent --bt-min-crypto-level=arc4 --bt-require-crypto=true aria2c --bt-min-crypto-level=arc4 --bt-require-crypto=true file.torrent
------------------------------------------------------------------------- -------------------------------------------------------------------------
RESUME DOWNLOAD RESUME DOWNLOAD
@ -648,7 +674,7 @@ SEEDING DOWNLOADED FILE IN BITTORRENT
------------------------------------- -------------------------------------
You can seed downloaded file using --check-integrity=true option. You can seed downloaded file using --check-integrity=true option.
--------------------------------------------- ---------------------------------------------
aria2c --check-integrity=true -T file.torrent aria2c --check-integrity=true file.torrent
--------------------------------------------- ---------------------------------------------
FILES FILES
@ -663,10 +689,9 @@ The lines beginning '#' are treated as comments.
-------------------------------------- --------------------------------------
# sample configuration file for aria2c # sample configuration file for aria2c
file-allocation=prealloc
listen-port=60000 listen-port=60000
seed-ratio=1.0 seed-ratio=1.0
max-upload-limit=100K max-upload-limit=50K
ftp-pasv=true ftp-pasv=true
-------------------------------------- --------------------------------------