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

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

Made option name bold. Updated SYNOPSIS to make it more 
readable.
	* doc/aria2c.1.txt
	* doc/aria2c.1
	* doc/aria2c.1.html
	* src/version_usage.cc
pull/1/head
Tatsuhiro Tsujikawa 2008-05-21 07:47:32 +00:00
parent 65c7d8f26c
commit 9ca3763190
5 changed files with 290 additions and 268 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ChangeLog
View File

@ -1,3 +1,11 @@
2008-05-21 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com>
Made option name bold. Updated SYNOPSIS to make it more readable.
* doc/aria2c.1.txt
* doc/aria2c.1
* doc/aria2c.1.html
* src/version_usage.cc
2008-05-21 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com>
Refactored. Use std::string instead of size and char*.

194
doc/aria2c.1
View File

@ -1,11 +1,11 @@
.\" Title: aria2c
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
.\" Date: 05/19/2008
.\" Date: 05/21/2008
.\" Manual:
.\" Source:
.\"
.TH "ARIA2C" "1" "05/19/2008" "" ""
.TH "ARIA2C" "1" "05/21/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@ -13,7 +13,7 @@
.SH "NAME"
aria2c - The ultra fast download utility
.SH "SYNOPSIS"
\fIaria2c\fR [OPTIONS] URL|TORRENT_FILE|METALINK_FILE \&...
aria2c [\fIOPTIONS\fR] [\fIURL\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&...
.sp
.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\.
@ -21,45 +21,45 @@ aria2 is a utility for downloading files\. The supported protocols are HTTP(S),
.SH "OPTIONS"
.SS "Basic Options"
.PP
\-d, \-\-dir=DIR
\fB\-d\fR, \fB\-\-dir\fR=DIR
.RS 4
The directory to store the downloaded file\.
.RE
.PP
\-i, \-\-input\-file=FILE
\fB\-i\fR, \fB\-\-input\-file\fR=FILE
.RS 4
Downloads URIs found in FILE\. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\. Reads input from stdin when
\fI\-\fR
is specified\.
.RE
.PP
\-l, \-\-log=LOG
\fB\-l\fR, \fB\-\-log\fR=LOG
.RS 4
The file name of the log file\. If
\fI\-\fR
is specified, log is written to stdout\.
.RE
.PP
\-j, \-\-max\-concurrent\-downloads=N
\fB\-j\fR, \fB\-\-max\-concurrent\-downloads\fR=N
.RS 4
Set maximum number of parallel downloads\. Default:
\fI5\fR
.RE
.PP
\-\-check\-integrity=\fItrue\fR|\fIfalse\fR
\fB\-\-check\-integrity\fR=\fItrue\fR|\fIfalse\fR
.RS 4
Check file integrity by validating piece hash\. This option only affects in BitTorrent downloads and Metalink downloads with chunk checksums\. Use this option to re\-download a damaged portion of a file\. Default:
\fIfalse\fR
.RE
.PP
\-c, \-\-continue
\fB\-c\fR, \fB\-\-continue\fR
.RS 4
Continue downloading a partially downloaded file\. Use this option to resume a download started by a web browser or another program which downloads files sequentially from the beginning\. Currently this option is only applicable to HTTP(S)/FTP downloads\.
.RE
.PP
\-h, \-\-help[=CATEGORY]
\fB\-h\fR, \fB\-\-help\fR[=CATEGORY]
.RS 4
Print usage and exit\. The help messages are classified in several categories\. For example, type "\-\-help=http" for detailed explanation for the options related to HTTP\. If no matching category is found, search option name using a given word in forward match and print the result\. Available Values:
Print usage and exit\. The help messages are classified in several categories\. For example, type "\fB\-\-help\fR=http" for detailed explanation for the options related to HTTP\. If no matching category is found, search option name using a given word in forward match and print the result\. Available Values:
\fIbasic\fR,
\fIadvanced\fR,
\fIhttp\fR,
@ -72,7 +72,7 @@ Default:
.RE
.SS "HTTP/FTP Options"
.PP
\-\-lowest\-speed\-limit=SPEED
\fB\-\-lowest\-speed\-limit\fR=SPEED
.RS 4
Close connection if download speed is lower than or equal to this value(bytes per sec)\.
\fI0\fR
@ -83,7 +83,7 @@ or
\fI0\fR
.RE
.PP
\-m, \-\-max\-tries=N
\fB\-m\fR, \fB\-\-max\-tries\fR=N
.RS 4
Set number of tries\.
\fI0\fR
@ -91,7 +91,7 @@ means unlimited\. Default:
\fI5\fR
.RE
.PP
\-o, \-\-out=FILE
\fB\-o\fR, \fB\-\-out\fR=FILE
.RS 4
The file name of the downloaded file\.
.RE
@ -101,9 +101,9 @@ The file name of the downloaded file\.
.nr an-break-flag 1
.br
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 \-i, \-Z option, like this: aria2c \-o myfile\.zip http://mirror1/file\.zip http://mirror2/file\.zip
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, \-Z option, like this: aria2c \-o myfile\.zip http://mirror1/file\.zip http://mirror2/file\.zip
.PP
\-\-retry\-wait=SEC
\fB\-\-retry\-wait\fR=SEC
.RS 4
Set the seconds to wait to retry after an error has occured\. Specify a value between
\fI0\fR
@ -112,7 +112,7 @@ and
\fI5\fR
.RE
.PP
\-s, \-\-split=N
\fB\-s\fR, \fB\-\-split\fR=N
.RS 4
Download a file using N connections\. N must be between
\fI1\fR
@ -121,14 +121,14 @@ and
\fI1\fR
.RE
.PP
\-t, \-\-timeout=SEC
\fB\-t\fR, \fB\-\-timeout\fR=SEC
.RS 4
Set timeout in seconds\. Default:
\fI60\fR
.RE
.SS "HTTP Specific Options"
.PP
\-\-http\-auth\-scheme=SCHEME
\fB\-\-http\-auth\-scheme\fR=SCHEME
.RS 4
Set HTTP authentication scheme\. Currently,
\fIbasic\fR
@ -136,32 +136,32 @@ is the only supported scheme\. Default:
\fIbasic\fR
.RE
.PP
\-\-http\-user=USER
\fB\-\-http\-user\fR=USER
.RS 4
Set HTTP user\. This affects all URLs\.
.RE
.PP
\-\-http\-passwd=PASSWD
\fB\-\-http\-passwd\fR=PASSWD
.RS 4
Set HTTP password\. This affects all URLs\.
.RE
.PP
\-\-http\-proxy=HOST:PORT
\fB\-\-http\-proxy\fR=HOST:PORT
.RS 4
Use HTTP proxy server\. This affects all URLs\.
.RE
.PP
\-\-http\-proxy\-user=USER
\fB\-\-http\-proxy\-user\fR=USER
.RS 4
Set HTTP proxy user\. This affects all URLs\.
.RE
.PP
\-\-http\-proxy\-passwd=PASSWD
\fB\-\-http\-proxy\-passwd\fR=PASSWD
.RS 4
Set HTTP proxy password\. This affects all URLs\.
.RE
.PP
\-\-http\-proxy\-method=METHOD
\fB\-\-http\-proxy\-method\fR=METHOD
.RS 4
Set the method to use in proxy request\.
\fIMETHOD\fR
@ -172,57 +172,59 @@ or
\fItunnel\fR
.RE
.PP
\-\-referer=REFERER
\fB\-\-referer\fR=REFERER
.RS 4
Set Referer\. This affects all URLs\.
.RE
.PP
\-\-enable\-http\-keep\-alive[=\fItrue\fR|\fIfalse\fR]
\fB\-\-enable\-http\-keep\-alive\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable HTTP/1\.1 persistent connection\. Default:
\fItrue\fR
.RE
.PP
\-\-enable\-http\-pipelining[=\fItrue\fR|\fIfalse\fR]
\fB\-\-enable\-http\-pipelining\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable HTTP/1\.1 pipelining\. Default:
\fIfalse\fR
.RE
.PP
\-\-header=HEADER
\fB\-\-header\fR=HEADER
.RS 4
Append HEADER to HTTP request header\. You can use this option repeatedly to specify more than one header: aria2c \-\-header="X\-A: b78" \-\-header="X\-B: 9J1" http://host/file
Append HEADER to HTTP request header\. You can use this option repeatedly to specify more than one header: aria2c
\fB\-\-header\fR="X\-A: b78"
\fB\-\-header\fR="X\-B: 9J1" http://host/file
.RE
.PP
\-\-load\-cookies=FILE
\fB\-\-load\-cookies\fR=FILE
.RS 4
Load cookies from FILE\. The format of FILE is the same used by Netscape and Mozilla\.
.RE
.PP
\-U, \-\-user\-agent=USER_AGENT
\fB\-U\fR, \fB\-\-user\-agent\fR=USER_AGENT
.RS 4
Set user agent for HTTP(S) downloads\.
.RE
.SS "FTP Specific Options"
.PP
\-\-ftp\-user=USER
\fB\-\-ftp\-user\fR=USER
.RS 4
Set FTP user\. This affects all URLs\. Default:
\fIanonymous\fR
.RE
.PP
\-\-ftp\-passwd=PASSWD
\fB\-\-ftp\-passwd\fR=PASSWD
.RS 4
Set FTP password\. This affects all URLs\. Default:
\fIARIA2USER@\fR
.RE
.PP
\-p, \-\-ftp\-pasv
\fB\-p\fR, \fB\-\-ftp\-pasv\fR
.RS 4
Use passive mode in FTP\.
.RE
.PP
\-\-ftp\-type=TYPE
\fB\-\-ftp\-type\fR=TYPE
.RS 4
Set FTP transfer type\. TYPE is either
\fIbinary\fR
@ -231,13 +233,13 @@ or
\fIbinary\fR
.RE
.PP
\-\-ftp\-reuse\-connection[=\fItrue\fR|\fIfalse\fR]
\fB\-\-ftp\-reuse\-connection\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Reuse connection in FTP\. Default:
\fItrue\fR
.RE
.PP
\-\-ftp\-via\-http\-proxy=METHOD
\fB\-\-ftp\-via\-http\-proxy\fR=METHOD
.RS 4
Use HTTP proxy in FTP\. METHOD is either
\fIget\fR
@ -246,18 +248,21 @@ or
\fItunnel\fR
.RE
.PP
\-n, \-\-no\-netrc
\fB\-n\fR, \fB\-\-no\-netrc\fR
.RS 4
Disables netrc support\. netrc support is enabled by default\.
.RE
.SS "BitTorrent/Metalink Options"
.PP
\-\-select\-file=INDEX\&...
\fB\-\-select\-file\fR=INDEX\&...
.RS 4
Set file to download by specifing its index\. You can find the file index using the \-\-show\-files option\. Multiple indexes can be specified by using ",", for example:
Set file to download by specifing its index\. You can find the file index using the
\fB\-\-show\-files\fR
option\. Multiple indexes can be specified by using ",", for example:
\fI3,6\fR\. You can also use "\-" to specify a range:
\fI1\-5\fR\. "," and "\-" can be used together:
\fI1\-5,8,9\fR\. When used with the \-M option, index may vary depending on the query (see \-\-metalink\-* options)\.
\fI1\-5,8,9\fR\. When used with the \-M option, index may vary depending on the query (see
\fB\-\-metalink\-\fR* options)\.
.RE
.sp
.it 1 an-trap
@ -267,30 +272,30 @@ Set file to download by specifing its index\. You can find the file index using
Note
In multi file torrent, the adjacent files specified by this option may also be downloaded\. This is by design, not a bug\. A single piece may include several files or part of files, and aria2 writes the piece to the appropriate files\.
.PP
\-S, \-\-show\-files
\fB\-S\fR, \fB\-\-show\-files\fR
.RS 4
Print file listing of \.torrent or \.metalink file and exit\. In case of \.torrent file, additional information (infohash, piece length, etc) is also printed\.
.RE
.SS "BitTorrent Specific Options"
.PP
\-\-bt\-min\-crypto\-level=\fIplain\fR|\fIarc4\fR
\fB\-\-bt\-min\-crypto\-level\fR=\fIplain\fR|\fIarc4\fR
.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:
\fIplain\fR
.RE
.PP
\-\-bt\-require\-crypto=\fItrue\fR|\fIfalse\fR
\fB\-\-bt\-require\-crypto\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If true is given, aria2 doesn\'t accept and establish connection with legacy BitTorrent handshake(\e19BitTorrent protocol)\. Thus aria2 always uses Obfuscation handshake\. Default:
\fIfalse\fR
.RE
.PP
\-\-dht\-entry\-point=HOST:PORT
\fB\-\-dht\-entry\-point\fR=HOST:PORT
.RS 4
Set host and port as an entry point to DHT network\.
.RE
.PP
\-\-dht\-listen\-port=PORT\&...
\fB\-\-dht\-listen\-port\fR=PORT\&...
.RS 4
Set UDP listening port for DHT\. Multiple ports can be specified by using ",", for example:
\fI6881,6885\fR\. You can also use "\-" to specify a range:
@ -298,13 +303,13 @@ Set UDP listening port for DHT\. Multiple ports can be specified by using ",", f
\fI6881\-6999\fR
.RE
.PP
\-\-direct\-file\-mapping=\fItrue\fR|\fIfalse\fR
\fB\-\-direct\-file\-mapping\fR=\fItrue\fR|\fIfalse\fR
.RS 4
Directly read from and write to each file mentioned in \.torrent file\. Use this option if lots of files are listed in \.torrent file and aria2 complains it cannot open files anymore\. Default:
\fItrue\fR
.RE
.PP
\-\-enable\-dht[=\fItrue\fR|\fIfalse\fR]
\fB\-\-enable\-dht\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable DHT functionality\. If a private flag is set in a torrent, aria2 doesn\'t use DHT for that download even if
\fItrue\fR
@ -312,7 +317,7 @@ is given\. Default:
\fIfalse\fR
.RE
.PP
\-\-enable\-peer\-exchange[=\fItrue\fR|\fIfalse\fR]
\fB\-\-enable\-peer\-exchange\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable Peer Exchange extension\. If a private flag is set in a torrent, this feature is disabled for that download even if
\fItrue\fR
@ -320,7 +325,7 @@ is given\. Default:
\fItrue\fR
.RE
.PP
\-\-follow\-torrent=\fItrue\fR|\fIfalse\fR|\fImem\fR
\fB\-\-follow\-torrent\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
.RS 4
If
\fItrue\fR
@ -334,7 +339,7 @@ is specified, the action mentioned above is not taken\. Default:
\fItrue\fR
.RE
.PP
\-\-listen\-port=PORT\&...
\fB\-\-listen\-port\fR=PORT\&...
.RS 4
Set TCP port number for BitTorrent downloads\. Multiple ports can be specified by using ",", for example:
\fI6881,6885\fR\. You can also use "\-" to specify a range:
@ -350,7 +355,7 @@ Set TCP port number for BitTorrent downloads\. Multiple ports can be specified b
Note
Make sure that the specified ports are open for incoming TCP traffic\.
.PP
\-\-max\-upload\-limit=SPEED
\fB\-\-max\-upload\-limit\fR=SPEED
.RS 4
Set max upload speed in bytes per sec\.
\fI0\fR
@ -361,34 +366,38 @@ or
\fI0\fR
.RE
.PP
\-\-peer\-id\-prefix=PEERI_ID_PREFIX
\fB\-\-peer\-id\-prefix\fR=PEERI_ID_PREFIX
.RS 4
Specify the prefix of peer ID\. The peer ID in BitTorrent is 20 byte length\. If more than 20 bytes are specified, only first 20 bytes are used\. If less than 20 bytes are specified, the random alphabet characters are added to make it\'s length 20 bytes\. Default:
\fI\-aria2\-\fR
.RE
.PP
\-\-seed\-ratio=RATIO
\fB\-\-seed\-ratio\fR=RATIO
.RS 4
Specify share ratio\. Seed completed torrents until share ratio reaches] RATIO\. I strongly encourages you to specify equals or more than
\fI1\.0\fR
here\. Specify
\fI0\.0\fR
if you intend to do seeding regardless of share ratio\. If \-\-seed\-time option is specified along with this option, seeding ends when at least one of the conditions is satisfied\. Default:
if you intend to do seeding regardless of share ratio\. If
\fB\-\-seed\-time\fR
option is specified along with this option, seeding ends when at least one of the conditions is satisfied\. Default:
\fI1\.0\fR
.RE
.PP
\-\-seed\-time=MINUTES
\fB\-\-seed\-time\fR=MINUTES
.RS 4
Specify seeding time in minutes\. Also see the \-\-seed\-ratio option\.
Specify seeding time in minutes\. Also see the
\fB\-\-seed\-ratio\fR
option\.
.RE
.PP
\-T, \-\-torrent\-file=TORRENT_FILE
\fB\-T\fR, \fB\-\-torrent\-file\fR=TORRENT_FILE
.RS 4
The path to the \.torrent file\. You may not use this option because you can specify torrent file without \-T\.
.RE
.SS "Metalink Specific Options"
.PP
\-\-follow\-metalink=\fItrue\fR|\fIfalse\fR|\fImem\fR
\fB\-\-follow\-metalink\fR=\fItrue\fR|\fIfalse\fR|\fImem\fR
.RS 4
If
\fItrue\fR
@ -402,39 +411,39 @@ is specified, the action mentioned above is not taken\. Default:
\fItrue\fR
.RE
.PP
\-M, \-\-metalink\-file=METALINK_FILE
\fB\-M\fR, \fB\-\-metalink\-file\fR=METALINK_FILE
.RS 4
The file path to \.metalink file\. You may not use this option because you can specify metalink file without \-M\.
.RE
.PP
\-C, \-\-metalink\-servers=NUM_SERVERS
\fB\-C\fR, \fB\-\-metalink\-servers\fR=NUM_SERVERS
.RS 4
The number of servers to connect to simultaneously\. Some metalinks regulates the number of servers to connect\. aria2 respects them\. Default:
\fI5\fR
.RE
.PP
\-\-metalink\-language=LANGUAGE
\fB\-\-metalink\-language\fR=LANGUAGE
.RS 4
The language of the file to download\.
.RE
.PP
\-\-metalink\-location=LOCATION[,\&...]
\fB\-\-metalink\-location\fR=LOCATION[,\&...]
.RS 4
The location of the preferred server\. A comma\-deliminated list of locations is acceptable, for example,
\fIJP,US\fR\.
.RE
.PP
\-\-metalink\-os=OS
\fB\-\-metalink\-os\fR=OS
.RS 4
The operating system of the file to download\.
.RE
.PP
\-\-metalink\-version=VERSION
\fB\-\-metalink\-version\fR=VERSION
.RS 4
The version of the file to download\.
.RE
.PP
\-\-metalink\-preferred\-protocol=PROTO
\fB\-\-metalink\-preferred\-protocol\fR=PROTO
.RS 4
Specify preferred protocol\. The possible values are
\fIhttp\fR,
@ -447,60 +456,65 @@ to disable this feature\. Default:
\fInone\fR
.RE
.PP
\-\-metalink\-enable\-unique\-protocol=\fItrue\fR|\fIfalse\fR
\fB\-\-metalink\-enable\-unique\-protocol\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If
\fItrue\fR
is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\. Use \-\-metalink\-preferred\-protocol option to specify the preference of protocol\. Default:
is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them\. Use
\fB\-\-metalink\-preferred\-protocol\fR
option to specify the preference of protocol\. Default:
\fItrue\fR
.RE
.SS "Advanced Options"
.PP
\-\-allow\-overwrite=\fItrue\fR|\fIfalse\fR
\fB\-\-allow\-overwrite\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If
\fIfalse\fR
is given, aria2 doesn\'t download a file which already exists but the corresponding \.aria2 file doesn\'t exist\. In HTTP(S)/FTP download, if \-\-auto\-file\-renaming=\fItrue\fR
then, file name will be renamed\. See \-\-auto\-file\-renaming for details\. Default:
is given, aria2 doesn\'t download a file which already exists but the corresponding \.aria2 file doesn\'t exist\. In HTTP(S)/FTP download, if
\fB\-\-auto\-file\-renaming\fR=\fItrue\fR
then, file name will be renamed\. See
\fB\-\-auto\-file\-renaming\fR
for details\. Default:
\fIfalse\fR
.RE
.PP
\-\-allow\-piece\-length\-change=\fItrue\fR|\fIfalse\fR
\fB\-\-allow\-piece\-length\-change\fR=\fItrue\fR|\fIfalse\fR
.RS 4
If false is given, aria2 aborts download when a piece length is different from one in a control file\. If true is given, you can proceed but some download progress will be lost\. Default:
\fIfalse\fR
.RE
.PP
\-\-async\-dns[=\fItrue\fR|\fIfalse\fR]
\fB\-\-async\-dns\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable asynchronous DNS\. Default:
\fItrue\fR
.RE
.PP
\-\-auto\-file\-renaming[=\fItrue\fR|\fIfalse\fR]
\fB\-\-auto\-file\-renaming\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Rename file name if the same file already exists\. This option works only in HTTP(S)/FTP download\. The new file name has a dot and a number(1\.\.9999) appended\. Default:
\fItrue\fR
.RE
.PP
\-\-conf\-path=PATH
\fB\-\-conf\-path\fR=PATH
.RS 4
Change the configuration file path to PATH\. Default:
\fI$HOME/\.aria2/aria2\.conf\fR
.RE
.PP
\-D, \-\-daemon
\fB\-D\fR, \fB\-\-daemon\fR
.RS 4
Run as daemon\.
.RE
.PP
\-\-enable\-direct\-io[=\fItrue\fR|\fIfalse\fR]
\fB\-\-enable\-direct\-io\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable directI/O, which lowers cpu usage while allocating/checking files\. Turn off if you encounter any error\. Default:
\fIfalse\fR
.RE
.PP
\-\-file\-allocation=METHOD
\fB\-\-file\-allocation\fR=METHOD
.RS 4
Specify file allocation method\. METHOD is either
\fInone\fR
@ -513,7 +527,7 @@ pre\-allocates file space before download begins\. This may take some time depen
\fIprealloc\fR
.RE
.PP
\-\-log\-level=LEVEL
\fB\-\-log\-level\fR=LEVEL
.RS 4
Set log level to output\. LEVEL is either
\fIdebug\fR,
@ -525,7 +539,7 @@ or
\fIdebug\fR
.RE
.PP
\-\-summary\-interval=SEC
\fB\-\-summary\-interval\fR=SEC
.RS 4
Set interval in seconds to output download progress summary\. Setting
\fI0\fR
@ -540,13 +554,13 @@ suppresses the output\. Default:
Note
In multi file torrent, the files adjacent forward to the specified files are also allocated if they share a same piece\.
.PP
\-Z, \-\-force\-sequential[=\fItrue\fR|\fIfalse\fR]
\fB\-Z\fR, \fB\-\-force\-sequential\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Fetch URIs in the command\-line sequentially and download each URI in a separate session, like the usual command\-line download utilities\. Default:
\fIfalse\fR
.RE
.PP
\-\-max\-download\-limit=SPEED
\fB\-\-max\-download\-limit\fR=SPEED
.RS 4
Set max download speed in bytes per sec\.
\fI0\fR
@ -557,12 +571,12 @@ or
\fI0\fR
.RE
.PP
\-\-no\-conf
\fB\-\-no\-conf\fR
.RS 4
Disable loading aria2\.conf file\.
.RE
.PP
\-\-no\-file\-allocation\-limit=SIZE
\fB\-\-no\-file\-allocation\-limit\fR=SIZE
.RS 4
No file allocation is made for files whose size is smaller than SIZE\. You can append
\fIK\fR
@ -571,7 +585,7 @@ or
\fI5M\fR
.RE
.PP
\-P, \-\-parameterized\-uri[=\fItrue\fR|\fIfalse\fR]
\fB\-P\fR, \fB\-\-parameterized\-uri\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Enable parameterized URI support\. You can specify set of parts:
\fIhttp://{sv1,sv2,sv3}/foo\.iso\fR\. Also you can specify numeric sequences with step counter:
@ -579,19 +593,19 @@ Enable parameterized URI support\. You can specify set of parts:
\fIfalse\fR
.RE
.PP
\-q, \-\-quiet[=\fItrue\fR|\fIfalse\fR]
\fB\-q\fR, \fB\-\-quiet\fR[=\fItrue\fR|\fIfalse\fR]
.RS 4
Make aria2 quite (no console output)\. Default:
\fIfalse\fR
.RE
.PP
\-\-realtime\-chunk\-checksum=\fItrue\fR|\fIfalse\fR
\fB\-\-realtime\-chunk\-checksum\fR=\fItrue\fR|\fIfalse\fR
.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:
\fItrue\fR
.RE
.PP
\-\-stop=SEC
\fB\-\-stop\fR=SEC
.RS 4
Stop application after SEC seconds has passed\. If
\fI0\fR
@ -599,7 +613,7 @@ is given, this feature is disabled\. Default:
\fI0\fR
.RE
.PP
\-v, \-\-version
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Print the version number, copyright and the configuration information and exit\.
.RE

178
doc/aria2c.1.html
View File

@ -312,7 +312,7 @@ div#toc a:visited { color: blue; }
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>aria2c</em> [OPTIONS] URL|TORRENT_FILE|METALINK_FILE &#8230;</p>
<p>aria2c [<em>OPTIONS</em>] [<em>URL</em> | <em>TORRENT_FILE</em> | <em>METALINK_FILE</em>]&#8230;</p>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
@ -323,7 +323,7 @@ div#toc a:visited { color: blue; }
<h3>Basic Options</h3>
<dl>
<dt>
-d, &#8212;dir=DIR
<strong>-d</strong>, <strong>&#8212;dir</strong>=DIR
</dt>
<dd>
<p>
@ -331,7 +331,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-i, &#8212;input-file=FILE
<strong>-i</strong>, <strong>&#8212;input-file</strong>=FILE
</dt>
<dd>
<p>
@ -341,7 +341,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-l, &#8212;log=LOG
<strong>-l</strong>, <strong>&#8212;log</strong>=LOG
</dt>
<dd>
<p>
@ -350,7 +350,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-j, &#8212;max-concurrent-downloads=N
<strong>-j</strong>, <strong>&#8212;max-concurrent-downloads</strong>=N
</dt>
<dd>
<p>
@ -359,7 +359,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
&#8212;check-integrity=<em>true</em>|<em>false</em>
<strong>&#8212;check-integrity</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
@ -371,7 +371,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-c, &#8212;continue
<strong>-c</strong>, <strong>&#8212;continue</strong>
</dt>
<dd>
<p>
@ -382,13 +382,13 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-h, &#8212;help[=CATEGORY]
<strong>-h</strong>, <strong>&#8212;help</strong>[=CATEGORY]
</dt>
<dd>
<p>
Print usage and exit.
The help messages are classified in several categories.
For example, type "&#8212;help=http" for detailed explanation for the options
For example, type "<strong>&#8212;help</strong>=http" for detailed explanation for the options
related to HTTP. If no matching category is found, search option name using
a given word in forward match and print the result.
Available Values: <em>basic</em>, <em>advanced</em>, <em>http</em>, <em>ftp</em>, <em>metalink</em>,
@ -400,7 +400,7 @@ div#toc a:visited { color: blue; }
<h3>HTTP/FTP Options</h3>
<dl>
<dt>
&#8212;lowest-speed-limit=SPEED
<strong>&#8212;lowest-speed-limit</strong>=SPEED
</dt>
<dd>
<p>
@ -413,7 +413,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-m, &#8212;max-tries=N
<strong>-m</strong>, <strong>&#8212;max-tries</strong>=N
</dt>
<dd>
<p>
@ -422,7 +422,7 @@ div#toc a:visited { color: blue; }
</p>
</dd>
<dt>
-o, &#8212;out=FILE
<strong>-o</strong>, <strong>&#8212;out</strong>=FILE
</dt>
<dd>
<p>
@ -437,13 +437,13 @@ div#toc a:visited { color: blue; }
</td>
<td class="content">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 -i, -Z option, like this:
is done by command line without <strong>-i</strong>, -Z option, like this:
aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</tr></table>
</div>
<dl>
<dt>
&#8212;retry-wait=SEC
<strong>&#8212;retry-wait</strong>=SEC
</dt>
<dd>
<p>
@ -453,7 +453,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
-s, &#8212;split=N
<strong>-s</strong>, <strong>&#8212;split</strong>=N
</dt>
<dd>
<p>
@ -464,7 +464,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
-t, &#8212;timeout=SEC
<strong>-t</strong>, <strong>&#8212;timeout</strong>=SEC
</dt>
<dd>
<p>
@ -476,7 +476,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
<h3>HTTP Specific Options</h3>
<dl>
<dt>
&#8212;http-auth-scheme=SCHEME
<strong>&#8212;http-auth-scheme</strong>=SCHEME
</dt>
<dd>
<p>
@ -486,7 +486,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;http-user=USER
<strong>&#8212;http-user</strong>=USER
</dt>
<dd>
<p>
@ -494,7 +494,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;http-passwd=PASSWD
<strong>&#8212;http-passwd</strong>=PASSWD
</dt>
<dd>
<p>
@ -502,7 +502,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;http-proxy=HOST:PORT
<strong>&#8212;http-proxy</strong>=HOST:PORT
</dt>
<dd>
<p>
@ -510,7 +510,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;http-proxy-user=USER
<strong>&#8212;http-proxy-user</strong>=USER
</dt>
<dd>
<p>
@ -518,7 +518,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;http-proxy-passwd=PASSWD
<strong>&#8212;http-proxy-passwd</strong>=PASSWD
</dt>
<dd>
<p>
@ -526,7 +526,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;http-proxy-method=METHOD
<strong>&#8212;http-proxy-method</strong>=METHOD
</dt>
<dd>
<p>
@ -536,7 +536,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;referer=REFERER
<strong>&#8212;referer</strong>=REFERER
</dt>
<dd>
<p>
@ -544,7 +544,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;enable-http-keep-alive[=<em>true</em>|<em>false</em>]
<strong>&#8212;enable-http-keep-alive</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -553,7 +553,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;enable-http-pipelining[=<em>true</em>|<em>false</em>]
<strong>&#8212;enable-http-pipelining</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -562,17 +562,17 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;header=HEADER
<strong>&#8212;header</strong>=HEADER
</dt>
<dd>
<p>
Append HEADER to HTTP request header.
You can use this option repeatedly to specify more than one header:
aria2c &#8212;header="X-A: b78" &#8212;header="X-B: 9J1" http://host/file
aria2c <strong>&#8212;header</strong>="X-A: b78" <strong>&#8212;header</strong>="X-B: 9J1" http://host/file
</p>
</dd>
<dt>
&#8212;load-cookies=FILE
<strong>&#8212;load-cookies</strong>=FILE
</dt>
<dd>
<p>
@ -581,7 +581,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
-U, &#8212;user-agent=USER_AGENT
<strong>-U</strong>, <strong>&#8212;user-agent</strong>=USER_AGENT
</dt>
<dd>
<p>
@ -592,7 +592,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
<h3>FTP Specific Options</h3>
<dl>
<dt>
&#8212;ftp-user=USER
<strong>&#8212;ftp-user</strong>=USER
</dt>
<dd>
<p>
@ -601,7 +601,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;ftp-passwd=PASSWD
<strong>&#8212;ftp-passwd</strong>=PASSWD
</dt>
<dd>
<p>
@ -610,7 +610,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
-p, &#8212;ftp-pasv
<strong>-p</strong>, <strong>&#8212;ftp-pasv</strong>
</dt>
<dd>
<p>
@ -618,7 +618,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;ftp-type=TYPE
<strong>&#8212;ftp-type</strong>=TYPE
</dt>
<dd>
<p>
@ -627,7 +627,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;ftp-reuse-connection[=<em>true</em>|<em>false</em>]
<strong>&#8212;ftp-reuse-connection</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -636,7 +636,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
&#8212;ftp-via-http-proxy=METHOD
<strong>&#8212;ftp-via-http-proxy</strong>=METHOD
</dt>
<dd>
<p>
@ -645,7 +645,7 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
</p>
</dd>
<dt>
-n, &#8212;no-netrc
<strong>-n</strong>, <strong>&#8212;no-netrc</strong>
</dt>
<dd>
<p>
@ -656,17 +656,17 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
<h3>BitTorrent/Metalink Options</h3>
<dl>
<dt>
&#8212;select-file=INDEX&#8230;
<strong>&#8212;select-file</strong>=INDEX&#8230;
</dt>
<dd>
<p>
Set file to download by specifing its index.
You can find the file index using the &#8212;show-files option.
You can find the file index using the <strong>&#8212;show-files</strong> option.
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>.
"," and "-" can be used together: <em>1-5,8,9</em>.
When used with the -M option, index may vary depending on the query
(see &#8212;metalink-* options).
(see <strong>&#8212;metalink-</strong>* options).
</p>
</dd>
</dl>
@ -683,7 +683,7 @@ writes the piece to the appropriate files.</td>
</div>
<dl>
<dt>
-S, &#8212;show-files
<strong>-S</strong>, <strong>&#8212;show-files</strong>
</dt>
<dd>
<p>
@ -696,7 +696,7 @@ writes the piece to the appropriate files.</td>
<h3>BitTorrent Specific Options</h3>
<dl>
<dt>
&#8212;bt-min-crypto-level=<em>plain</em>|<em>arc4</em>
<strong>&#8212;bt-min-crypto-level</strong>=<em>plain</em>|<em>arc4</em>
</dt>
<dd>
<p>
@ -707,7 +707,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;bt-require-crypto=<em>true</em>|<em>false</em>
<strong>&#8212;bt-require-crypto</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
@ -718,7 +718,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;dht-entry-point=HOST:PORT
<strong>&#8212;dht-entry-point</strong>=HOST:PORT
</dt>
<dd>
<p>
@ -726,7 +726,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;dht-listen-port=PORT&#8230;
<strong>&#8212;dht-listen-port</strong>=PORT&#8230;
</dt>
<dd>
<p>
@ -738,7 +738,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;direct-file-mapping=<em>true</em>|<em>false</em>
<strong>&#8212;direct-file-mapping</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
@ -749,7 +749,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;enable-dht[=<em>true</em>|<em>false</em>]
<strong>&#8212;enable-dht</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -759,7 +759,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;enable-peer-exchange[=<em>true</em>|<em>false</em>]
<strong>&#8212;enable-peer-exchange</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -769,7 +769,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;follow-torrent=<em>true</em>|<em>false</em>|<em>mem</em>
<strong>&#8212;follow-torrent</strong>=<em>true</em>|<em>false</em>|<em>mem</em>
</dt>
<dd>
<p>
@ -783,7 +783,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;listen-port=PORT&#8230;
<strong>&#8212;listen-port</strong>=PORT&#8230;
</dt>
<dd>
<p>
@ -805,7 +805,7 @@ writes the piece to the appropriate files.</td>
</div>
<dl>
<dt>
&#8212;max-upload-limit=SPEED
<strong>&#8212;max-upload-limit</strong>=SPEED
</dt>
<dd>
<p>
@ -815,7 +815,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;peer-id-prefix=PEERI_ID_PREFIX
<strong>&#8212;peer-id-prefix</strong>=PEERI_ID_PREFIX
</dt>
<dd>
<p>
@ -827,7 +827,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;seed-ratio=RATIO
<strong>&#8212;seed-ratio</strong>=RATIO
</dt>
<dd>
<p>
@ -835,21 +835,21 @@ writes the piece to the appropriate files.</td>
RATIO.
I strongly encourages you 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.
If &#8212;seed-time option is specified along with this option, seeding ends when
If <strong>&#8212;seed-time</strong> option is specified along with this option, seeding ends when
at least one of the conditions is satisfied.
Default: <em>1.0</em>
</p>
</dd>
<dt>
&#8212;seed-time=MINUTES
<strong>&#8212;seed-time</strong>=MINUTES
</dt>
<dd>
<p>
Specify seeding time in minutes. Also see the &#8212;seed-ratio option.
Specify seeding time in minutes. Also see the <strong>&#8212;seed-ratio</strong> option.
</p>
</dd>
<dt>
-T, &#8212;torrent-file=TORRENT_FILE
<strong>-T</strong>, <strong>&#8212;torrent-file</strong>=TORRENT_FILE
</dt>
<dd>
<p>
@ -861,7 +861,7 @@ writes the piece to the appropriate files.</td>
<h3>Metalink Specific Options</h3>
<dl>
<dt>
&#8212;follow-metalink=<em>true</em>|<em>false</em>|<em>mem</em>
<strong>&#8212;follow-metalink</strong>=<em>true</em>|<em>false</em>|<em>mem</em>
</dt>
<dd>
<p>
@ -875,7 +875,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
-M, &#8212;metalink-file=METALINK_FILE
<strong>-M</strong>, <strong>&#8212;metalink-file</strong>=METALINK_FILE
</dt>
<dd>
<p>
@ -884,7 +884,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
-C, &#8212;metalink-servers=NUM_SERVERS
<strong>-C</strong>, <strong>&#8212;metalink-servers</strong>=NUM_SERVERS
</dt>
<dd>
<p>
@ -895,7 +895,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;metalink-language=LANGUAGE
<strong>&#8212;metalink-language</strong>=LANGUAGE
</dt>
<dd>
<p>
@ -903,7 +903,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;metalink-location=LOCATION[,&#8230;]
<strong>&#8212;metalink-location</strong>=LOCATION[,&#8230;]
</dt>
<dd>
<p>
@ -912,7 +912,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;metalink-os=OS
<strong>&#8212;metalink-os</strong>=OS
</dt>
<dd>
<p>
@ -920,7 +920,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;metalink-version=VERSION
<strong>&#8212;metalink-version</strong>=VERSION
</dt>
<dd>
<p>
@ -928,7 +928,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;metalink-preferred-protocol=PROTO
<strong>&#8212;metalink-preferred-protocol</strong>=PROTO
</dt>
<dd>
<p>
@ -939,13 +939,13 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;metalink-enable-unique-protocol=<em>true</em>|<em>false</em>
<strong>&#8212;metalink-enable-unique-protocol</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
If <em>true</em> is given and several protocols are available for a mirror in a
metalink file, aria2 uses one of them.
Use &#8212;metalink-preferred-protocol option to specify the preference of
Use <strong>&#8212;metalink-preferred-protocol</strong> option to specify the preference of
protocol.
Default: <em>true</em>
</p>
@ -954,19 +954,19 @@ writes the piece to the appropriate files.</td>
<h3>Advanced Options</h3>
<dl>
<dt>
&#8212;allow-overwrite=<em>true</em>|<em>false</em>
<strong>&#8212;allow-overwrite</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
If <em>false</em> is given, aria2 doesn't download a file which already exists but
the corresponding .aria2 file doesn't exist.
In HTTP(S)/FTP download, if &#8212;auto-file-renaming=<em>true</em> then,
file name will be renamed. See &#8212;auto-file-renaming for details.
In HTTP(S)/FTP download, if <strong>&#8212;auto-file-renaming</strong>=<em>true</em> then,
file name will be renamed. See <strong>&#8212;auto-file-renaming</strong> for details.
Default: <em>false</em>
</p>
</dd>
<dt>
&#8212;allow-piece-length-change=<em>true</em>|<em>false</em>
<strong>&#8212;allow-piece-length-change</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
@ -977,7 +977,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;async-dns[=<em>true</em>|<em>false</em>]
<strong>&#8212;async-dns</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -986,7 +986,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;auto-file-renaming[=<em>true</em>|<em>false</em>]
<strong>&#8212;auto-file-renaming</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -997,7 +997,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;conf-path=PATH
<strong>&#8212;conf-path</strong>=PATH
</dt>
<dd>
<p>
@ -1006,7 +1006,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
-D, &#8212;daemon
<strong>-D</strong>, <strong>&#8212;daemon</strong>
</dt>
<dd>
<p>
@ -1014,7 +1014,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;enable-direct-io[=<em>true</em>|<em>false</em>]
<strong>&#8212;enable-direct-io</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -1024,7 +1024,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;file-allocation=METHOD
<strong>&#8212;file-allocation</strong>=METHOD
</dt>
<dd>
<p>
@ -1036,7 +1036,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;log-level=LEVEL
<strong>&#8212;log-level</strong>=LEVEL
</dt>
<dd>
<p>
@ -1046,7 +1046,7 @@ writes the piece to the appropriate files.</td>
</p>
</dd>
<dt>
&#8212;summary-interval=SEC
<strong>&#8212;summary-interval</strong>=SEC
</dt>
<dd>
<p>
@ -1067,7 +1067,7 @@ are also allocated if they share a same piece.</td>
</div>
<dl>
<dt>
-Z, &#8212;force-sequential[=<em>true</em>|<em>false</em>]
<strong>-Z</strong>, <strong>&#8212;force-sequential</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -1077,7 +1077,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
&#8212;max-download-limit=SPEED
<strong>&#8212;max-download-limit</strong>=SPEED
</dt>
<dd>
<p>
@ -1087,7 +1087,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
&#8212;no-conf
<strong>&#8212;no-conf</strong>
</dt>
<dd>
<p>
@ -1095,7 +1095,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
&#8212;no-file-allocation-limit=SIZE
<strong>&#8212;no-file-allocation-limit</strong>=SIZE
</dt>
<dd>
<p>
@ -1105,7 +1105,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
-P, &#8212;parameterized-uri[=<em>true</em>|<em>false</em>]
<strong>-P</strong>, <strong>&#8212;parameterized-uri</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -1120,7 +1120,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
-q, &#8212;quiet[=<em>true</em>|<em>false</em>]
<strong>-q</strong>, <strong>&#8212;quiet</strong>[=<em>true</em>|<em>false</em>]
</dt>
<dd>
<p>
@ -1129,7 +1129,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
&#8212;realtime-chunk-checksum=<em>true</em>|<em>false</em>
<strong>&#8212;realtime-chunk-checksum</strong>=<em>true</em>|<em>false</em>
</dt>
<dd>
<p>
@ -1140,7 +1140,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
&#8212;stop=SEC
<strong>&#8212;stop</strong>=SEC
</dt>
<dd>
<p>
@ -1150,7 +1150,7 @@ are also allocated if they share a same piece.</td>
</p>
</dd>
<dt>
-v, &#8212;version
<strong>-v</strong>, <strong>&#8212;version</strong>
</dt>
<dd>
<p>
@ -1548,7 +1548,7 @@ files in the program, then also delete it here.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 19-May-2008 21:34:04 JST
Last updated 21-May-2008 16:44:28 JST
</div>
</div>
</body>

176
doc/aria2c.1.txt
View File

@ -8,7 +8,7 @@ aria2c - The ultra fast download utility
SYNOPSIS
--------
'aria2c' [OPTIONS] URL|TORRENT_FILE|METALINK_FILE ...
aria2c ['OPTIONS'] ['URL' | 'TORRENT_FILE' | 'METALINK_FILE']...
DESCRIPTION
-----------
@ -19,39 +19,39 @@ OPTIONS
Basic Options
~~~~~~~~~~~~~
-d, --dir=DIR::
*-d*, *--dir*=DIR::
The directory to store the downloaded file.
-i, --input-file=FILE::
*-i*, *--input-file*=FILE::
Downloads URIs found in FILE. You can specify multiple URIs for a single
entity: separate URIs on a single line using the TAB character.
Reads input from stdin when '-' is specified.
-l, --log=LOG::
*-l*, *--log*=LOG::
The file name of the log file. If '-' is specified, log is written to
stdout.
-j, --max-concurrent-downloads=N::
*-j*, *--max-concurrent-downloads*=N::
Set maximum number of parallel downloads.
Default: '5'
--check-integrity='true'|'false'::
*--check-integrity*='true'|'false'::
Check file integrity by validating piece hash.
This option only affects in BitTorrent downloads and Metalink downloads with
chunk checksums.
Use this option to re-download a damaged portion of a file.
Default: 'false'
-c, --continue::
*-c*, *--continue*::
Continue downloading a partially downloaded file.
Use this option to resume a download started by a web browser or another
program which downloads files sequentially from the beginning.
Currently this option is only applicable to HTTP(S)/FTP downloads.
-h, --help[=CATEGORY]::
*-h*, *--help*[=CATEGORY]::
Print usage and exit.
The help messages are classified in several categories.
For example, type "--help=http" for detailed explanation for the options
For example, type "*--help*=http" for detailed explanation for the options
related to HTTP. If no matching category is found, search option name using
a given word in forward match and print the result.
Available Values: 'basic', 'advanced', 'http', 'ftp', 'metalink',
@ -60,7 +60,7 @@ Basic Options
HTTP/FTP Options
~~~~~~~~~~~~~~~~
--lowest-speed-limit=SPEED::
*--lowest-speed-limit*=SPEED::
Close connection if download speed is lower than or equal to this
value(bytes per sec).
'0' means aria2 does not have a lowest speed limit.
@ -68,122 +68,122 @@ HTTP/FTP Options
This option does not affect BitTorrent downloads.
Default: '0'
-m, --max-tries=N::
*-m*, *--max-tries*=N::
Set number of tries. '0' means unlimited.
Default: '5'
-o, --out=FILE::
*-o*, *--out*=FILE::
The file name of the downloaded file.
[NOTE]
In Metalink, BitTorrent download you cannot specify file name.
The file name specified here is only used when the URLs fed to aria2
is done by command line without -i, -Z option, like this:
is done by command line without *-i*, -Z option, like this:
aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip
--retry-wait=SEC::
*--retry-wait*=SEC::
Set the seconds to wait to retry after an error has occured.
Specify a value between '0' and '60'.
Default: '5'
-s, --split=N::
*-s*, *--split*=N::
Download a file using N connections. N must be between '1' and '5'.
This option affects all URLs. Thus, aria2 connects to each URL with N
connections.
Default: '1'
-t, --timeout=SEC::
*-t*, *--timeout*=SEC::
Set timeout in seconds.
Default: '60'
HTTP Specific Options
~~~~~~~~~~~~~~~~~~~~~
--http-auth-scheme=SCHEME::
*--http-auth-scheme*=SCHEME::
Set HTTP authentication scheme.
Currently, 'basic' is the only supported scheme.
Default: 'basic'
--http-user=USER::
*--http-user*=USER::
Set HTTP user. This affects all URLs.
--http-passwd=PASSWD::
*--http-passwd*=PASSWD::
Set HTTP password. This affects all URLs.
--http-proxy=HOST:PORT::
*--http-proxy*=HOST:PORT::
Use HTTP proxy server. This affects all URLs.
--http-proxy-user=USER::
*--http-proxy-user*=USER::
Set HTTP proxy user. This affects all URLs.
--http-proxy-passwd=PASSWD::
*--http-proxy-passwd*=PASSWD::
Set HTTP proxy password. This affects all URLs.
--http-proxy-method=METHOD::
*--http-proxy-method*=METHOD::
Set the method to use in proxy request.
'METHOD' is either 'get' or 'tunnel'.
Default: 'tunnel'
--referer=REFERER::
*--referer*=REFERER::
Set Referer. This affects all URLs.
--enable-http-keep-alive[='true'|'false']::
*--enable-http-keep-alive*[='true'|'false']::
Enable HTTP/1.1 persistent connection.
Default: 'true'
--enable-http-pipelining[='true'|'false']::
*--enable-http-pipelining*[='true'|'false']::
Enable HTTP/1.1 pipelining.
Default: 'false'
--header=HEADER::
*--header*=HEADER::
Append HEADER to HTTP request header.
You can use this option repeatedly to specify more than one header:
aria2c --header="X-A: b78" --header="X-B: 9J1" http://host/file
aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" http://host/file
--load-cookies=FILE::
*--load-cookies*=FILE::
Load cookies from FILE.
The format of FILE is the same used by Netscape and Mozilla.
-U, --user-agent=USER_AGENT::
*-U*, *--user-agent*=USER_AGENT::
Set user agent for HTTP(S) downloads.
FTP Specific Options
~~~~~~~~~~~~~~~~~~~~
--ftp-user=USER::
*--ftp-user*=USER::
Set FTP user. This affects all URLs.
Default: 'anonymous'
--ftp-passwd=PASSWD::
*--ftp-passwd*=PASSWD::
Set FTP password. This affects all URLs.
Default: 'ARIA2USER@'
-p, --ftp-pasv::
*-p*, *--ftp-pasv*::
Use passive mode in FTP.
--ftp-type=TYPE::
*--ftp-type*=TYPE::
Set FTP transfer type. TYPE is either 'binary' or 'ascii'.
Default: 'binary'
--ftp-reuse-connection[='true'|'false']::
*--ftp-reuse-connection*[='true'|'false']::
Reuse connection in FTP.
Default: 'true'
--ftp-via-http-proxy=METHOD::
*--ftp-via-http-proxy*=METHOD::
Use HTTP proxy in FTP. METHOD is either 'get' or 'tunnel'.
Default: 'tunnel'
-n, --no-netrc::
*-n*, *--no-netrc*::
Disables netrc support. netrc support is enabled by default.
BitTorrent/Metalink Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~
--select-file=INDEX...::
*--select-file*=INDEX...::
Set file to download by specifing its index.
You can find the file index using the --show-files option.
You can find the file index using the *--show-files* option.
Multiple indexes can be specified by using ",", for example: '3,6'.
You can also use "-" to specify a range: '1-5'.
"," and "-" can be used together: '1-5,8,9'.
When used with the -M option, index may vary depending on the query
(see --metalink-* options).
(see *--metalink-** options).
[NOTE]
In multi file torrent, the adjacent files specified by this option may
@ -191,52 +191,52 @@ also be downloaded. This is by design, not a bug.
A single piece may include several files or part of files, and aria2
writes the piece to the appropriate files.
-S, --show-files::
*-S*, *--show-files*::
Print file listing of .torrent or .metalink file and exit.
In case of .torrent file, additional information
(infohash, piece length, etc) is also printed.
BitTorrent Specific Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~
--bt-min-crypto-level='plain'|'arc4'::
*--bt-min-crypto-level*='plain'|'arc4'::
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: 'plain'
--bt-require-crypto='true'|'false'::
*--bt-require-crypto*='true'|'false'::
If true is given, aria2 doesn't accept and establish connection with legacy
BitTorrent handshake(\19BitTorrent protocol).
Thus aria2 always uses Obfuscation handshake.
Default: 'false'
--dht-entry-point=HOST:PORT::
*--dht-entry-point*=HOST:PORT::
Set host and port as an entry point to DHT network.
--dht-listen-port=PORT...::
*--dht-listen-port*=PORT...::
Set UDP listening port for DHT.
Multiple ports can be specified by using ",", for example: '6881,6885'.
You can also use "-" to specify a range: '6881-6999'. "," and "-" can be used
together.
Default: '6881-6999'
--direct-file-mapping='true'|'false'::
*--direct-file-mapping*='true'|'false'::
Directly read from and write to each file mentioned in .torrent file.
Use this option if lots of files are listed in .torrent file and aria2
complains it cannot open files anymore.
Default: 'true'
--enable-dht[='true'|'false']::
*--enable-dht*[='true'|'false']::
Enable DHT functionality. If a private flag is set in a torrent, aria2
doesn't use DHT for that download even if 'true' is given.
Default: 'false'
--enable-peer-exchange[='true'|'false']::
*--enable-peer-exchange*[='true'|'false']::
Enable Peer Exchange extension. If a private flag is set in a torrent, this
feature is disabled for that download even if 'true' is given.
Default: 'true'
--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
type is "application/x-bittorrent" is downloaded, aria2 parses it as a torrent
file and downloads files mentioned in it.
@ -245,7 +245,7 @@ BitTorrent Specific Options
If 'false' is specified, the action mentioned above is not taken.
Default: 'true'
--listen-port=PORT...::
*--listen-port*=PORT...::
Set TCP port number for BitTorrent downloads.
Multiple ports can be specified by using ",", for example: '6881,6885'.
You can also use "-" to specify a range: '6881-6999'.
@ -255,37 +255,37 @@ BitTorrent Specific Options
[NOTE]
Make sure that the specified ports are open for incoming TCP traffic.
--max-upload-limit=SPEED::
*--max-upload-limit*=SPEED::
Set max upload speed in bytes per sec. '0' means unrestricted.
You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
Default: '0'
--peer-id-prefix=PEERI_ID_PREFIX::
*--peer-id-prefix*=PEERI_ID_PREFIX::
Specify the prefix of peer ID. The peer ID in BitTorrent is 20 byte length.
If more than 20 bytes are specified, only first 20 bytes are used.
If less than 20 bytes are specified, the random alphabet characters are
added to make it's length 20 bytes.
Default: '-aria2-'
--seed-ratio=RATIO::
*--seed-ratio*=RATIO::
Specify share ratio. Seed completed torrents until share ratio reaches]
RATIO.
I strongly encourages you to specify equals or more than '1.0' here.
Specify '0.0' if you intend to do seeding regardless of share ratio.
If --seed-time option is specified along with this option, seeding ends when
If *--seed-time* option is specified along with this option, seeding ends when
at least one of the conditions is satisfied.
Default: '1.0'
--seed-time=MINUTES::
Specify seeding time in minutes. Also see the --seed-ratio option.
*--seed-time*=MINUTES::
Specify seeding time in minutes. Also see the *--seed-ratio* option.
-T, --torrent-file=TORRENT_FILE::
*-T*, *--torrent-file*=TORRENT_FILE::
The path to the .torrent file.
You may not use this option because you can specify torrent file without -T.
Metalink Specific Options
~~~~~~~~~~~~~~~~~~~~~~~~~
--follow-metalink='true'|'false'|'mem'::
*--follow-metalink*='true'|'false'|'mem'::
If 'true' or 'mem' 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.
@ -294,92 +294,92 @@ Metalink Specific Options
If 'false' is specified, the action mentioned above is not taken.
Default: 'true'
-M, --metalink-file=METALINK_FILE::
*-M*, *--metalink-file*=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.
Some metalinks regulates the number of servers to connect.
aria2 respects them.
Default: '5'
--metalink-language=LANGUAGE::
*--metalink-language*=LANGUAGE::
The language of the file to download.
--metalink-location=LOCATION[,...]::
*--metalink-location*=LOCATION[,...]::
The location of the preferred server.
A comma-deliminated list of locations is acceptable, for example, 'JP,US'.
--metalink-os=OS::
*--metalink-os*=OS::
The operating system of the file to download.
--metalink-version=VERSION::
*--metalink-version*=VERSION::
The version of the file to download.
--metalink-preferred-protocol=PROTO::
*--metalink-preferred-protocol*=PROTO::
Specify preferred protocol.
The possible values are 'http', 'https', 'ftp' and 'none'.
Specifiy 'none' to disable this feature.
Default: 'none'
--metalink-enable-unique-protocol='true'|'false'::
*--metalink-enable-unique-protocol*='true'|'false'::
If 'true' is given and several protocols are available for a mirror in a
metalink file, aria2 uses one of them.
Use --metalink-preferred-protocol option to specify the preference of
Use *--metalink-preferred-protocol* option to specify the preference of
protocol.
Default: 'true'
Advanced Options
~~~~~~~~~~~~~~~~
--allow-overwrite='true'|'false'::
*--allow-overwrite*='true'|'false'::
If 'false' is given, aria2 doesn't download a file which already exists but
the corresponding .aria2 file doesn't exist.
In HTTP(S)/FTP download, if --auto-file-renaming='true' then,
file name will be renamed. See --auto-file-renaming for details.
In HTTP(S)/FTP download, if *--auto-file-renaming*='true' then,
file name will be renamed. See *--auto-file-renaming* for details.
Default: 'false'
--allow-piece-length-change='true'|'false'::
*--allow-piece-length-change*='true'|'false'::
If false is given, aria2 aborts download when a piece length is different
from one in a control file.
If true is given, you can proceed but some download progress will be lost.
Default: 'false'
--async-dns[='true'|'false']::
*--async-dns*[='true'|'false']::
Enable asynchronous DNS.
Default: 'true'
--auto-file-renaming[='true'|'false']::
*--auto-file-renaming*[='true'|'false']::
Rename file name if the same file already exists.
This option works only in HTTP(S)/FTP download.
The new file name has a dot and a number(1..9999) appended.
Default: 'true'
--conf-path=PATH::
*--conf-path*=PATH::
Change the configuration file path to PATH.
Default: '$HOME/.aria2/aria2.conf'
-D, --daemon::
*-D*, *--daemon*::
Run as daemon.
--enable-direct-io[='true'|'false']::
*--enable-direct-io*[='true'|'false']::
Enable directI/O, which lowers cpu usage while allocating/checking files.
Turn off if you encounter any error.
Default: 'false'
--file-allocation=METHOD::
*--file-allocation*=METHOD::
Specify file allocation method. METHOD is either 'none' or 'prealloc'.
'none' doesn't pre-allocate file space. 'prealloc' pre-allocates file space
before download begins. This may take some time depending on the size of the
file.
Default: 'prealloc'
--log-level=LEVEL::
*--log-level*=LEVEL::
Set log level to output.
LEVEL is either 'debug', 'info', 'notice', 'warn' or 'error'.
Default: 'debug'
--summary-interval=SEC::
*--summary-interval*=SEC::
Set interval in seconds to output download progress summary.
Setting '0' suppresses the output.
Default: '60'
@ -388,25 +388,25 @@ Advanced Options
In multi file torrent, the files adjacent forward to the specified files
are also allocated if they share a same piece.
-Z, --force-sequential[='true'|'false']::
*-Z*, *--force-sequential*[='true'|'false']::
Fetch URIs in the command-line sequentially and download each URI in a
separate session, like the usual command-line download utilities.
Default: 'false'
--max-download-limit=SPEED::
*--max-download-limit*=SPEED::
Set max download speed in bytes per sec. '0' means unrestricted.
You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
Default: '0'
--no-conf::
*--no-conf*::
Disable loading aria2.conf file.
--no-file-allocation-limit=SIZE::
*--no-file-allocation-limit*=SIZE::
No file allocation is made for files whose size is smaller than SIZE.
You can append 'K' or 'M'(1K = 1024, 1M = 1024K).
Default: '5M'
-P, --parameterized-uri[='true'|'false']::
*-P*, *--parameterized-uri*[='true'|'false']::
Enable parameterized URI support.
You can specify set of parts: 'http://{sv1,sv2,sv3}/foo.iso'.
Also you can specify numeric sequences with step counter:
@ -416,22 +416,22 @@ are also allocated if they share a same piece.
-Z option is required.
Default: 'false'
-q, --quiet[='true'|'false']::
*-q*, *--quiet*[='true'|'false']::
Make aria2 quite (no console output).
Default: 'false'
--realtime-chunk-checksum='true'|'false'::
*--realtime-chunk-checksum*='true'|'false'::
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: 'true'
--stop=SEC::
*--stop*=SEC::
Stop application after SEC seconds has passed.
If '0' is given, this feature is disabled.
Default: '0'
-v, --version::
*-v*, *--version*::
Print the version number, copyright and the configuration information and
exit.

2
src/version_usage.cc
View File

@ -74,7 +74,7 @@ void showVersion() {
}
void showUsage(const std::string& category, const Option* option) {
std::cout << StringFormat(_("Usage: %s [options] URL|TORRENT_FILE|METALINK_FILE ..."), PACKAGE_NAME) << "\n"
std::cout << StringFormat(_("Usage: %s [OPTIONS] [URL | TORRENT_FILE | METALINK_FILE]..."), PACKAGE_NAME) << "\n"
<< "\n";
SharedHandle<TagContainer> tc = HelpItemFactory::createHelpItems(option);