mirrors/aria2
1
0
Fork 0
mirror of https://github.com/aria2/aria2.git synced 2025-04-04 21:17:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

Document about restart when certain option is changed by RPC method

Browse source
This commit is contained in:
Tatsuhiro Tsujikawa 2016-05-22 21:07:00 +09:00
parent 9d40c47799
commit d658fdecc6
1 changed files with 13 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/manual-src/en/aria2c.rst
View file

@ -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) This method changes options of the download denoted by *gid* (string)
dynamically. *options* is a struct. 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-max-peers <--bt-max-peers>`
* :option:`bt-request-peer-speed-limit <--bt-request-peer-speed-limit>` * :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-download-limit <--max-download-limit>`
* :option:`max-upload-limit <-u>` * :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. This method returns ``OK`` for success.
The following examples set the :option:`max-download-limit The following examples set the :option:`max-download-limit