diff --git a/ChangeLog b/ChangeLog index 9f0f65f1..018f4a3b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-07-11 Tatsuhiro Tsujikawa + + Documented getVersion in man page. + * doc/aria2c.1.txt + 2009-07-11 Tatsuhiro Tsujikawa Documented type of offset and num for tellWaiting xml-rpc method. diff --git a/doc/aria2c.1 b/doc/aria2c.1 index f13a834c..6625b5e2 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -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\&. diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index deba33fb..558c9357 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -2744,6 +2744,27 @@ method returns "OK" for success.

aria2.purgeDownloadResult

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

In case of error, aria2 returns faultCode=1 and the error message in faultString.

@@ -3196,7 +3217,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index ff73bead..79afb903 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -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 ~~~~~~~~~~~~~~