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

2009-06-14 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 

Documented 'position' parameter is starting from 0 in man page.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-06-14 07:22:16 +00:00
parent d98e740dac
commit 1c070ed66e
4 changed files with 39 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2009-06-14 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented 'position' parameter is starting from 0 in man page.
* doc/aria2c.1.txt
2009-06-12 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Updated doc.

10
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.0 <http://docbook.sf.net/>
.\" Date: 06/06/2009
.\" Date: 06/14/2009
.\" Manual: [FIXME: manual]
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "ARIA2C" "1" "06/06/2009" "[FIXME: source]" "[FIXME: manual]"
.TH "ARIA2C" "1" "06/14/2009" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@ -2059,15 +2059,15 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI
.sp
\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\&. 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\&.
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 starting from 0, 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[, 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\&. 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\&.
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 starting from 0, 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[, 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\&. 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 array of 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 starting from 0, 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 array of GID of registered download\&.
.sp
\fBaria2\&.remove\fR \fIgid\fR
.sp

29
doc/aria2c.1.html
View File

@ -2419,10 +2419,11 @@ GID
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
pair of 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>
If <em>position</em> is given as an integer starting from 0, 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.
<em>torrent</em> is of type base64 which contains Base64-encoded .torrent
@ -2431,20 +2432,20 @@ string. <em>uris</em> is used for Web-seeding. Note that <em>uris</em> is ignore
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
<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>
integer starting from 0, 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.
<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
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 array of GID of registered
download.</p></div>
<em>position</em> is given as an integer starting from 0, 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 array of GID of
registered download.</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
string. If specified download is in progress, it is stopped at
@ -3172,7 +3173,7 @@ files in the program, then also delete it here.</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-06-06 23:28:59 JST
Last updated 2009-06-14 16:20:17 JST
</div>
</div>
</body>

27
doc/aria2c.1.txt
View File

@ -1044,10 +1044,11 @@ 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.
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.
If 'position' is given as an integer starting from 0, 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]]]'
@ -1058,10 +1059,10 @@ 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. 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.
integer starting from 0, 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]]'
@ -1069,11 +1070,11 @@ 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. 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 array of GID of registered
download.
'position' is given as an integer starting from 0, 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 array of GID of
registered download.
*aria2.remove* 'gid'