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

Documented getVersion in man page.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-07-10 16:10:26 +00:00
parent e651cf6084
commit c0c12cdd81
4 changed files with 55 additions and 1 deletions

View File

@ -1,3 +1,8 @@
2009-07-11 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented getVersion in man page.
* doc/aria2c.1.txt
2009-07-11 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented type of offset and num for tellWaiting xml-rpc method.

View File

@ -2255,6 +2255,20 @@ This method changes global options dynamically\&. \fIoptions\fR is of type struc
\fBaria2\&.purgeDownloadResult\fR
.sp
This method purges completed/error/removed downloads to free memory\&. This method returns "OK"\&.
.sp
\fBaria2\&.getVersion\fR
.sp
This method returns version of the program and the list of enabled features\&. The response is of type struct and contains following keys\&.
.PP
version
.RS 4
Version number of the program in string\&.
.RE
.PP
enabledFeatures
.RS 4
List of enabled features\&. Each feature name is of type string\&.
.RE
.SS "Error Handling"
.sp
In case of error, aria2 returns faultCode=1 and the error message in faultString\&.

View File

@ -2744,6 +2744,27 @@ method returns "OK" for success.</p></div>
<div class="paragraph"><p><strong>aria2.purgeDownloadResult</strong></p></div>
<div class="paragraph"><p>This method purges completed/error/removed downloads to free memory.
This method returns "OK".</p></div>
<div class="paragraph"><p><strong>aria2.getVersion</strong></p></div>
<div class="paragraph"><p>This method returns version of the program and the list of enabled
features. The response is of type struct and contains following keys.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
version
</dt>
<dd>
<p>
Version number of the program in string.
</p>
</dd>
<dt class="hdlist1">
enabledFeatures
</dt>
<dd>
<p>
List of enabled features. Each feature name is of type string.
</p>
</dd>
</dl></div>
<h3 id="_error_handling">Error Handling</h3><div style="clear:left"></div>
<div class="paragraph"><p>In case of error, aria2 returns faultCode=1 and the error message in
faultString.</p></div>
@ -3196,7 +3217,7 @@ files in the program, then also delete it here.</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-07-11 00:50:11 JST
Last updated 2009-07-11 01:08:42 JST
</div>
</div>
</body>

View File

@ -1277,6 +1277,20 @@ method returns "OK" for success.
This method purges completed/error/removed downloads to free memory.
This method returns "OK".
*aria2.getVersion*
This method returns version of the program and the list of enabled
features. The response is of type struct and contains following keys.
version::
Version number of the program in string.
enabledFeatures::
List of enabled features. Each feature name is of type string.
Error Handling
~~~~~~~~~~~~~~