diff --git a/ChangeLog b/ChangeLog index 78e45604..d980f360 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-05-31 Tatsuhiro Tsujikawa + + Documented position parameter in man page. + * doc/aria2c.1.txt + 2009-05-31 Tatsuhiro Tsujikawa Added 'position' parameter to addUri, addTorrent and addMetalink diff --git a/doc/aria2c.1 b/doc/aria2c.1 index bc48bff8..645f9840 100644 --- a/doc/aria2c.1 +++ b/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.0 -.\" Date: 05/27/2009 +.\" Date: 05/30/2009 .\" Manual: [FIXME: manual] .\" Source: [FIXME: source] .\" 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 .\" ----------------------------------------------------------------- @@ -2057,17 +2057,17 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI .RE .SS "Methods" .sp -\fBaria2\&.addUri\fR \fIuris[, options]\fR +\fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR .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 -\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options]]\fR +\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR .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 -\fBaria2\&.addMetalink\fR \fImetalink[, options]\fR +\fBaria2\&.addMetalink\fR \fImetalink[, options[, position]]\fR .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 \fBaria2\&.remove\fR \fIgid\fR .sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 29563809..60cacb27 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -2414,27 +2414,36 @@ GID

Methods

-

aria2.addUri uris[, options]

+

aria2.addUri uris[, options[, position]]

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 percent-encoded. 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.

-

aria2.addTorrent torrent[, uris[, options]]

+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[, position]]]

This method adds BitTorrent download by uploading .torrent file. torrent is of type base64 which contains Base64-encoded .torrent 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 specified torrent is a multi-file torrent. 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.

-

aria2.addMetalink metalink[, options]

+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[, position]]

This method adds Metalink download by uploading .metalink file. metalink is of type base64 which contains Base64-encoded .metalink 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

This method removes the download denoted by gid. gid is of type string. If specified download is in progress, it is stopped at @@ -3137,7 +3146,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 47316358..2860484e 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -1038,15 +1038,18 @@ GID:: Methods ~~~~~~~ -*aria2.addUri* 'uris[, options]' +*aria2.addUri* 'uris[, options[, position]]' 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 percent-encoded. '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. +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. '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 specified torrent is a multi-file torrent. '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. +*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. 'metalink' is of type base64 which contains Base64-encoded .metalink 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'