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

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

Documented about followedBy and belongsTo in man page.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-12-20 09:52:05 +00:00
parent 2952abf064
commit 2ba1992905
4 changed files with 103 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
ChangeLog
View File

@ -1,3 +1,35 @@
2009-12-20 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented about followedBy and belongsTo in man page.
* doc/aria2c.1.txt
2009-12-20 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Added following 2 keys, followedBy and belongsTo, to the response
of tellStatus.
followedBy: List of GIDs which are generated by the consequence of
this download. For example, when aria2 downloaded Metalink file,
it generates downloads described in it(see *--follow-metalink*
option). This value is useful to track these auto generated
downloads. If there is no such downloads, this key will not be
included in the response.
belongsTo: GID of a parent download. Some downloads are a part of
another download. For example, if a file in Metalink has
BitTorrent resource, the download of .torrent is a part of that
file. If this download has no parent, this key will not be
included in the response.
* src/BtPostDownloadHandler.cc
* src/DownloadResult.h
* src/Metalink2RequestGroup.cc
* src/MetalinkPostDownloadHandler.cc
* src/RequestGroup.cc
* src/RequestGroup.h
* src/UTMetadataPostDownloadHandler.cc
* src/XmlRpcMethodImpl.cc
* src/XmlRpcMethodImpl.h
2009-12-20 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Assigned BObject in BDE() to avoid segmentation fault when calling

35
doc/aria2c.1
View File

@ -2,12 +2,21 @@
.\" 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/11/2009
.\" Date: 12/20/2009
.\" Manual: Aria2 Manual
.\" Source: Aria2
.\" Language: English
.\"
.TH "ARIA2C" "1" "12/11/2009" "Aria2" "Aria2 Manual"
.TH "ARIA2C" "1" "12/20/2009" "Aria2" "Aria2 Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@ -1109,7 +1118,7 @@ The options that have its argument surrounded by square brackets([]) take an opt
.sp
You can specify multiple URLs in command\-line\&. Unless you specify \fB\-Z\fR option, all URLs must point to the same file or downloading will fail\&.
.sp
You can specify arbitrary number of BitTorrent Magnet URI\&. Please note that they are always treated as a separate download\&. Both hex encoded 40 characters Info Hash and Base32 encoded 32 characters Info Hash are supported\&. The multiple "tr" paramters are supported\&. Because BitTorrent Magnet URI is likely to contain "&" character, it is highly recommended to always quote URI with single(\') or double(") quotation\&. It is strongly recommended to enable DHT especially when "tr" parameter is missing\&. See http://www\&.bittorrent\&.org/beps/bep_0009\&.html for more details about BitTorrent Magnet URI\&.
You can specify arbitrary number of BitTorrent Magnet URI\&. Please note that they are always treated as a separate download\&. Both hex encoded 40 characters Info Hash and Base32 encoded 32 characters Info Hash are supported\&. The multiple "tr" paramters are supported\&. Because BitTorrent Magnet URI is likely to contain "&" character, it is highly recommended to always quote URI with single(\*(Aq) or double(") quotation\&. It is strongly recommended to enable DHT especially when "tr" parameter is missing\&. See http://www\&.bittorrent\&.org/beps/bep_0009\&.html for more details about BitTorrent Magnet URI\&.
.sp
You can also specify arbitrary number of torrent files and metalink files stored on a local drive\&. Please note that they are always treated as a separate download\&.
.sp
@ -1127,7 +1136,7 @@ You can specify both torrent file with \-T option and URLs\&. By doing this, you
.ps -1
.br
.sp
Make sure that URL is quoted with single(\') or double(") quotation if it contains "&" or any characters that have special meaning in shell\&.
Make sure that URL is quoted with single(\*(Aq) or double(") quotation if it contains "&" or any characters that have special meaning in shell\&.
.sp .5v
.RE
.SS "Resuming Download"
@ -2199,6 +2208,18 @@ errorCode
.RS 4
The last error code occurred in this download\&. The value is of type string\&. The error codes are defined in EXIT STATUS section\&. This value is only available for stopped/completed downloads\&.
.RE
.PP
followedBy
.RS 4
List of GIDs which are generated by the consequence of this download\&. For example, when aria2 downloaded Metalink file, it generates downloads described in it(see
\fB\-\-follow\-metalink\fR
option)\&. This value is useful to track these auto generated downloads\&. If there is no such downloads, this key will not be included in the response\&.
.RE
.PP
belongsTo
.RS 4
GID of a parent download\&. Some downloads are a part of another download\&. For example, if a file in Metalink has BitTorrent resource, the download of \&.torrent is a part of that file\&. If this download has no parent, this key will not be included in the response\&.
.RE
.sp
\fBaria2\&.getUris\fR \fIgid\fR
.sp
@ -2380,8 +2401,8 @@ The following Ruby script adds \fIhttp://localhost/aria2\&.tar\&.bz2\fR to aria2
.nf
#!/usr/bin/env ruby
require \'xmlrpc/client\'
require \'pp\'
require \*(Aqxmlrpc/client\*(Aq
require \*(Aqpp\*(Aq
client=XMLRPC::Client\&.new2("http://localhost:6800/rpc")
@ -2852,7 +2873,7 @@ aria2c "magnet:?xt=urn:btih:248d0a1cd08284299de78d5c1ed359bb46717d8c&dn=aria2"
.ps -1
.br
.sp
Don\(cqt forget to quote BitTorrent Magnet URI which includes "&" character with single(\') or double(") quotation\&.
Don\(cqt forget to quote BitTorrent Magnet URI which includes "&" character with single(\*(Aq) or double(") quotation\&.
.sp .5v
.RE
.RE

27
doc/aria2c.1.html
View File

@ -2807,6 +2807,31 @@ errorCode
value is only available for stopped/completed downloads.
</p>
</dd>
<dt class="hdlist1">
followedBy
</dt>
<dd>
<p>
List of GIDs which are generated by the consequence of this
download. For example, when aria2 downloaded Metalink file, it
generates downloads described in it(see <strong>--follow-metalink</strong>
option). This value is useful to track these auto generated
downloads. If there is no such downloads, this key will not
be included in the response.
</p>
</dd>
<dt class="hdlist1">
belongsTo
</dt>
<dd>
<p>
GID of a parent download. Some downloads are a part of another
download. For example, if a file in Metalink has BitTorrent
resource, the download of .torrent is a part of that file. If this
download has no parent, this key will not be included in the
response.
</p>
</dd>
</dl></div>
<div class="paragraph"><p><strong>aria2.getUris</strong> <em>gid</em></p></div>
<div class="paragraph"><p>This method returns URIs used in the download denoted by <em>gid</em>. <em>gid</em>
@ -3461,7 +3486,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-11 21:59:14 JST
Last updated 2009-12-20 18:35:41 JST
</div>
</div>
</body>

17
doc/aria2c.1.txt
View File

@ -1214,6 +1214,23 @@ errorCode::
string. The error codes are defined in EXIT STATUS section. This
value is only available for stopped/completed downloads.
followedBy::
List of GIDs which are generated by the consequence of this
download. For example, when aria2 downloaded Metalink file, it
generates downloads described in it(see *--follow-metalink*
option). This value is useful to track these auto generated
downloads. If there is no such downloads, this key will not
be included in the response.
belongsTo::
GID of a parent download. Some downloads are a part of another
download. For example, if a file in Metalink has BitTorrent
resource, the download of .torrent is a part of that file. If this
download has no parent, this key will not be included in the
response.
*aria2.getUris* 'gid'
This method returns URIs used in the download denoted by 'gid'. 'gid'