Fix sphinx warnings

pull/1038/head release-1.33.0
Tatsuhiro Tsujikawa 2017-10-17 23:13:40 +09:00
parent 9a38c73583
commit 450b4f467f
6 changed files with 188 additions and 188 deletions

View File

@ -76,7 +76,7 @@ Basic Options
can configure the number of connections using :option:`--split can configure the number of connections using :option:`--split
<-s>` and/or :option:`--min-split-size <-k>`, etc. <-s>` and/or :option:`--min-split-size <-k>`, etc.
.. option:: -V, --check-integrity[=true|false] .. option:: -V, --check-integrity [true|false]
Check file integrity by validating piece hashes or a hash of entire Check file integrity by validating piece hashes or a hash of entire
file. This option has effect only in BitTorrent, Metalink downloads file. This option has effect only in BitTorrent, Metalink downloads
@ -90,7 +90,7 @@ Basic Options
of entire file are provided, only piece hashes are used. Default: of entire file are provided, only piece hashes are used. Default:
``false`` ``false``
.. option:: -c, --continue[=true|false] .. option:: -c, --continue [true|false]
Continue downloading a partially downloaded file. Continue downloading a partially downloaded file.
Use this option to resume a download started by a web browser or another Use this option to resume a download started by a web browser or another
@ -164,7 +164,7 @@ HTTP/FTP/SFTP Options
option makes no effect and :option:`--timeout <-t>` option is used instead. option makes no effect and :option:`--timeout <-t>` option is used instead.
Default: ``60`` Default: ``60``
.. option:: --dry-run[=true|false] .. option:: --dry-run [true|false]
If ``true`` is given, aria2 just checks whether the remote file is If ``true`` is given, aria2 just checks whether the remote file is
available and doesn't download data. This option has effect on available and doesn't download data. This option has effect on
@ -223,7 +223,7 @@ HTTP/FTP/SFTP Options
Permission of the .netrc file must be 600. Otherwise, the file Permission of the .netrc file must be 600. Otherwise, the file
will be ignored. will be ignored.
.. option:: -n, --no-netrc[=true|false] .. option:: -n, --no-netrc [true|false]
Disables netrc support. netrc support is enabled by default. Disables netrc support. netrc support is enabled by default.
@ -276,13 +276,13 @@ HTTP/FTP/SFTP Options
option. option.
Default: ``get`` Default: ``get``
.. option:: -R, --remote-time[=true|false] .. option:: -R, --remote-time [true|false]
Retrieve timestamp of the remote file from the remote HTTP/FTP Retrieve timestamp of the remote file from the remote HTTP/FTP
server and if it is available, apply it to the local file. server and if it is available, apply it to the local file.
Default: ``false`` Default: ``false``
.. option:: --reuse-uri[=true|false] .. option:: --reuse-uri [true|false]
Reuse already used URIs if no unused URIs are left. Reuse already used URIs if no unused URIs are left.
Default: ``true`` Default: ``true``
@ -426,12 +426,12 @@ HTTP Specific Options
Alternatively PKCS12 files are also supported. PEM files, however, are not Alternatively PKCS12 files are also supported. PEM files, however, are not
supported. supported.
.. option:: --check-certificate[=true|false] .. option:: --check-certificate [true|false]
Verify the peer using certificates specified in :option:`--ca-certificate` option. Verify the peer using certificates specified in :option:`--ca-certificate` option.
Default: ``true`` Default: ``true``
.. option:: --http-accept-gzip[=true|false] .. option:: --http-accept-gzip [true|false]
Send ``Accept: deflate, gzip`` request header and inflate response if Send ``Accept: deflate, gzip`` request header and inflate response if
remote server responds with ``Content-Encoding: gzip`` or remote server responds with ``Content-Encoding: gzip`` or
@ -443,7 +443,7 @@ HTTP Specific Options
itself is gzipped file. aria2 inflates them anyway because of the itself is gzipped file. aria2 inflates them anyway because of the
response header. response header.
.. option:: --http-auth-challenge[=true|false] .. option:: --http-auth-challenge [true|false]
Send HTTP authorization header only when it is requested by the Send HTTP authorization header only when it is requested by the
server. If ``false`` is set, then authorization header is always sent server. If ``false`` is set, then authorization header is always sent
@ -451,7 +451,7 @@ HTTP Specific Options
embedded in URI, authorization header is always sent to the server embedded in URI, authorization header is always sent to the server
regardless of this option. Default: ``false`` regardless of this option. Default: ``false``
.. option:: --http-no-cache[=true|false] .. option:: --http-no-cache [true|false]
Send ``Cache-Control: no-cache`` and ``Pragma: no-cache`` header to avoid Send ``Cache-Control: no-cache`` and ``Pragma: no-cache`` header to avoid
cached content. If ``false`` is given, these headers are not sent cached content. If ``false`` is given, these headers are not sent
@ -510,12 +510,12 @@ HTTP Specific Options
This may be useful when used together with the This may be useful when used together with the
:option:`--parameterized-uri <-P>` option. :option:`--parameterized-uri <-P>` option.
.. option:: --enable-http-keep-alive[=true|false] .. option:: --enable-http-keep-alive [true|false]
Enable HTTP/1.1 persistent connection. Enable HTTP/1.1 persistent connection.
Default: ``true`` Default: ``true``
.. option:: --enable-http-pipelining[=true|false] .. option:: --enable-http-pipelining [true|false]
Enable HTTP/1.1 pipelining. Enable HTTP/1.1 pipelining.
Default: ``false`` Default: ``false``
@ -552,7 +552,7 @@ HTTP Specific Options
are also saved and their expiry values are treated as 0. Possible are also saved and their expiry values are treated as 0. Possible
Values: ``/path/to/file`` Values: ``/path/to/file``
.. option:: --use-head[=true|false] .. option:: --use-head [true|false]
Use HEAD method for the first request to the HTTP server. Use HEAD method for the first request to the HTTP server.
Default: ``false`` Default: ``false``
@ -579,7 +579,7 @@ FTP/SFTP Specific Options
option. option.
Default: ``ARIA2USER@`` Default: ``ARIA2USER@``
.. option:: -p, --ftp-pasv[=true|false] .. option:: -p, --ftp-pasv [true|false]
Use the passive mode in FTP. Use the passive mode in FTP.
If ``false`` is given, the active mode will be used. If ``false`` is given, the active mode will be used.
@ -613,7 +613,7 @@ FTP/SFTP Specific Options
This option is ignored for SFTP transfer. This option is ignored for SFTP transfer.
.. option:: --ftp-reuse-connection[=true|false] .. option:: --ftp-reuse-connection [true|false]
Reuse connection in FTP. Reuse connection in FTP.
Default: ``true`` Default: ``true``
@ -646,7 +646,7 @@ BitTorrent/Metalink Options
A single piece may include several files or part of files, and aria2 A single piece may include several files or part of files, and aria2
writes the piece to the appropriate files. writes the piece to the appropriate files.
.. option:: -S, --show-files[=true|false] .. option:: -S, --show-files [true|false]
Print file listing of ".torrent", ".meta4" and ".metalink" file and exit. Print file listing of ".torrent", ".meta4" and ".metalink" file and exit.
In case of ".torrent" file, additional information In case of ".torrent" file, additional information
@ -655,7 +655,7 @@ BitTorrent/Metalink Options
BitTorrent Specific Options BitTorrent Specific Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. option:: --bt-detach-seed-only[=true|false] .. option:: --bt-detach-seed-only [true|false]
Exclude seed only downloads when counting concurrent active Exclude seed only downloads when counting concurrent active
downloads (See :option:`-j` option). This means that if ``-j3`` is downloads (See :option:`-j` option). This means that if ``-j3`` is
@ -665,7 +665,7 @@ BitTorrent Specific Options
queue gets started. But be aware that seeding item is still queue gets started. But be aware that seeding item is still
recognized as active download in RPC method. Default: ``false`` recognized as active download in RPC method. Default: ``false``
.. option:: --bt-enable-hook-after-hash-check[=true|false] .. option:: --bt-enable-hook-after-hash-check [true|false]
Allow hook command invocation after hash check (see :option:`-V` Allow hook command invocation after hash check (see :option:`-V`
option) in BitTorrent download. By default, when hash check option) in BitTorrent download. By default, when hash check
@ -673,7 +673,7 @@ BitTorrent Specific Options
is executed. To disable this action, give ``false`` to this option. is executed. To disable this action, give ``false`` to this option.
Default: ``true`` Default: ``true``
.. option:: --bt-enable-lpd[=true|false] .. option:: --bt-enable-lpd [true|false]
Enable Local Peer Discovery. If a private flag is set in a torrent, 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 aria2 doesn't use this feature for that download even if ``true`` is
@ -696,7 +696,7 @@ BitTorrent Specific Options
function is named ``external``, it can accept any kind of IP function is named ``external``, it can accept any kind of IP
addresses. addresses.
.. option:: --bt-force-encryption[=true|false] .. option:: --bt-force-encryption [true|false]
Requires BitTorrent message payload encryption with arc4. This is a Requires BitTorrent message payload encryption with arc4. This is a
shorthand of :option:`--bt-require-crypto` shorthand of :option:`--bt-require-crypto`
@ -705,7 +705,7 @@ BitTorrent Specific Options
legacy BitTorrent handshake and only use Obfuscation handshake and legacy BitTorrent handshake and only use Obfuscation handshake and
always encrypt message payload. Default: ``false`` always encrypt message payload. Default: ``false``
.. option:: --bt-hash-check-seed[=true|false] .. option:: --bt-hash-check-seed [true|false]
If ``true`` is given, after hash check using :option:`--check-integrity <-V>` option and If ``true`` is given, after hash check using :option:`--check-integrity <-V>` option and
file is complete, continue to seed file. If you want to check file file is complete, continue to seed file. If you want to check file
@ -713,7 +713,7 @@ BitTorrent Specific Options
option to ``false``. This option has effect only on BitTorrent download. option to ``false``. This option has effect only on BitTorrent download.
Default: ``true`` Default: ``true``
.. option:: --bt-load-saved-metadata[=true|false] .. option:: --bt-load-saved-metadata [true|false]
Before getting torrent metadata from DHT when downloading with Before getting torrent metadata from DHT when downloading with
magnet link, first try to read file saved by magnet link, first try to read file saved by
@ -740,7 +740,7 @@ BitTorrent Specific Options
unlimited. See also :option:`--bt-request-peer-speed-limit` option. unlimited. See also :option:`--bt-request-peer-speed-limit` option.
Default: ``55`` Default: ``55``
.. option:: --bt-metadata-only[=true|false] .. option:: --bt-metadata-only [true|false]
Download meta data only. The file(s) described in meta data will not Download meta data only. The file(s) described in meta data will not
be downloaded. This option has effect only when BitTorrent Magnet be downloaded. This option has effect only when BitTorrent Magnet
@ -764,7 +764,7 @@ BitTorrent Specific Options
last SIZE bytes of each file. SIZE can include ``K`` or ``M`` (1K = 1024, last SIZE bytes of each file. SIZE can include ``K`` or ``M`` (1K = 1024,
1M = 1024K). If SIZE is omitted, SIZE=1M is used. 1M = 1024K). If SIZE is omitted, SIZE=1M is used.
.. option:: --bt-remove-unselected-file[=true|false] .. option:: --bt-remove-unselected-file [true|false]
Removes the unselected files when download is completed in Removes the unselected files when download is completed in
BitTorrent. To select files, use BitTorrent. To select files, use
@ -774,7 +774,7 @@ BitTorrent Specific Options
disk. disk.
Default: ``false`` Default: ``false``
.. option:: --bt-require-crypto[=true|false] .. option:: --bt-require-crypto [true|false]
If ``true`` is given, aria2 doesn't accept and establish connection with legacy If ``true`` is given, aria2 doesn't accept and establish connection with legacy
BitTorrent handshake(\\19BitTorrent protocol). BitTorrent handshake(\\19BitTorrent protocol).
@ -790,7 +790,7 @@ BitTorrent Specific Options
You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K). You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
Default: ``50K`` Default: ``50K``
.. option:: --bt-save-metadata[=true|false] .. option:: --bt-save-metadata [true|false]
Save meta data as ".torrent" file. This option has effect only when Save meta data as ".torrent" file. This option has effect only when
BitTorrent Magnet URI is used. The file name is hex encoded info BitTorrent Magnet URI is used. The file name is hex encoded info
@ -799,7 +799,7 @@ BitTorrent Specific Options
exists, meta data is not saved. See also :option:`--bt-metadata-only` exists, meta data is not saved. See also :option:`--bt-metadata-only`
option. Default: ``false`` option. Default: ``false``
.. option:: --bt-seed-unverified[=true|false] .. option:: --bt-seed-unverified [true|false]
Seed previously downloaded files without verifying piece hashes. Seed previously downloaded files without verifying piece hashes.
Default: ``false`` Default: ``false``
@ -876,20 +876,20 @@ BitTorrent Specific Options
Set timeout in seconds. Default: ``10`` Set timeout in seconds. Default: ``10``
.. option:: --enable-dht[=true|false] .. option:: --enable-dht [true|false]
Enable IPv4 DHT functionality. It also enables UDP tracker Enable IPv4 DHT functionality. It also enables UDP tracker
support. If a private flag is set in a torrent, aria2 doesn't use support. If a private flag is set in a torrent, aria2 doesn't use
DHT for that download even if ``true`` is given. Default: ``true`` DHT for that download even if ``true`` is given. Default: ``true``
.. option:: --enable-dht6[=true|false] .. option:: --enable-dht6 [true|false]
Enable IPv6 DHT functionality. If a private flag is set in a 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 torrent, aria2 doesn't use DHT for that download even if ``true`` is
given. Use :option:`--dht-listen-port` option to specify port number to given. Use :option:`--dht-listen-port` option to specify port number to
listen on. See also :option:`--dht-listen-addr6` option. listen on. See also :option:`--dht-listen-addr6` option.
.. option:: --enable-peer-exchange[=true|false] .. option:: --enable-peer-exchange [true|false]
Enable Peer Exchange extension. If a private flag is set in a torrent, this 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. feature is disabled for that download even if ``true`` is given.
@ -1037,7 +1037,7 @@ Metalink Specific Options
Specify ``none`` to disable this feature. Specify ``none`` to disable this feature.
Default: ``none`` Default: ``none``
.. option:: --metalink-enable-unique-protocol[=true|false] .. option:: --metalink-enable-unique-protocol [true|false]
If ``true`` is given and several protocols are available for a mirror in a If ``true`` is given and several protocols are available for a mirror in a
metalink file, aria2 uses one of them. metalink file, aria2 uses one of them.
@ -1048,19 +1048,19 @@ Metalink Specific Options
RPC Options RPC Options
~~~~~~~~~~~ ~~~~~~~~~~~
.. option:: --enable-rpc[=true|false] .. option:: --enable-rpc [true|false]
Enable JSON-RPC/XML-RPC server. It is strongly recommended to set Enable JSON-RPC/XML-RPC server. It is strongly recommended to set
secret authorization token using :option:`--rpc-secret` option. See secret authorization token using :option:`--rpc-secret` option. See
also :option:`--rpc-listen-port` option. Default: ``false`` also :option:`--rpc-listen-port` option. Default: ``false``
.. option:: --pause[=true|false] .. option:: --pause [true|false]
Pause download after added. This option is effective only when Pause download after added. This option is effective only when
:option:`--enable-rpc=true <--enable-rpc>` is given. :option:`--enable-rpc=true <--enable-rpc>` is given.
Default: ``false`` Default: ``false``
.. option:: --pause-metadata[=true|false] .. option:: --pause-metadata [true|false]
Pause downloads created as a result of metadata download. There are Pause downloads created as a result of metadata download. There are
3 types of metadata downloads in aria2: (1) downloading .torrent 3 types of metadata downloads in aria2: (1) downloading .torrent
@ -1071,7 +1071,7 @@ RPC Options
:option:`--enable-rpc=true <--enable-rpc>` is given. :option:`--enable-rpc=true <--enable-rpc>` is given.
Default: ``false`` Default: ``false``
.. option:: --rpc-allow-origin-all[=true|false] .. option:: --rpc-allow-origin-all [true|false]
Add Access-Control-Allow-Origin header field with value ``*`` to the Add Access-Control-Allow-Origin header field with value ``*`` to the
RPC response. RPC response.
@ -1103,7 +1103,7 @@ RPC Options
Alternatively PKCS12 files are also supported. PEM files, however, are not Alternatively PKCS12 files are also supported. PEM files, however, are not
supported. supported.
.. option:: --rpc-listen-all[=true|false] .. option:: --rpc-listen-all [true|false]
Listen incoming JSON-RPC/XML-RPC requests on all network interfaces. If false Listen incoming JSON-RPC/XML-RPC requests on all network interfaces. If false
is given, listen only on local loopback interface. Default: ``false`` is given, listen only on local loopback interface. Default: ``false``
@ -1134,7 +1134,7 @@ RPC Options
decrypted and in PEM format. Use :option:`--rpc-secure` option to decrypted and in PEM format. Use :option:`--rpc-secure` option to
enable encryption. See also :option:`--rpc-certificate` option. enable encryption. See also :option:`--rpc-certificate` option.
.. option:: --rpc-save-upload-metadata[=true|false] .. option:: --rpc-save-upload-metadata [true|false]
Save the uploaded torrent or metalink meta data in the directory Save the uploaded torrent or metalink meta data in the directory
specified by :option:`--dir` option. The file name consists of SHA-1 specified by :option:`--dir` option. The file name consists of SHA-1
@ -1149,7 +1149,7 @@ RPC Options
Set RPC secret authorization token. Read :ref:`rpc_auth` to know Set RPC secret authorization token. Read :ref:`rpc_auth` to know
how this option value is used. how this option value is used.
.. option:: --rpc-secure[=true|false] .. option:: --rpc-secure [true|false]
RPC transport will be encrypted by SSL/TLS. The RPC clients must RPC transport will be encrypted by SSL/TLS. The RPC clients must
use https scheme to access the server. For WebSocket client, use wss use https scheme to access the server. For WebSocket client, use wss
@ -1169,20 +1169,20 @@ RPC Options
Advanced Options Advanced Options
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. option:: --allow-overwrite[=true|false] .. option:: --allow-overwrite [true|false]
Restart download from scratch if the corresponding control file Restart download from scratch if the corresponding control file
doesn't exist. See also :option:`--auto-file-renaming` option. Default: doesn't exist. See also :option:`--auto-file-renaming` option. Default:
``false`` ``false``
.. option:: --allow-piece-length-change[=true|false] .. option:: --allow-piece-length-change [true|false]
If false is given, aria2 aborts download when a piece length is different If false is given, aria2 aborts download when a piece length is different
from one in a control file. from one in a control file.
If true is given, you can proceed but some download progress will be lost. If true is given, you can proceed but some download progress will be lost.
Default: ``false`` Default: ``false``
.. option:: --always-resume[=true|false] .. option:: --always-resume [true|false]
Always resume download. If ``true`` is given, aria2 always tries to Always resume download. If ``true`` is given, aria2 always tries to
resume download and if resume is not possible, aborts download. If resume download and if resume is not possible, aborts download. If
@ -1192,7 +1192,7 @@ Advanced Options
downloads file from scratch. See :option:`--max-resume-failure-tries` downloads file from scratch. See :option:`--max-resume-failure-tries`
option. Default: ``true`` option. Default: ``true``
.. option:: --async-dns[=true|false] .. option:: --async-dns [true|false]
Enable asynchronous DNS. Enable asynchronous DNS.
Default: ``true`` Default: ``true``
@ -1207,7 +1207,7 @@ Advanced Options
option is useful when the system does not have ``/etc/resolv.conf`` and option is useful when the system does not have ``/etc/resolv.conf`` and
user does not have the permission to create it. user does not have the permission to create it.
.. option:: --auto-file-renaming[=true|false] .. option:: --auto-file-renaming [true|false]
Rename file name if the same file already exists. Rename file name if the same file already exists.
This option works only in HTTP(S)/FTP download. This option works only in HTTP(S)/FTP download.
@ -1223,7 +1223,7 @@ Advanced Options
The possible values are between ``0`` to ``600``. The possible values are between ``0`` to ``600``.
Default: ``60`` Default: ``60``
.. option:: --conditional-get[=true|false] .. option:: --conditional-get [true|false]
Download file only when the local file is older than remote Download file only when the local file is older than remote
file. This function only works with HTTP(S) downloads only. It does file. This function only works with HTTP(S) downloads only. It does
@ -1247,19 +1247,19 @@ Advanced Options
Set log level to output to console. LEVEL is either ``debug``, Set log level to output to console. LEVEL is either ``debug``,
``info``, ``notice``, ``warn`` or ``error``. Default: ``notice`` ``info``, ``notice``, ``warn`` or ``error``. Default: ``notice``
.. option:: --content-disposition-default-utf8[=true|false] .. option:: --content-disposition-default-utf8 [true|false]
Handle quoted string in Content-Disposition header as UTF-8 instead Handle quoted string in Content-Disposition header as UTF-8 instead
of ISO-8859-1, for example, the filename parameter, but not the of ISO-8859-1, for example, the filename parameter, but not the
extended version filename*. Default: ``false`` extended version filename*. Default: ``false``
.. option:: -D, --daemon[=true|false] .. option:: -D, --daemon [true|false]
Run as daemon. The current working directory will be changed to ``/`` Run as daemon. The current working directory will be changed to ``/``
and standard input, standard output and standard error will be and standard input, standard output and standard error will be
redirected to ``/dev/null``. Default: ``false`` redirected to ``/dev/null``. Default: ``false``
.. option:: --deferred-input[=true|false] .. option:: --deferred-input [true|false]
If ``true`` is given, aria2 does not read all URIs and options from file If ``true`` is given, aria2 does not read all URIs and options from file
specified by :option:`--input-file <-i>` option at startup, specified by :option:`--input-file <-i>` option at startup,
@ -1274,7 +1274,7 @@ Advanced Options
:option:`--deferred-input` option will be disabled when :option:`--deferred-input` option will be disabled when
:option:`--save-session` is used together. :option:`--save-session` is used together.
.. option:: --disable-ipv6[=true|false] .. option:: --disable-ipv6 [true|false]
Disable IPv6. This is useful if you have to use broken DNS and want Disable IPv6. This is useful if you have to use broken DNS and want
to avoid terribly slow AAAA record lookup. Default: ``false`` to avoid terribly slow AAAA record lookup. Default: ``false``
@ -1327,12 +1327,12 @@ Advanced Options
This option is only available on systems supporting the rlimit API. This option is only available on systems supporting the rlimit API.
.. option:: --enable-color[=true|false] .. option:: --enable-color [true|false]
Enable color output for a terminal. Enable color output for a terminal.
Default: ``true`` Default: ``true``
.. option:: --enable-mmap[=true|false] .. option:: --enable-mmap [true|false]
Map files into memory. This option may not work if the file space Map files into memory. This option may not work if the file space
is not pre-allocated. See :option:`--file-allocation`. is not pre-allocated. See :option:`--file-allocation`.
@ -1382,7 +1382,7 @@ Advanced Options
In multi file torrent downloads, the files adjacent forward to the specified files In multi file torrent downloads, the files adjacent forward to the specified files
are also allocated if they share the same piece. are also allocated if they share the same piece.
.. option:: --force-save[=true|false] .. option:: --force-save [true|false]
Save download with :option:`--save-session <--save-session>` option Save download with :option:`--save-session <--save-session>` option
even if the download is completed or removed. This option also saves even if the download is completed or removed. This option also saves
@ -1390,7 +1390,7 @@ Advanced Options
BitTorrent seeding which is recognized as completed state. BitTorrent seeding which is recognized as completed state.
Default: ``false`` Default: ``false``
.. option:: --save-not-found[=true|false] .. option:: --save-not-found [true|false]
Save download with :option:`--save-session <--save-session>` option Save download with :option:`--save-session <--save-session>` option
even if the file was not found on the server. This option also saves even if the file was not found on the server. This option also saves
@ -1408,14 +1408,14 @@ Advanced Options
:option:`--save-session <--save-session>` option. If this option is :option:`--save-session <--save-session>` option. If this option is
not used, new GID is generated by aria2. not used, new GID is generated by aria2.
.. option:: --hash-check-only[=true|false] .. option:: --hash-check-only [true|false]
If ``true`` is given, after hash check using If ``true`` is given, after hash check using
:option:`--check-integrity <-V>` option, :option:`--check-integrity <-V>` option,
abort download whether or not download is complete. abort download whether or not download is complete.
Default: ``false`` Default: ``false``
.. option:: --human-readable[=true|false] .. option:: --human-readable [true|false]
Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi) Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi)
in the console readout. Default: ``true`` in the console readout. Default: ``true``
@ -1433,7 +1433,7 @@ Advanced Options
system doesn't have :manpage:`getifaddrs(3)`, this option doesn't accept interface system doesn't have :manpage:`getifaddrs(3)`, this option doesn't accept interface
name. name.
.. option:: --keep-unfinished-download-result[=true|false] .. option:: --keep-unfinished-download-result [true|false]
Keep unfinished download results even if doing so exceeds Keep unfinished download results even if doing so exceeds
:option:`--max-download-result`. This is useful if all unfinished :option:`--max-download-result`. This is useful if all unfinished
@ -1539,7 +1539,7 @@ Advanced Options
Possible Values: ``/path/to/command`` Possible Values: ``/path/to/command``
.. option:: --optimize-concurrent-downloads[=true|false|<A>:<B>] .. option:: --optimize-concurrent-downloads [true|false|<A>:<B>]
Optimizes the number of concurrent downloads according to the Optimizes the number of concurrent downloads according to the
bandwidth available. aria2 uses the download speed observed in the bandwidth available. aria2 uses the download speed observed in the
@ -1568,12 +1568,12 @@ Advanced Options
To enable HTTP pipelining use To enable HTTP pipelining use
:option:`--enable-http-pipelining`. :option:`--enable-http-pipelining`.
.. option:: --show-console-readout[=true|false] .. option:: --show-console-readout [true|false]
Show console readout. Default: ``true`` Show console readout. Default: ``true``
.. option:: --stderr[=true|false] .. option:: --stderr [true|false]
Redirect all console output that would be otherwise printed in Redirect all console output that would be otherwise printed in
stdout to stderr. Default: ``false`` stdout to stderr. Default: ``false``
@ -1584,7 +1584,7 @@ Advanced Options
Setting ``0`` suppresses the output. Setting ``0`` suppresses the output.
Default: ``60`` Default: ``60``
.. option:: -Z, --force-sequential[=true|false] .. option:: -Z, --force-sequential [true|false]
Fetch URIs in the command-line sequentially and download each URI in a Fetch URIs in the command-line sequentially and download each URI in a
separate session, like the usual command-line download utilities. separate session, like the usual command-line download utilities.
@ -1604,7 +1604,7 @@ Advanced Options
limit the overall download speed, use :option:`--max-overall-download-limit` limit the overall download speed, use :option:`--max-overall-download-limit`
option. Default: ``0`` option. Default: ``0``
.. option:: --no-conf[=true|false] .. option:: --no-conf [true|false]
Disable loading aria2.conf file. Disable loading aria2.conf file.
@ -1614,7 +1614,7 @@ Advanced Options
You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K). You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
Default: ``5M`` Default: ``5M``
.. option:: -P, --parameterized-uri[=true|false] .. option:: -P, --parameterized-uri [true|false]
Enable parameterized URI support. Enable parameterized URI support.
You can specify set of parts: ``http://{sv1,sv2,sv3}/foo.iso``. You can specify set of parts: ``http://{sv1,sv2,sv3}/foo.iso``.
@ -1625,19 +1625,19 @@ Advanced Options
-Z option is required. -Z option is required.
Default: ``false`` Default: ``false``
.. option:: -q, --quiet[=true|false] .. option:: -q, --quiet [true|false]
Make aria2 quiet (no console output). Make aria2 quiet (no console output).
Default: ``false`` Default: ``false``
.. option:: --realtime-chunk-checksum[=true|false] .. option:: --realtime-chunk-checksum [true|false]
Validate chunk of data by calculating checksum while downloading a file if Validate chunk of data by calculating checksum while downloading a file if
chunk checksums are provided. chunk checksums are provided.
Default: ``true`` Default: ``true``
.. option:: --remove-control-file[=true|false] .. option:: --remove-control-file [true|false]
Remove control file before download. Using with Remove control file before download. Using with
:option:`--allow-overwrite=true, <--allow-overwrite>` download always starts from :option:`--allow-overwrite=true, <--allow-overwrite>` download always starts from
@ -1701,7 +1701,7 @@ Advanced Options
can fork aria2 with its own pid and when parent process exits for can fork aria2 with its own pid and when parent process exits for
some reason, aria2 can detect it and shutdown itself. some reason, aria2 can detect it and shutdown itself.
.. option:: --truncate-console-readout[=true|false] .. option:: --truncate-console-readout [true|false]
Truncate console readout to fit in a single line. Truncate console readout to fit in a single line.
Default: ``true`` Default: ``true``

View File

@ -128,7 +128,7 @@ html_theme_path = ['@srcdir@/../../sphinx_themes']
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
html_use_smartypants = False #html_use_smartypants = False
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} #html_sidebars = {}

View File

@ -70,7 +70,7 @@ Opções Comuns
HTTPS, FTP), Torrent e Metalink. Ver também opção :option:`--split <-s>`. HTTPS, FTP), Torrent e Metalink. Ver também opção :option:`--split <-s>`.
Padrão: ``5`` Padrão: ``5``
.. option:: -V, --check-integrity[=true|false] .. option:: -V, --check-integrity [true|false]
Verifica a integridade do arquivo validando pedaços hashes ou um hash do Verifica a integridade do arquivo validando pedaços hashes ou um hash do
arquivo inteiro. Essa opção tem efeito só em downloads BitTorrent, Metalink arquivo inteiro. Essa opção tem efeito só em downloads BitTorrent, Metalink
@ -84,7 +84,7 @@ Opções Comuns
Padrão: Padrão:
``false`` ``false``
.. option:: -c, --continue[=true|false] .. option:: -c, --continue [true|false]
Continua o download a partir de um download parcial, anteriormente Continua o download a partir de um download parcial, anteriormente
interrompido. Use esta opção para retormar um download iniciado a partir interrompido. Use esta opção para retormar um download iniciado a partir
@ -167,7 +167,7 @@ Opções HTTP / FTP
a opção :option:`--timeout <-t>` será utilizada. a opção :option:`--timeout <-t>` será utilizada.
Padrão: ``60`` Padrão: ``60``
.. option:: --dry-run[=true|false] .. option:: --dry-run [true|false]
Se ``true`` é informado, aria2 apenas verifica se o arquivo remoto está Se ``true`` é informado, aria2 apenas verifica se o arquivo remoto está
disponível para download dos dados. Esta opção tem efeito em downloads de disponível para download dos dados. Esta opção tem efeito em downloads de
@ -216,7 +216,7 @@ Opções HTTP / FTP
Valores Possíveis: ``1M`` -``1024M`` Valores Possíveis: ``1M`` -``1024M``
Padrão: ``20M`` Padrão: ``20M``
.. option:: -n, --no-netrc[=true|false] .. option:: -n, --no-netrc [true|false]
Desabilita suporte netrc. Desabilita suporte netrc.
Padrão: Suporte a netrc é habilitado por padrão. Padrão: Suporte a netrc é habilitado por padrão.
@ -267,13 +267,13 @@ Opções HTTP / FTP
desta opção. desta opção.
Padrão: ``get`` Padrão: ``get``
.. option:: -R, --remote-time[=true|false] .. option:: -R, --remote-time [true|false]
Recuperar timestamp do arquivo remoto a partir do servidor remoto HTTP / FTP Recuperar timestamp do arquivo remoto a partir do servidor remoto HTTP / FTP
e se disponível, aplicá-lo ao arquivo local. e se disponível, aplicá-lo ao arquivo local.
Padrão: ``false`` Padrão: ``false``
.. option:: --reuse-uri[=true|false] .. option:: --reuse-uri [true|false]
Reutilizar uma URI já utilizada. Se não habilitada as URIs já utilizadas serão Reutilizar uma URI já utilizada. Se não habilitada as URIs já utilizadas serão
abandonadas. abandonadas.
@ -399,13 +399,13 @@ Opções Específicas de HTTP e HTTPS
Pode ser usada a opção :option:`--private-key` para especificar uma chave Pode ser usada a opção :option:`--private-key` para especificar uma chave
particular. particular.
.. option:: --check-certificate[=true|false] .. option:: --check-certificate [true|false]
Verifica se o peer esta usando o certificado especificado na opção Verifica se o peer esta usando o certificado especificado na opção
:option:`--ca-certificate`. :option:`--ca-certificate`.
Padrão: ``true`` Padrão: ``true``
.. option:: --http-accept-gzip[=true|false] .. option:: --http-accept-gzip [true|false]
Envia cabeçalho requisição ``Accept: deflate, gzip`` e faz (inflate) se Envia cabeçalho requisição ``Accept: deflate, gzip`` e faz (inflate) se
o servidor remoto responder com ``Content-Encoding: gzip`` ou o servidor remoto responder com ``Content-Encoding: gzip`` ou
@ -416,7 +416,7 @@ Opções Específicas de HTTP e HTTPS
Alguns servidores respondem com ``Content-Encoding: gzip`` para arquivos Alguns servidores respondem com ``Content-Encoding: gzip`` para arquivos
que são gzip. aria2 faz inflate destes por causa do cabeçalho de resposta. que são gzip. aria2 faz inflate destes por causa do cabeçalho de resposta.
.. option:: --http-auth-challenge[=true|false] .. option:: --http-auth-challenge [true|false]
Envia cabeçalho de autorização HTTP só quando requisitado pelo servidor. Envia cabeçalho de autorização HTTP só quando requisitado pelo servidor.
Se ``false`` é habilitado, então o cabeçalho de autorização sempre será Se ``false`` é habilitado, então o cabeçalho de autorização sempre será
@ -424,7 +424,7 @@ Opções Específicas de HTTP e HTTPS
embutidas na URI, o cabeçalho de autorização sempre será enviado ao servidor embutidas na URI, o cabeçalho de autorização sempre será enviado ao servidor
independente desta opção. Padrão: ``false`` independente desta opção. Padrão: ``false``
.. option:: --http-no-cache[=true|false] .. option:: --http-no-cache [true|false]
Envia Cache-Control: no-cache e Pragma: cabeçalho no-cache para evitar Envia Cache-Control: no-cache e Pragma: cabeçalho no-cache para evitar
conteúdo do cache. Se ``false`` é fornecido, esses cabeçalhos não serão conteúdo do cache. Se ``false`` é fornecido, esses cabeçalhos não serão
@ -480,12 +480,12 @@ Opções Específicas de HTTP e HTTPS
como referência (referer). Pode ser útil quando usado em conjunto com a opção como referência (referer). Pode ser útil quando usado em conjunto com a opção
:option:`--parameterized-uri`. :option:`--parameterized-uri`.
.. option:: --enable-http-keep-alive[=true|false] .. option:: --enable-http-keep-alive [true|false]
Enable HTTP/1.1 persistent connection. Enable HTTP/1.1 persistent connection.
Padrão: ``true`` Padrão: ``true``
.. option:: --enable-http-pipelining[=true|false] .. option:: --enable-http-pipelining [true|false]
Habilita pipelining para HTTP/1.1. Habilita pipelining para HTTP/1.1.
Padrão: ``false`` Padrão: ``false``
@ -523,7 +523,7 @@ Opções Específicas de HTTP e HTTPS
serão salvos e seus valores de expiração serão tratados como 0. serão salvos e seus valores de expiração serão tratados como 0.
Valores Possíveis: ``/caminho/do/arquivo`` Valores Possíveis: ``/caminho/do/arquivo``
.. option:: --use-head[=true|false] .. option:: --use-head [true|false]
Usar método HEAD para a primeira requisição ao servidor HTTP. Usar método HEAD para a primeira requisição ao servidor HTTP.
Padrão: ``false`` Padrão: ``false``
@ -550,7 +550,7 @@ Opções Específicas de FTP
no .netrc. Se não existir será utilizada a senha declarada nesta opção. no .netrc. Se não existir será utilizada a senha declarada nesta opção.
Padrão: ``ARIA2USER@`` Padrão: ``ARIA2USER@``
.. option:: -p, --ftp-pasv[=true|false] .. option:: -p, --ftp-pasv [true|false]
Usar modo passivo no FTP. Usar modo passivo no FTP.
Se ``false`` é informado, o modo ativo será usado. Se ``false`` é informado, o modo ativo será usado.
@ -576,7 +576,7 @@ Opções Específicas de FTP
Define tipo de transferência FTP. Que pode ser: ``binary`` ou ``ascii``. Define tipo de transferência FTP. Que pode ser: ``binary`` ou ``ascii``.
Padrão: ``binary`` Padrão: ``binary``
.. option:: --ftp-reuse-connection[=true|false] .. option:: --ftp-reuse-connection [true|false]
Reutilizar conexão FTP. Reutilizar conexão FTP.
Padrão: ``true`` Padrão: ``true``
@ -602,7 +602,7 @@ Opções Comuns de BitTorrent / Metalink
partes de arquivos, e aria2 grava o pedaço(s) no(s) arquivo(s) partes de arquivos, e aria2 grava o pedaço(s) no(s) arquivo(s)
apropriado(s). apropriado(s).
.. option:: -S, --show-files[=true|false] .. option:: -S, --show-files [true|false]
Imprimir a lista de arquivos do ".torrent", ".meta4" e ".metalink" e termina. Imprimir a lista de arquivos do ".torrent", ".meta4" e ".metalink" e termina.
No caso de arquivo ".torrent", informações adicionais são impressas. No caso de arquivo ".torrent", informações adicionais são impressas.
@ -611,7 +611,7 @@ Opções Comuns de BitTorrent / Metalink
Opções Específicas de BitTorrent Opções Específicas de BitTorrent
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. option:: --bt-enable-lpd[=true|false] .. option:: --bt-enable-lpd [true|false]
Habilita Descobrir Peer Local. Se indicador particular é configurado Habilita Descobrir Peer Local. Se indicador particular é configurado
no torrent, aria2 não usa esta funcionalidade mesmo que ``true`` foi no torrent, aria2 não usa esta funcionalidade mesmo que ``true`` foi
@ -633,7 +633,7 @@ Opções Específicas de BitTorrent
função tenha o nome ``external``, ela pode aceitar qualquer tipo de endereço função tenha o nome ``external``, ela pode aceitar qualquer tipo de endereço
IP. ENDEREÇO-IP deve ser um endereço IP numérico. IP. ENDEREÇO-IP deve ser um endereço IP numérico.
.. option:: --bt-hash-check-seed[=true|false] .. option:: --bt-hash-check-seed [true|false]
Se ``true`` é informado, após o check do hash usando a opção :option: Se ``true`` é informado, após o check do hash usando a opção :option:
`--check-integrity <-V>` e o arquivo esta completo, continue o arquivo seed. `--check-integrity <-V>` e o arquivo esta completo, continue o arquivo seed.
@ -661,7 +661,7 @@ Opções Específicas de BitTorrent
ilimitado. Ver também a opção :option: `--bt-request-peer-speed-limit`. ilimitado. Ver também a opção :option: `--bt-request-peer-speed-limit`.
Padrão: ``55`` Padrão: ``55``
.. option:: --bt-metadata-only[=true|false] .. option:: --bt-metadata-only [true|false]
Download somente os metadados. O(s) arquivo(s) descrito(s) no(s) metadado(s) Download somente os metadados. O(s) arquivo(s) descrito(s) no(s) metadado(s)
não será(ão) baixado(s). Esta opção só tem efeito para URI BitTorrent Magnet. não será(ão) baixado(s). Esta opção só tem efeito para URI BitTorrent Magnet.
@ -688,7 +688,7 @@ Opções Específicas de BitTorrent
incluir ``K`` ou ``M`` (1K = 1024, 1M = 1024K). Se TAMANHO é omitido, incluir ``K`` ou ``M`` (1K = 1024, 1M = 1024K). Se TAMANHO é omitido,
TAMNHA de 1M será usado. TAMNHA de 1M será usado.
.. option:: --bt-remove-unselected-file[=true|false] .. option:: --bt-remove-unselected-file [true|false]
Remove os arquivos não selecionados quando o download do BitTorrent estiver Remove os arquivos não selecionados quando o download do BitTorrent estiver
completo. Para selecionar arquivo(s) use a opção :option:`--select-file`. completo. Para selecionar arquivo(s) use a opção :option:`--select-file`.
@ -697,7 +697,7 @@ Opções Específicas de BitTorrent
arquivo(s) do seu disco. arquivo(s) do seu disco.
Padrão: ``false`` Padrão: ``false``
.. option:: --bt-require-crypto[=true|false] .. option:: --bt-require-crypto [true|false]
Se true é informado, aria2 não aceita nem estabelece conexão com handshake de Se true é informado, aria2 não aceita nem estabelece conexão com handshake de
BitTorrent (protocolo \19BitTorrent). Em vez disso aria2 usa BitTorrent (protocolo \19BitTorrent). Em vez disso aria2 usa
@ -713,7 +713,7 @@ Opções Específicas de BitTorrent
ser anexado ``K`` ou ``M`` (1K = 1024, 1M = 1024K). ser anexado ``K`` ou ``M`` (1K = 1024, 1M = 1024K).
Padrão: ``50K`` Padrão: ``50K``
.. option:: --bt-save-metadata[=true|false] .. option:: --bt-save-metadata [true|false]
Salvar metadados como arquivo ".torrent" file. Esta opção tem efeito somente Salvar metadados como arquivo ".torrent" file. Esta opção tem efeito somente
se URI usada é de BitTorrent Magnet. O nome do arquivo é codificado em hash se URI usada é de BitTorrent Magnet. O nome do arquivo é codificado em hash
@ -723,7 +723,7 @@ Opções Específicas de BitTorrent
`--bt-metadata-only`. `--bt-metadata-only`.
Padrão: ``false`` Padrão: ``false``
.. option:: --bt-seed-unverified[=true|false] .. option:: --bt-seed-unverified [true|false]
Faz Seed do arquivo previamente baixado sem verificar os hashes dos pedaços. Faz Seed do arquivo previamente baixado sem verificar os hashes dos pedaços.
Padrão: ``false`` Padrão: ``false``
@ -805,14 +805,14 @@ Opções Específicas de BitTorrent
Define timeout em segundos. Define timeout em segundos.
Padrão: ``10`` Padrão: ``10``
.. option:: --enable-dht[=true|false] .. option:: --enable-dht [true|false]
Habilita funcionalidade DHT IPv4. Tambem habilita suporte a rastreador UDP. Habilita funcionalidade DHT IPv4. Tambem habilita suporte a rastreador UDP.
Se um identificador particular é usado em um torrente, aria2 não usa DHT Se um identificador particular é usado em um torrente, aria2 não usa DHT
para aquele download, mesmo que ``true`` foi informado. para aquele download, mesmo que ``true`` foi informado.
Padrão: ``true`` Padrão: ``true``
.. option:: --enable-dht6[=true|false] .. option:: --enable-dht6 [true|false]
Habilita funcionalidade DHT IPv6. Se identificador particular é usado em um Habilita funcionalidade DHT IPv6. Se identificador particular é usado em um
torrent, aria2 não usa DHT para aquele download mesmo que ``true`` foi torrent, aria2 não usa DHT para aquele download mesmo que ``true`` foi
@ -821,7 +821,7 @@ Opções Específicas de BitTorrent
--dht-listen-addr6` --dht-listen-addr6`
Padrão: ``true`` Padrão: ``true``
.. option:: --enable-peer-exchange[=true|false] .. option:: --enable-peer-exchange [true|false]
Habilita extensão Peer Exchange. Se um indicador particular é usado nesse Habilita extensão Peer Exchange. Se um indicador particular é usado nesse
torrent, essa funcionalidade será desabilitada para o download, mesmo que torrent, essa funcionalidade será desabilitada para o download, mesmo que
@ -959,7 +959,7 @@ Opções Específicas de Metalink
Specify ``none`` to disable this feature. Specify ``none`` to disable this feature.
Padrão: ``none`` Padrão: ``none``
.. option:: --metalink-enable-unique-protocol[=true|false] .. option:: --metalink-enable-unique-protocol [true|false]
If ``true`` is given and several protocols are available for a mirror in a If ``true`` is given and several protocols are available for a mirror in a
metalink file, aria2 uses one of them. metalink file, aria2 uses one of them.
@ -970,19 +970,19 @@ Opções Específicas de Metalink
Opções específicas de RPC Opções específicas de RPC
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. option:: --enable-rpc[=true|false] .. option:: --enable-rpc [true|false]
Enable JSON-RPC/XML-RPC server. It is strongly recommended to set username Enable JSON-RPC/XML-RPC server. It is strongly recommended to set username
and password using :option:`--rpc-user` and :option:`--rpc-passwd` and password using :option:`--rpc-user` and :option:`--rpc-passwd`
option. See also :option:`--rpc-listen-port` option. Padrão: ``false`` option. See also :option:`--rpc-listen-port` option. Padrão: ``false``
.. option:: --pause[=true|false] .. option:: --pause [true|false]
Pause o download após adicionado. Está opção só é efetiva quando Pause o download após adicionado. Está opção só é efetiva quando
a opção :option:`--enable-rpc=true <--enable-rpc>` é informada. a opção :option:`--enable-rpc=true <--enable-rpc>` é informada.
Padrão: ``false`` Padrão: ``false``
.. option:: --rpc-allow-origin-all[=true|false] .. option:: --rpc-allow-origin-all [true|false]
Adiciona o campo de cabeçalho, ``Access-Control-Allow-Origin``, Adiciona o campo de cabeçalho, ``Access-Control-Allow-Origin``,
com o valor ``*`` á resposta RPC. com o valor ``*`` á resposta RPC.
@ -1002,7 +1002,7 @@ Opções específicas de RPC
`--rpc-certificate=<SHA-1>` e apenas omitir a opção `--rpc-certificate=<SHA-1>` e apenas omitir a opção
:option:`--rpc-private-key` :option:`--rpc-private-key`
.. option:: --rpc-listen-all[=true|false] .. option:: --rpc-listen-all [true|false]
Listen incoming JSON-RPC/XML-RPC requests on all network interfaces. If false Listen incoming JSON-RPC/XML-RPC requests on all network interfaces. If false
is given, listen only on local loopback interface. Padrão: ``false`` is given, listen only on local loopback interface. Padrão: ``false``
@ -1027,7 +1027,7 @@ Opções específicas de RPC
decrypted and in PEM format. Use :option:`--rpc-secure` option to decrypted and in PEM format. Use :option:`--rpc-secure` option to
enable encryption. See also :option:`--rpc-certificate` option. enable encryption. See also :option:`--rpc-certificate` option.
.. option:: --rpc-save-upload-metadata[=true|false] .. option:: --rpc-save-upload-metadata [true|false]
Save the uploaded torrent or metalink metadata in the directory Save the uploaded torrent or metalink metadata in the directory
specified by :option:`--dir` option. The filename consists of SHA-1 specified by :option:`--dir` option. The filename consists of SHA-1
@ -1037,7 +1037,7 @@ Opções específicas de RPC
:func:`aria2.addTorrent` or :func:`aria2.addMetalink` will not be :func:`aria2.addTorrent` or :func:`aria2.addMetalink` will not be
saved by :option:`--save-session` option. Default: ``false`` saved by :option:`--save-session` option. Default: ``false``
.. option:: --rpc-secure[=true|false] .. option:: --rpc-secure [true|false]
RPC transport will be encrypted by SSL/TLS. The RPC clients must RPC transport will be encrypted by SSL/TLS. The RPC clients must
use https scheme to access the server. For WebSocket client, use wss use https scheme to access the server. For WebSocket client, use wss
@ -1051,20 +1051,20 @@ Opções específicas de RPC
Opções Avançadas Opções Avançadas
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. option:: --allow-overwrite[=true|false] .. option:: --allow-overwrite [true|false]
Reiniciar o download desde o início se o correspondente arquivo de controle Reiniciar o download desde o início se o correspondente arquivo de controle
não existir. Ver também a opção :option:`--auto-file-renaming`. não existir. Ver também a opção :option:`--auto-file-renaming`.
Padrão: ``false`` Padrão: ``false``
.. option:: --allow-piece-length-change[=true|false] .. option:: --allow-piece-length-change [true|false]
Se ``false`` é informado, aria2 interrompe o download quando o tamanho de um Se ``false`` é informado, aria2 interrompe o download quando o tamanho de um
pedaço for diferente do especificado no arquivo controle. Se ``true`` pedaço for diferente do especificado no arquivo controle. Se ``true``
é informado, o download prossegue mas o progresso será perdido. é informado, o download prossegue mas o progresso será perdido.
Padrão: ``false`` Padrão: ``false``
.. option:: --always-resume[=true|false] .. option:: --always-resume [true|false]
Sempre continuar. Se If ``true`` é informado, aria2 sempre tentará Sempre continuar. Se If ``true`` é informado, aria2 sempre tentará
retomar o download do ponto interrompido e se não for possivel o download retomar o download do ponto interrompido e se não for possivel o download
@ -1075,7 +1075,7 @@ Opções Avançadas
do início. Ver opção :option:`--max-resume-failure-tries` do início. Ver opção :option:`--max-resume-failure-tries`
Padrão: ``true`` Padrão: ``true``
.. option:: --async-dns[=true|false] .. option:: --async-dns [true|false]
Habilita DNS assíncrono. Habilita DNS assíncrono.
Padrão: ``true`` Padrão: ``true``
@ -1091,7 +1091,7 @@ Opções Avançadas
quando o sistema não possui ``/etc/resolv.conf`` e o usuário não tem quando o sistema não possui ``/etc/resolv.conf`` e o usuário não tem
permissão para criá-lo. permissão para criá-lo.
.. option:: --auto-file-renaming[=true|false] .. option:: --auto-file-renaming [true|false]
Renomear o arquivo se o mesmo já existir. Renomear o arquivo se o mesmo já existir.
Essa opção só funciona em download HTTP, HTTPS e FTP. Essa opção só funciona em download HTTP, HTTPS e FTP.
@ -1106,7 +1106,7 @@ Opções Avançadas
do valor. As possibilidades vão desde ``0`` até ``600``. do valor. As possibilidades vão desde ``0`` até ``600``.
Padrão: ``60`` Padrão: ``60``
.. option:: --conditional-get[=true|false] .. option:: --conditional-get [true|false]
Download file only when the local file is older than remote Download file only when the local file is older than remote
file. This function only works with HTTP, HTTPS, downloads only. It does file. This function only works with HTTP, HTTPS, downloads only. It does
@ -1129,13 +1129,13 @@ Opções Avançadas
Set log level to output to console. LEVEL is either ``debug``, Set log level to output to console. LEVEL is either ``debug``,
``info``, ``notice``, ``warn`` or ``error``. Default: ``notice`` ``info``, ``notice``, ``warn`` or ``error``. Default: ``notice``
.. option:: -D, --daemon[=true|false] .. option:: -D, --daemon [true|false]
Run as daemon. The current working directory will be changed to ``/`` Run as daemon. The current working directory will be changed to ``/``
and standard input, standard output and standard error will be and standard input, standard output and standard error will be
redirected to ``/dev/null``. Padrão: ``false`` redirected to ``/dev/null``. Padrão: ``false``
.. option:: --deferred-input[=true|false] .. option:: --deferred-input [true|false]
If ``true`` is given, aria2 does not read all URIs and options from file If ``true`` is given, aria2 does not read all URIs and options from file
specified by :option:`--input-file <-i>` option at startup, specified by :option:`--input-file <-i>` option at startup,
@ -1145,7 +1145,7 @@ Opções Avançadas
and options at startup. and options at startup.
Padrão: ``false`` Padrão: ``false``
.. option:: --disable-ipv6[=true|false] .. option:: --disable-ipv6 [true|false]
Disable IPv6. This is useful if you have to use broken DNS and want Disable IPv6. This is useful if you have to use broken DNS and want
to avoid terribly slow AAAA record lookup. Padrão: ``false`` to avoid terribly slow AAAA record lookup. Padrão: ``false``
@ -1173,13 +1173,13 @@ Opções Avançadas
printed for each requested file in each row. printed for each requested file in each row.
Padrão: ``default`` Padrão: ``default``
.. option:: --enable-async-dns6[=true|false] .. option:: --enable-async-dns6 [true|false]
Enable IPv6 name resolution in asynchronous DNS resolver. This Enable IPv6 name resolution in asynchronous DNS resolver. This
option will be ignored when :option:`--async-dns=false. <--async-dns>` option will be ignored when :option:`--async-dns=false. <--async-dns>`
Padrão: ``false`` Padrão: ``false``
.. option:: --enable-mmap[=true|false] .. option:: --enable-mmap [true|false]
Map files into memory. This option may not work if the file space Map files into memory. This option may not work if the file space
is not pre-allocated. See :option:`--file-allocation`. is not pre-allocated. See :option:`--file-allocation`.
@ -1217,7 +1217,7 @@ Opções Avançadas
Possible Values: ``none``, ``prealloc``, ``trunc``, ``falloc`` Possible Values: ``none``, ``prealloc``, ``trunc``, ``falloc``
Padrão: ``prealloc`` Padrão: ``prealloc``
.. option:: --force-save[=true|false] .. option:: --force-save [true|false]
Save download with :option:`--save-session <--save-session>` option Save download with :option:`--save-session <--save-session>` option
even if the download is completed or removed. This may be useful to even if the download is completed or removed. This may be useful to
@ -1235,14 +1235,14 @@ Opções Avançadas
:option:`--save-session <--save-session>` option. If this option is :option:`--save-session <--save-session>` option. If this option is
not used, new GID is generated by aria2. not used, new GID is generated by aria2.
.. option:: --hash-check-only[=true|false] .. option:: --hash-check-only [true|false]
If ``true`` is given, after hash check using If ``true`` is given, after hash check using
:option:`--check-integrity <-V>` option, :option:`--check-integrity <-V>` option,
abort download whether or not download is complete. abort download whether or not download is complete.
Padrão: ``false`` Padrão: ``false``
.. option:: --human-readable[=true|false] .. option:: --human-readable [true|false]
Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi) Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi)
in the console readout. Padrão: ``true`` in the console readout. Padrão: ``true``
@ -1345,7 +1345,7 @@ Opções Avançadas
To enable HTTP pipelining use To enable HTTP pipelining use
:option:`--enable-http-pipelining`. :option:`--enable-http-pipelining`.
.. option:: --show-console-readout[=true|false] .. option:: --show-console-readout [true|false]
Show console readout. Padrão: ``true`` Show console readout. Padrão: ``true``
@ -1360,7 +1360,7 @@ Opções Avançadas
In multi file torrent downloads, the files adjacent forward to the specified files In multi file torrent downloads, the files adjacent forward to the specified files
are also allocated if they share the same piece. are also allocated if they share the same piece.
.. option:: -Z, --force-sequential[=true|false] .. option:: -Z, --force-sequential [true|false]
Fetch URIs in the command-line sequentially and download each URI in a Fetch URIs in the command-line sequentially and download each URI in a
separate session, like the usual command-line download utilities. separate session, like the usual command-line download utilities.
@ -1380,7 +1380,7 @@ Opções Avançadas
limit the overall download speed, use :option:`--max-overall-download-limit` limit the overall download speed, use :option:`--max-overall-download-limit`
option. Padrão: ``0`` option. Padrão: ``0``
.. option:: --no-conf[=true|false] .. option:: --no-conf [true|false]
Disable loading aria2.conf file. Disable loading aria2.conf file.
@ -1390,7 +1390,7 @@ Opções Avançadas
You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K). You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
Padrão: ``5M`` Padrão: ``5M``
.. option:: -P, --parameterized-uri[=true|false] .. option:: -P, --parameterized-uri [true|false]
Enable parameterized URI support. Enable parameterized URI support.
You can specify set of parts: ``http://{sv1,sv2,sv3}/foo.iso``. You can specify set of parts: ``http://{sv1,sv2,sv3}/foo.iso``.
@ -1401,19 +1401,19 @@ Opções Avançadas
-Z option is required. -Z option is required.
Padrão: ``false`` Padrão: ``false``
.. option:: -q, --quiet[=true|false] .. option:: -q, --quiet [true|false]
Make aria2 quiet (no console output). Make aria2 quiet (no console output).
Padrão: ``false`` Padrão: ``false``
.. option:: --realtime-chunk-checksum[=true|false] .. option:: --realtime-chunk-checksum [true|false]
Validate chunk of data by calculating checksum while downloading a file if Validate chunk of data by calculating checksum while downloading a file if
chunk checksums are provided. chunk checksums are provided.
Padrão: ``true`` Padrão: ``true``
.. option:: --remove-control-file[=true|false] .. option:: --remove-control-file [true|false]
Remove control file before download. Using with Remove control file before download. Using with
:option:`--allow-overwrite=true, <--allow-overwrite>` download always starts from :option:`--allow-overwrite=true, <--allow-overwrite>` download always starts from
@ -1452,7 +1452,7 @@ Opções Avançadas
Este recurso evita que um processo gere subprocessos que ficam no Este recurso evita que um processo gere subprocessos que ficam no
limbo. limbo.
.. option:: --truncate-console-readout[=true|false] .. option:: --truncate-console-readout [true|false]
Truncar a linha da console para ajustar-se a uma linha. Truncar a linha da console para ajustar-se a uma linha.
Padrão: ``true`` Padrão: ``true``

View File

@ -128,7 +128,7 @@ html_short_title = u'Aria2 @PACKAGE_VERSION@ Manual em Português'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
html_use_smartypants = False #html_use_smartypants = False
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} #html_sidebars = {}

View File

@ -79,7 +79,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
количество соединений, используя :option:`--split <-s>` количество соединений, используя :option:`--split <-s>`
и/или :option:`--min-split-size <-k>`. и/или :option:`--min-split-size <-k>`.
.. option:: -V, --check-integrity[=true|false] .. option:: -V, --check-integrity [true|false]
Проверить целостность файла путем подтверждения хэшей блоков или хэша Проверить целостность файла путем подтверждения хэшей блоков или хэша
полного файла. Этот параметр влияет лишь на BitTorrent, Metalink полного файла. Этот параметр влияет лишь на BitTorrent, Metalink
@ -92,7 +92,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
использоваться только хэши блоков. использоваться только хэши блоков.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: -c, --continue[=true|false] .. option:: -c, --continue [true|false]
Продолжить загрузку частично загруженного файла. Продолжить загрузку частично загруженного файла.
Используйте этот параметр, чтобы возобновить загрузку, Используйте этот параметр, чтобы возобновить загрузку,
@ -171,7 +171,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
используется параметр :option:`--timeout <-t>`. используется параметр :option:`--timeout <-t>`.
По умолчанию: ``60`` По умолчанию: ``60``
.. option:: --dry-run[=true|false] .. option:: --dry-run [true|false]
Если задано ``true``, aria2 только проверяет, является ли удаленный Если задано ``true``, aria2 только проверяет, является ли удаленный
файл доступным и не загружает данные. Этот параметр влияет на файл доступным и не загружает данные. Этот параметр влияет на
@ -236,7 +236,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Права доступа к файлу .netrc должны быть равны 600. Иначе, файл Права доступа к файлу .netrc должны быть равны 600. Иначе, файл
будет проигнорирован. будет проигнорирован.
.. option:: -n, --no-netrc[=true|false] .. option:: -n, --no-netrc [true|false]
Отключить поддержку netrc. Поддержка netrc по умолчанию Отключить поддержку netrc. Поддержка netrc по умолчанию
включена. включена.
@ -287,13 +287,13 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
не обращая внимания на этот параметр. не обращая внимания на этот параметр.
По умолчанию: ``get`` По умолчанию: ``get``
.. option:: -R, --remote-time[=true|false] .. option:: -R, --remote-time [true|false]
Извлекать временную метку файла с удаленного HTTP/FTP-сервера и, Извлекать временную метку файла с удаленного HTTP/FTP-сервера и,
если это доступно, применить ее к локальному файлу. если это доступно, применить ее к локальному файлу.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --reuse-uri[=true|false] .. option:: --reuse-uri [true|false]
Повторно использовать уже использованные URI, если Повторно использовать уже использованные URI, если
не осталось неиспользованных URI. не осталось неиспользованных URI.
@ -442,13 +442,13 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Альтернативные PKCS12-файлы также поддерживаются. PEM-файлы, однако, Альтернативные PKCS12-файлы также поддерживаются. PEM-файлы, однако,
не поддерживаются. не поддерживаются.
.. option:: --check-certificate[=true|false] .. option:: --check-certificate [true|false]
Проверять каждый из используемых сертификатов, которые Проверять каждый из используемых сертификатов, которые
указаны в параметре :option:`--ca-certificate`. указаны в параметре :option:`--ca-certificate`.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --http-accept-gzip[=true|false] .. option:: --http-accept-gzip [true|false]
Посылать ``Accept: deflate, gzip`` в запросе-заголовке и добавлять в ответ, Посылать ``Accept: deflate, gzip`` в запросе-заголовке и добавлять в ответ,
если удаленный сервер ответит ``Content-Encoding: gzip`` или если удаленный сервер ответит ``Content-Encoding: gzip`` или
@ -461,7 +461,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
по себе сжаты (gzipped). aria2 добавляет их, так или иначе, из-за заголовка по себе сжаты (gzipped). aria2 добавляет их, так или иначе, из-за заголовка
ответа. ответа.
.. option:: --http-auth-challenge[=true|false] .. option:: --http-auth-challenge [true|false]
Отправлять заголовок HTTP-авторизации только тогда, когда он запрошен Отправлять заголовок HTTP-авторизации только тогда, когда он запрошен
с сервера. Если задано ``false``, тогда заголовок авторизации всегда с сервера. Если задано ``false``, тогда заголовок авторизации всегда
@ -470,7 +470,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
отправляется на сервер, независимо от этого параметра. отправляется на сервер, независимо от этого параметра.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --http-no-cache[=true|false] .. option:: --http-no-cache [true|false]
Отправлять заголовок ``Cache-Control: no-cache`` и ``Pragma: no-cache``, Отправлять заголовок ``Cache-Control: no-cache`` и ``Pragma: no-cache``,
чтобы избежать кэширования содержимого. Если задано ``false``, то эти чтобы избежать кэширования содержимого. Если задано ``false``, то эти
@ -532,12 +532,12 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Это может быть полезно при использовании вместе с параметром Это может быть полезно при использовании вместе с параметром
:option:`--parameterized-uri <-P>`. :option:`--parameterized-uri <-P>`.
.. option:: --enable-http-keep-alive[=true|false] .. option:: --enable-http-keep-alive [true|false]
Включить HTTP/1.1 постоянное соединение. Включить HTTP/1.1 постоянное соединение.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --enable-http-pipelining[=true|false] .. option:: --enable-http-pipelining [true|false]
Включить конвейерную обработку HTTP/1.1. Включить конвейерную обработку HTTP/1.1.
По умолчанию: ``false`` По умолчанию: ``false``
@ -573,7 +573,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
сохранится, и значение ее окончания будет трактоваться как 0. сохранится, и значение ее окончания будет трактоваться как 0.
Возможные значения: ``/путь/к/файлу`` Возможные значения: ``/путь/к/файлу``
.. option:: --use-head[=true|false] .. option:: --use-head [true|false]
Использовать метод HEAD для первого запроса к HTTP серверу. Использовать метод HEAD для первого запроса к HTTP серверу.
По умолчанию: ``false`` По умолчанию: ``false``
@ -600,7 +600,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Если нет, используется пароль, указанный в этом параметре. Если нет, используется пароль, указанный в этом параметре.
По умолчанию: ``ARIA2USER@`` По умолчанию: ``ARIA2USER@``
.. option:: -p, --ftp-pasv[=true|false] .. option:: -p, --ftp-pasv [true|false]
Использовать пассивный режим FTP. Если задано ``false``, Использовать пассивный режим FTP. Если задано ``false``,
то будет использован активный режим. то будет использован активный режим.
@ -635,7 +635,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Этот параметр игнорируется для SFTP-передачи. Этот параметр игнорируется для SFTP-передачи.
.. option:: --ftp-reuse-connection[=true|false] .. option:: --ftp-reuse-connection [true|false]
Повторно использовать FTP соединение. Повторно использовать FTP соединение.
По умолчанию: ``true`` По умолчанию: ``true``
@ -669,7 +669,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
данных может включать несколько файлов или часть файла, и aria2 запишет блок данных может включать несколько файлов или часть файла, и aria2 запишет блок
данных соответствующего файла. данных соответствующего файла.
.. option:: -S, --show-files[=true|false] .. option:: -S, --show-files [true|false]
Вывести список файлов из ".torrent", ".meta4" или ".metalink" и Вывести список файлов из ".torrent", ".meta4" или ".metalink" и
завершить работу. Для файла .torrent будет выведена более детальная завершить работу. Для файла .torrent будет выведена более детальная
@ -678,7 +678,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Специфические параметры BitTorrent Специфические параметры BitTorrent
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. option:: --bt-detach-seed-only[=true|false] .. option:: --bt-detach-seed-only [true|false]
Исключить только раздачи при подсчёте одновременных активных загрузок Исключить только раздачи при подсчёте одновременных активных загрузок
(смотрите параметр :option:`-j`). Это значит, что если задано ``-j3`` (смотрите параметр :option:`-j`). Это значит, что если задано ``-j3``
@ -688,7 +688,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
загрузка стартует. Но знайте, что в RPC-методе сидирующий элемент всё загрузка стартует. Но знайте, что в RPC-методе сидирующий элемент всё
ещё признаётся как активная загрузка. По умолчанию: ``false`` ещё признаётся как активная загрузка. По умолчанию: ``false``
.. option:: --bt-enable-hook-after-hash-check[=true|false] .. option:: --bt-enable-hook-after-hash-check [true|false]
Позволяет перехватить команду вызова (управление) после проверки хэша Позволяет перехватить команду вызова (управление) после проверки хэша
(см. параметр :option:`-V`) в BitTorrent-загрузке. По умолчанию, когда (см. параметр :option:`-V`) в BitTorrent-загрузке. По умолчанию, когда
@ -697,7 +697,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Укажите для этого параметра ``false``, чтобы отключить это действие. Укажите для этого параметра ``false``, чтобы отключить это действие.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --bt-enable-lpd[=true|false] .. option:: --bt-enable-lpd [true|false]
Включить поиск локальных пиров. Если в torrent-файле установлен Включить поиск локальных пиров. Если в torrent-файле установлен
приватный признак, то aria2 не будет использовать эту возможность, приватный признак, то aria2 не будет использовать эту возможность,
@ -722,7 +722,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Несмотря на то, что эта функция названа ``external`` (``внешний``), Несмотря на то, что эта функция названа ``external`` (``внешний``),
она может принимать любой IP-адрес. она может принимать любой IP-адрес.
.. option:: --bt-force-encryption[=true|false] .. option:: --bt-force-encryption [true|false]
Требовать шифрование при помощи arc4 полезной нагрузки Требовать шифрование при помощи arc4 полезной нагрузки
BitTorrent-сообщения. Это сокращение :option:`--bt-require-crypto` BitTorrent-сообщения. Это сокращение :option:`--bt-require-crypto`
@ -733,7 +733,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
полезная нагрузка. полезная нагрузка.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --bt-hash-check-seed[=true|false] .. option:: --bt-hash-check-seed [true|false]
Если задано ``true``, то после проверки хэша с использованием параметра Если задано ``true``, то после проверки хэша с использованием параметра
:option:`--check-integrity <-V>`, и когда файл :option:`--check-integrity <-V>`, и когда файл
@ -743,7 +743,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
лишь на BitTorrent-загрузки. лишь на BitTorrent-загрузки.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --bt-load-saved-metadata[=true|false] .. option:: --bt-load-saved-metadata [true|false]
Прежде, чем получить метаданные торрента из DHT при загрузке Прежде, чем получить метаданные торрента из DHT при загрузке
magnet-ссылки, сначала попытаться считать файл, сохранённый параметром magnet-ссылки, сначала попытаться считать файл, сохранённый параметром
@ -770,7 +770,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--bt-request-peer-speed-limit`. :option:`--bt-request-peer-speed-limit`.
По умолчанию: ``55`` По умолчанию: ``55``
.. option:: --bt-metadata-only[=true|false] .. option:: --bt-metadata-only [true|false]
Загрузить только метаданные. Файл(ы), описывающий метаданные не Загрузить только метаданные. Файл(ы), описывающий метаданные не
должен быть загружен. Этот параметр эффективен, только если должен быть загружен. Этот параметр эффективен, только если
@ -799,7 +799,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
(1K = 1024, 1M = 1024K). Если SIZE пропущено, то будет использовано (1K = 1024, 1M = 1024K). Если SIZE пропущено, то будет использовано
по умолчанию значение: SIZE=1M. по умолчанию значение: SIZE=1M.
.. option:: --bt-remove-unselected-file[=true|false] .. option:: --bt-remove-unselected-file [true|false]
Удалить невыбранные файлы, когда завершена загрузка в Удалить невыбранные файлы, когда завершена загрузка в
BitTorrent. Чтобы выбрать файлы, используйте параметр BitTorrent. Чтобы выбрать файлы, используйте параметр
@ -809,7 +809,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
так как это фактически удалит файлы с вашего диска. так как это фактически удалит файлы с вашего диска.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --bt-require-crypto[=true|false] .. option:: --bt-require-crypto [true|false]
Если задано ``true``, aria2 не принимает и не устанавливает соединение с Если задано ``true``, aria2 не принимает и не устанавливает соединение с
традиционным BitTorrent-рукопожатием (handshake) (\\19BitTorrent протокол). традиционным BitTorrent-рукопожатием (handshake) (\\19BitTorrent протокол).
@ -825,7 +825,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
скорость загрузки. Вы можете добавить ``K`` или ``M`` (1K = 1024, 1M = 1024K). скорость загрузки. Вы можете добавить ``K`` или ``M`` (1K = 1024, 1M = 1024K).
По умолчанию: ``50K`` По умолчанию: ``50K``
.. option:: --bt-save-metadata[=true|false] .. option:: --bt-save-metadata [true|false]
Сохранить метаданные как файл ".torrent". Этот параметр Сохранить метаданные как файл ".torrent". Этот параметр
эффективен только если используется BitTorrent Magnet-ссылка. эффективен только если используется BitTorrent Magnet-ссылка.
@ -836,7 +836,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--bt-metadata-only`. :option:`--bt-metadata-only`.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --bt-seed-unverified[=true|false] .. option:: --bt-seed-unverified [true|false]
Раздавать первоначально загруженные файлы без проверки хэшей блоков. Раздавать первоначально загруженные файлы без проверки хэшей блоков.
По умолчанию: ``false`` По умолчанию: ``false``
@ -922,7 +922,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Задать время ожидания в секундах. Задать время ожидания в секундах.
По умолчанию: ``10`` По умолчанию: ``10``
.. option:: --enable-dht[=true|false] .. option:: --enable-dht [true|false]
Включить функцию IPv4 DHT. Это также включает поддержку Включить функцию IPv4 DHT. Это также включает поддержку
UDP-трекера. Если в torrent-файле задан приватный признак, UDP-трекера. Если в torrent-файле задан приватный признак,
@ -930,7 +930,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
установлен ``true``. установлен ``true``.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --enable-dht6[=true|false] .. option:: --enable-dht6 [true|false]
Включить IPv6 DHT функциональность. Если в torrent-файле задан Включить IPv6 DHT функциональность. Если в torrent-файле задан
приватный признак, aria2 не будет использовать DHT для загрузки, приватный признак, aria2 не будет использовать DHT для загрузки,
@ -939,7 +939,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
прослушиваемого порта. Смотрите также параметр прослушиваемого порта. Смотрите также параметр
:option:`--dht-listen-addr6`. :option:`--dht-listen-addr6`.
.. option:: --enable-peer-exchange[=true|false] .. option:: --enable-peer-exchange [true|false]
Включить расширение BitTorrent-протокола для обмена списками участников. Включить расширение BitTorrent-протокола для обмена списками участников.
Если в torrent-файле задан приватный признак, то эта возможность будет Если в torrent-файле задан приватный признак, то эта возможность будет
@ -1094,7 +1094,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
и ``none``. Указать ``none`` для отключения этой возможности. и ``none``. Указать ``none`` для отключения этой возможности.
По умолчанию: ``none`` По умолчанию: ``none``
.. option:: --metalink-enable-unique-protocol[=true|false] .. option:: --metalink-enable-unique-protocol [true|false]
Если задано ``true``, а в metalink-файле доступно несколько Если задано ``true``, а в metalink-файле доступно несколько
протоколов, то aria2 использует один из них. Используйте параметр протоколов, то aria2 использует один из них. Используйте параметр
@ -1105,19 +1105,19 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Параметры RPC Параметры RPC
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. option:: --enable-rpc[=true|false] .. option:: --enable-rpc [true|false]
Включить JSON-RPC/XML-RPC-сервер. Настоятельно рекомендуется указать Включить JSON-RPC/XML-RPC-сервер. Настоятельно рекомендуется указать
секретный маркер авторизации, используя параметр :option:`--rpc-secret`. секретный маркер авторизации, используя параметр :option:`--rpc-secret`.
Смотрите также параметр :option:`--rpc-listen-port`. По умолчанию: ``false`` Смотрите также параметр :option:`--rpc-listen-port`. По умолчанию: ``false``
.. option:: --pause[=true|false] .. option:: --pause [true|false]
Приостановка загрузки после добавления. Этот параметр действенен Приостановка загрузки после добавления. Этот параметр действенен
только, когда задан :option:`--enable-rpc=true. <--enable-rpc>` только, когда задан :option:`--enable-rpc=true. <--enable-rpc>`
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --pause-metadata[=true|false] .. option:: --pause-metadata [true|false]
Приостановить загрузки, созданные в результате загрузки метаданных. Приостановить загрузки, созданные в результате загрузки метаданных.
Есть 3 типа метаданных загрузок в aria2: (1) загрузка .torrent-файла. Есть 3 типа метаданных загрузок в aria2: (1) загрузка .torrent-файла.
@ -1128,7 +1128,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--enable-rpc=true <--enable-rpc>`. :option:`--enable-rpc=true <--enable-rpc>`.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --rpc-allow-origin-all[=true|false] .. option:: --rpc-allow-origin-all [true|false]
Добавить заголовок Access-Control-Allow-Origin со значением ``*`` в RPC-ответе. Добавить заголовок Access-Control-Allow-Origin со значением ``*`` в RPC-ответе.
По умолчанию: ``false`` По умолчанию: ``false``
@ -1159,7 +1159,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Альтернативные PKCS12-файлы также поддерживаются. PEM-файлы, однако, Альтернативные PKCS12-файлы также поддерживаются. PEM-файлы, однако,
не поддерживаются. не поддерживаются.
.. option:: --rpc-listen-all[=true|false] .. option:: --rpc-listen-all [true|false]
Слушать входящие JSON-RPC/XML-RPC-запросы на всех сетевых интерфейсах. Слушать входящие JSON-RPC/XML-RPC-запросы на всех сетевых интерфейсах.
Если указано ``false``, слушать только на локальном петлевом Если указано ``false``, слушать только на локальном петлевом
@ -1196,7 +1196,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--rpc-secure` для включения шифрования. :option:`--rpc-secure` для включения шифрования.
Смотрите также параметр :option:`--rpc-certificate`. Смотрите также параметр :option:`--rpc-certificate`.
.. option:: --rpc-save-upload-metadata[=true|false] .. option:: --rpc-save-upload-metadata [true|false]
Сохранить загруженные метаданные torrent или metalink в каталоге, Сохранить загруженные метаданные torrent или metalink в каталоге,
заданном параметром :option:`--dir`. Имя файла содержит заданном параметром :option:`--dir`. Имя файла содержит
@ -1212,7 +1212,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Задать секретный маркер RPC-авторизации. Читайте :ref:`rpc_auth`, Задать секретный маркер RPC-авторизации. Читайте :ref:`rpc_auth`,
чтобы узнать, как использовать значение этого параметра. чтобы узнать, как использовать значение этого параметра.
.. option:: --rpc-secure[=true|false] .. option:: --rpc-secure [true|false]
RPC-транспорт будет зашифрован с использованием SSL/TLS. RPC-клиенты должны RPC-транспорт будет зашифрован с использованием SSL/TLS. RPC-клиенты должны
использовать https-схему для доступа к серверу. Для WebSocket-клиента, использовать https-схему для доступа к серверу. Для WebSocket-клиента,
@ -1232,14 +1232,14 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Дополнительные параметры Дополнительные параметры
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
.. option:: --allow-overwrite[=true|false] .. option:: --allow-overwrite [true|false]
Повторно запустить загрузку с нуля, если соответствующий контрольный Повторно запустить загрузку с нуля, если соответствующий контрольный
файл отсутствует. Смотрите также параметр файл отсутствует. Смотрите также параметр
:option:`--auto-file-renaming`. :option:`--auto-file-renaming`.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --allow-piece-length-change[=true|false] .. option:: --allow-piece-length-change [true|false]
Если задано ``false``, aria2 прерывает загрузку, когда длина блока Если задано ``false``, aria2 прерывает загрузку, когда длина блока
отлична от той, которая находится в контрольном файле. Если задано отлична от той, которая находится в контрольном файле. Если задано
@ -1247,7 +1247,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
будет потерян. будет потерян.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --always-resume[=true|false] .. option:: --always-resume [true|false]
Всегда возобновлять загрузку. Если задано ``true``, aria2 всегда пытается Всегда возобновлять загрузку. Если задано ``true``, aria2 всегда пытается
возобновить загрузку и если это не возможно, прерывает ее. возобновить загрузку и если это не возможно, прерывает ее.
@ -1259,7 +1259,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--max-resume-failure-tries`. :option:`--max-resume-failure-tries`.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --async-dns[=true|false] .. option:: --async-dns [true|false]
Включить асинхронный DNS. Включить асинхронный DNS.
По умолчанию: ``true`` По умолчанию: ``true``
@ -1274,7 +1274,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Этот параметр полезен, когда в системе нет ``/etc/resolv.conf`` и у Этот параметр полезен, когда в системе нет ``/etc/resolv.conf`` и у
пользователя нет прав на его создание. пользователя нет прав на его создание.
.. option:: --auto-file-renaming[=true|false] .. option:: --auto-file-renaming [true|false]
Переименовать файл, если такой уже существует. Переименовать файл, если такой уже существует.
Этот параметр работает только для HTTP(S)/FTP-загрузок. Этот параметр работает только для HTTP(S)/FTP-загрузок.
@ -1291,7 +1291,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Возможные значения: от ``0`` до ``600``. Возможные значения: от ``0`` до ``600``.
По умолчанию: ``60`` По умолчанию: ``60``
.. option:: --conditional-get[=true|false] .. option:: --conditional-get [true|false]
Загружать файл только когда локальный файл старше, чем удаленный. Загружать файл только когда локальный файл старше, чем удаленный.
Эта функция работает только для HTTP(S)-загрузок. Это не работает, Эта функция работает только для HTTP(S)-загрузок. Это не работает,
@ -1319,20 +1319,20 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
быть: ``debug``, ``info``, ``notice``, ``warn`` или ``error``. быть: ``debug``, ``info``, ``notice``, ``warn`` или ``error``.
По умолчанию: ``notice`` По умолчанию: ``notice``
.. option:: --content-disposition-default-utf8[=true|false] .. option:: --content-disposition-default-utf8 [true|false]
Обрабатывать строку в кавычках в заголовке Content-Disposition как Обрабатывать строку в кавычках в заголовке Content-Disposition как
UTF-8 вместо ISO-8859-1, например, параметр filename, UTF-8 вместо ISO-8859-1, например, параметр filename,
но не расширенную версию filename*. По умолчанию: ``false`` но не расширенную версию filename*. По умолчанию: ``false``
.. option:: -D, --daemon[=true|false] .. option:: -D, --daemon [true|false]
Запустить как демон (фоновый процесс). Текущий рабочий каталог Запустить как демон (фоновый процесс). Текущий рабочий каталог
будет заменен на ``/``, а стандартный ввод, стандартный вывод, будет заменен на ``/``, а стандартный ввод, стандартный вывод,
стандартный вывод ошибок будут перенаправлены на ``/dev/null``. стандартный вывод ошибок будут перенаправлены на ``/dev/null``.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --deferred-input[=true|false] .. option:: --deferred-input [true|false]
Если задано ``true``, aria2 при запуске не считывает все URI и параметры Если задано ``true``, aria2 при запуске не считывает все URI и параметры
из файла, указанного в параметре :option:`--input-file <-i>`, а из файла, указанного в параметре :option:`--input-file <-i>`, а
@ -1347,7 +1347,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
параметр :option:`--deferred-input` будет заблокирован, если параметр :option:`--deferred-input` будет заблокирован, если
используется вместе с :option:`--save-session`. используется вместе с :option:`--save-session`.
.. option:: --disable-ipv6[=true|false] .. option:: --disable-ipv6 [true|false]
Отключить IPv6. Это полезно, если вы используете поврежденный DNS Отключить IPv6. Это полезно, если вы используете поврежденный DNS
и хотите избежать ужасно медленного поиска AAAA-записи. и хотите избежать ужасно медленного поиска AAAA-записи.
@ -1403,12 +1403,12 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Этот параметр доступен только в системах, поддерживающих API rlimit. Этот параметр доступен только в системах, поддерживающих API rlimit.
.. option:: --enable-color[=true|false] .. option:: --enable-color [true|false]
Включить цветной вывод для терминала. Включить цветной вывод для терминала.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --enable-mmap[=true|false] .. option:: --enable-mmap [true|false]
Отображение файлов в память. Этот параметр может не работать, Отображение файлов в память. Этот параметр может не работать,
если место под файл предварительно не выделено. если место под файл предварительно не выделено.
@ -1460,7 +1460,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
В загрузках многофайлового торрента, по определенным смежным файлам также, В загрузках многофайлового торрента, по определенным смежным файлам также,
которые размещены в части одного блока. которые размещены в части одного блока.
.. option:: --force-save[=true|false] .. option:: --force-save [true|false]
Сохранить загрузку с параметром :option:`--save-session <--save-session>`, Сохранить загрузку с параметром :option:`--save-session <--save-session>`,
даже если загрузка будет завершена или удалена. В этих ситуациях параметр даже если загрузка будет завершена или удалена. В этих ситуациях параметр
@ -1469,7 +1469,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
состояние как завершенное. состояние как завершенное.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --save-not-found[=true|false] .. option:: --save-not-found [true|false]
Сохранить загрузку с параметром :option:`--save-session <--save-session>`, Сохранить загрузку с параметром :option:`--save-session <--save-session>`,
даже если файл не был найден на сервере. В этой ситуации параметр даже если файл не был найден на сервере. В этой ситуации параметр
@ -1488,14 +1488,14 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--save-session <--save-session>`. Если этот параметр не :option:`--save-session <--save-session>`. Если этот параметр не
использован, то новый GID будет сгенерирован aria2. использован, то новый GID будет сгенерирован aria2.
.. option:: --hash-check-only[=true|false] .. option:: --hash-check-only [true|false]
Если задано ``true``, то после проверки хэша, используя параметр Если задано ``true``, то после проверки хэша, используя параметр
:option:`--check-integrity <-V>`, загрузка прервётся, в любом :option:`--check-integrity <-V>`, загрузка прервётся, в любом
случае загрузка завершится. случае загрузка завершится.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --human-readable[=true|false] .. option:: --human-readable [true|false]
Выводить размеры и скорость в удобочитаемом формате Выводить размеры и скорость в удобочитаемом формате
(например, 1.2Ки, 3.4Ми) на консольный индикатор. (например, 1.2Ки, 3.4Ми) на консольный индикатор.
@ -1515,7 +1515,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--disable-ipv6`. Если ваша система не имеет :manpage:`getifaddrs(3)`, это :option:`--disable-ipv6`. Если ваша система не имеет :manpage:`getifaddrs(3)`, это
параметр не принимает имя интерфейса. параметр не принимает имя интерфейса.
.. option:: --keep-unfinished-download-result[=true|false] .. option:: --keep-unfinished-download-result [true|false]
Сохранять результаты незавершённых загрузок, даже если превышено значение Сохранять результаты незавершённых загрузок, даже если превышено значение
:option:`--max-download-result`. Это полезно, если незавершённые загрузки :option:`--max-download-result`. Это полезно, если незавершённые загрузки
@ -1630,7 +1630,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
значения: ``/путь/к/команде`` значения: ``/путь/к/команде``
.. option:: --optimize-concurrent-downloads[=true|false|<A>:<B>] .. option:: --optimize-concurrent-downloads [true|false|<A>:<B>]
Оптимизирует количество одновременных загрузок в соответствии с Оптимизирует количество одновременных загрузок в соответствии с
доступной полосой пропускания. aria2 использует скорость загрузки, доступной полосой пропускания. aria2 использует скорость загрузки,
@ -1659,13 +1659,13 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
HTTP-запросе. Для включения конвейерной обработки HTTP используйте HTTP-запросе. Для включения конвейерной обработки HTTP используйте
:option:`--enable-http-pipelining`. :option:`--enable-http-pipelining`.
.. option:: --show-console-readout[=true|false] .. option:: --show-console-readout [true|false]
Показывать консольный индикатор. Показывать консольный индикатор.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --stderr[=true|false] .. option:: --stderr [true|false]
Перенаправить весь вывод консоли в stderr (стандартный поток ошибок), Перенаправить весь вывод консоли в stderr (стандартный поток ошибок),
иначе будет использован stdout (стандартный поток вывода). иначе будет использован stdout (стандартный поток вывода).
@ -1677,7 +1677,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
загрузки. Установка ``0`` запрещает вывод. загрузки. Установка ``0`` запрещает вывод.
По умолчанию: ``60`` По умолчанию: ``60``
.. option:: -Z, --force-sequential[=true|false] .. option:: -Z, --force-sequential [true|false]
Получить URI в последовательности командной строки и загрузить каждое Получить URI в последовательности командной строки и загрузить каждое
URI в отдельной сессии, как в обычных утилитах загрузки командной URI в отдельной сессии, как в обычных утилитах загрузки командной
@ -1700,7 +1700,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
:option:`--max-overall-download-limit`. :option:`--max-overall-download-limit`.
По умолчанию: ``0`` По умолчанию: ``0``
.. option:: --no-conf[=true|false] .. option:: --no-conf [true|false]
Отключить загрузку файла aria2.conf. Отключить загрузку файла aria2.conf.
@ -1710,7 +1710,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
Вы можете добавить ``K`` или ``M`` (1K = 1024, 1M = 1024K). Вы можете добавить ``K`` или ``M`` (1K = 1024, 1M = 1024K).
По умолчанию: ``5M`` По умолчанию: ``5M``
.. option:: -P, --parameterized-uri[=true|false] .. option:: -P, --parameterized-uri [true|false]
Включить поддержку параметризованных URI. Вы можете указать набор Включить поддержку параметризованных URI. Вы можете указать набор
частей: ``http://{sv1,sv2,sv3}/foo.iso``. Также вы можете указать частей: ``http://{sv1,sv2,sv3}/foo.iso``. Также вы можете указать
@ -1720,19 +1720,19 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
во втором приведенном выше примере, то необходим параметр -Z. во втором приведенном выше примере, то необходим параметр -Z.
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: -q, --quiet[=true|false] .. option:: -q, --quiet [true|false]
Сделать aria2 молчаливой (без консольного вывода). Сделать aria2 молчаливой (без консольного вывода).
По умолчанию: ``false`` По умолчанию: ``false``
.. option:: --realtime-chunk-checksum[=true|false] .. option:: --realtime-chunk-checksum [true|false]
Подтверждать правильность блока данных путем вычисления контрольной суммы Подтверждать правильность блока данных путем вычисления контрольной суммы
во время загрузки файла, если предусмотрена контрольная сумма блоков. во время загрузки файла, если предусмотрена контрольная сумма блоков.
По умолчанию: ``true`` По умолчанию: ``true``
.. option:: --remove-control-file[=true|false] .. option:: --remove-control-file [true|false]
Удалять контрольный файл перед загрузкой. При использовании с Удалять контрольный файл перед загрузкой. При использовании с
:option:`--allow-overwrite=true <--allow-overwrite>` файл :option:`--allow-overwrite=true <--allow-overwrite>` файл
@ -1798,7 +1798,7 @@ HTTP(S)/FTP, они тут же могут выгружаться в BitTorrent-
идентификационным номером и когда он (процесс) завершится по какой-то идентификационным номером и когда он (процесс) завершится по какой-то
причине, aria2 может обнаружить это и самостоятельно завершить работу. причине, aria2 может обнаружить это и самостоятельно завершить работу.
.. option:: --truncate-console-readout[=true|false] .. option:: --truncate-console-readout [true|false]
Укорачивать консольный индикатор, чтобы он поместился в Укорачивать консольный индикатор, чтобы он поместился в
одну строку. одну строку.

View File

@ -128,7 +128,7 @@ html_theme_path = ['@srcdir@/../../sphinx_themes']
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
html_use_smartypants = False #html_use_smartypants = False
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} #html_sidebars = {}