diff --git a/ChangeLog b/ChangeLog index 5ba42e69..0cab4a89 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2010-10-30 Tatsuhiro Tsujikawa + + Added command-line options cross reference in HTML man page. + * doc/aria2c.1.txt + 2010-10-30 Tatsuhiro Tsujikawa Moved -x and -k option to HTTP/FTP option. diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 5f3569b2..9ffe4d5f 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -604,7 +604,7 @@ downloading a file like BitTorrent.

Basic Options

--d, --dir=DIR +-d, --dir=DIR

@@ -612,7 +612,7 @@ downloading a file like BitTorrent.

--i, --input-file=FILE +-i, --input-file=FILE

@@ -625,7 +625,7 @@ downloading a file like BitTorrent.

--l, --log=LOG +-l, --log=LOG

@@ -634,17 +634,17 @@ downloading a file like BitTorrent.

--j, --max-concurrent-downloads=N +-j, --max-concurrent-downloads=N

Set maximum number of parallel downloads for every static (HTTP/FTP) URI, - torrent and metalink. See also -s and -C option. + torrent and metalink. See also -s and -C option. Default: 5

--V, --check-integrity[=true|false] +-V, --check-integrity[=true|false]

@@ -660,7 +660,7 @@ downloading a file like BitTorrent.

--c, --continue +-c, --continue

@@ -671,7 +671,7 @@ downloading a file like BitTorrent.

--h, --help[=TAG|KEYWORD] +-h, --help[=TAG|KEYWORD]

@@ -689,14 +689,14 @@ downloading a file like BitTorrent.

HTTP/FTP Options

---all-proxy=PROXY +--all-proxy=PROXY

Use this proxy server for all protocols. To erase previously defined proxy, use "". You can override this setting and specify a - proxy server for a particular protocol using --http-proxy, - --https-proxy and --ftp-proxy options. This affects all URIs. + proxy server for a particular protocol using --http-proxy, + --https-proxy and --ftp-proxy options. This affects all URIs. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -724,34 +724,34 @@ then you get HTTP proxy "http://proxy" with user "user" and password
---all-proxy-passwd=PASSWD +--all-proxy-passwd=PASSWD

- Set password for --all-proxy option. + Set password for --all-proxy option.

---all-proxy-user=USER +--all-proxy-user=USER

- Set user for --all-proxy option. + Set user for --all-proxy option.

---connect-timeout=SEC +--connect-timeout=SEC

Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server. After the connection is established, this - option makes no effect and --timeout option is used instead. + option makes no effect and --timeout option is used instead. Default: 60

---dry-run[=true|false] +--dry-run[=true|false]

@@ -762,7 +762,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password

---lowest-speed-limit=SPEED +--lowest-speed-limit=SPEED

@@ -775,7 +775,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password

--x, --max-connection-per-server=NUM +-x, --max-connection-per-server=NUM

@@ -784,7 +784,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password

---max-file-not-found=NUM +--max-file-not-found=NUM

@@ -796,7 +796,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password

--m, --max-tries=N +-m, --max-tries=N

@@ -805,21 +805,21 @@ then you get HTTP proxy "http://proxy" with user "user" and password

--k, --min-split-size=SIZE +-k, --min-split-size=SIZE

aria2 does not split less than 2*SIZE byte range. For example, let’s consider downloading 20MiB file. If SIZE is 10M, aria2 can split file into 2 range [0-10MiB) and [10MiB-20MiB) and download it - using 2 sources(if --split >= 2, of course). If SIZE is 15M, + using 2 sources(if --split >= 2, of course). If SIZE is 15M, since 2*15M > 20MiB, aria2 does not split file and download it using 1 source. You can append K or M(1K = 1024, 1M = 1024K). Possible Values: 1M-1024M Default: 20M

--n, --no-netrc +-n, --no-netrc

@@ -827,7 +827,7 @@ then you get HTTP proxy "http://proxy" with user "user" and password

---no-proxy=DOMAINS +--no-proxy=DOMAINS

@@ -843,17 +843,17 @@ then you get HTTP proxy "http://proxy" with user "user" and password For network address with CIDR block, only IPv4 address works. Current implementation does not resolve hostname in URI to compare network -address specified in --no-proxy. So it is only effecive if URI has +address specified in --no-proxy. So it is only effecive if URI has numeric IP addresses.

--o, --out=FILE +-o, --out=FILE

- The file name of the downloaded file. When -Z option is used, this + The file name of the downloaded file. When -Z option is used, this option is ignored.

@@ -865,13 +865,13 @@ numeric IP addresses. In Metalink or BitTorrent download you cannot specify file name. The file name specified here is only used when the URIs fed to aria2 -are done by command line without -i, -Z option. For example: +are done by command line without -i, -Z option. For example: aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
---proxy-method=METHOD +--proxy-method=METHOD

@@ -882,7 +882,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

--R, --remote-time[=true|false] +-R, --remote-time[=true|false]

@@ -901,30 +901,30 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

---server-stat-of=FILE +--server-stat-of=FILE

Specify the filename to which performance profile of the servers is - saved. You can load saved data using --server-stat-if option. See + saved. You can load saved data using --server-stat-if option. See Server Performance Profile subsection below for file format.

---server-stat-if=FILE +--server-stat-if=FILE

Specify the filename to load performance profile of the servers. The loaded data will be used in some URI selector such as feedback. - See also --uri-selector option. See + See also --uri-selector option. See Server Performance Profile subsection below for file format.

---server-stat-timeout=SEC +--server-stat-timeout=SEC

@@ -934,7 +934,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

--s, --split=N +-s, --split=N

@@ -943,14 +943,14 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" less than N URIs are given, those URIs are used more than once so that N connections total are made simultaneously. The number of connections to the same host is restricted by - --max-connection-per-server option. Please see -j and - --min-split-size option too. Please note that in Metalink - download, this option has no effect and use -C option instead. + --max-connection-per-server option. Please see -j and + --min-split-size option too. Please note that in Metalink + download, this option has no effect and use -C option instead. Default: 5

--t, --timeout=SEC +-t, --timeout=SEC

@@ -959,7 +959,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

---uri-selector=SELECTOR +--uri-selector=SELECTOR

@@ -969,8 +969,8 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" uses download speed observed in the previous downloads and choose fastest server in the URI list. This also effectively skips dead mirrors. The observed download speed is a part of performance - profile of servers mentioned in --server-stat-of and - --server-stat-if options. If adaptive is given, selects one of + profile of servers mentioned in --server-stat-of and + --server-stat-if options. If adaptive is given, selects one of the best mirrors for the first and reserved connections. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mirrors @@ -983,37 +983,37 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

HTTP Specific Options

---ca-certificate=FILE +--ca-certificate=FILE

Use the certificate authorities in FILE to verify the peers. The certificate file must be in PEM format and can contain multiple CA certificates. - Use --check-certificate option to enable verification. + Use --check-certificate option to enable verification.

---certificate=FILE +--certificate=FILE

Use the client certificate in FILE. The certificate must be in PEM format. - You may use --private-key option to specify the private key. + You may use --private-key option to specify the private key.

---check-certificate[=true|false] +--check-certificate[=true|false]

- Verify the peer using certificates specified in --ca-certificate option. + Verify the peer using certificates specified in --ca-certificate option. Default: true

---http-accept-gzip[=true|false] +--http-accept-gzip[=true|false]

@@ -1035,7 +1035,7 @@ response header.

---http-auth-challenge[=true|false] +--http-auth-challenge[=true|false]

@@ -1047,18 +1047,18 @@ response header.

---http-no-cache[=true|false] +--http-no-cache[=true|false]

Send Cache-Control: no-cache and Pragma: no-cache header to avoid cached content. If false is given, these headers are not sent and you can add Cache-Control header with a directive you like - using --header option. Default: true + using --header option. Default: true

---http-user=USER +--http-user=USER

@@ -1066,7 +1066,7 @@ response header.

---http-passwd=PASSWD +--http-passwd=PASSWD

@@ -1074,70 +1074,70 @@ response header.

---http-proxy=PROXY +--http-proxy=PROXY

Use this proxy server for HTTP. To erase previously defined proxy, - use "". See also --all-proxy option. This affects all URIs. The + use "". See also --all-proxy option. This affects all URIs. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

---http-proxy-passwd=PASSWD +--http-proxy-passwd=PASSWD

- Set password for --http-proxy option. + Set password for --http-proxy option.

---http-proxy-user=USER +--http-proxy-user=USER

- Set user for --http-proxy option. + Set user for --http-proxy option.

---https-proxy=PROXY +--https-proxy=PROXY

Use this proxy server for HTTPS. To erase previously defined proxy, - use "". See also --all-proxy option. This affects all URIs. The + use "". See also --all-proxy option. This affects all URIs. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

---https-proxy-passwd=PASSWD +--https-proxy-passwd=PASSWD

- Set password for --https-proxy option. + Set password for --https-proxy option.

---https-proxy-user=USER +--https-proxy-user=USER

- Set user for --https-proxy option. + Set user for --https-proxy option.

---private-key=FILE +--private-key=FILE

Use the private key in FILE. The private key must be decrypted and in PEM format. The behavior when encrypted one is given is undefined. - See also --certificate option. + See also --certificate option.

---referer=REFERER +--referer=REFERER

@@ -1145,7 +1145,7 @@ response header.

---enable-http-keep-alive[=true|false] +--enable-http-keep-alive[=true|false]

@@ -1154,7 +1154,7 @@ response header.

---enable-http-pipelining[=true|false] +--enable-http-pipelining[=true|false]

@@ -1174,17 +1174,17 @@ this option.

---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

@@ -1205,7 +1205,7 @@ and Chromium/Google Chrome cookie format.

---save-cookies=FILE +--save-cookies=FILE

@@ -1216,7 +1216,7 @@ and Chromium/Google Chrome cookie format.

---use-head[=true|false] +--use-head[=true|false]

@@ -1225,7 +1225,7 @@ and Chromium/Google Chrome cookie format.

--U, --user-agent=USER_AGENT +-U, --user-agent=USER_AGENT

@@ -1237,7 +1237,7 @@ and Chromium/Google Chrome cookie format.

FTP Specific Options

---ftp-user=USER +--ftp-user=USER

@@ -1246,7 +1246,7 @@ and Chromium/Google Chrome cookie format.

---ftp-passwd=PASSWD +--ftp-passwd=PASSWD

@@ -1259,7 +1259,7 @@ and Chromium/Google Chrome cookie format.

--p, --ftp-pasv[=true|false] +-p, --ftp-pasv[=true|false]

@@ -1269,33 +1269,33 @@ and Chromium/Google Chrome cookie format.

---ftp-proxy=PROXY +--ftp-proxy=PROXY

Use this proxy server for FTP. To erase previously defined proxy, - use "". See also --all-proxy option. This affects all URIs. The + use "". See also --all-proxy option. This affects all URIs. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

---ftp-proxy-passwd=PASSWD +--ftp-proxy-passwd=PASSWD

- Set password for --ftp-proxy option. + Set password for --ftp-proxy option.

---ftp-proxy-user=USER +--ftp-proxy-user=USER

- Set user for --ftp-proxy option. + Set user for --ftp-proxy option.

---ftp-type=TYPE +--ftp-type=TYPE

@@ -1304,7 +1304,7 @@ and Chromium/Google Chrome cookie format.

---ftp-reuse-connection[=true|false] +--ftp-reuse-connection[=true|false]

@@ -1316,12 +1316,12 @@ and Chromium/Google Chrome cookie format.

BitTorrent/Metalink Options

---select-file=INDEX… +--select-file=INDEX…

Set file to download by specifying 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. @@ -1343,7 +1343,7 @@ writes the piece to the appropriate files.

--S, --show-files +-S, --show-files

@@ -1356,7 +1356,7 @@ writes the piece to the appropriate files.

BitTorrent Specific Options

---bt-enable-lpd[=true|false] +--bt-enable-lpd[=true|false]

@@ -1366,7 +1366,7 @@ writes the piece to the appropriate files.

---bt-exclude-tracker=URI[,…] +--bt-exclude-tracker=URI[,…]

@@ -1374,11 +1374,11 @@ writes the piece to the appropriate files. remove. You can use special value "*" which matches all URIs, thus removes all announce URIs. When specifying "*" in shell command-line, don’t forget to escape or quote it. See also - --bt-tracker option. + --bt-tracker option.

---bt-external-ip=IPADDRESS +--bt-external-ip=IPADDRESS

@@ -1388,11 +1388,11 @@ writes the piece to the appropriate files.

---bt-hash-check-seed[=true|false] +--bt-hash-check-seed[=true|false]

- If true is given, after hash check using --check-integrity option and + If true is given, after hash check using --check-integrity option and file is complete, continue to seed file. If you want to check file and download it only when it is damaged or incomplete, set this option to false. This option has effect only on BitTorrent download. @@ -1400,7 +1400,7 @@ writes the piece to the appropriate files.

---bt-lpd-interface=INTERFACE +--bt-lpd-interface=INTERFACE

@@ -1411,7 +1411,7 @@ writes the piece to the appropriate files.

---bt-max-open-files=NUM +--bt-max-open-files=NUM

@@ -1420,27 +1420,27 @@ writes the piece to the appropriate files.

---bt-max-peers=NUM +--bt-max-peers=NUM

Specify the maximum number of peers per torrent. 0 means - unlimited. See also --bt-request-peer-speed-limit option. + unlimited. See also --bt-request-peer-speed-limit option. Default: 55

---bt-metadata-only[=true|false] +--bt-metadata-only[=true|false]

Download metadata only. The file(s) described in metadata will not be downloaded. This option has effect only when BitTorrent Magnet - URI is used. See also --bt-save-metadata option. Default: false + URI is used. See also --bt-save-metadata option. Default: false

---bt-min-crypto-level=plain|arc4 +--bt-min-crypto-level=plain|arc4

@@ -1451,7 +1451,7 @@ writes the piece to the appropriate files.

---bt-prioritize-piece=head[=SIZE],tail[=SIZE] +--bt-prioritize-piece=head[=SIZE],tail[=SIZE]

@@ -1466,7 +1466,7 @@ writes the piece to the appropriate files.

---bt-require-crypto=true|false +--bt-require-crypto=true|false

@@ -1477,7 +1477,7 @@ writes the piece to the appropriate files.

---bt-request-peer-speed-limit=SPEED +--bt-request-peer-speed-limit=SPEED

@@ -1490,7 +1490,7 @@ writes the piece to the appropriate files.

---bt-save-metadata[=true|false] +--bt-save-metadata[=true|false]

@@ -1498,12 +1498,12 @@ writes the piece to the appropriate files. BitTorrent Magnet URI is used. The filename is hex encoded info hash with suffix .torrent. The directory to be saved is the same directory where download file is saved. If the same file already - exists, metadata is not saved. See also --bt-metadata-only + exists, metadata is not saved. See also --bt-metadata-only option. Default: false

---bt-seed-unverified[=true|false] +--bt-seed-unverified[=true|false]

@@ -1512,7 +1512,7 @@ writes the piece to the appropriate files.

---bt-stop-timeout=SEC +--bt-stop-timeout=SEC

@@ -1521,29 +1521,29 @@ writes the piece to the appropriate files.

---bt-tracker=URI[,…] +--bt-tracker=URI[,…]

Comma separated list of additional BitTorrent tracker’s announce - URI. These URIs are not affected by --bt-exclude-tracker option - because they are added after URIs in --bt-exclude-tracker option are + URI. These URIs are not affected by --bt-exclude-tracker option + because they are added after URIs in --bt-exclude-tracker option are removed.

---bt-tracker-connect-timeout=SEC +--bt-tracker-connect-timeout=SEC

Set the connect timeout in seconds to establish connection to tracker. After the connection is established, this option makes no - effect and --bt-tracker-timeout option is used instead. Default: + effect and --bt-tracker-timeout option is used instead. Default: 60

---bt-tracker-interval=SEC +--bt-tracker-interval=SEC

@@ -1555,7 +1555,7 @@ writes the piece to the appropriate files.

---bt-tracker-timeout=SEC +--bt-tracker-timeout=SEC

@@ -1563,7 +1563,7 @@ writes the piece to the appropriate files.

---dht-entry-point=HOST:PORT +--dht-entry-point=HOST:PORT

@@ -1571,7 +1571,7 @@ writes the piece to the appropriate files.

---dht-entry-point6=HOST:PORT +--dht-entry-point6=HOST:PORT

@@ -1579,7 +1579,7 @@ writes the piece to the appropriate files.

---dht-file-path=PATH +--dht-file-path=PATH

@@ -1588,7 +1588,7 @@ writes the piece to the appropriate files.

---dht-file-path6=PATH +--dht-file-path6=PATH

@@ -1597,7 +1597,7 @@ writes the piece to the appropriate files.

---dht-listen-addr6=ADDR +--dht-listen-addr6=ADDR

@@ -1606,7 +1606,7 @@ writes the piece to the appropriate files.

---dht-listen-port=PORT… +--dht-listen-port=PORT…

@@ -1628,7 +1628,7 @@ writes the piece to the appropriate files.

---dht-message-timeout=SEC +--dht-message-timeout=SEC

@@ -1636,7 +1636,7 @@ writes the piece to the appropriate files.

---enable-dht[=true|false] +--enable-dht[=true|false]

@@ -1646,18 +1646,18 @@ writes the piece to the appropriate files.

---enable-dht6[=true|false] +--enable-dht6[=true|false]

Enable IPv6 DHT functionality. If a private flag is set in a torrent, aria2 doesn’t use DHT for that download even if true is - given. Use --dht-listen-port option to specify port number to - listen on. See also --dht-listen-addr6 option. + given. Use --dht-listen-port option to specify port number to + listen on. See also --dht-listen-addr6 option.

---enable-peer-exchange[=true|false] +--enable-peer-exchange[=true|false]

@@ -1667,7 +1667,7 @@ writes the piece to the appropriate files.

---follow-torrent=true|false|mem +--follow-torrent=true|false|mem

@@ -1681,19 +1681,19 @@ writes the piece to the appropriate files.

--O, --index-out=INDEX=PATH +-O, --index-out=INDEX=PATH

Set file path for file with index=INDEX. You can find the file index - using the --show-files option. PATH is a relative path to the - path specified in --dir option. You can use this option multiple + using the --show-files option. PATH is a relative path to the + path specified in --dir option. You can use this option multiple times. Using this option, you can specify the output filenames of BitTorrent downloads.

---listen-port=PORT… +--listen-port=PORT…

@@ -1715,31 +1715,31 @@ writes the piece to the appropriate files.

---max-overall-upload-limit=SPEED +--max-overall-upload-limit=SPEED

Set max overall upload speed in bytes/sec. 0 means unrestricted. You can append K or M(1K = 1024, 1M = 1024K). - To limit the upload speed per torrent, use --max-upload-limit option. + To limit the upload speed per torrent, use --max-upload-limit option. Default: 0

--u, --max-upload-limit=SPEED +-u, --max-upload-limit=SPEED

Set max upload speed per each torrent in bytes/sec. 0 means unrestricted. You can append K or M(1K = 1024, 1M = 1024K). - To limit the overall upload speed, use --max-overall-upload-limit option. + To limit the overall upload speed, use --max-overall-upload-limit option. Default: 0

---peer-id-prefix=PEER_ID_PREFIX +--peer-id-prefix=PEER_ID_PREFIX

@@ -1752,7 +1752,7 @@ writes the piece to the appropriate files.

---seed-ratio=RATIO +--seed-ratio=RATIO

@@ -1760,17 +1760,17 @@ writes the piece to the appropriate files. RATIO. You are strongly encouraged 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 +--seed-time=MINUTES

- Specify seeding time in minutes. Also see the --seed-ratio option. + Specify seeding time in minutes. Also see the --seed-ratio option.

@@ -1779,24 +1779,24 @@ writes the piece to the appropriate files.
Note
-Specifying --seed-time=0 disables seeding after download completed. +Specifying --seed-time=0 disables seeding after download completed.
--T, --torrent-file=TORRENT_FILE +-T, --torrent-file=TORRENT_FILE

The path to the .torrent file. You are not required to use this - option because you can specify .torrent files without -T. + option because you can specify .torrent files without -T.

Metalink Specific Options

---follow-metalink=true|false|mem +--follow-metalink=true|false|mem

@@ -1810,17 +1810,17 @@ writes the piece to the appropriate files.

--M, --metalink-file=METALINK_FILE +-M, --metalink-file=METALINK_FILE

The file path to .metalink file. Reads input from stdin when - is specified. You are not required to use this option because you can - specify .metalink files without -M. + specify .metalink files without -M.

--C, --metalink-servers=NUM_SERVERS +-C, --metalink-servers=NUM_SERVERS

@@ -1830,12 +1830,12 @@ writes the piece to the appropriate files. 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 -s and -j options. + See also -s and -j options. Default: 5

---metalink-language=LANGUAGE +--metalink-language=LANGUAGE

@@ -1843,7 +1843,7 @@ writes the piece to the appropriate files.

---metalink-location=LOCATION[,…] +--metalink-location=LOCATION[,…]

@@ -1852,7 +1852,7 @@ writes the piece to the appropriate files.

---metalink-os=OS +--metalink-os=OS

@@ -1860,7 +1860,7 @@ writes the piece to the appropriate files.

---metalink-version=VERSION +--metalink-version=VERSION

@@ -1868,7 +1868,7 @@ writes the piece to the appropriate files.

---metalink-preferred-protocol=PROTO +--metalink-preferred-protocol=PROTO

@@ -1879,13 +1879,13 @@ writes the piece to the appropriate files.

---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

@@ -1894,17 +1894,17 @@ writes the piece to the appropriate files.

XML-RPC Options

---enable-xml-rpc[=true|false] +--enable-xml-rpc[=true|false]

Enable XML-RPC server. It is strongly recommended to set username - and password using --xml-rpc-user and --xml-rpc-passwd - option. See also --xml-rpc-listen-port option. Default: false + and password using --xml-rpc-user and --xml-rpc-passwd + option. See also --xml-rpc-listen-port option. Default: false

---xml-rpc-listen-all[=true|false] +--xml-rpc-listen-all[=true|false]

@@ -1913,7 +1913,7 @@ writes the piece to the appropriate files.

---xml-rpc-listen-port=PORT +--xml-rpc-listen-port=PORT

@@ -1922,7 +1922,7 @@ writes the piece to the appropriate files.

---xml-rpc-max-request-size=SIZE +--xml-rpc-max-request-size=SIZE

@@ -1931,7 +1931,7 @@ writes the piece to the appropriate files.

---xml-rpc-passwd=PASSWD +--xml-rpc-passwd=PASSWD

@@ -1939,7 +1939,7 @@ writes the piece to the appropriate files.

---xml-rpc-user=USER +--xml-rpc-user=USER

@@ -1950,17 +1950,17 @@ writes the piece to the appropriate files.

Advanced Options

---allow-overwrite=true|false +--allow-overwrite=true|false

Restart download from scratch if the corresponding control file - doesn’t exist. See also --auto-file-renaming option. Default: + doesn’t exist. See also --auto-file-renaming option. Default: false

---allow-piece-length-change=true|false +--allow-piece-length-change=true|false

@@ -1971,7 +1971,7 @@ writes the piece to the appropriate files.

---always-resume[=true|false] +--always-resume[=true|false]

@@ -1979,13 +1979,13 @@ writes the piece to the appropriate files. resume download and if resume is not possible, aborts download. If false is given, when all given URIs do not support resume or aria2 encounters N URIs which does not support resume (N is the value - specified using --max-resume-failure-tries option), aria2 - downloads file from scratch. See --max-resume-failure-tries + specified using --max-resume-failure-tries option), aria2 + downloads file from scratch. See --max-resume-failure-tries option. Default: true

---async-dns[=true|false] +--async-dns[=true|false]

@@ -1994,7 +1994,7 @@ writes the piece to the appropriate files.

---auto-file-renaming[=true|false] +--auto-file-renaming[=true|false]

@@ -2005,7 +2005,7 @@ writes the piece to the appropriate files.

---auto-save-interval=SEC +--auto-save-interval=SEC

@@ -2017,7 +2017,7 @@ writes the piece to the appropriate files.

---conditional-get[=true|false] +--conditional-get[=true|false]

@@ -2027,12 +2027,12 @@ writes the piece to the appropriate files. Content-Disposition header. If a control file exists, this option will be ignored. This function uses If-Modified-Since header to get only newer file conditionally. When getting modification time of - local file, it uses user supplied filename(see --out option) or - filename part in URI if --out is not specified. Default: false + local file, it uses user supplied filename(see --out option) or + filename part in URI if --out is not specified. Default: false

---conf-path=PATH +--conf-path=PATH

@@ -2041,7 +2041,7 @@ writes the piece to the appropriate files.

--D, --daemon +-D, --daemon

@@ -2051,7 +2051,7 @@ writes the piece to the appropriate files.

---disable-ipv6[=true|false] +--disable-ipv6[=true|false]

@@ -2060,17 +2060,17 @@ writes the piece to the appropriate files.

---enable-async-dns6[=true|false] +--enable-async-dns6[=true|false]

Enable IPv6 name resolution in asynchronous DNS resolver. This - option will be ignored when --async-dns=false. + option will be ignored when --async-dns=false. Default: false

---enable-direct-io[=true|false] +--enable-direct-io[=true|false]

@@ -2080,7 +2080,7 @@ writes the piece to the appropriate files.

---event-poll=POLL +--event-poll=POLL

@@ -2093,7 +2093,7 @@ writes the piece to the appropriate files.

---file-allocation=METHOD +--file-allocation=METHOD

@@ -2115,7 +2115,7 @@ writes the piece to the appropriate files.

---human-readable[=true|false] +--human-readable[=true|false]

@@ -2124,7 +2124,7 @@ writes the piece to the appropriate files.

---interface=INTERFACE +--interface=INTERFACE

@@ -2140,14 +2140,14 @@ writes the piece to the appropriate files.

Note
If an interface has multiple addresses, it is highly recommended to -specify IP address explicitly. See also --disable-ipv6. If your +specify IP address explicitly. See also --disable-ipv6. If your system doesn’t have getifaddrs(), this option doesn’t accept interface name.
---max-download-result=NUM +--max-download-result=NUM

@@ -2163,19 +2163,19 @@ name.

---max-resume-failure-tries=N +--max-resume-failure-tries=N

- When used with --always-resume=false, aria2 downloads file from + When used with --always-resume=false, aria2 downloads file from scratch when aria2 detects N number of URIs that does not support resume. If N is 0, aria2 downloads file from scratch when all - given URIs do not support resume. See --always-resume option. + given URIs do not support resume. See --always-resume option. Default: 0

---log-level=LEVEL +--log-level=LEVEL

@@ -2185,51 +2185,51 @@ name.

---on-bt-download-complete=COMMAND +--on-bt-download-complete=COMMAND

- For BitTorrent, a command specified in --on-download-complete is + For BitTorrent, a command specified in --on-download-complete is called when download completes and seeding is over. On the other hand, this option set the command to be executed when download - completes but before seeding. See --on-download-start option for + completes but before seeding. See --on-download-start option for the requirement of COMMAND. Possible Values: /path/to/command

---on-download-complete=COMMAND +--on-download-complete=COMMAND

Set the command to be executed when download completes. See - --on-download-start option for the requirement of COMMAND. See - also --on-download-stop option. Possible Values: + --on-download-start option for the requirement of COMMAND. See + also --on-download-stop option. Possible Values: /path/to/command

---on-download-error=COMMAND +--on-download-error=COMMAND

Set the command to be executed when download aborts due to error. - See --on-download-start option for the requirement of COMMAND. - See also --on-download-stop option. Possible Values: + See --on-download-start option for the requirement of COMMAND. + See also --on-download-stop option. Possible Values: /path/to/command

---on-download-pause=COMMAND +--on-download-pause=COMMAND

Set the command to be executed when download is paused. See - --on-download-start option for the requirement of COMMAND. + --on-download-start option for the requirement of COMMAND. Possible Values: /path/to/command

---on-download-start=COMMAND +--on-download-start=COMMAND

@@ -2239,20 +2239,20 @@ name.

---on-download-stop=COMMAND +--on-download-stop=COMMAND

Set the command to be executed when download stops. You can override the command to be executed for particular download result using - --on-download-complete and --on-download-error. If they are + --on-download-complete and --on-download-error. If they are specified, command specified in this option is not executed. See - --on-download-start option for the requirement of COMMAND. + --on-download-start option for the requirement of COMMAND. Possible Values: /path/to/command

---summary-interval=SEC +--summary-interval=SEC

@@ -2273,7 +2273,7 @@ are also allocated if they share the same piece.

--Z, --force-sequential[=true|false] +-Z, --force-sequential[=true|false]

@@ -2283,29 +2283,29 @@ are also allocated if they share the same piece.

---max-overall-download-limit=SPEED +--max-overall-download-limit=SPEED

Set max overall download speed in bytes/sec. 0 means unrestricted. You can append K or M(1K = 1024, 1M = 1024K). To - limit the download speed per download, use --max-download-limit + limit the download speed per download, use --max-download-limit option. Default: 0

---max-download-limit=SPEED +--max-download-limit=SPEED

Set max download speed per each download in bytes/sec. 0 means unrestricted. You can append K or M(1K = 1024, 1M = 1024K). To - limit the overall download speed, use --max-overall-download-limit + limit the overall download speed, use --max-overall-download-limit option. Default: 0

---no-conf +--no-conf

@@ -2313,7 +2313,7 @@ are also allocated if they share the same piece.

---no-file-allocation-limit=SIZE +--no-file-allocation-limit=SIZE

@@ -2323,7 +2323,7 @@ are also allocated if they share the same piece.

--P, --parameterized-uri[=true|false] +-P, --parameterized-uri[=true|false]

@@ -2338,7 +2338,7 @@ are also allocated if they share the same piece.

--q, --quiet[=true|false] +-q, --quiet[=true|false]

@@ -2347,7 +2347,7 @@ are also allocated if they share the same piece.

---realtime-chunk-checksum=true|false +--realtime-chunk-checksum=true|false

@@ -2357,12 +2357,12 @@ are also allocated if they share the same piece.

---remove-control-file[=true|false] +--remove-control-file[=true|false]

Remove control file before download. Using with - --allow-overwrite=true, download always starts from + --allow-overwrite=true, download always starts from scratch. This will be useful for users behind proxy server which disables resume.

@@ -2380,18 +2380,18 @@ connections.
---save-session=FILE +--save-session=FILE

Save error/unfinished downloads to FILE on exit. You can pass this - output file to aria2c with -i option on restart. Please note that + output file to aria2c with -i option on restart. Please note that downloads added by aria2.addTorrent and aria2.addMetalink XML-RPC method are not saved.

---stop=SEC +--stop=SEC

@@ -2401,7 +2401,7 @@ connections.

--v, --version +-v, --version

@@ -2419,7 +2419,7 @@ an argument, then the option name and its argument should be concatenated(e.g. the argument will be treated as URI and usually this is not what you expect.

URI, MAGNET, TORRENT_FILE, METALINK_FILE

You can specify multiple URIs in command-line. Unless you specify --Z option, all URIs must point to the same file or downloading will +-Z option, all URIs must point to the same file or downloading will fail.

You can specify arbitrary number of BitTorrent Magnet URI. Please note that they are always treated as a separate download. Both hex encoded @@ -2455,7 +2455,7 @@ contains "&" or any characters that have special meaning in shell. URI) if the previous transfer is made by aria2.

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 URI).

+-c URI).

EXIT STATUS

@@ -2501,7 +2501,7 @@ based on the last error encountered.

If aria2 sees the specfied number of "resource not found" error. - See --max-file-not-found option). + See --max-file-not-found option).

@@ -2510,7 +2510,7 @@ based on the last error encountered.

If a download aborts because download speed is too slow. - See --lowest-speed-limit option) + See --lowest-speed-limit option)

@@ -2563,7 +2563,7 @@ http_proxy [http://][USER:PASSWORD@]HOST[:PORT]

Specify proxy server for use in HTTP. Overrides http-proxy value in configuration file. - The command-line option --http-proxy overrides this value. + The command-line option --http-proxy overrides this value.

@@ -2573,7 +2573,7 @@ https_proxy [http://][USER:PASSWORD@]HOST[:PORT]

Specify proxy server for use in HTTPS. Overrides https-proxy value in configuration file. - The command-line option --https-proxy overrides this value. + The command-line option --https-proxy overrides this value.

@@ -2583,7 +2583,7 @@ ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]

Specify proxy server for use in FTP. Overrides ftp-proxy value in configuration file. - The command-line option --ftp-proxy overrides this value. + The command-line option --ftp-proxy overrides this value.

@@ -2593,7 +2593,7 @@ all_proxy [http://][USER:PASSWORD@]HOST[:PORT]

Specify proxy server for use if no protocol-specific proxy is specified. Overrides all-proxy value in configuration file. - The command-line option --all-proxy overrides this value. + The command-line option --all-proxy overrides this value.

@@ -2604,7 +2604,7 @@ no_proxy [DOMAIN,…] Specify comma-separated hostname, domains and network address with or without CIDR block to which proxy should not be used. Overrides no-proxy value in configuration file. The command-line option - --no-proxy overrides this value. + --no-proxy overrides this value.

@@ -2614,8 +2614,8 @@ no_proxy [DOMAIN,…]

aria2.conf

By default, aria2 parses $HOME/.aria2/aria2.conf as a configuraiton file. You can specify the path to configuration file using ---conf-path option. If you don’t want to use the configuraitonf -file, use --no-conf option.

+--conf-path option. If you don’t want to use the configuraitonf +file, use --no-conf option.

The configuration file is a text file and has 1 option per each line. In each line, you can specify name-value pair in the format: NAME=VALUE, where name is the long command-line option name without @@ -2636,7 +2636,7 @@ ftp-pasv=true the path $HOME/.aria2/dht6.dat.

Netrc

Netrc support is enabled by default for HTTP(S)/FTP. To disable netrc -support, specify -n option. Your .netrc file should have correct +support, specify -n option. Your .netrc file should have correct permissions(600).

If machine name starts ".", aria2 performs domain match instead of exact match. This is an extension of aria2. For example of domain @@ -2671,7 +2671,7 @@ to aria2c in command-line.

can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character.

Each line is treated as if it is provided in command-line argument. -Therefore they are affected by -Z and -P options.

+Therefore they are affected by -Z and -P options.

Lines starting with "#" are treated as comments and skipped.

Additionally, the following options can be specified after each line of URIs. These optional lines must start with white space(s).

@@ -3152,11 +3152,11 @@ command-line options, but it just applies to the URIs it belongs to.

out=file.img http://foo/bar -

If aria2 is executed with -i uri.txt -d /tmp options, then +

If aria2 is executed with -i uri.txt -d /tmp options, then file.iso is saved as /iso_images/file.img and it is downloaded from http://server/file.iso and http://mirror/file.iso. The file bar is downloaded from http://foo/bar and saved as /tmp/bar.

-

In some cases, out parameter has no effect. See note of --out +

In some cases, out parameter has no effect. See note of --out option for the restrictions.

Server Performance Profile

This section describes the format of server performance profile. The @@ -3316,7 +3316,7 @@ given as an integer starting from 0, the new download is inserted at position is larger than the size of the queue, it is appended at the end of the queue. This method returns GID of registered download. Please note that the downloads added by this method are not saved by ---save-session.

+--save-session.

Adding local file file.torrent to aria2:

@@ -3335,7 +3335,7 @@ inserted at position in the waiting queue. If position is not given or position is larger than the size of the queue, it is appended at the end of the queue. This method returns array of GID of registered download. Please note that the downloads added by this -method are not saved by --save-session.

+method are not saved by --save-session.

Adding local file file.meta4 to aria2:

@@ -3527,7 +3527,7 @@ followedBy

List of GIDs which are generated by the consequence of this download. For example, when aria2 downloaded Metalink file, it - generates downloads described in it(see --follow-metalink + generates downloads described in it(see --follow-metalink option). This value is useful to track these auto generated downloads. If there is no such downloads, this key will not be included in the response. @@ -3722,8 +3722,8 @@ selected

- "true" if this file is selected by --select-file option. If - --select-file is not specified or this is single torrent or no + "true" if this file is selected by --select-file option. If + --select-file is not specified or this is single torrent or no torrent download, this value is always "true". Otherwise "false".

@@ -4051,7 +4051,7 @@ http://example.org/file and second one is file.torrent:

In case of error, aria2 returns faultCode=1 and the error message in faultString.

Options

-

Same options for -i list are available. See Input File subsection for complete list of options.

+

Same options for -i list are available. See Input File subsection for complete list of options.

In the option struct, name element is option name(without preceding "--") and value element is argument as string.

@@ -4102,7 +4102,7 @@ header option has 2 values, so it uses a list:

Sample XML-RPC Client Code

The following Ruby script adds http://localhost/aria2.tar.bz2 to -aria2c operated on localhost with option --dir=/downloads and +aria2c operated on localhost with option --dir=/downloads and prints its reponse.

@@ -4194,8 +4194,8 @@ pprint(r)
Note
-See --http-proxy, --https-proxy, --ftp-proxy, --all-proxy and ---no-proxy for details. You can specify proxy in the environment +See --http-proxy, --https-proxy, --ftp-proxy, --all-proxy and +--no-proxy for details. You can specify proxy in the environment variables. See ENVIRONMENT section.
@@ -4326,7 +4326,7 @@ character with single(') or double(") quotation.

Specify output filename

To specify output filename for BitTorrent downloads, you need to know -the index of file in torrent file using -S option. For example, the +the index of file in torrent file using -S option. For example, the output looks like this:

@@ -4402,7 +4402,7 @@ forwarding, it’s up to you to do it manually.
Note
-If aria2c is not built with c-ares, --enable-async-dns6 is +If aria2c is not built with c-ares, --enable-async-dns6 is unnecessary. aria2 shares same port between IPv4 and IPv6 DHT.
@@ -4442,7 +4442,7 @@ unnecessary. aria2 shares same port between IPv4 and IPv6 DHT.
Note
-The file specified in --private-key must be decrypted. The behavior when +The file specified in --private-key must be decrypted. The behavior when encrypted one is given is undefined.
@@ -4550,7 +4550,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 148e01f2..ae2d8194 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -30,10 +30,10 @@ OPTIONS Basic Options ~~~~~~~~~~~~~ -*-d*, *--dir*=DIR:: +[[aria2_optref_dir]]*-d*, *--dir*=DIR:: The directory to store the downloaded file. -*-i*, *--input-file*=FILE:: +[[aria2_optref_input_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. @@ -41,16 +41,16 @@ Basic Options URIs. This optional line must start with white space(s). See *<<_input_file, Input File>>* subsection for details. -*-l*, *--log*=LOG:: +[[aria2_optref_log]]*-l*, *--log*=LOG:: The file name of the log file. If '-' is specified, log is written to stdout. If empty string("") is specified, log is not written to file. -*-j*, *--max-concurrent-downloads*=N:: +[[aria2_optref_max_concurrent_downloads]]*-j*, *--max-concurrent-downloads*=N:: Set maximum number of parallel downloads for every static (HTTP/FTP) URI, - torrent and metalink. See also *-s* and *-C* option. + torrent and metalink. See also *<>* and *<>* option. Default: '5' -*-V*, *--check-integrity*[='true'|'false']:: +[[aria2_optref_check_integrity]]*-V*, *--check-integrity*[='true'|'false']:: Check file integrity by validating piece hashes or a hash of entire file. This option has effect only in BitTorrent and Metalink @@ -62,13 +62,13 @@ Basic Options hashes and a hash of entire file are provided, only piece hashes are used. Default: 'false' -*-c*, *--continue*:: +[[aria2_optref_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*[=TAG|KEYWORD]:: +[[aria2_optref_help]]*-h*, *--help*[=TAG|KEYWORD]:: The help messages are classified with tags. A tag starts with "#". For example, type "--help=#http" to get the usage for the @@ -81,12 +81,12 @@ Basic Options HTTP/FTP Options ~~~~~~~~~~~~~~~~ -*--all-proxy*=PROXY:: +[[aria2_optref_all_proxy]]*--all-proxy*=PROXY:: Use this proxy server for all protocols. To erase previously defined proxy, use "". You can override this setting and specify a - proxy server for a particular protocol using *--http-proxy*, - *--https-proxy* and *--ftp-proxy* options. This affects all URIs. + proxy server for a particular protocol using *<>*, + *<>* and *<>* options. This affects all URIs. The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] [NOTE] @@ -106,27 +106,27 @@ example: if you specified in command-line --http-proxy-user="myname" then you get HTTP proxy "http://proxy" with user "user" and password "pass". -*--all-proxy-passwd*=PASSWD:: +[[aria2_optref_all_proxy_passwd]]*--all-proxy-passwd*=PASSWD:: - Set password for *--all-proxy* option. + Set password for *<>* option. -*--all-proxy-user*=USER:: +[[aria2_optref_all_proxy_user]]*--all-proxy-user*=USER:: - Set user for *--all-proxy* option. + Set user for *<>* option. -*--connect-timeout*=SEC:: +[[aria2_optref_connect_timeout]]*--connect-timeout*=SEC:: Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server. After the connection is established, this - option makes no effect and *--timeout* option is used instead. + option makes no effect and *<>* option is used instead. Default: '60' -*--dry-run*[='true'|'false']:: +[[aria2_optref_dry_run]]*--dry-run*[='true'|'false']:: If 'true' is given, aria2 just checks whether the remote file is available and doesn't download data. This option has effect on HTTP/FTP download. BitTorrent downloads are canceled if 'true' is specified. Default: 'false' -*--lowest-speed-limit*=SPEED:: +[[aria2_optref_lowest_speed_limit]]*--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. @@ -134,63 +134,63 @@ then you get HTTP proxy "http://proxy" with user "user" and password This option does not affect BitTorrent downloads. Default: '0' -*-x*, *--max-connection-per-server*=NUM:: +[[aria2_optref_max_connection_per_server]]*-x*, *--max-connection-per-server*=NUM:: The maximum number of connections to one server for each download. Default: '1' -*--max-file-not-found*=NUM:: +[[aria2_optref_max_file_not_found]]*--max-file-not-found*=NUM:: If aria2 receives `file not found' status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail. Specify '0' to disable this option. This options is effective only when using HTTP/FTP servers. Default: '0' -*-m*, *--max-tries*=N:: +[[aria2_optref_max_tries]]*-m*, *--max-tries*=N:: Set number of tries. '0' means unlimited. Default: '5' -*-k*, *--min-split-size*=SIZE:: +[[aria2_optref_min_split_size]]*-k*, *--min-split-size*=SIZE:: aria2 does not split less than 2*SIZE byte range. For example, let's consider downloading 20MiB file. If SIZE is 10M, aria2 can split file into 2 range [0-10MiB) and [10MiB-20MiB) and download it - using 2 sources(if *--split* >= 2, of course). If SIZE is 15M, + using 2 sources(if *<>* >= 2, of course). If SIZE is 15M, since 2*15M > 20MiB, aria2 does not split file and download it using 1 source. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). Possible Values: '1M'-'1024M' Default: '20M' -*-n*, *--no-netrc*:: +[[aria2_optref_no_netrc]]*-n*, *--no-netrc*:: Disables netrc support. netrc support is enabled by default. -*--no-proxy*=DOMAINS:: +[[aria2_optref_no_proxy]]*--no-proxy*=DOMAINS:: Specify comma separated hostnames, domains and network address with or without CIDR block where proxy should not be used. [NOTE] For network address with CIDR block, only IPv4 address works. Current implementation does not resolve hostname in URI to compare network -address specified in *--no-proxy*. So it is only effecive if URI has +address specified in *<>*. So it is only effecive if URI has numeric IP addresses. -*-o*, *--out*=FILE:: +[[aria2_optref_out]]*-o*, *--out*=FILE:: - The file name of the downloaded file. When *-Z* option is used, this + The file name of the downloaded file. When *<>* option is used, this option is ignored. [NOTE] In Metalink or BitTorrent download you cannot specify file name. The file name specified here is only used when the URIs fed to aria2 -are done by command line without *-i*, *-Z* option. For example: +are done by command line without *<>*, *<>* option. For example: aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" -*--proxy-method*=METHOD:: +[[aria2_optref_proxy_method]]*--proxy-method*=METHOD:: Set the method to use in proxy request. 'METHOD' is either 'get' or 'tunnel'. HTTPS downloads always use 'tunnel' regardless of this option. Default: 'get' -*-R*, *--remote-time*[='true'|'false']:: +[[aria2_optref_remote_time]]*-R*, *--remote-time*[='true'|'false']:: Retrieve timestamp of the remote file from the remote HTTP/FTP server and if it is available, apply it to the local file. Default: 'false' @@ -200,51 +200,51 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" Reuse already used URIs if no unused URIs are left. Default: 'true' -*--server-stat-of*=FILE:: +[[aria2_optref_server_stat_of]]*--server-stat-of*=FILE:: Specify the filename to which performance profile of the servers is - saved. You can load saved data using *--server-stat-if* option. See + saved. You can load saved data using *<>* option. See *<<_server_performance_profile, Server Performance Profile>>* subsection below for file format. -*--server-stat-if*=FILE:: +[[aria2_optref_server_stat_if]]*--server-stat-if*=FILE:: Specify the filename to load performance profile of the servers. The loaded data will be used in some URI selector such as 'feedback'. - See also *--uri-selector* option. See + See also *<>* option. See *<<_server_performance_profile, Server Performance Profile>>* subsection below for file format. -*--server-stat-timeout*=SEC:: +[[aria2_optref_server_stat_timeout]]*--server-stat-timeout*=SEC:: Specifies timeout in seconds to invalidate performance profile of the servers since the last contact to them. Default: '86400' (24hours) -*-s*, *--split*=N:: +[[aria2_optref_split]]*-s*, *--split*=N:: Download a file using N connections. If more than N URIs are given, first N URIs are used and remaining URIs are used for backup. If less than N URIs are given, those URIs are used more than once so that N connections total are made simultaneously. The number of connections to the same host is restricted by - *--max-connection-per-server* option. Please see *-j* and - *--min-split-size* option too. Please note that in Metalink - download, this option has no effect and use *-C* option instead. + *<>* option. Please see *<>* and + *<>* option too. Please note that in Metalink + download, this option has no effect and use *<>* option instead. Default: '5' -*-t*, *--timeout*=SEC:: +[[aria2_optref_timeout]]*-t*, *--timeout*=SEC:: Set timeout in seconds. Default: '60' -*--uri-selector*=SELECTOR:: +[[aria2_optref_uri_selector]]*--uri-selector*=SELECTOR:: Specify URI selection algorithm. The possible values are 'inorder', 'feedback' and 'adaptive'. If 'inorder' is given, URI is tried in the order appeared in the URI list. If 'feedback' is given, aria2 uses download speed observed in the previous downloads and choose fastest server in the URI list. This also effectively skips dead mirrors. The observed download speed is a part of performance - profile of servers mentioned in *--server-stat-of* and - *--server-stat-if* options. If 'adaptive' is given, selects one of + profile of servers mentioned in *<>* and + *<>* options. If 'adaptive' is given, selects one of the best mirrors for the first and reserved connections. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mirrors @@ -254,22 +254,22 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" HTTP Specific Options ~~~~~~~~~~~~~~~~~~~~~ -*--ca-certificate*=FILE:: +[[aria2_optref_ca_certificate]]*--ca-certificate*=FILE:: Use the certificate authorities in FILE to verify the peers. The certificate file must be in PEM format and can contain multiple CA certificates. - Use *--check-certificate* option to enable verification. + Use *<>* option to enable verification. -*--certificate*=FILE:: +[[aria2_optref_certificate]]*--certificate*=FILE:: Use the client certificate in FILE. The certificate must be in PEM format. - You may use *--private-key* option to specify the private key. + You may use *<>* option to specify the private key. -*--check-certificate*[='true'|'false']:: - Verify the peer using certificates specified in *--ca-certificate* option. +[[aria2_optref_check_certificate]]*--check-certificate*[='true'|'false']:: + Verify the peer using certificates specified in *<>* option. Default: 'true' -*--http-accept-gzip*[='true'|'false']:: +[[aria2_optref_http_accept_gzip]]*--http-accept-gzip*[='true'|'false']:: Send "Accept: deflate, gzip" request header and inflate response if remote server responds with "Content-Encoding: gzip" or @@ -281,68 +281,68 @@ Some server responds with "Content-Encoding: gzip" for files which itself is gzipped file. aria2 inflates them anyway because of the response header. -*--http-auth-challenge*[='true'|'false']:: +[[aria2_optref_http_auth_challenge]]*--http-auth-challenge*[='true'|'false']:: Send HTTP authorization header only when it is requested by the server. If 'false' is set, then authorization header is always sent to the server. There is an exception: if username and password are embedded in URI, authorization header is always sent to the server regardless of this option. Default: 'false' -*--http-no-cache*[='true'|'false']:: +[[aria2_optref_http_no_cache]]*--http-no-cache*[='true'|'false']:: Send Cache-Control: no-cache and Pragma: no-cache header to avoid cached content. If 'false' is given, these headers are not sent and you can add Cache-Control header with a directive you like - using *--header* option. Default: 'true' + using *<>* option. Default: 'true' -*--http-user*=USER:: +[[aria2_optref_http_user]]*--http-user*=USER:: Set HTTP user. This affects all URIs. -*--http-passwd*=PASSWD:: +[[aria2_optref_http_passwd]]*--http-passwd*=PASSWD:: Set HTTP password. This affects all URIs. -*--http-proxy*=PROXY:: +[[aria2_optref_http_proxy]]*--http-proxy*=PROXY:: Use this proxy server for HTTP. To erase previously defined proxy, - use "". See also *--all-proxy* option. This affects all URIs. The + use "". See also *<>* option. This affects all URIs. The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] -*--http-proxy-passwd*=PASSWD:: +[[aria2_optref_http_proxy_passwd]]*--http-proxy-passwd*=PASSWD:: - Set password for *--http-proxy* option. + Set password for *<>* option. -*--http-proxy-user*=USER:: +[[aria2_optref_http_proxy_user]]*--http-proxy-user*=USER:: - Set user for *--http-proxy* option. + Set user for *<>* option. -*--https-proxy*=PROXY:: +[[aria2_optref_https_proxy]]*--https-proxy*=PROXY:: Use this proxy server for HTTPS. To erase previously defined proxy, - use "". See also *--all-proxy* option. This affects all URIs. The + use "". See also *<>* option. This affects all URIs. The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] -*--https-proxy-passwd*=PASSWD:: +[[aria2_optref_https_proxy_passwd]]*--https-proxy-passwd*=PASSWD:: - Set password for *--https-proxy* option. + Set password for *<>* option. -*--https-proxy-user*=USER:: +[[aria2_optref_https_proxy_user]]*--https-proxy-user*=USER:: - Set user for *--https-proxy* option. + Set user for *<>* option. -*--private-key*=FILE:: +[[aria2_optref_private_key]]*--private-key*=FILE:: Use the private key in FILE. The private key must be decrypted and in PEM format. The behavior when encrypted one is given is undefined. - See also *--certificate* option. + See also *<>* option. -*--referer*=REFERER:: +[[aria2_optref_referer]]*--referer*=REFERER:: Set Referer. This affects all URIs. -*--enable-http-keep-alive*[='true'|'false']:: +[[aria2_optref_enable_http_keep_alive]]*--enable-http-keep-alive*[='true'|'false']:: Enable HTTP/1.1 persistent connection. Default: 'true' -*--enable-http-pipelining*[='true'|'false']:: +[[aria2_optref_enable_http_pipelining]]*--enable-http-pipelining*[='true'|'false']:: Enable HTTP/1.1 pipelining. Default: 'false' @@ -351,12 +351,12 @@ response header. In performance perspective, there is usually no advantage to enable this option. -*--header*=HEADER:: +[[aria2_optref_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 *<>*="X-A: b78" *<>*="X-B: 9J1" "http://host/file" -*--load-cookies*=FILE:: +[[aria2_optref_load_cookies]]*--load-cookies*=FILE:: Load Cookies from FILE using the Firefox3 format (SQLite3), Chromium/Google Chrome (SQLite3) and the @@ -366,29 +366,29 @@ this option. If aria2 is built without libsqlite3, then it doesn't support Firefox3 and Chromium/Google Chrome cookie format. -*--save-cookies*=FILE:: +[[aria2_optref_save_cookies]]*--save-cookies*=FILE:: Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape format. If FILE already exists, it is overwritten. Session Cookies are also saved and their expiry values are treated as 0. Possible Values: '/path/to/file' -*--use-head*[='true'|'false']:: +[[aria2_optref_use_head]]*--use-head*[='true'|'false']:: Use HEAD method for the first request to the HTTP server. Default: 'false' -*-U*, *--user-agent*=USER_AGENT:: +[[aria2_optref_user_agent]]*-U*, *--user-agent*=USER_AGENT:: Set user agent for HTTP(S) downloads. Default: 'aria2/$VERSION', $VERSION is replaced by package version. FTP Specific Options ~~~~~~~~~~~~~~~~~~~~ -*--ftp-user*=USER:: +[[aria2_optref_ftp_user]]*--ftp-user*=USER:: Set FTP user. This affects all URIs. Default: 'anonymous' -*--ftp-passwd*=PASSWD:: +[[aria2_optref_ftp_passwd]]*--ftp-passwd*=PASSWD:: Set FTP password. This affects all URIs. If user name is embedded but password is missing in URI, aria2 tries to resolve password using .netrc. If password is found in .netrc, @@ -396,38 +396,38 @@ FTP Specific Options option. Default: 'ARIA2USER@' -*-p*, *--ftp-pasv*[='true'|'false']:: +[[aria2_optref_ftp_pasv]]*-p*, *--ftp-pasv*[='true'|'false']:: Use the passive mode in FTP. If 'false' is given, the active mode will be used. Default: 'true' -*--ftp-proxy*=PROXY:: +[[aria2_optref_ftp_proxy]]*--ftp-proxy*=PROXY:: Use this proxy server for FTP. To erase previously defined proxy, - use "". See also *--all-proxy* option. This affects all URIs. The + use "". See also *<>* option. This affects all URIs. The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] -*--ftp-proxy-passwd*=PASSWD:: +[[aria2_optref_ftp_proxy_passwd]]*--ftp-proxy-passwd*=PASSWD:: - Set password for *--ftp-proxy* option. + Set password for *<>* option. -*--ftp-proxy-user*=USER:: +[[aria2_optref_ftp_proxy_user]]*--ftp-proxy-user*=USER:: - Set user for *--ftp-proxy* option. + Set user for *<>* option. -*--ftp-type*=TYPE:: +[[aria2_optref_ftp_type]]*--ftp-type*=TYPE:: Set FTP transfer type. TYPE is either 'binary' or 'ascii'. Default: 'binary' -*--ftp-reuse-connection*[='true'|'false']:: +[[aria2_optref_ftp_reuse_connection]]*--ftp-reuse-connection*[='true'|'false']:: Reuse connection in FTP. Default: 'true' BitTorrent/Metalink Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -*--select-file*=INDEX...:: +[[aria2_optref_select_file]]*--select-file*=INDEX...:: Set file to download by specifying its index. - You can find the file index using the *--show-files* option. + You can find the file index using the *<>* 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'. @@ -440,7 +440,7 @@ 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*:: +[[aria2_optref_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. @@ -448,61 +448,61 @@ writes the piece to the appropriate files. BitTorrent Specific Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -*--bt-enable-lpd*[='true'|'false']:: +[[aria2_optref_bt_enable_lpd]]*--bt-enable-lpd*[='true'|'false']:: Enable Local Peer Discovery. If a private flag is set in a torrent, aria2 doesn't use this feature for that download even if 'true' is given. Default: 'false' -*--bt-exclude-tracker*=URI[,...]:: +[[aria2_optref_bt_exclude_tracker]]*--bt-exclude-tracker*=URI[,...]:: Comma separated list of BitTorrent tracker's announce URI to remove. You can use special value "\*" which matches all URIs, thus removes all announce URIs. When specifying "\*" in shell command-line, don't forget to escape or quote it. See also - *--bt-tracker* option. + *<>* option. -*--bt-external-ip*=IPADDRESS:: +[[aria2_optref_bt_external_ip]]*--bt-external-ip*=IPADDRESS:: Specify the external IP address to report to a BitTorrent tracker. Although this function is named "external", it can accept any kind of IP addresses. IPADDRESS must be a numeric IP address. -*--bt-hash-check-seed*[='true'|'false']:: - If 'true' is given, after hash check using *--check-integrity* option and +[[aria2_optref_bt_hash_check_seed]]*--bt-hash-check-seed*[='true'|'false']:: + If 'true' is given, after hash check using *<>* option and file is complete, continue to seed file. If you want to check file and download it only when it is damaged or incomplete, set this option to 'false'. This option has effect only on BitTorrent download. Default: 'true' -*--bt-lpd-interface*=INTERFACE:: +[[aria2_optref_bt_lpd_interface]]*--bt-lpd-interface*=INTERFACE:: Use given interface for Local Peer Discovery. If this option is not specified, the default interface is chosen. You can specify interface name and IP address. Possible Values: interface, IP addres -*--bt-max-open-files*=NUM:: +[[aria2_optref_bt_max_open_files]]*--bt-max-open-files*=NUM:: Specify maximum number of files to open in each BitTorrent download. Default: '100' -*--bt-max-peers*=NUM:: +[[aria2_optref_bt_max_peers]]*--bt-max-peers*=NUM:: Specify the maximum number of peers per torrent. '0' means - unlimited. See also *--bt-request-peer-speed-limit* option. + unlimited. See also *<>* option. Default: '55' -*--bt-metadata-only*[='true'|'false']:: +[[aria2_optref_bt_metadata_only]]*--bt-metadata-only*[='true'|'false']:: Download metadata only. The file(s) described in metadata will not be downloaded. This option has effect only when BitTorrent Magnet - URI is used. See also *--bt-save-metadata* option. Default: 'false' + URI is used. See also *<>* option. Default: 'false' -*--bt-min-crypto-level*='plain'|'arc4':: +[[aria2_optref_bt_min_crypto_level]]*--bt-min-crypto-level*='plain'|'arc4':: 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: 'plain' -*--bt-prioritize-piece*='head'[=SIZE],'tail'[=SIZE]:: +[[aria2_optref_bt_prioritize_piece]]*--bt-prioritize-piece*='head'[=SIZE],'tail'[=SIZE]:: Try to download first and last pieces of each file first. This is useful for previewing files. The argument can contain 2 keywords: @@ -513,13 +513,13 @@ BitTorrent Specific Options last SIZE bytes of each file. SIZE can include 'K' or 'M'(1K = 1024, 1M = 1024K). If SIZE is omitted, SIZE=1M is used. -*--bt-require-crypto*='true'|'false':: +[[aria2_optref_bt_require_crypto]]*--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' -*--bt-request-peer-speed-limit*=SPEED:: +[[aria2_optref_bt_request_peer_speed_limit]]*--bt-request-peer-speed-limit*=SPEED:: If the whole download speed of every torrent is lower than SPEED, aria2 temporarily increases the number of peers to try for more download speed. Configuring this option with your preferred download @@ -527,71 +527,71 @@ BitTorrent Specific Options You can append 'K' or 'M'(1K = 1024, 1M = 1024K). Default: '50K' -*--bt-save-metadata*[='true'|'false']:: +[[aria2_optref_bt_save_metadata]]*--bt-save-metadata*[='true'|'false']:: Save metadata as .torrent file. This option has effect only when BitTorrent Magnet URI is used. The filename is hex encoded info hash with suffix .torrent. The directory to be saved is the same directory where download file is saved. If the same file already - exists, metadata is not saved. See also *--bt-metadata-only* + exists, metadata is not saved. See also *<>* option. Default: 'false' -*--bt-seed-unverified*[='true'|'false']:: +[[aria2_optref_bt_seed_unverified]]*--bt-seed-unverified*[='true'|'false']:: Seed previously downloaded files without verifying piece hashes. Default: 'false' -*--bt-stop-timeout*=SEC:: +[[aria2_optref_bt_stop_timeout]]*--bt-stop-timeout*=SEC:: Stop BitTorrent download if download speed is 0 in consecutive SEC seconds. If '0' is given, this feature is disabled. Default: '0' -*--bt-tracker*=URI[,...]:: +[[aria2_optref_bt_tracker]]*--bt-tracker*=URI[,...]:: Comma separated list of additional BitTorrent tracker's announce - URI. These URIs are not affected by *--bt-exclude-tracker* option - because they are added after URIs in *--bt-exclude-tracker* option are + URI. These URIs are not affected by *<>* option + because they are added after URIs in *<>* option are removed. -*--bt-tracker-connect-timeout*=SEC:: +[[aria2_optref_bt_tracker_connect_timeout]]*--bt-tracker-connect-timeout*=SEC:: Set the connect timeout in seconds to establish connection to tracker. After the connection is established, this option makes no - effect and *--bt-tracker-timeout* option is used instead. Default: + effect and *<>* option is used instead. Default: '60' -*--bt-tracker-interval*=SEC:: +[[aria2_optref_bt_tracker_interval]]*--bt-tracker-interval*=SEC:: Set the interval in seconds between tracker requests. This completely overrides interval value and aria2 just uses this value and ignores the min interval and interval value in the response of tracker. If '0' is set, aria2 determines interval based on the response of tracker and the download progress. Default: '0' -*--bt-tracker-timeout*=SEC:: +[[aria2_optref_bt_tracker_timeout]]*--bt-tracker-timeout*=SEC:: Set timeout in seconds. Default: '60' -*--dht-entry-point*=HOST:PORT:: +[[aria2_optref_dht_entry_point]]*--dht-entry-point*=HOST:PORT:: Set host and port as an entry point to IPv4 DHT network. -*--dht-entry-point6*=HOST:PORT:: +[[aria2_optref_dht_entry_point6]]*--dht-entry-point6*=HOST:PORT:: Set host and port as an entry point to IPv6 DHT network. -*--dht-file-path*=PATH:: +[[aria2_optref_dht_file_path]]*--dht-file-path*=PATH:: Change the IPv4 DHT routing table file to PATH. Default: '$HOME/.aria2/dht.dat' -*--dht-file-path6*=PATH:: +[[aria2_optref_dht_file_path6]]*--dht-file-path6*=PATH:: Change the IPv6 DHT routing table file to PATH. Default: '$HOME/.aria2/dht6.dat' -*--dht-listen-addr6*=ADDR:: +[[aria2_optref_dht_listen_addr6]]*--dht-listen-addr6*=ADDR:: Specify address to bind socket for IPv6 DHT. It should be a global unicast IPv6 address of the host. -*--dht-listen-port*=PORT...:: +[[aria2_optref_dht_listen_port]]*--dht-listen-port*=PORT...:: Set UDP listening port for both IPv4 and IPv6 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 @@ -601,29 +601,29 @@ BitTorrent Specific Options [NOTE] Make sure that the specified ports are open for incoming UDP traffic. -*--dht-message-timeout*=SEC:: +[[aria2_optref_dht_message_timeout]]*--dht-message-timeout*=SEC:: Set timeout in seconds. Default: '10' -*--enable-dht*[='true'|'false']:: +[[aria2_optref_enable_dht]]*--enable-dht*[='true'|'false']:: Enable IPv4 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: 'true' -*--enable-dht6*[='true'|'false']:: +[[aria2_optref_enable_dht6]]*--enable-dht6*[='true'|'false']:: Enable IPv6 DHT functionality. If a private flag is set in a torrent, aria2 doesn't use DHT for that download even if 'true' is - given. Use *--dht-listen-port* option to specify port number to - listen on. See also *--dht-listen-addr6* option. + given. Use *<>* option to specify port number to + listen on. See also *<>* option. -*--enable-peer-exchange*[='true'|'false']:: +[[aria2_optref_enable_peer_exchange]]*--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':: +[[aria2_optref_follow_torrent]]*--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. @@ -632,14 +632,14 @@ Make sure that the specified ports are open for incoming UDP traffic. If 'false' is specified, the action mentioned above is not taken. Default: 'true' -*-O*, *--index-out*=INDEX=PATH:: +[[aria2_optref_index_out]]*-O*, *--index-out*=INDEX=PATH:: Set file path for file with index=INDEX. You can find the file index - using the *--show-files* option. PATH is a relative path to the - path specified in *--dir* option. You can use this option multiple + using the *<>* option. PATH is a relative path to the + path specified in *<>* option. You can use this option multiple times. Using this option, you can specify the output filenames of BitTorrent downloads. -*--listen-port*=PORT...:: +[[aria2_optref_listen_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'. @@ -649,21 +649,21 @@ Make sure that the specified ports are open for incoming UDP traffic. [NOTE] Make sure that the specified ports are open for incoming TCP traffic. -*--max-overall-upload-limit*=SPEED:: +[[aria2_optref_max_overall_upload_limit]]*--max-overall-upload-limit*=SPEED:: Set max overall upload speed in bytes/sec. '0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). - To limit the upload speed per torrent, use *--max-upload-limit* option. + To limit the upload speed per torrent, use *<>* option. Default: '0' -*-u*, *--max-upload-limit*=SPEED:: +[[aria2_optref_max_upload_limit]]*-u*, *--max-upload-limit*=SPEED:: Set max upload speed per each torrent in bytes/sec. '0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). - To limit the overall upload speed, use *--max-overall-upload-limit* option. + To limit the overall upload speed, use *<>* option. Default: '0' -*--peer-id-prefix*=PEER_ID_PREFIX:: +[[aria2_optref_peer_id_prefix]]*--peer-id-prefix*=PEER_ID_PREFIX:: Specify the prefix of peer ID. The peer ID in BitTorrent is 20 byte length. If more than 20 @@ -672,30 +672,30 @@ Make sure that the specified ports are open for incoming TCP traffic. byte data are added to make its length 20 bytes. Default: 'aria2/$VERSION-', $VERSION is replaced by package version. -*--seed-ratio*=RATIO:: +[[aria2_optref_seed_ratio]]*--seed-ratio*=RATIO:: Specify share ratio. Seed completed torrents until share ratio reaches RATIO. You are strongly encouraged 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 *<>* 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. +[[aria2_optref_seed_time]]*--seed-time*=MINUTES:: + Specify seeding time in minutes. Also see the *<>* option. [NOTE] -Specifying *--seed-time*='0' disables seeding after download completed. +Specifying *<>*='0' disables seeding after download completed. -*-T*, *--torrent-file*=TORRENT_FILE:: +[[aria2_optref_torrent_file]]*-T*, *--torrent-file*=TORRENT_FILE:: The path to the .torrent file. You are not required to use this - option because you can specify .torrent files without *-T*. + option because you can specify .torrent files without *<>*. Metalink Specific Options ~~~~~~~~~~~~~~~~~~~~~~~~~ -*--follow-metalink*='true'|'false'|'mem':: +[[aria2_optref_follow_metalink]]*--follow-metalink*='true'|'false'|'mem':: If 'true' or 'mem' is specified, when a file whose suffix is ".metalink" or content type of "application/metalink+xml" is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it. @@ -704,118 +704,118 @@ Metalink Specific Options If 'false' is specified, the action mentioned above is not taken. Default: 'true' -*-M*, *--metalink-file*=METALINK_FILE:: +[[aria2_optref_metalink_file]]*-M*, *--metalink-file*=METALINK_FILE:: The file path to .metalink file. Reads input from stdin when '-' is specified. You are not required to use this option because you can - specify .metalink files without *-M*. + specify .metalink files without *<>*. -*-C*, *--metalink-servers*=NUM_SERVERS:: +[[aria2_optref_metalink_servers]]*-C*, *--metalink-servers*=NUM_SERVERS:: 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 *-s* and *-j* options. + See also *<>* and *<>* options. Default: '5' -*--metalink-language*=LANGUAGE:: +[[aria2_optref_metalink_language]]*--metalink-language*=LANGUAGE:: The language of the file to download. -*--metalink-location*=LOCATION[,...]:: +[[aria2_optref_metalink_location]]*--metalink-location*=LOCATION[,...]:: The location of the preferred server. A comma-delimited list of locations is acceptable, for example, 'jp,us'. -*--metalink-os*=OS:: +[[aria2_optref_metalink_os]]*--metalink-os*=OS:: The operating system of the file to download. -*--metalink-version*=VERSION:: +[[aria2_optref_metalink_version]]*--metalink-version*=VERSION:: The version of the file to download. -*--metalink-preferred-protocol*=PROTO:: +[[aria2_optref_metalink_preferred_protocol]]*--metalink-preferred-protocol*=PROTO:: Specify preferred protocol. The possible values are 'http', 'https', 'ftp' and 'none'. Specify 'none' to disable this feature. Default: 'none' -*--metalink-enable-unique-protocol*='true'|'false':: +[[aria2_optref_metalink_enable_unique_protocol]]*--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 *<>* option to specify the preference of protocol. Default: 'true' XML-RPC Options ~~~~~~~~~~~~~~~ -*--enable-xml-rpc*[='true'|'false']:: +[[aria2_optref_enable_xml_rpc]]*--enable-xml-rpc*[='true'|'false']:: Enable XML-RPC server. It is strongly recommended to set username - and password using *--xml-rpc-user* and *--xml-rpc-passwd* - option. See also *--xml-rpc-listen-port* option. Default: 'false' + and password using *<>* and *<>* + option. See also *<>* option. Default: 'false' -*--xml-rpc-listen-all*[='true'|'false']:: +[[aria2_optref_xml_rpc_listen_all]]*--xml-rpc-listen-all*[='true'|'false']:: Listen incoming XML-RPC requests on all network interfaces. If false is given, listen only on local loopback interface. Default: 'false' -*--xml-rpc-listen-port*=PORT:: +[[aria2_optref_xml_rpc_listen_port]]*--xml-rpc-listen-port*=PORT:: Specify a port number for XML-RPC server to listen to. Possible Values: '1024'-'65535' Default: '6800' -*--xml-rpc-max-request-size*=SIZE:: +[[aria2_optref_xml_rpc_max_request_size]]*--xml-rpc-max-request-size*=SIZE:: Set max size of XML-RPC request. If aria2 detects the request is more than SIZE bytes, it drops connection. Default: '2M' -*--xml-rpc-passwd*=PASSWD:: +[[aria2_optref_xml_rpc_passwd]]*--xml-rpc-passwd*=PASSWD:: Set XML-RPC password. -*--xml-rpc-user*=USER:: +[[aria2_optref_xml_rpc_user]]*--xml-rpc-user*=USER:: Set XML-RPC user. Advanced Options ~~~~~~~~~~~~~~~~ -*--allow-overwrite*='true'|'false':: +[[aria2_optref_allow_overwrite]]*--allow-overwrite*='true'|'false':: Restart download from scratch if the corresponding control file - doesn't exist. See also *--auto-file-renaming* option. Default: + doesn't exist. See also *<>* option. Default: 'false' -*--allow-piece-length-change*='true'|'false':: +[[aria2_optref_allow_piece_length_change]]*--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' -*--always-resume*[='true'|'false']:: +[[aria2_optref_always_resume]]*--always-resume*[='true'|'false']:: Always resume download. If 'true' is given, aria2 always tries to resume download and if resume is not possible, aborts download. If 'false' is given, when all given URIs do not support resume or aria2 encounters 'N' URIs which does not support resume ('N' is the value - specified using *--max-resume-failure-tries* option), aria2 - downloads file from scratch. See *--max-resume-failure-tries* + specified using *<>* option), aria2 + downloads file from scratch. See *<>* option. Default: 'true' -*--async-dns*[='true'|'false']:: +[[aria2_optref_async_dns]]*--async-dns*[='true'|'false']:: Enable asynchronous DNS. Default: 'true' -*--auto-file-renaming*[='true'|'false']:: +[[aria2_optref_auto_file_renaming]]*--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' -*--auto-save-interval*=SEC:: +[[aria2_optref_auto_save_interval]]*--auto-save-interval*=SEC:: Save a control file(*.aria2) every SEC seconds. If '0' is given, a control file is not saved during download. aria2 saves a control file when it stops regardless of the value. The possible values are between '0' to '600'. Default: '60' -*--conditional-get*[='true'|'false']:: +[[aria2_optref_conditional_get]]*--conditional-get*[='true'|'false']:: Download file only when the local file is older than remote file. This function only works with HTTP(S) downloads only. It does @@ -823,35 +823,35 @@ Advanced Options Content-Disposition header. If a control file exists, this option will be ignored. This function uses If-Modified-Since header to get only newer file conditionally. When getting modification time of - local file, it uses user supplied filename(see *--out* option) or - filename part in URI if *--out* is not specified. Default: 'false' + local file, it uses user supplied filename(see *<>* option) or + filename part in URI if *<>* is not specified. Default: 'false' -*--conf-path*=PATH:: +[[aria2_optref_conf_path]]*--conf-path*=PATH:: Change the configuration file path to PATH. Default: '$HOME/.aria2/aria2.conf' -*-D*, *--daemon*:: +[[aria2_optref_daemon]]*-D*, *--daemon*:: Run as daemon. The current working directory will be changed to '/' and standard input, standard output and standard error will be redirected to '/dev/null'. Default: 'false' -*--disable-ipv6*[='true'|'false']:: +[[aria2_optref_disable_ipv6]]*--disable-ipv6*[='true'|'false']:: Disable IPv6. This is useful if you have to use broken DNS and want to avoid terribly slow AAAA record lookup. Default: 'false' -*--enable-async-dns6*[='true'|'false']:: +[[aria2_optref_enable_async_dns6]]*--enable-async-dns6*[='true'|'false']:: Enable IPv6 name resolution in asynchronous DNS resolver. This - option will be ignored when *--async-dns*='false'. + option will be ignored when *<>*='false'. Default: 'false' -*--enable-direct-io*[='true'|'false']:: +[[aria2_optref_enable_direct_io]]*--enable-direct-io*[='true'|'false']:: Enable directI/O, which lowers cpu usage while allocating/checking files. Turn off if you encounter any error. Default: 'true' -*--event-poll*=POLL:: +[[aria2_optref_event_poll]]*--event-poll*=POLL:: Specify the method for polling events. The possible values are 'epoll', 'kqueue', 'port', 'poll' and 'select'. For each 'epoll', @@ -860,7 +860,7 @@ Advanced Options various *BSD systems including Mac OS X. 'port' is available on Open Solaris. The default value may vary depending on the system you use. -*--file-allocation*=METHOD:: +[[aria2_optref_file_allocation]]*--file-allocation*=METHOD:: Specify file allocation method. 'none' doesn't pre-allocate file space. 'prealloc' pre-allocates file space @@ -878,12 +878,12 @@ Advanced Options Possible Values: 'none', 'prealloc', 'falloc' Default: 'prealloc' -*--human-readable*[='true'|'false']:: +[[aria2_optref_human_readable]]*--human-readable*[='true'|'false']:: Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi) in the console readout. Default: 'true' -*--interface*=INTERFACE:: +[[aria2_optref_interface]]*--interface*=INTERFACE:: Bind sockets to given interface. You can specify interface name, IP address and hostname. @@ -891,11 +891,11 @@ Advanced Options [NOTE] If an interface has multiple addresses, it is highly recommended to -specify IP address explicitly. See also *--disable-ipv6*. If your +specify IP address explicitly. See also *<>*. If your system doesn't have getifaddrs(), this option doesn't accept interface name. -*--max-download-result*=NUM:: +[[aria2_optref_max_download_result]]*--max-download-result*=NUM:: Set maximum number of download result kept in memory. The download results are completed/error/removed downloads. The download results @@ -907,63 +907,63 @@ name. downloads. Specifying 0 means no download result is kept. Default: '1000' -*--max-resume-failure-tries*=N:: +[[aria2_optref_max_resume_failure_tries]]*--max-resume-failure-tries*=N:: - When used with *--always-resume*='false', aria2 downloads file from + When used with *<>*='false', aria2 downloads file from scratch when aria2 detects 'N' number of URIs that does not support resume. If 'N' is '0', aria2 downloads file from scratch when all - given URIs do not support resume. See *--always-resume* option. + given URIs do not support resume. See *<>* option. Default: '0' -*--log-level*=LEVEL:: +[[aria2_optref_log_level]]*--log-level*=LEVEL:: Set log level to output. LEVEL is either 'debug', 'info', 'notice', 'warn' or 'error'. Default: 'debug' -*--on-bt-download-complete*=COMMAND:: +[[aria2_optref_on_bt_download_complete]]*--on-bt-download-complete*=COMMAND:: - For BitTorrent, a command specified in *--on-download-complete* is + For BitTorrent, a command specified in *<>* is called when download completes and seeding is over. On the other hand, this option set the command to be executed when download - completes but before seeding. See *--on-download-start* option for + completes but before seeding. See *<>* option for the requirement of COMMAND. Possible Values: '/path/to/command' -*--on-download-complete*=COMMAND:: +[[aria2_optref_on_download_complete]]*--on-download-complete*=COMMAND:: Set the command to be executed when download completes. See - *--on-download-start* option for the requirement of COMMAND. See - also *--on-download-stop* option. Possible Values: + *<>* option for the requirement of COMMAND. See + also *<>* option. Possible Values: '/path/to/command' -*--on-download-error*=COMMAND:: +[[aria2_optref_on_download_error]]*--on-download-error*=COMMAND:: Set the command to be executed when download aborts due to error. - See *--on-download-start* option for the requirement of COMMAND. - See also *--on-download-stop* option. Possible Values: + See *<>* option for the requirement of COMMAND. + See also *<>* option. Possible Values: '/path/to/command' -*--on-download-pause*=COMMAND:: +[[aria2_optref_on_download_pause]]*--on-download-pause*=COMMAND:: Set the command to be executed when download is paused. See - *--on-download-start* option for the requirement of COMMAND. + *<>* option for the requirement of COMMAND. Possible Values: '/path/to/command' -*--on-download-start*=COMMAND:: +[[aria2_optref_on_download_start]]*--on-download-start*=COMMAND:: Set the command to be executed when download starts up. COMMAND must take just one argument and GID is passed to COMMAND as a first argument. Possible Values: '/path/to/command' -*--on-download-stop*=COMMAND:: +[[aria2_optref_on_download_stop]]*--on-download-stop*=COMMAND:: Set the command to be executed when download stops. You can override the command to be executed for particular download result using - *--on-download-complete* and *--on-download-error*. If they are + *<>* and *<>*. If they are specified, command specified in this option is not executed. See - *--on-download-start* option for the requirement of COMMAND. + *<>* option for the requirement of COMMAND. Possible Values: '/path/to/command' -*--summary-interval*=SEC:: +[[aria2_optref_summary_interval]]*--summary-interval*=SEC:: Set interval in seconds to output download progress summary. Setting '0' suppresses the output. Default: '60' @@ -972,32 +972,32 @@ name. In multi file torrent downloads, the files adjacent forward to the specified files are also allocated if they share the same piece. -*-Z*, *--force-sequential*[='true'|'false']:: +[[aria2_optref_force_sequential]]*-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-overall-download-limit*=SPEED:: +[[aria2_optref_max_overall_download_limit]]*--max-overall-download-limit*=SPEED:: Set max overall download speed in bytes/sec. '0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To - limit the download speed per download, use *--max-download-limit* + limit the download speed per download, use *<>* option. Default: '0' -*--max-download-limit*=SPEED:: +[[aria2_optref_max_download_limit]]*--max-download-limit*=SPEED:: Set max download speed per each download in bytes/sec. '0' means unrestricted. You can append 'K' or 'M'(1K = 1024, 1M = 1024K). To - limit the overall download speed, use *--max-overall-download-limit* + limit the overall download speed, use *<>* option. Default: '0' -*--no-conf*:: +[[aria2_optref_no_conf]]*--no-conf*:: Disable loading aria2.conf file. -*--no-file-allocation-limit*=SIZE:: +[[aria2_optref_no_file_allocation_limit]]*--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']:: +[[aria2_optref_parameterized_uri]]*-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: @@ -1007,20 +1007,20 @@ are also allocated if they share the same piece. -Z option is required. Default: 'false' -*-q*, *--quiet*[='true'|'false']:: +[[aria2_optref_quiet]]*-q*, *--quiet*[='true'|'false']:: Make aria2 quiet (no console output). Default: 'false' -*--realtime-chunk-checksum*='true'|'false':: +[[aria2_optref_realtime_chunk_checksum]]*--realtime-chunk-checksum*='true'|'false':: Validate chunk of data by calculating checksum while downloading a file if chunk checksums are provided. Default: 'true' -*--remove-control-file*[='true'|'false']:: +[[aria2_optref_remove_control_file]]*--remove-control-file*[='true'|'false']:: Remove control file before download. Using with - *--allow-overwrite*='true', download always starts from + *<>*='true', download always starts from scratch. This will be useful for users behind proxy server which disables resume. @@ -1030,19 +1030,19 @@ For Metalink downloads, -C1 is recommended for proxy server which disables resume, in order to avoid establishing unnecessary connections. -*--save-session*=FILE:: +[[aria2_optref_save_session]]*--save-session*=FILE:: Save error/unfinished downloads to FILE on exit. You can pass this - output file to aria2c with *-i* option on restart. Please note that + output file to aria2c with *<>* option on restart. Please note that downloads added by *aria2.addTorrent* and *aria2.addMetalink* XML-RPC method are not saved. -*--stop*=SEC:: +[[aria2_optref_stop]]*--stop*=SEC:: Stop application after SEC seconds has passed. If '0' is given, this feature is disabled. Default: '0' -*-v*, *--version*:: +[[aria2_optref_version]]*-v*, *--version*:: Print the version number, copyright and the configuration information and exit. @@ -1059,7 +1059,7 @@ URI, MAGNET, TORRENT_FILE, METALINK_FILE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can specify multiple URIs in command-line. Unless you specify -*-Z* option, all URIs must point to the same file or downloading will +*<>* option, all URIs must point to the same file or downloading will fail. You can specify arbitrary number of BitTorrent Magnet URI. Please note @@ -1097,7 +1097,7 @@ URI) if the previous transfer is made by aria2. 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* URI). +*<>* URI). EXIT STATUS @@ -1121,11 +1121,11 @@ based on the last error encountered. *4*:: If aria2 sees the specfied number of "resource not found" error. - See *--max-file-not-found* option). + See *<>* option). *5*:: If a download aborts because download speed is too slow. - See *--lowest-speed-limit* option) + See *<>* option) *6*:: If network problem occurs. @@ -1152,29 +1152,29 @@ aria2 recognizes the following environment variables. http_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use in HTTP. Overrides http-proxy value in configuration file. - The command-line option *--http-proxy* overrides this value. + The command-line option *<>* overrides this value. https_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use in HTTPS. Overrides https-proxy value in configuration file. - The command-line option *--https-proxy* overrides this value. + The command-line option *<>* overrides this value. ftp_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use in FTP. Overrides ftp-proxy value in configuration file. - The command-line option *--ftp-proxy* overrides this value. + The command-line option *<>* overrides this value. all_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use if no protocol-specific proxy is specified. Overrides all-proxy value in configuration file. - The command-line option *--all-proxy* overrides this value. + The command-line option *<>* overrides this value. no_proxy [DOMAIN,...]:: Specify comma-separated hostname, domains and network address with or without CIDR block to which proxy should not be used. Overrides no-proxy value in configuration file. The command-line option - *--no-proxy* overrides this value. + *<>* overrides this value. FILES ----- @@ -1183,8 +1183,8 @@ aria2.conf By default, aria2 parses '$HOME/.aria2/aria2.conf' as a configuraiton file. You can specify the path to configuration file using -*--conf-path* option. If you don't want to use the configuraitonf -file, use *--no-conf* option. +*<>* option. If you don't want to use the configuraitonf +file, use *<>* option. The configuration file is a text file and has 1 option per each line. In each line, you can specify name-value pair in the format: @@ -1212,7 +1212,7 @@ Netrc ~~~~~ Netrc support is enabled by default for HTTP(S)/FTP. To disable netrc -support, specify *-n* option. Your .netrc file should have correct +support, specify *<>* option. Your .netrc file should have correct permissions(600). If machine name starts ".", aria2 performs domain match instead of @@ -1258,7 +1258,7 @@ can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character. Each line is treated as if it is provided in command-line argument. -Therefore they are affected by *-Z* and *-P* options. +Therefore they are affected by *<>* and *<>* options. Lines starting with "#" are treated as comments and skipped. @@ -1371,12 +1371,12 @@ http://server/file.iso http://mirror/file.iso http://foo/bar ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If aria2 is executed with *-i* uri.txt *-d* /tmp options, then +If aria2 is executed with *<>* uri.txt *<>* /tmp options, then 'file.iso' is saved as '/iso_images/file.img' and it is downloaded from \http://server/file.iso and \http://mirror/file.iso. The file 'bar' is downloaded from \http://foo/bar and saved as '/tmp/bar'. -In some cases, *out* parameter has no effect. See note of *--out* +In some cases, *out* parameter has no effect. See note of *<>* option for the restrictions. Server Performance Profile @@ -1501,7 +1501,7 @@ given as an integer starting from 0, the new download is inserted at 'position' is larger than the size of the queue, it is appended at the end of the queue. This method returns GID of registered download. Please note that the downloads added by this method are not saved by -*--save-session*. +*<>*. Adding local file file.torrent to aria2: --------------------------------------------------------------------- @@ -1522,7 +1522,7 @@ inserted at 'position' in the waiting queue. If 'position' is not given or 'position' is larger than the size of the queue, it is appended at the end of the queue. This method returns array of GID of registered download. Please note that the downloads added by this -method are not saved by *--save-session*. +method are not saved by *<>*. Adding local file file.meta4 to aria2: -------------------------------------------------------------------- @@ -1674,7 +1674,7 @@ followedBy:: List of GIDs which are generated by the consequence of this download. For example, when aria2 downloaded Metalink file, it - generates downloads described in it(see *--follow-metalink* + generates downloads described in it(see *<>* option). This value is useful to track these auto generated downloads. If there is no such downloads, this key will not be included in the response. @@ -1802,8 +1802,8 @@ length:: selected:: - "true" if this file is selected by *--select-file* option. If - *--select-file* is not specified or this is single torrent or no + "true" if this file is selected by *<>* option. If + *<>* is not specified or this is single torrent or no torrent download, this value is always "true". Otherwise "false". uris:: @@ -2094,7 +2094,7 @@ faultString. Options ~~~~~~~ -Same options for *-i* list are available. See *<<_input_file, Input +Same options for *<>* list are available. See *<<_input_file, Input File>>* subsection for complete list of options. In the option struct, name element is option name(without preceding @@ -2151,7 +2151,7 @@ Sample XML-RPC Client Code ~~~~~~~~~~~~~~~~~~~~~~~~~~ The following Ruby script adds 'http://localhost/aria2.tar.bz2' to -aria2c operated on localhost with option *--dir*='/downloads' and +aria2c operated on localhost with option *<>*='/downloads' and prints its reponse. ---------------------------------------------- @@ -2237,8 +2237,8 @@ aria2c --ftp-proxy="http://proxy:8080" "ftp://host/file" [NOTE] -See *--http-proxy*, *--https-proxy*, *--ftp-proxy*, *--all-proxy* and -*--no-proxy* for details. You can specify proxy in the environment +See *<>*, *<>*, *<>*, *<>* and +*<>* for details. You can specify proxy in the environment variables. See *<<_environment, ENVIRONMENT>>* section. Proxy with authorization @@ -2345,7 +2345,7 @@ Specify output filename ^^^^^^^^^^^^^^^^^^^^^^^ To specify output filename for BitTorrent downloads, you need to know -the index of file in torrent file using *-S* option. For example, the +the index of file in torrent file using *<>* option. For example, the output looks like this: -------------------------- @@ -2406,7 +2406,7 @@ Enable IPv6 DHT aria2c --enable-dht6 --dht-listen-port=6881 --dht-listen-addr6=YOUR_GLOBAL_UNICAST_IPV6_ADDR --enable-async-dns6 ----------------------------------------------------------------------------------------------------------- [NOTE] -If aria2c is not built with c-ares, *--enable-async-dns6* is +If aria2c is not built with c-ares, *<>* is unnecessary. aria2 shares same port between IPv4 and IPv6 DHT. Add and remove tracker URI @@ -2441,7 +2441,7 @@ Client certificate authorization for SSL/TLS aria2c --certificate=/path/to/mycert.pem --private-key=/path/to/mykey.pem https://host/file ------------------------------------------------------------------------------------------ [NOTE] -The file specified in *--private-key* must be decrypted. The behavior when +The file specified in *<>* must be decrypted. The behavior when encrypted one is given is undefined. Verify peer in SSL/TLS using given CA certificates