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

Fixed compile error with asciidoc. 

Generated man page and html.
pull/1/head
Tatsuhiro Tsujikawa 2008-11-28 14:32:22 +00:00
parent 796f8373cd
commit 1aef3cd005
3 changed files with 75 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
doc/aria2c.1
View File

@ -1,11 +1,11 @@
.\" Title: aria2c .\" Title: aria2c
.\" Author: .\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: 11/20/2008 .\" Date: 11/28/2008
.\" Manual: .\" Manual:
.\" Source: .\" Source:
.\" .\"
.TH "ARIA2C" "1" "11/20/2008" "" "" .TH "ARIA2C" "1" "11/28/2008" "" ""
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
@ -16,7 +16,7 @@ aria2c \- The ultra fast download utility
aria2c [\fIOPTIONS\fR] [\fIURL\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&... aria2c [\fIOPTIONS\fR] [\fIURL\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&...
.sp .sp
.SH "DESCRIPTION" .SH "DESCRIPTION"
aria2 is a utility for downloading files\&. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\&. It can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth\&. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm\&. Using Metalink\'s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\&. aria2 is a utility for downloading files\&. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\&. aria2 can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth\&. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm\&. Using Metalink\'s chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\&.
.sp .sp
.SH "OPTIONS" .SH "OPTIONS"
.SS "Basic Options" .SS "Basic Options"
@ -82,7 +82,7 @@ Default:
.PP .PP
\fB\-\-all\-proxy\fR=PROXY \fB\-\-all\-proxy\fR=PROXY
.RS 4 .RS 4
Use this proxy server in the all protocols\&. You can override this setting and specify a proxy server for particular proctol using Use this proxy server for all protocols\&. You can override this setting and specify a proxy server for a particular proctol using
\fB\-\-http\-proxy\fR, \fB\-\-http\-proxy\fR,
\fB\-\-https\-proxy\fR \fB\-\-https\-proxy\fR
and and
@ -113,7 +113,7 @@ or
.RS 4 .RS 4
If aria2 recieves `file not found\' status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify If aria2 recieves `file not found\' status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify
\fI0\fR \fI0\fR
to disable this option\&. This options is only effective only when using HTTP/FTP servers\&. Default: to disable this option\&. This options is effective only when using HTTP/FTP servers\&. Default:
\fI0\fR \fI0\fR
.RE .RE
.PP .PP
@ -127,7 +127,7 @@ means unlimited\&. Default:
.PP .PP
\fB\-\-no\-proxy\fR=DOMAINS \fB\-\-no\-proxy\fR=DOMAINS
.RS 4 .RS 4
Specify comma separated hostnames or domains to which proxy should not be used\&. Specify comma separated hostnames or domains where proxy should not be used\&.
.RE .RE
.PP .PP
\fB\-o\fR, \fB\-\-out\fR=FILE \fB\-o\fR, \fB\-\-out\fR=FILE
@ -140,7 +140,7 @@ The file name of the downloaded file\&.
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
In Metalink, BitTorrent download you cannot specify file name\&. The file name specified here is only used when the URLs fed to aria2 is done by command line without \fB\-i\fR, \fB\-Z\fR option\&. 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 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
.PP .PP
\fB\-\-proxy\-method\fR=METHOD \fB\-\-proxy\-method\fR=METHOD
.RS 4 .RS 4
@ -313,7 +313,7 @@ Append HEADER to HTTP request header\&. You can use this option repeatedly to sp
.PP .PP
\fB\-\-load\-cookies\fR=FILE \fB\-\-load\-cookies\fR=FILE
.RS 4 .RS 4
Load Cookies from FILE using the Firefox3 format(SQLite3) and the Mozilla/Firefox(1\&.x/2\&.x)/Netscape format\&. Load Cookies from FILE using the Firefox3 format (SQLite3) and the Mozilla/Firefox(1\&.x/2\&.x)/Netscape format\&.
.RE .RE
.sp .sp
.it 1 an-trap .it 1 an-trap
@ -321,7 +321,7 @@ Load Cookies from FILE using the Firefox3 format(SQLite3) and the Mozilla/Firefo
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
If aria2 is build without libsqlite3, then it doesn\'t support Firefox3 cookie\&. If aria2 is built without libsqlite3, then it doesn\'t support Firefox3 cookie format\&.
.PP .PP
\fB\-U\fR, \fB\-\-user\-agent\fR=USER_AGENT \fB\-U\fR, \fB\-\-user\-agent\fR=USER_AGENT
.RS 4 .RS 4
@ -379,7 +379,7 @@ Disables netrc support\&. netrc support is enabled by default\&.
.PP .PP
\fB\-\-select\-file\fR=INDEX\&... \fB\-\-select\-file\fR=INDEX\&...
.RS 4 .RS 4
Set file to download by specifing its index\&. You can find the file index using the Set file to download by specifying its index\&. You can find the file index using the
\fB\-\-show\-files\fR \fB\-\-show\-files\fR
option\&. Multiple indexes can be specified by using ",", for example: option\&. Multiple indexes can be specified by using ",", for example:
\fI3,6\fR\&. You can also use "\-" to specify a range: \fI3,6\fR\&. You can also use "\-" to specify a range:
@ -409,7 +409,7 @@ Specify maximum number of files to open in each BitTorrent download\&. Default:
.PP .PP
\fB\-\-bt\-min\-crypto\-level\fR=\fIplain\fR|\fIarc4\fR \fB\-\-bt\-min\-crypto\-level\fR=\fIplain\fR|\fIarc4\fR
.RS 4 .RS 4
Set minimum level of encryption method\&. If several encryption methods are provided by a peer, aria2 chooses a lowest one which satisfies the given level\&. Default: Set minimum level of encryption method\&. If several encryption methods are provided by a peer, aria2 chooses the lowest one which satisfies the given level\&. Default:
\fIplain\fR \fIplain\fR
.RE .RE
.PP .PP
@ -524,7 +524,7 @@ Specify the prefix of peer ID\&. The peer ID in BitTorrent is 20 byte length\&.
.PP .PP
\fB\-\-seed\-ratio\fR=RATIO \fB\-\-seed\-ratio\fR=RATIO
.RS 4 .RS 4
Specify share ratio\&. Seed completed torrents until share ratio reaches] RATIO\&. I strongly encourages you to specify equals or more than Specify share ratio\&. Seed completed torrents until share ratio reaches] RATIO\&. You are strongly encouraged to specify equals or more than
\fI1\&.0\fR \fI1\&.0\fR
here\&. Specify here\&. Specify
\fI0\&.0\fR \fI0\&.0\fR
@ -543,7 +543,7 @@ option\&.
.PP .PP
\fB\-T\fR, \fB\-\-torrent\-file\fR=TORRENT_FILE \fB\-T\fR, \fB\-\-torrent\-file\fR=TORRENT_FILE
.RS 4 .RS 4
The path to the \&.torrent file\&. You may not use this option because you can specify torrent file without \-T\&. The path to the \&.torrent file\&. You are not required to use this option because you can specify a torrent file without \-T\&.
.RE .RE
.SS "Metalink Specific Options" .SS "Metalink Specific Options"
.PP .PP
@ -553,7 +553,7 @@ If
\fItrue\fR \fItrue\fR
or or
\fImem\fR \fImem\fR
is specified, when a file whose suffix is "\&.metaink" or content type is "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it\&. If is specified, when a file whose suffix is "\&.metaink" or content type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it\&. If
\fImem\fR \fImem\fR
is specified, a metalink file is not written to the disk, but is just kept in memory\&. If is specified, a metalink file is not written to the disk, but is just kept in memory\&. If
\fIfalse\fR \fIfalse\fR
@ -563,12 +563,12 @@ is specified, the action mentioned above is not taken\&. Default:
.PP .PP
\fB\-M\fR, \fB\-\-metalink\-file\fR=METALINK_FILE \fB\-M\fR, \fB\-\-metalink\-file\fR=METALINK_FILE
.RS 4 .RS 4
The file path to \&.metalink file\&. You may not use this option because you can specify metalink file without \-M\&. The file path to \&.metalink file\&. You are not required to use this option because you can specify a metalink file without \-M\&.
.RE .RE
.PP .PP
\fB\-C\fR, \fB\-\-metalink\-servers\fR=NUM_SERVERS \fB\-C\fR, \fB\-\-metalink\-servers\fR=NUM_SERVERS
.RS 4 .RS 4
The number of servers to connect to simultaneously\&. Some Metalinks regulates the number of servers to connect\&. aria2 strictly respects them\&. This means that if Metalink defines the maxconnections attribute lower than NUM_SERVERS, then aria2 uses the value of maxconnections attribute instead of NUM_SERVERS\&. See also The number of servers to connect to simultaneously\&. Some Metalinks regulate the number of servers to connect\&. aria2 strictly respects them\&. This means that if Metalink defines the maxconnections attribute lower than NUM_SERVERS, then aria2 uses the value of maxconnections attribute instead of NUM_SERVERS\&. See also
\fB\-s\fR \fB\-s\fR
and and
\fB\-j\fR \fB\-j\fR
@ -583,7 +583,7 @@ The language of the file to download\&.
.PP .PP
\fB\-\-metalink\-location\fR=LOCATION[,\&...] \fB\-\-metalink\-location\fR=LOCATION[,\&...]
.RS 4 .RS 4
The location of the preferred server\&. A comma\-deliminated list of locations is acceptable, for example, The location of the preferred server\&. A comma\-delimited list of locations is acceptable, for example,
\fIJP,US\fR\&. \fIJP,US\fR\&.
.RE .RE
.PP .PP
@ -717,7 +717,7 @@ suppresses the output\&. Default:
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
In multi file torrent, the files adjacent forward to the specified files are also allocated if they share a same piece\&. In multi file torrent downloads, the files adjacent forward to the specified files are also allocated if they share the same piece\&.
.PP .PP
\fB\-Z\fR, \fB\-\-force\-sequential\fR[=\fItrue\fR|\fIfalse\fR] \fB\-Z\fR, \fB\-\-force\-sequential\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
@ -760,13 +760,13 @@ Enable parameterized URI support\&. You can specify set of parts:
.PP .PP
\fB\-q\fR, \fB\-\-quiet\fR[=\fItrue\fR|\fIfalse\fR] \fB\-q\fR, \fB\-\-quiet\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4 .RS 4
Make aria2 quite (no console output)\&. Default: Make aria2 quiet (no console output)\&. Default:
\fIfalse\fR \fIfalse\fR
.RE .RE
.PP .PP
\fB\-\-realtime\-chunk\-checksum\fR=\fItrue\fR|\fIfalse\fR \fB\-\-realtime\-chunk\-checksum\fR=\fItrue\fR|\fIfalse\fR
.RS 4 .RS 4
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: Validate chunk of data by calculating checksum while downloading a file if chunk checksums are provided\&. Currently Metalink is the only way to provide chunk checksums\&. Default:
\fItrue\fR \fItrue\fR
.RE .RE
.PP .PP
@ -783,14 +783,14 @@ is given, this feature is disabled\&. Default:
Print the version number, copyright and the configuration information and exit\&. Print the version number, copyright and the configuration information and exit\&.
.RE .RE
.SS "OPTIONS THAT TAKE AN OPTIONAL ARGUMENT" .SS "OPTIONS THAT TAKE AN OPTIONAL ARGUMENT"
The options that have its argument surrounded by square brackets([]) take an optional argument\&. Usually ommiting the argument is evaluated to \fItrue\fR\&. If you use short form of these options(such as \fI\-V\fR) and give an arugment, 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 ommiting the argument is evaluated to \fItrue\fR\&. If you use short form of these options(such as \fI\-V\fR) and give an argument, then the option name and its argument should be concatenated(e\&.g\&. \fI\-Vfalse\fR)\&. If any spaces are inserted between the option name and the argument, the argument will be treated as URI and usually this is not what you expect\&.
.sp .sp
.SS "URL, TORRENT_FILE, METALINK_FILE" .SS "URL, TORRENT_FILE, METALINK_FILE"
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 URLs in command\-line\&. Unless you specify \fB\-Z\fR option, all URLs must point to the same file or downloading will fail\&.
.sp .sp
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 also specify arbitrary number of torrent files and metalink files stored on a local drive\&. Please note that they are always treated as a separate download\&.
.sp .sp
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 both torrent file with \-T option and URLs\&. By doing this, you can download a file from both torrent swarm and HTTP(S)/FTP server at the same time, while the data from HTTP(S)/FTP are uploaded to the torrent swarm\&. Note that only single file torrent can be integrated with HTTP(S)/FTP\&.
.sp .sp
.sp .sp
.it 1 an-trap .it 1 an-trap
@ -851,7 +851,7 @@ aria2 uses 5 connections to download 1 file by default\&. \-s1 limtis the number
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument at 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 URLs as long as they are pointing to the same file\&.
.sp .sp
.RE .RE
.sp .sp
@ -887,7 +887,7 @@ aria2c http://host1/file\&.zip ftp://host2/file\&.zip
.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 files listed in a file concurrently Download files listed in a text file concurrently
.RS .RS
.sp .sp
.RS 4 .RS 4
@ -984,7 +984,7 @@ aria2c \-p \-\-lowest\-speed\-limit=4000 file\&.metalink
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument at the same directory\&. To pause a download, press Ctrl\-C\&. You can resume the transfer by running aria2c with the same argument in the same directory\&.
.sp .sp
.RE .RE
.sp .sp
@ -1079,7 +1079,7 @@ Note
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
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 in the same directory\&.
.sp .sp
.RE .RE
.sp .sp
@ -1181,7 +1181,7 @@ aria2c \-\-seed\-time=120 \-\-seed\-ratio=1\&.0 file\&.torrent
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note Note
In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1\&.0\&. In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1\&.0\&.
.sp .sp
.RE .RE
.sp .sp
@ -1418,10 +1418,10 @@ aria2c \-\-bt\-min\-crypto\-level=arc4 \-\-bt\-require\-crypto=true file\&.torre
.SH "RESUME DOWNLOAD" .SH "RESUME DOWNLOAD"
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 URL) if the previous transfer is made by aria2\&.
.sp .sp
If the previous transfer is made by a browser or wget like sequencial download manager, then use \-c option to continue the transfer(aria2c \-c 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 \-c URL)\&.
.sp .sp
.SH "CONTROL FILE" .SH "CONTROL FILE"
aria2 uses a control file to keep track the progress of download\&. A control file is placed at the same directory of the dowloading file and its filename is the filename of downloading file with "\&.aria2" appended\&. For example, if you are downloading file\&.zip, then the control file should be file\&.zip\&.aria2\&. (There is a exception for this naming convention\&. If you are downloading a multi torrent, its control file is the "top directory" name of the torrent with "\&.aria2" appended\&. The "top directory" name is a value of "name" key in "info" directory in a torrent file\&.) aria2 uses a control file to track the progress of a download\&. A control file is placed in the same directory as the dowloading file and its filename is the filename of downloading file with "\&.aria2" appended\&. For example, if you are downloading file\&.zip, then the control file should be file\&.zip\&.aria2\&. (There is a exception for this naming convention\&. If you are downloading a multi torrent, its control file is the "top directory" name of the torrent with "\&.aria2" appended\&. The "top directory" name is a value of "name" key in "info" directory in a torrent file\&.)
.sp .sp
Usually a control file is deleted once download completed\&. If aria2 decides that download cannot be resumed(for example, when downloading a file from a HTTP server which doesn\'t support resume), a control file is not created\&. Usually a control file is deleted once download completed\&. If aria2 decides that download cannot be resumed(for example, when downloading a file from a HTTP server which doesn\'t support resume), a control file is not created\&.
.sp .sp
@ -1437,11 +1437,11 @@ aria2c \-V file\&.torrent
.fi .fi
.RE .RE
.SH "INPUT FILE" .SH "INPUT FILE"
The input file can contain list of URIs to feed them into aria2\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&. The input file can contain a list of URIs for aria2 to download\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&.
.sp .sp
Each line is treated as if it is provided in command\-line argument\&. Therefore they are affected by \fB\-Z\fR and \fB\-P\fR options\&. The additional \fBout\fR and \fBdir\fR options can be specified after each line of URIs\&. This optional line must start with white space(s)\&. Each line is treated as if it is provided in command\-line argument\&. Therefore they are affected by \fB\-Z\fR and \fB\-P\fR options\&. The additional \fBout\fR and \fBdir\fR options can be specified after each line of URIs\&. This optional line must start with white space(s)\&.
.sp .sp
For example, let the content of uri\&.txt be For example, the content of uri\&.txt is
.sp .sp
.sp .sp
.RS 4 .RS 4
@ -1485,7 +1485,7 @@ ERROR is set when server cannot be reached or out\-of\-service or timeout occurr
.RE .RE
Those fields must exist in one line\&. The order of the fields is not significant\&.You can put pairs other than above; they are simply ignored\&. Those fields must exist in one line\&. The order of the fields is not significant\&.You can put pairs other than above; they are simply ignored\&.
.sp .sp
An example is follow: An example follows:
.sp .sp
.sp .sp
.RS 4 .RS 4
@ -1496,7 +1496,7 @@ host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR
.RE .RE
.SH "FILES" .SH "FILES"
.SS "aria2\&.conf" .SS "aria2\&.conf"
User configuration file\&. It must be placed under $HOME/\&.aria2 and must be named as aria2\&.conf\&. In each line, there is 1 parameter whose syntax is name=value pair, where name is the long command\-line option name without \fI\-\-\fR prefix\&. The lines beginning \fI#\fR are treated as comments\&. User configuration file\&. It must be placed under $HOME/\&.aria2 and must be named 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
.sp .sp
.RS 4 .RS 4

78
doc/aria2c.1.html
View File

@ -377,7 +377,7 @@ ARIA2C(1) Manual Page
</div> </div>
<h2 id="_description">DESCRIPTION</h2> <h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="para"><p>aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. It can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.</p></div> <div class="para"><p>aria2 is a utility for downloading files. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink. aria2 can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm. Using Metalink's chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent.</p></div>
</div> </div>
<h2 id="_options">OPTIONS</h2> <h2 id="_options">OPTIONS</h2>
<div class="sectionbody"> <div class="sectionbody">
@ -469,8 +469,8 @@ ARIA2C(1) Manual Page
</dt> </dt>
<dd> <dd>
<p> <p>
Use this proxy server in the all protocols. Use this proxy server for all protocols.
You can override this setting and specify a proxy server for particular You can override this setting and specify a proxy server for a particular
proctol using <strong>--http-proxy</strong>, <strong>--https-proxy</strong> and <strong>--ftp-proxy</strong> options. proctol using <strong>--http-proxy</strong>, <strong>--https-proxy</strong> and <strong>--ftp-proxy</strong> options.
This affects all URLs. This affects all URLs.
The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
@ -508,7 +508,7 @@ ARIA2C(1) Manual Page
If aria2 recieves `file not found' status from the remote HTTP/FTP If aria2 recieves `file not found' status from the remote HTTP/FTP
servers NUM times without getting a single byte, then force the servers NUM times without getting a single byte, then force the
download to fail. Specify <em>0</em> to disable this option. This options is download to fail. Specify <em>0</em> to disable this option. This options is
only effective only when using HTTP/FTP servers. effective only when using HTTP/FTP servers.
Default: <em>0</em> Default: <em>0</em>
</p> </p>
</dd> </dd>
@ -526,7 +526,7 @@ ARIA2C(1) Manual Page
</dt> </dt>
<dd> <dd>
<p> <p>
Specify comma separated hostnames or domains to which proxy should not be Specify comma separated hostnames or domains where proxy should not be
used. used.
</p> </p>
</dd> </dd>
@ -544,9 +544,9 @@ ARIA2C(1) Manual Page
<td class="icon"> <td class="icon">
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">In Metalink, 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 URLs fed to aria2
is 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>
</div> </div>
@ -783,7 +783,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Load Cookies from FILE using the Firefox3 format(SQLite3) and the Load Cookies from FILE using the Firefox3 format (SQLite3) and the
Mozilla/Firefox(1.x/2.x)/Netscape format. Mozilla/Firefox(1.x/2.x)/Netscape format.
</p> </p>
</dd> </dd>
@ -793,7 +793,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
<td class="icon"> <td class="icon">
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">If aria2 is build without libsqlite3, then it doesn't support Firefox3 cookie.</td> <td class="content">If aria2 is built without libsqlite3, then it doesn't support Firefox3 cookie format.</td>
</tr></table> </tr></table>
</div> </div>
<div class="vlist"><dl> <div class="vlist"><dl>
@ -880,7 +880,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Set file to download by specifing its index. Set file to download by specifying its index.
You can find the file index using the <strong>--show-files</strong> option. You can find the file index using the <strong>--show-files</strong> option.
Multiple indexes can be specified by using ",", for example: <em>3,6</em>. Multiple indexes can be specified by using ",", for example: <em>3,6</em>.
You can also use "-" to specify a range: <em>1-5</em>. You can also use "-" to specify a range: <em>1-5</em>.
@ -930,7 +930,7 @@ writes the piece to the appropriate files.</td>
<dd> <dd>
<p> <p>
Set minimum level of encryption method. Set minimum level of encryption method.
If several encryption methods are provided by a peer, aria2 chooses a lowest If several encryption methods are provided by a peer, aria2 chooses the lowest
one which satisfies the given level. one which satisfies the given level.
Default: <em>plain</em> Default: <em>plain</em>
</p> </p>
@ -1091,7 +1091,7 @@ writes the piece to the appropriate files.</td>
<p> <p>
Specify share ratio. Seed completed torrents until share ratio reaches] Specify share ratio. Seed completed torrents until share ratio reaches]
RATIO. RATIO.
I strongly encourages you to specify equals or more than <em>1.0</em> here. You are strongly encouraged to specify equals or more than <em>1.0</em> here.
Specify <em>0.0</em> if you intend to do seeding regardless of share ratio. Specify <em>0.0</em> if you intend to do seeding regardless of share ratio.
If <strong>--seed-time</strong> option is specified along with this option, seeding ends when If <strong>--seed-time</strong> option is specified along with this option, seeding ends when
at least one of the conditions is satisfied. at least one of the conditions is satisfied.
@ -1112,7 +1112,7 @@ writes the piece to the appropriate files.</td>
<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. You are not required to use this option because you can specify a torrent file without -T.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -1124,7 +1124,7 @@ writes the piece to the appropriate files.</td>
<dd> <dd>
<p> <p>
If <em>true</em> or <em>mem</em> is specified, when a file whose suffix is ".metaink" or content If <em>true</em> or <em>mem</em> is specified, when a file whose suffix is ".metaink" or content
type is "application/metalink+xml" is downloaded, aria2 parses it as a metalink type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink
file and downloads files mentioned in it. file and downloads files mentioned in it.
If <em>mem</em> is specified, a metalink file is not written to the disk, but is just If <em>mem</em> is specified, a metalink file is not written to the disk, but is just
kept in memory. kept in memory.
@ -1137,8 +1137,8 @@ writes the piece to the appropriate files.</td>
</dt> </dt>
<dd> <dd>
<p> <p>
The file path to .metalink file. You may not use this option because you can The file path to .metalink file. You are not required to use this option because you can
specify metalink file without -M. specify a metalink file without -M.
</p> </p>
</dd> </dd>
<dt> <dt>
@ -1147,7 +1147,7 @@ writes the piece to the appropriate files.</td>
<dd> <dd>
<p> <p>
The number of servers to connect to simultaneously. The number of servers to connect to simultaneously.
Some Metalinks regulates the number of servers to connect. Some Metalinks regulate the number of servers to connect.
aria2 strictly respects them. aria2 strictly respects them.
This means that if Metalink defines the maxconnections attribute lower This means that if Metalink defines the maxconnections attribute lower
than NUM_SERVERS, then aria2 uses the value of maxconnections attribute than NUM_SERVERS, then aria2 uses the value of maxconnections attribute
@ -1170,7 +1170,7 @@ writes the piece to the appropriate files.</td>
<dd> <dd>
<p> <p>
The location of the preferred server. The location of the preferred server.
A comma-deliminated list of locations is acceptable, for example, <em>JP,US</em>. A comma-delimited list of locations is acceptable, for example, <em>JP,US</em>.
</p> </p>
</dd> </dd>
<dt> <dt>
@ -1335,8 +1335,8 @@ writes the piece to the appropriate files.</td>
<td class="icon"> <td class="icon">
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">In multi file torrent, the files adjacent forward to the specified files <td class="content">In multi file torrent downloads, the files adjacent forward to the specified files
are also allocated if they share a same piece.</td> are also allocated if they share the same piece.</td>
</tr></table> </tr></table>
</div> </div>
<div class="vlist"><dl> <div class="vlist"><dl>
@ -1398,7 +1398,7 @@ are also allocated if they share a same piece.</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Make aria2 quite (no console output). Make aria2 quiet (no console output).
Default: <em>false</em> Default: <em>false</em>
</p> </p>
</dd> </dd>
@ -1407,8 +1407,8 @@ are also allocated if they share a same piece.</td>
</dt> </dt>
<dd> <dd>
<p> <p>
Validate chunk of data by calculating checkusm while download a file if Validate chunk of data by calculating checksum while downloading a file if
chunk checksums are provided. Currently Metalink is the only way to to chunk checksums are provided. Currently Metalink is the only way to
provide chunk checksums. provide chunk checksums.
Default: <em>true</em> Default: <em>true</em>
</p> </p>
@ -1437,17 +1437,17 @@ are also allocated if they share a same piece.</td>
<div class="para"><p>The options that have its argument surrounded by square brackets([]) <div class="para"><p>The options that have its argument surrounded by square brackets([])
take an optional argument. Usually ommiting the argument is evaluated to <em>true</em>. take an optional argument. Usually ommiting the argument is evaluated to <em>true</em>.
If you use short form of these options(such as <em>-V</em>) and give If you use short form of these options(such as <em>-V</em>) and give
an arugment, then the option name and its argument should be concatenated(e.g. 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="_url_torrent_file_metalink_file">URL, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div> <h3 id="_url_torrent_file_metalink_file">URL, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div>
<div class="para"><p>You can specify multiple URLs in command-line. <div class="para"><p>You can specify multiple URLs in command-line.
Unless you specify <strong>-Z</strong> option, all URLs must point to the same file or downloading will fail.</p></div> Unless you specify <strong>-Z</strong> option, all URLs must point to the same file or downloading will fail.</p></div>
<div class="para"><p>You can also specify arbitrary number of torrent files and metalink files <div class="para"><p>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 stored on a local drive. Please note that they are always treated as a
separate download.</p></div> separate download.</p></div>
<div class="para"><p>You can specify both torrent file with -T option and URLs. By doing this, <div class="para"><p>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, you can download a file from both torrent swarm and HTTP(S)/FTP server at the same time,
while the data from HTTP(S)/FTP are uploaded to the torrent swarm. Note that 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.</p></div> only single file torrent can be integrated with HTTP(S)/FTP.</p></div>
<div class="admonitionblock"> <div class="admonitionblock">
@ -1495,7 +1495,7 @@ contains "&amp;" or any characters that have special meaning in shell.</td>
<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 at 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 URLs 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>
@ -1508,7 +1508,7 @@ contains "&amp;" or any characters that have special meaning in shell.</td>
<div class="content"> <div class="content">
<pre><tt>aria2c http://host1/file.zip ftp://host2/file.zip</tt></pre> <pre><tt>aria2c http://host1/file.zip ftp://host2/file.zip</tt></pre>
</div></div> </div></div>
<h4 id="_download_files_listed_in_a_file_concurrently">Download files listed in a file concurrently</h4> <h4 id="_download_files_listed_in_a_text_file_concurrently">Download files listed in a text file concurrently</h4>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>aria2c -ifiles.txt -j2</tt></pre> <pre><tt>aria2c -ifiles.txt -j2</tt></pre>
@ -1564,7 +1564,7 @@ You can specify proxy in the environment variables. See ENVIRONMENT section.</td
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">To pause a download, press Ctrl-C. <td class="content">To pause a download, press Ctrl-C.
You can resume the transfer by running aria2c with the same argument at the same You can resume the transfer by running aria2c with the same argument in the same
directory.</td> directory.</td>
</tr></table> </tr></table>
</div> </div>
@ -1615,7 +1615,7 @@ directory.</td>
<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 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 in the same directory.</td>
</tr></table> </tr></table>
</div> </div>
<h4 id="_download_2_torrents">Download 2 torrents</h4> <h4 id="_download_2_torrents">Download 2 torrents</h4>
@ -1673,7 +1673,7 @@ to you to do it manually.</td>
<td class="icon"> <td class="icon">
<div class="title">Note</div> <div class="title">Note</div>
</td> </td>
<td class="content">In the above example, the program exists when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.</td> <td class="content">In the above example, the program exits when the 120 minutes has elapsed since download completed or seed ratio reaches 1.0.</td>
</tr></table> </tr></table>
</div> </div>
<h4 id="_throttle_upload_speed">Throttle upload speed</h4> <h4 id="_throttle_upload_speed">Throttle upload speed</h4>
@ -1798,13 +1798,13 @@ checksums.</td>
<div class="sectionbody"> <div class="sectionbody">
<div class="para"><p>Usually, you can resume transfer by just issuing same command(aria2c URL) <div class="para"><p>Usually, you can resume transfer by just issuing same command(aria2c URL)
if the previous transfer is made by aria2.</p></div> if the previous transfer is made by aria2.</p></div>
<div class="para"><p>If the previous transfer is made by a browser or wget like sequencial <div class="para"><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 -c URL).</p></div> download manager, then use -c option to continue the transfer(aria2c -c URL).</p></div>
</div> </div>
<h2 id="_control_file">CONTROL FILE</h2> <h2 id="_control_file">CONTROL FILE</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="para"><p>aria2 uses a control file to keep track the progress of download. <div class="para"><p>aria2 uses a control file to track the progress of a download.
A control file is placed at the same directory of the dowloading file and A control file is placed in the same directory as the dowloading file and
its filename is the filename of downloading file with ".aria2" appended. its filename is the filename of downloading file with ".aria2" appended.
For example, if you are downloading file.zip, then the control file should be For example, if you are downloading file.zip, then the control file should be
file.zip.aria2. file.zip.aria2.
@ -1831,14 +1831,14 @@ you can resume the download without a control file by giving
</div> </div>
<h2 id="_input_file">INPUT FILE</h2> <h2 id="_input_file">INPUT FILE</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="para"><p>The input file can contain list of URIs to feed them into aria2. <div class="para"><p>The input file can contain a list of URIs for aria2 to download.
You can specify multiple URIs for a single entity: You can specify multiple URIs for a single entity:
separate URIs on a single line using the TAB character.</p></div> separate URIs on a single line using the TAB character.</p></div>
<div class="para"><p>Each line is treated as if it is provided in command-line argument. <div class="para"><p>Each line is treated as if it is provided in command-line argument.
Therefore they are affected by <strong>-Z</strong> and <strong>-P</strong> options. Therefore they are affected by <strong>-Z</strong> and <strong>-P</strong> options.
The additional <strong>out</strong> and <strong>dir</strong> options can be specified after each line of The additional <strong>out</strong> and <strong>dir</strong> options can be specified after each line of
URIs. This optional line must start with white space(s).</p></div> URIs. This optional line must start with white space(s).</p></div>
<div class="para"><p>For example, let the content of uri.txt be</p></div> <div class="para"><p>For example, the content of uri.txt is</p></div>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>http://server/file.iso http://mirror/file.iso <pre><tt>http://server/file.iso http://mirror/file.iso
@ -1905,7 +1905,7 @@ status
</dd> </dd>
</dl></div> </dl></div>
<div class="para"><p>Those fields must exist in one line. The order of the fields is not significant.You can put pairs other than above; they are simply ignored.</p></div> <div class="para"><p>Those fields must exist in one line. The order of the fields is not significant.You can put pairs other than above; they are simply ignored.</p></div>
<div class="para"><p>An example is follow:</p></div> <div class="para"><p>An example follows:</p></div>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><tt>host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK <pre><tt>host=localhost, protocol=http, dl_speed=32000, last_updated=1222491640, status=OK
@ -1916,7 +1916,7 @@ host=localhost, protocol=ftp, dl_speed=0, last_updated=1222491632, status=ERROR<
<div class="sectionbody"> <div class="sectionbody">
<h3 id="_aria2_conf">aria2.conf</h3><div style="clear:left"></div> <h3 id="_aria2_conf">aria2.conf</h3><div style="clear:left"></div>
<div class="para"><p>User configuration file. <div class="para"><p>User configuration file.
It must be placed under $HOME/.aria2 and must be named as aria2.conf. It must be placed under $HOME/.aria2 and must be named aria2.conf.
In each line, there is 1 parameter whose syntax is name=value pair, In each line, there is 1 parameter whose syntax is name=value pair,
where name is the long command-line option name without <em>--</em> prefix. where name is the long command-line option name without <em>--</em> prefix.
The lines beginning <em>#</em> are treated as comments.</p></div> The lines beginning <em>#</em> are treated as comments.</p></div>
@ -2030,7 +2030,7 @@ files in the program, then also delete it here.</p></div>
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2008-11-20 21:02:18 JST Last updated 2008-11-28 23:31:27 JST
</div> </div>
</div> </div>
</body> </body>

4
doc/aria2c.1.txt
View File

@ -391,7 +391,7 @@ Make sure that the specified ports are open for incoming TCP traffic.
*-T*, *--torrent-file*=TORRENT_FILE:: *-T*, *--torrent-file*=TORRENT_FILE::
The path to the .torrent file. The path to the .torrent file.
You are not required touse this option because you can specify a torrent file without -T. You are not required to use this option because you can specify a torrent file without -T.
Metalink Specific Options Metalink Specific Options
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
@ -620,7 +620,7 @@ aria2c http://host1/file.zip ftp://host2/file.zip
------------------------------------------------- -------------------------------------------------
Download files listed in a text file concurrently Download files listed in a text file concurrently
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------ ------------------------
aria2c -ifiles.txt -j2 aria2c -ifiles.txt -j2
------------------------ ------------------------