Browse Source

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

	Documented position parameter in man page.
	* doc/aria2c.1.txt
Tatsuhiro Tsujikawa 16 years ago
parent
commit
c1549cbc65
4 changed files with 48 additions and 25 deletions
  1. 5 0
      ChangeLog
  2. 8 8
      doc/aria2c.1
  3. 18 9
      doc/aria2c.1.html
  4. 17 8
      doc/aria2c.1.txt

+ 5 - 0
ChangeLog

@@ -1,3 +1,8 @@
+2009-05-31  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
+	Documented position parameter in man page.
+	* doc/aria2c.1.txt
+
 2009-05-31  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 2009-05-31  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 
 
 	Added 'position' parameter to addUri, addTorrent and addMetalink
 	Added 'position' parameter to addUri, addTorrent and addMetalink

+ 8 - 8
doc/aria2c.1

@@ -2,12 +2,12 @@
 .\"     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.0 <http://docbook.sf.net/>
-.\"      Date: 05/27/2009
+.\"      Date: 05/30/2009
 .\"    Manual: [FIXME: manual]
 .\"    Manual: [FIXME: manual]
 .\"    Source: [FIXME: source]
 .\"    Source: [FIXME: source]
 .\"  Language: English
 .\"  Language: English
 .\"
 .\"
-.TH "ARIA2C" "1" "05/27/2009" "[FIXME: source]" "[FIXME: manual]"
+.TH "ARIA2C" "1" "05/30/2009" "[FIXME: source]" "[FIXME: manual]"
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
@@ -2057,17 +2057,17 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI
 .RE
 .RE
 .SS "Methods"
 .SS "Methods"
 .sp
 .sp
-\fBaria2\&.addUri\fR \fIuris[, options]\fR
+\fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR
 .sp
 .sp
-This method adds new HTTP(S)/FTP download\&. \fIuris\fR is of type array and its element is URI which is of type string\&. URI should be percent\-encoded\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. This method returns GID of registered download\&.
+This method adds new HTTP(S)/FTP download\&. \fIuris\fR is of type array and its element is URI which is of type string\&. URI should be percent\-encoded\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
 .sp
 .sp
-\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options]]\fR
+\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR
 .sp
 .sp
-This method adds BitTorrent download by uploading \&.torrent file\&. \fItorrent\fR is of type base64 which contains Base64\-encoded \&.torrent file\&. \fIuris\fR is of type array and its element is URI which is of type string\&. \fIuris\fR is used for Web\-seeding\&. Note that \fIuris\fR is ignored if specified torrent is a multi\-file torrent\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. This method returns GID of registered download\&.
+This method adds BitTorrent download by uploading \&.torrent file\&. \fItorrent\fR is of type base64 which contains Base64\-encoded \&.torrent file\&. \fIuris\fR is of type array and its element is URI which is of type string\&. \fIuris\fR is used for Web\-seeding\&. Note that \fIuris\fR is ignored if specified torrent is a multi\-file torrent\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
 .sp
 .sp
-\fBaria2\&.addMetalink\fR \fImetalink[, options]\fR
+\fBaria2\&.addMetalink\fR \fImetalink[, options[, position]]\fR
 .sp
 .sp
-This method adds Metalink download by uploading \&.metalink file\&. \fImetalink\fR is of type base64 which contains Base64\-encoded \&.metalink file\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. This method returns GID of registered download\&.
+This method adds Metalink download by uploading \&.metalink file\&. \fImetalink\fR is of type base64 which contains Base64\-encoded \&.metalink file\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
 .sp
 .sp
 \fBaria2\&.remove\fR \fIgid\fR
 \fBaria2\&.remove\fR \fIgid\fR
 .sp
 .sp

+ 18 - 9
doc/aria2c.1.html

@@ -2414,27 +2414,36 @@ GID
 </dd>
 </dd>
 </dl></div>
 </dl></div>
 <h3 id="_methods">Methods</h3><div style="clear:left"></div>
 <h3 id="_methods">Methods</h3><div style="clear:left"></div>
-<div class="paragraph"><p><strong>aria2.addUri</strong> <em>uris[, options]</em></p></div>
+<div class="paragraph"><p><strong>aria2.addUri</strong> <em>uris[, options[, position]]</em></p></div>
 <div class="paragraph"><p>This method adds new HTTP(S)/FTP download.  <em>uris</em> is of type array
 <div class="paragraph"><p>This method adds new HTTP(S)/FTP download.  <em>uris</em> is of type array
 and its element is URI which is of type string. URI should be
 and its element is URI which is of type string. URI should be
 percent-encoded.  <em>options</em> is of type struct and its members are a
 percent-encoded.  <em>options</em> is of type struct and its members are a
 pair of option name and value. See <strong>Options</strong> below for more details.
 pair of option name and value. See <strong>Options</strong> below for more details.
-This method returns GID of registered download.</p></div>
-<div class="paragraph"><p><strong>aria2.addTorrent</strong> <em>torrent[, uris[, options]]</em></p></div>
+If <em>position</em> is given as an integer, the new download is inserted at
+<em>position</em> in the waiting queue. If <em>position</em> is not given or
+<em>position</em> is larger than the size of the queue, it is appended at the
+end of the queue.  This method returns GID of registered download.</p></div>
+<div class="paragraph"><p><strong>aria2.addTorrent</strong> <em>torrent[, uris[, options[, position]]]</em></p></div>
 <div class="paragraph"><p>This method adds BitTorrent download by uploading .torrent file.
 <div class="paragraph"><p>This method adds BitTorrent download by uploading .torrent file.
 <em>torrent</em> is of type base64 which contains Base64-encoded .torrent
 <em>torrent</em> is of type base64 which contains Base64-encoded .torrent
 file.  <em>uris</em> is of type array and its element is URI which is of type
 file.  <em>uris</em> is of type array and its element is URI which is of type
 string. <em>uris</em> is used for Web-seeding. Note that <em>uris</em> is ignored if
 string. <em>uris</em> is used for Web-seeding. Note that <em>uris</em> is ignored if
 specified torrent is a multi-file torrent.  <em>options</em> is of type
 specified torrent is a multi-file torrent.  <em>options</em> is of type
 struct and its members are a pair of option name and value. See
 struct and its members are a pair of option name and value. See
-<strong>Options</strong> below for more details.  This method returns GID of
-registered download.</p></div>
-<div class="paragraph"><p><strong>aria2.addMetalink</strong> <em>metalink[, options]</em></p></div>
+<strong>Options</strong> below for more details.  If <em>position</em> is given as an
+integer, the new download is inserted at <em>position</em> in the waiting
+queue. If <em>position</em> is not given or <em>position</em> is larger than the
+size of the queue, it is appended at the end of the queue.  This
+method returns GID of registered download.</p></div>
+<div class="paragraph"><p><strong>aria2.addMetalink</strong> <em>metalink[, options[, position]]</em></p></div>
 <div class="paragraph"><p>This method adds Metalink download by uploading .metalink file.
 <div class="paragraph"><p>This method adds Metalink download by uploading .metalink file.
 <em>metalink</em> is of type base64 which contains Base64-encoded .metalink
 <em>metalink</em> is of type base64 which contains Base64-encoded .metalink
 file.  <em>options</em> is of type struct and its members are a pair of
 file.  <em>options</em> is of type struct and its members are a pair of
-option name and value. See <strong>Options</strong> below for more details.  This
-method returns GID of registered download.</p></div>
+option name and value. See <strong>Options</strong> below for more details.  If
+<em>position</em> is given as an integer, the new download is inserted at
+<em>position</em> in the waiting queue. If <em>position</em> is not given or
+<em>position</em> is larger than the size of the queue, it is appended at the
+end of the queue.  This method returns GID of registered download.</p></div>
 <div class="paragraph"><p><strong>aria2.remove</strong> <em>gid</em></p></div>
 <div class="paragraph"><p><strong>aria2.remove</strong> <em>gid</em></p></div>
 <div class="paragraph"><p>This method removes the download denoted by <em>gid</em>. <em>gid</em> is of type
 <div class="paragraph"><p>This method removes the download denoted by <em>gid</em>. <em>gid</em> is of type
 string. If specified download is in progress, it is stopped at
 string. If specified download is in progress, it is stopped at
@@ -3137,7 +3146,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-05-27 21:56:45 JST
+Last updated 2009-05-31 07:57:09 JST
 </div>
 </div>
 </div>
 </div>
 </body>
 </body>

+ 17 - 8
doc/aria2c.1.txt

@@ -1038,15 +1038,18 @@ GID::
 Methods
 Methods
 ~~~~~~~
 ~~~~~~~
 
 
-*aria2.addUri* 'uris[, options]'
+*aria2.addUri* 'uris[, options[, position]]'
 
 
 This method adds new HTTP(S)/FTP download.  'uris' is of type array
 This method adds new HTTP(S)/FTP download.  'uris' is of type array
 and its element is URI which is of type string. URI should be
 and its element is URI which is of type string. URI should be
 percent-encoded.  'options' is of type struct and its members are a
 percent-encoded.  'options' is of type struct and its members are a
 pair of option name and value. See *Options* below for more details.
 pair of option name and value. See *Options* below for more details.
-This method returns GID of registered download.
+If 'position' is given as an integer, the new download is inserted at
+'position' in the waiting queue. If 'position' is not given or
+'position' is larger than the size of the queue, it is appended at the
+end of the queue.  This method returns GID of registered download.
 
 
-*aria2.addTorrent* 'torrent[, uris[, options]]'
+*aria2.addTorrent* 'torrent[, uris[, options[, position]]]'
 
 
 This method adds BitTorrent download by uploading .torrent file.
 This method adds BitTorrent download by uploading .torrent file.
 'torrent' is of type base64 which contains Base64-encoded .torrent
 'torrent' is of type base64 which contains Base64-encoded .torrent
@@ -1054,16 +1057,22 @@ file.  'uris' is of type array and its element is URI which is of type
 string. 'uris' is used for Web-seeding. Note that 'uris' is ignored if
 string. 'uris' is used for Web-seeding. Note that 'uris' is ignored if
 specified torrent is a multi-file torrent.  'options' is of type
 specified torrent is a multi-file torrent.  'options' is of type
 struct and its members are a pair of option name and value. See
 struct and its members are a pair of option name and value. See
-*Options* below for more details.  This method returns GID of
-registered download.
+*Options* below for more details.  If 'position' is given as an
+integer, the new download is inserted at 'position' in the waiting
+queue. If 'position' is not given or 'position' is larger than the
+size of the queue, it is appended at the end of the queue.  This
+method returns GID of registered download.
 
 
-*aria2.addMetalink* 'metalink[, options]'
+*aria2.addMetalink* 'metalink[, options[, position]]'
 
 
 This method adds Metalink download by uploading .metalink file.
 This method adds Metalink download by uploading .metalink file.
 'metalink' is of type base64 which contains Base64-encoded .metalink
 'metalink' is of type base64 which contains Base64-encoded .metalink
 file.  'options' is of type struct and its members are a pair of
 file.  'options' is of type struct and its members are a pair of
-option name and value. See *Options* below for more details.  This
-method returns GID of registered download.
+option name and value. See *Options* below for more details.  If
+'position' is given as an integer, the new download is inserted at
+'position' in the waiting queue. If 'position' is not given or
+'position' is larger than the size of the queue, it is appended at the
+end of the queue.  This method returns GID of registered download.
 
 
 *aria2.remove* 'gid'
 *aria2.remove* 'gid'