summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTatsuhiro Tsujikawa <tatsuhiro.t@gmail.com>2016-05-22 21:07:00 +0900
committerTatsuhiro Tsujikawa <tatsuhiro.t@gmail.com>2016-05-22 21:07:00 +0900
commitd658fdecc66c0b2fac3ea37cc10f16942efb524a (patch)
tree16491b5a97de3644a68f108c0f3bf1ba096d68a5
parent9d40c47799bbec12bb02f7579736fbc1fcc35c08 (diff)
Document about restart when certain option is changed by RPC methoddynamic-select-file
-rw-r--r--doc/manual-src/en/aria2c.rst23
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/manual-src/en/aria2c.rst b/doc/manual-src/en/aria2c.rst
index eacee203..466b5bb0 100644
--- a/doc/manual-src/en/aria2c.rst
+++ b/doc/manual-src/en/aria2c.rst
@@ -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