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

Updated the description for aria2.addTorrent XML-RPC method.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-12-22 15:10:48 +00:00
parent f927654103
commit 55f652882f
4 changed files with 37 additions and 30 deletions

View File

@ -1,3 +1,8 @@
2009-12-23 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Updated the description for aria2.addTorrent XML-RPC method.
* doc/aria2c.1.txt
2009-12-22 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Added changePosition to aria2rpc.

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/22/2009
.\" Date: 12/23/2009
.\" Manual: Aria2 Manual
.\" Source: Aria2
.\" Language: English
.\"
.TH "ARIA2C" "1" "12/22/2009" "Aria2" "Aria2 Manual"
.TH "ARIA2C" "1" "12/23/2009" "Aria2" "Aria2 Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -2125,7 +2125,7 @@ This method adds new HTTP(S)/FTP/BitTorrent Magnet URI\&. \fIuris\fR is of type
.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\&. For single file torrents, URI can be a complete URI pointing to the resource or if URI ends with /, name in torrent file is added\&. For multi\-file torrents, name and path in torrent are added to form a URI for each 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 GID of registered download\&.
This method adds BitTorrent download by uploading \&.torrent file\&. If you want to add BitTorrent Magnet URI, use \fBaria2\&.addUri\fR method instead\&. \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\&. For single file torrents, URI can be a complete URI pointing to the resource or if URI ends with /, name in torrent file is added\&. For multi\-file torrents, name and path in torrent are added to form a URI for each 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 GID of registered download\&.
.sp
\fBaria2\&.addMetalink\fR \fImetalink[, options[, position]]\fR
.sp

View File

@ -2654,19 +2654,20 @@ new download is inserted at <em>position</em> in the waiting queue. If
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
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. For single file torrents, URI
can be a complete URI pointing to the resource or if URI ends with /,
name in torrent file is added. For multi-file torrents, name and path
in torrent are added to form a URI for each 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 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>This method adds BitTorrent download by uploading .torrent file. If
you want to add BitTorrent Magnet URI, use <strong>aria2.addUri</strong> method
instead. <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 string. <em>uris</em> is used for Web-seeding. For single file
torrents, URI can be a complete URI pointing to the resource or if URI
ends with /, name in torrent file is added. For multi-file torrents,
name and path in torrent are added to form a URI for each 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 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
@ -3511,7 +3512,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-22 00:24:21 JST
Last updated 2009-12-23 00:06:15 JST
</div>
</div>
</body>

View File

@ -1111,19 +1111,20 @@ 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. For single file torrents, URI
can be a complete URI pointing to the resource or if URI ends with /,
name in torrent file is added. For multi-file torrents, name and path
in torrent are added to form a URI for each 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 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.
This method adds BitTorrent download by uploading .torrent file. If
you want to add BitTorrent Magnet URI, use *aria2.addUri* method
instead. '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. For single file
torrents, URI can be a complete URI pointing to the resource or if URI
ends with /, name in torrent file is added. For multi-file torrents,
name and path in torrent are added to form a URI for each 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 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]]'