mirror of
https://github.com/aria2/aria2.git
synced 2024-11-24 02:23:38 +08:00
Document about restart when certain option is changed by RPC method
This commit is contained in:
parent
9d40c47799
commit
d658fdecc6
@ -3159,7 +3159,19 @@ For information on the *secret* parameter, see :ref:`rpc_auth`.
|
||||
|
||||
This method changes options of the download denoted by *gid* (string)
|
||||
dynamically. *options* is a struct.
|
||||
The following options are available for active downloads:
|
||||
The options listed in `Input File`_ subsection are available,
|
||||
**except** for following options:
|
||||
|
||||
* :option:`dry-run <--dry-run>`
|
||||
* :option:`metalink-base-uri <--metalink-base-uri>`
|
||||
* :option:`parameterized-uri <-P>`
|
||||
* :option:`pause <--pause>`
|
||||
* :option:`piece-length <--piece-length>`
|
||||
* :option:`rpc-save-upload-metadata <--rpc-save-upload-metadata>`
|
||||
|
||||
Except for the following options, changing the other options of
|
||||
active download makes it restart (restart itself is managed by
|
||||
aria2, and no user intervention is required):
|
||||
|
||||
* :option:`bt-max-peers <--bt-max-peers>`
|
||||
* :option:`bt-request-peer-speed-limit <--bt-request-peer-speed-limit>`
|
||||
@ -3168,15 +3180,6 @@ For information on the *secret* parameter, see :ref:`rpc_auth`.
|
||||
* :option:`max-download-limit <--max-download-limit>`
|
||||
* :option:`max-upload-limit <-u>`
|
||||
|
||||
For waiting or paused downloads, in addition to the above options,
|
||||
options listed in `Input File`_ subsection are available,
|
||||
**except** for following options:
|
||||
:option:`dry-run <--dry-run>`,
|
||||
:option:`metalink-base-uri <--metalink-base-uri>`,
|
||||
:option:`parameterized-uri <-P>`,
|
||||
:option:`pause <--pause>`,
|
||||
:option:`piece-length <--piece-length>` and
|
||||
:option:`rpc-save-upload-metadata <--rpc-save-upload-metadata>` option.
|
||||
This method returns ``OK`` for success.
|
||||
|
||||
The following examples set the :option:`max-download-limit
|
||||
|
Loading…
Reference in New Issue
Block a user