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

Documented missing seeder in getPeers xml-rpc method.
	Documented uploadLength and numSeeders.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-06-06 14:42:24 +00:00
parent 9d910c47c2
commit 4dc9217bb6
4 changed files with 60 additions and 3 deletions

View File

@ -1,3 +1,9 @@
2009-06-06 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented missing seeder in getPeers xml-rpc method.
Documented uploadLength and numSeeders.
* doc/aria2c.1.txt
2009-06-06 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net> 2009-06-06 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Added uploadLength and numSeeders to the response of tellStatus Added uploadLength and numSeeders to the response of tellStatus

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.0 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.0 <http://docbook.sf.net/>
.\" Date: 05/31/2009 .\" Date: 06/06/2009
.\" Manual: [FIXME: manual] .\" Manual: [FIXME: manual]
.\" Source: [FIXME: source] .\" Source: [FIXME: source]
.\" Language: English .\" Language: English
.\" .\"
.TH "ARIA2C" "1" "05/31/2009" "[FIXME: source]" "[FIXME: manual]" .TH "ARIA2C" "1" "06/06/2009" "[FIXME: source]" "[FIXME: manual]"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * set default formatting .\" * set default formatting
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -2097,6 +2097,11 @@ completedLength
Completed length of this download in bytes\&. Completed length of this download in bytes\&.
.RE .RE
.PP .PP
uploadLength
.RS 4
Uploaded length of this download in bytes\&.
.RE
.PP
bitfield bitfield
.RS 4 .RS 4
Hexadecimal representation of the download progress\&. The highest bit corresponds to piece index 0\&. The set bits indicate the piece is available and unset bits indicate the piece is missing\&. The spare bits at the end are set to zero\&. Hexadecimal representation of the download progress\&. The highest bit corresponds to piece index 0\&. The set bits indicate the piece is available and unset bits indicate the piece is missing\&. The spare bits at the end are set to zero\&.
@ -2117,6 +2122,11 @@ infoHash
InfoHash\&. BitTorrent only\&. InfoHash\&. BitTorrent only\&.
.RE .RE
.PP .PP
numSeeders
.RS 4
The number of seeders the client has connected to\&. BitTorrent only\&.
.RE
.PP
pieceLength pieceLength
.RS 4 .RS 4
Piece length in bytes\&. Piece length in bytes\&.
@ -2212,6 +2222,11 @@ uploadSpeed
.RS 4 .RS 4
Upload speed(byte/sec) that this client uploads to the peer\&. Upload speed(byte/sec) that this client uploads to the peer\&.
.RE .RE
.PP
seeder
.RS 4
"true" is this client is a seeder\&. Otherwise "false"\&.
.RE
.sp .sp
\fBaria2\&.tellActive\fR \fBaria2\&.tellActive\fR
.sp .sp

View File

@ -2491,6 +2491,14 @@ completedLength
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
uploadLength
</dt>
<dd>
<p>
Uploaded length of this download in bytes.
</p>
</dd>
<dt class="hdlist1">
bitfield bitfield
</dt> </dt>
<dd> <dd>
@ -2526,6 +2534,14 @@ infoHash
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
numSeeders
</dt>
<dd>
<p>
The number of seeders the client has connected to. BitTorrent only.
</p>
</dd>
<dt class="hdlist1">
pieceLength pieceLength
</dt> </dt>
<dd> <dd>
@ -2678,6 +2694,14 @@ uploadSpeed
Upload speed(byte/sec) that this client uploads to the peer. Upload speed(byte/sec) that this client uploads to the peer.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
seeder
</dt>
<dd>
<p>
"true" is this client is a seeder. Otherwise "false".
</p>
</dd>
</dl></div> </dl></div>
<div class="paragraph"><p><strong>aria2.tellActive</strong></p></div> <div class="paragraph"><p><strong>aria2.tellActive</strong></p></div>
<div class="paragraph"><p>This method returns the list of active downloads. The respose is of <div class="paragraph"><p>This method returns the list of active downloads. The respose is of
@ -3148,7 +3172,7 @@ files in the program, then also delete it here.</p></div>
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2009-05-31 22:30:09 JST Last updated 2009-06-06 23:28:59 JST
</div> </div>
</div> </div>
</body> </body>

View File

@ -1107,6 +1107,10 @@ completedLength::
Completed length of this download in bytes. Completed length of this download in bytes.
uploadLength::
Uploaded length of this download in bytes.
bitfield:: bitfield::
Hexadecimal representation of the download progress. The highest bit Hexadecimal representation of the download progress. The highest bit
@ -1126,6 +1130,10 @@ infoHash::
InfoHash. BitTorrent only. InfoHash. BitTorrent only.
numSeeders::
The number of seeders the client has connected to. BitTorrent only.
pieceLength:: pieceLength::
Piece length in bytes. Piece length in bytes.
@ -1216,6 +1224,10 @@ uploadSpeed::
Upload speed(byte/sec) that this client uploads to the peer. Upload speed(byte/sec) that this client uploads to the peer.
seeder::
"true" is this client is a seeder. Otherwise "false".
*aria2.tellActive* *aria2.tellActive*
This method returns the list of active downloads. The respose is of This method returns the list of active downloads. The respose is of