github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity

2009-12-25 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 

Documented tellStopped XML-RPC method in man page.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-12-25 14:51:26 +00:00
parent 17a1bfea09
commit 49bd2c1b92
4 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2009-12-25 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented tellStopped XML-RPC method in man page.
* doc/aria2c.1.txt
2009-12-25 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Added tellStopped XML-RPC method to aria2rpc.

8
doc/aria2c.1
View File

@ -2,12 +2,12 @@
.\" Title: aria2c
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/23/2009
.\" Date: 12/25/2009
.\" Manual: Aria2 Manual
.\" Source: Aria2
.\" Language: English
.\"
.TH "ARIA2C" "1" "12/23/2009" "Aria2" "Aria2 Manual"
.TH "ARIA2C" "1" "12/25/2009" "Aria2" "Aria2 Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -2315,6 +2315,10 @@ 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\&.tellStopped\fR \fIoffset, num\fR
.sp
This method returns the list of stopped download in the range of [\fIoffset\fR, \fIoffset\fR+\fInum\fR)\&. \fIoffset\fR is of type integer and specifies the offset from the oldest download\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. The respose is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.
.sp
\fBaria2\&.changePosition\fR \fIgid, pos, how\fR
.sp
This method changes the position of the download denoted by \fIgid\fR\&. \fIpos\fR is of type integer\&. \fIhow\fR is of type string\&. If \fIhow\fR is "POS_SET", it moves the download to a position relative to the beginning of the queue\&. If \fIhow\fR is "POS_CUR", it moves the download to a position relative to the current position\&. If \fIhow\fR is "POS_END", it moves the download to a position relative to the end of the queue\&. If the destination position is less than 0 or beyond the end of the queue, it moves the download to the beginning or the end of the queue respectively\&. The response is of type integer and it is the destination position\&.

9
doc/aria2c.1.html
View File

@ -2984,6 +2984,13 @@ 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.tellStopped</strong> <em>offset, num</em></p></div>
<div class="paragraph"><p>This method returns the list of stopped download in the range of
[<em>offset</em>, <em>offset</em>+<em>num</em>). <em>offset</em> is of type integer and specifies
the offset from the oldest download. <em>num</em> is of type integer and
specifies the number of downloads to be returned. 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.changePosition</strong> <em>gid, pos, how</em></p></div>
<div class="paragraph"><p>This method changes the position of the download denoted by
<em>gid</em>. <em>pos</em> is of type integer. <em>how</em> is of type string. If <em>how</em> is
@ -3512,7 +3519,7 @@ files in the program, then also delete it here.</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2009-12-23 13:22:43 JST
Last updated 2009-12-25 23:48:03 JST
</div>
</div>
</body>

9
doc/aria2c.1.txt
View File

@ -1331,6 +1331,15 @@ 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.tellStopped* 'offset, num'
This method returns the list of stopped download in the range of
['offset', 'offset'+'num'). 'offset' is of type integer and specifies
the offset from the oldest download. 'num' is of type integer and
specifies the number of downloads to be returned. The respose is of
type array and its element is the same struct returned by
*aria2.tellStatus* method.
*aria2.changePosition* 'gid, pos, how'
This method changes the position of the download denoted by