2010-06-28 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

Updated doc for aria2.addUri
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2010-06-28 12:05:14 +00:00
parent 985bc37c00
commit ad7cb6ed6a
4 changed files with 43 additions and 18 deletions

View File

@ -1,3 +1,8 @@
2010-06-28 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Updated doc for aria2.addUri
* doc/aria2c.1.txt
2010-06-27 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 2010-06-27 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Don't set previousUri_ to "" on redirect. Don't set previousUri_ to "" on redirect.

View File

@ -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.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 06/23/2010 .\" Date: 06/28/2010
.\" Manual: Aria2 Manual .\" Manual: Aria2 Manual
.\" Source: Aria2 1.9.4 .\" Source: Aria2 1.9.4
.\" Language: English .\" Language: English
.\" .\"
.TH "ARIA2C" "1" "06/23/2010" "Aria2 1\&.9\&.4" "Aria2 Manual" .TH "ARIA2C" "1" "06/28/2010" "Aria2 1\&.9\&.4" "Aria2 Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -2623,7 +2623,7 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI
.sp .sp
\fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR \fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR
.sp .sp
This method adds new HTTP(S)/FTP/BitTorrent Magnet URI\&. \fIuris\fR is of type array and its element is URI which is of type string\&. For BitTorrent Magnet URI, \fIuris\fR must have only one element and it should be BitTorrent Magnet URI\&. \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 new HTTP(S)/FTP/BitTorrent Magnet URI\&. \fIuris\fR is of type array and its element is URI which is of type string\&. For BitTorrent Magnet URI, \fIuris\fR must have only one element and it should be BitTorrent Magnet URI\&. URIs in \fIuris\fR must point to the same file\&. For example, a file \fIchunkybaconlinux\&.iso\fR is hosted in 2 locations: http://server/chunkybaconlinux\&.iso and http://mirror/chunkybaconlinux\&.iso\&. You can download this iso image using 2 URIs issuing aria2\&.addUri([\fIhttp://server/chunkybaconlinux\&.iso\fR, \fIhttp://mirror/chunkybaconlinux\&.iso\fR])\&. Imagine there is an another file URI, say, http://mirror2/chunkydonutslinux\&.iso, which is different iso image\&. You cannot mix this URI with previous URIs in one aria2\&.addUri command\&. If you do, aria2 does not complain but download may fail\&. \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 .sp
\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR \fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR
.sp .sp

View File

@ -3064,13 +3064,23 @@ GID
<div class="paragraph"><p>This method adds new HTTP(S)/FTP/BitTorrent Magnet URI. <em>uris</em> is of <div class="paragraph"><p>This method adds new HTTP(S)/FTP/BitTorrent Magnet URI. <em>uris</em> is of
type array and its element is URI which is of type string. For type array and its element is URI which is of type string. For
BitTorrent Magnet URI, <em>uris</em> must have only one element and it should BitTorrent Magnet URI, <em>uris</em> must have only one element and it should
be BitTorrent Magnet URI. <em>options</em> is of type struct and its members be BitTorrent Magnet URI. URIs in <em>uris</em> must point to the same
are a pair of option name and value. See <strong>Options</strong> below for more file. For example, a file <em>chunkybaconlinux.iso</em> is hosted in 2
details. If <em>position</em> is given as an integer starting from 0, the locations: <a href="http://server/chunkybaconlinux.iso">http://server/chunkybaconlinux.iso</a> and
new download is inserted at <em>position</em> in the waiting queue. If <a href="http://mirror/chunkybaconlinux.iso">http://mirror/chunkybaconlinux.iso</a>. You can download this iso image
<em>position</em> is not given or <em>position</em> is larger than the size of the using 2 URIs issuing
queue, it is appended at the end of the queue. This method returns aria2.addUri([<em>http://server/chunkybaconlinux.iso</em>,
GID of registered download.</p></div> <em>http://mirror/chunkybaconlinux.iso</em>]). Imagine there is an another
file URI, say, <a href="http://mirror2/chunkydonutslinux.iso">http://mirror2/chunkydonutslinux.iso</a>, which is
different iso image. You cannot mix this URI with previous URIs in
one aria2.addUri command. If you do, aria2 does not complain but
download may fail. <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.addTorrent</strong> <em>torrent[, uris[, options[, position]]]</em></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. If <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 you want to add BitTorrent Magnet URI, use <strong>aria2.addUri</strong> method
@ -4202,7 +4212,7 @@ files in the program, then also delete it here.</p></div>
<div id="footnotes"><hr /></div> <div id="footnotes"><hr /></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2010-06-23 23:10:50 JST Last updated 2010-06-28 21:00:35 JST
</div> </div>
</div> </div>
</body> </body>

View File

@ -1317,13 +1317,23 @@ Methods
This method adds new HTTP(S)/FTP/BitTorrent Magnet URI. 'uris' is of This method adds new HTTP(S)/FTP/BitTorrent Magnet URI. 'uris' is of
type array and its element is URI which is of type string. For type array and its element is URI which is of type string. For
BitTorrent Magnet URI, 'uris' must have only one element and it should BitTorrent Magnet URI, 'uris' must have only one element and it should
be BitTorrent Magnet URI. 'options' is of type struct and its members be BitTorrent Magnet URI. URIs in 'uris' must point to the same
are a pair of option name and value. See *Options* below for more file. For example, a file chunkybaconlinux.iso is hosted in 2
details. If 'position' is given as an integer starting from 0, the locations: http://server/chunkybaconlinux.iso and
new download is inserted at 'position' in the waiting queue. If http://mirror/chunkybaconlinux.iso. You can download this iso image
'position' is not given or 'position' is larger than the size of the using 2 URIs by issuing
queue, it is appended at the end of the queue. This method returns aria2.addUri(['http://server/chunkybaconlinux.iso',
GID of registered download. 'http://mirror/chunkybaconlinux.iso']). Imagine there is an another
file URI, say, http://mirror2/chunkydonutslinux.iso, which is
different iso image. You cannot mix this URI with previous URIs in
one aria2.addUri command. If you do, aria2 does not complain but
download may fail. '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.addTorrent* 'torrent[, uris[, options[, position]]]' *aria2.addTorrent* 'torrent[, uris[, options[, position]]]'