From c7a59e076e08df350430edf63eaef5a04cc1bd7a Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 20 Dec 2009 14:44:54 +0000 Subject: 2009-12-20 Tatsuhiro Tsujikawa Documented getOption and getGlobalOption XML-RPC method in man page * doc/aria2c.1.txt --- ChangeLog | 6 ++++++ doc/aria2c.1 | 8 ++++++++ doc/aria2c.1.html | 12 +++++++++++- doc/aria2c.1.txt | 14 ++++++++++++++ 4 files changed, 39 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index 4cb2a5b4..6c9a8a1c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2009-12-20 Tatsuhiro Tsujikawa + + Documented getOption and getGlobalOption XML-RPC method in man + page + * doc/aria2c.1.txt + 2009-12-20 Tatsuhiro Tsujikawa Added getOption and getGlobalOption XML-RPC method. getOption diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 93254747..53a39497 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -2315,10 +2315,18 @@ This method returns the list of active downloads\&. The respose is of type array .sp This method returns the list of waiting download in the range of [\fIoffset\fR, \fIoffset\fR+\fInum\fR)\&. \fIoffset\fR is of type integer and specifies the offset from the download waiting at the front\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. For example, imagine that three downloads "A","B" and "C" are waiting in this order\&. aria2\&.tellWaiting(0, 1) returns "A"\&. aria2\&.tellWaiting(1, 2) returns "B" and "C"\&. The respose is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&. .sp +\fBaria2\&.getOption\fR \fIgid\fR +.sp +This method returns options of the download denoted by \fIgid\fR\&. The response is of type struct\&. Its key is the name of option\&. The value type is string\&. +.sp \fBaria2\&.changeOption\fR \fIgid, options\fR .sp This method changes options of the download denoted by \fIgid\fR dynamically\&. \fIgid\fR is of type string\&. \fIoptions\fR is of type struct and the available options are: \fBbt\-max\-peers\fR, \fBbt\-request\-peer\-speed\-limit\fR, \fBmax\-download\-limit\fR and \fBmax\-upload\-limit\fR\&. This method returns "OK" for success\&. .sp +\fBaria2\&.getGlobalOption\fR +.sp +This method returns global options\&. The response is of type struct\&. Its key is the name of option\&. The value type is string\&. Because global options are used as a template for the options of newly added download, the response contains keys returned by \fBaria2\&.getOption\fR method\&. +.sp \fBaria2\&.changeGlobalOption\fR \fIoptions\fR .sp This method changes global options dynamically\&. \fIoptions\fR is of type struct and the available options are \fBmax\-concurrent\-downloads\fR, \fBmax\-overall\-download\-limit\fR and \fBmax\-overall\-upload\-limit\fR\&. This method returns "OK" for success\&. diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index bf921948..271beb43 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -2983,12 +2983,22 @@ example, imagine that three downloads "A","B" and "C" are waiting in this order. aria2.tellWaiting(0, 1) returns "A". aria2.tellWaiting(1, 2) returns "B" and "C". The respose is of type array and its element is the same struct returned by aria2.tellStatus method.

+

aria2.getOption gid

+

This method returns options of the download denoted by gid. The +response is of type struct. Its key is the name of option. The value type +is string.

aria2.changeOption gid, options

This method changes options of the download denoted by gid dynamically. gid is of type string. options is of type struct and the available options are: bt-max-peers, bt-request-peer-speed-limit, max-download-limit and max-upload-limit. This method returns "OK" for success.

+

aria2.getGlobalOption

+

This method returns global options. The response is of type +struct. Its key is the name of option. The value type is string. +Because global options are used as a template for the options of newly +added download, the response contains keys returned by +aria2.getOption method.

aria2.changeGlobalOption options

This method changes global options dynamically. options is of type struct and the available options are max-concurrent-downloads, @@ -3486,7 +3496,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index f1427df0..bc7b20b3 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -1330,6 +1330,12 @@ this order. aria2.tellWaiting(0, 1) returns "A". aria2.tellWaiting(1, 2) returns "B" and "C". The respose is of type array and its element is the same struct returned by *aria2.tellStatus* method. +*aria2.getOption* 'gid' + +This method returns options of the download denoted by 'gid'. The +response is of type struct. Its key is the name of option. The value type +is string. + *aria2.changeOption* 'gid, options' This method changes options of the download denoted by 'gid' @@ -1338,6 +1344,14 @@ and the available options are: *bt-max-peers*, *bt-request-peer-speed-limit*, *max-download-limit* and *max-upload-limit*. This method returns "OK" for success. +*aria2.getGlobalOption* + +This method returns global options. The response is of type +struct. Its key is the name of option. The value type is string. +Because global options are used as a template for the options of newly +added download, the response contains keys returned by +*aria2.getOption* method. + *aria2.changeGlobalOption* 'options' This method changes global options dynamically. 'options' is of type -- cgit