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

Documented type of offset and num for tellWaiting xml-rpc method.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-07-10 15:58:37 +00:00
parent d6a8fa5b10
commit e651cf6084
4 changed files with 24 additions and 19 deletions

View File

@ -1,3 +1,8 @@
2009-07-11 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented type of offset and num for tellWaiting xml-rpc method.
* doc/aria2c.1.txt
2009-07-11 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 2009-07-11 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Implemented getVersion xml-rpc method. This method returns struct Implemented getVersion xml-rpc method. This method returns struct

View File

@ -1,13 +1,13 @@
'\" t '\" t
.\" Title: aria2c .\" Title: aria2c
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.0 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
.\" Date: 07/06/2009 .\" Date: 07/11/2009
.\" Manual: Aria2 Manual .\" Manual: Aria2 Manual
.\" Source: Aria2 .\" Source: Aria2
.\" Language: English .\" Language: English
.\" .\"
.TH "ARIA2C" "1" "07/06/2009" "Aria2" "Aria2 Manual" .TH "ARIA2C" "1" "07/11/2009" "Aria2" "Aria2 Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * set default formatting .\" * set default formatting
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -2242,7 +2242,7 @@ This method returns the list of active downloads\&. The respose is of type array
.sp .sp
\fBaria2\&.tellWaiting\fR \fIoffset, num\fR \fBaria2\&.tellWaiting\fR \fIoffset, num\fR
.sp .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\&. 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 .sp
\fBaria2\&.changeOption\fR \fIgid, options\fR \fBaria2\&.changeOption\fR \fIgid, options\fR
.sp .sp

View File

@ -2724,13 +2724,13 @@ 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><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 <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 [<em>offset</em>, <em>offset</em>+<em>num</em>). <em>offset</em> is of type integer and specifies
download waiting at the front and <em>num</em> specifies the number of the offset from the download waiting at the front. <em>num</em> is of type
downloads to be returned. For example, imagine that three downloads integer and specifies the number of downloads to be returned. For
"A","B" and "C" are waiting in this order. aria2.tellWaiting(0, 1) example, imagine that three downloads "A","B" and "C" are waiting in
returns "A". aria2.tellWaiting(1, 2) returns "B" and "C". The respose this order. aria2.tellWaiting(0, 1) returns "A". aria2.tellWaiting(1,
is of type array and its element is the same struct returned by 2) returns "B" and "C". The respose is of type array and its element
<strong>aria2.tellStatus</strong> method.</p></div> 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
@ -3196,7 +3196,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-06 22:33:35 JST Last updated 2009-07-11 00:50:11 JST
</div> </div>
</div> </div>
</body> </body>

View File

@ -1250,13 +1250,13 @@ type array and its element is the same struct returned by
*aria2.tellWaiting* 'offset, num' *aria2.tellWaiting* 'offset, num'
This method returns the list of waiting download in the range of This method returns the list of waiting download in the range of
['offset', 'offset'+'num'). 'offset' specifies the offset from the ['offset', 'offset'+'num'). 'offset' is of type integer and specifies
download waiting at the front and 'num' specifies the number of the offset from the download waiting at the front. 'num' is of type
downloads to be returned. For example, imagine that three downloads integer and specifies the number of downloads to be returned. For
"A","B" and "C" are waiting in this order. aria2.tellWaiting(0, 1) example, imagine that three downloads "A","B" and "C" are waiting in
returns "A". aria2.tellWaiting(1, 2) returns "B" and "C". The respose this order. aria2.tellWaiting(0, 1) returns "A". aria2.tellWaiting(1,
is of type array and its element is the same struct returned by 2) returns "B" and "C". The respose is of type array and its element
*aria2.tellStatus* method. is the same struct returned by *aria2.tellStatus* method.
*aria2.changeOption* 'gid, options' *aria2.changeOption* 'gid, options'