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

	Documented changePosition XML-RPC method in man page.
	* doc/aria2c.1.txt

ChangeLog

@@ -1,3 +1,8 @@
+2009-12-22  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
+	Documented changePosition XML-RPC method in man page.
+	* doc/aria2c.1.txt
+
 2009-12-22  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 
 	Added changePosition XML-RPC method. It takes 3 parameters: gid,

doc/aria2c.1

@@ -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/20/2009
+.\"      Date: 12/22/2009
 .\"    Manual: Aria2 Manual
 .\"    Source: Aria2
 .\"  Language: English
 .\"
-.TH "ARIA2C" "1" "12/20/2009" "Aria2" "Aria2 Manual"
+.TH "ARIA2C" "1" "12/22/2009" "Aria2" "Aria2 Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -2315,6 +2315,12 @@ 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\&.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\&.
+.sp
+For example, if GID#1 is placed in position 3, aria2\&.changePosition(1, \-1, POS_CUR) will change its position to 2\&. Additional aria2\&.changePosition(1, 0, POS_SET) will change its position to 0(the beginning of the queue)\&.
+.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\&.

doc/aria2c.1.html

@@ -2983,6 +2983,21 @@ 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.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
+"POS_SET", it moves the download to a position relative to the
+beginning of the queue.  If <em>how</em> is "POS_CUR", it moves the download
+to a position relative to the current position. If <em>how</em> 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.</p></div>
+<div class="paragraph"><p>For example, if GID#1 is placed in position 3, aria2.changePosition(1,
+-1, POS_CUR) will change its position to 2. Additional
+aria2.changePosition(1, 0, POS_SET) will change its position to 0(the
+beginning of the queue).</p></div>
 <div class="paragraph"><p><strong>aria2.getOption</strong> <em>gid</em></p></div>
 <div class="paragraph"><p>This method returns options of the download denoted by <em>gid</em>.  The
 response is of type struct. Its key is the name of option.  The value type
@@ -3496,7 +3511,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-20 23:42:01 JST
+Last updated 2009-12-22 00:24:21 JST
 </div>
 </div>
 </body>

doc/aria2c.1.txt

@@ -1330,6 +1330,24 @@ 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.changePosition* 'gid, pos, how'
+
+This method changes the position of the download denoted by
+'gid'. 'pos' is of type integer. 'how' is of type string. If 'how' is
+"POS_SET", it moves the download to a position relative to the
+beginning of the queue.  If 'how' is "POS_CUR", it moves the download
+to a position relative to the current position. If 'how' 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.
+
+For example, if GID#1 is placed in position 3, aria2.changePosition(1,
+-1, POS_CUR) will change its position to 2. Additional
+aria2.changePosition(1, 0, POS_SET) will change its position to 0(the
+beginning of the queue).
+
 *aria2.getOption* 'gid'
 
 This method returns options of the download denoted by 'gid'.  The