2009-07-05 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

Documented tellWaiting xml-rpc method in man page.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-07-05 09:32:51 +00:00
parent 0fdbf1b09c
commit 4595e0262d
4 changed files with 30 additions and 1 deletions

View File

@ -1,3 +1,8 @@
2009-07-05 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented tellWaiting xml-rpc method in man page.
* doc/aria2c.1.txt
2009-07-05 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 2009-07-05 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Bump up version number to 1.5.0 Bump up version number to 1.5.0

View File

@ -2240,6 +2240,10 @@ seeder
.sp .sp
This method returns the list of active downloads\&. The respose is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&. This method returns the list of active downloads\&. The respose is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.
.sp .sp
\fBaria2\&.tellWaiting\fR \fIoffset, num\fR
.sp
This method returns the list of waiting download in the range of [\fIoffset\fR, \fIoffset\fR+\fInum\fR)\&. \fIoffset\fR specifies the offset from the download waiting at the front and \fInum\fR 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\&.changeOption\fR \fIgid, options\fR \fBaria2\&.changeOption\fR \fIgid, options\fR
.sp .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 \fBmax\-download\-limit\fR and \fBmax\-upload\-limit\fR\&. This method returns "OK" for success\&. 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 \fBmax\-download\-limit\fR and \fBmax\-upload\-limit\fR\&. This method returns "OK" for success\&.

View File

@ -2723,6 +2723,15 @@ seeder
<div class="paragraph"><p>This method returns the list of active downloads. The respose is of <div class="paragraph"><p>This method returns the list of active downloads. The respose is of
type array and its element is the same struct returned by type array and its element is the same struct returned by
<strong>aria2.tellStatus</strong> method.</p></div> <strong>aria2.tellStatus</strong> method.</p></div>
<div class="paragraph"><p><strong>aria2.tellWaiting</strong> <em>offset, num</em></p></div>
<div class="paragraph"><p>This method returns the list of waiting download in the range of
[<em>offset</em>, <em>offset</em>+<em>num</em>). <em>offset</em> specifies the offset from the
download waiting at the front and <em>num</em> 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
<strong>aria2.tellStatus</strong> method.</p></div>
<div class="paragraph"><p><strong>aria2.changeOption</strong> <em>gid, options</em></p></div> <div class="paragraph"><p><strong>aria2.changeOption</strong> <em>gid, options</em></p></div>
<div class="paragraph"><p>This method changes options of the download denoted by <em>gid</em> <div class="paragraph"><p>This method changes options of the download denoted by <em>gid</em>
dynamically. <em>gid</em> is of type string. <em>options</em> is of type struct dynamically. <em>gid</em> is of type string. <em>options</em> is of type struct
@ -3188,7 +3197,7 @@ files in the program, then also delete it here.</p></div>
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2009-07-05 14:54:23 JST Last updated 2009-07-05 18:30:39 JST
</div> </div>
</div> </div>
</body> </body>

View File

@ -1248,6 +1248,17 @@ This method returns the list of active downloads. The respose is of
type array and its element is the same struct returned by type array and its element is the same struct returned by
*aria2.tellStatus* method. *aria2.tellStatus* method.
*aria2.tellWaiting* 'offset, num'
This method returns the list of waiting download in the range of
['offset', 'offset'+'num'). 'offset' specifies the offset from the
download waiting at the front and 'num' 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
*aria2.tellStatus* method.
*aria2.changeOption* 'gid, options' *aria2.changeOption* 'gid, options'
This method changes options of the download denoted by 'gid' This method changes options of the download denoted by 'gid'