From c38a2491a68a3ac303bed6570f1072fc7ce684b2 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Mon, 19 Jan 2009 13:46:39 +0000 Subject: [PATCH] 2009-01-19 Tatsuhiro Tsujikawa Documented exit codes. * doc/aria2c.1.txt --- ChangeLog | 5 +++ doc/aria2c.1 | 58 +++++++++++++++++++++++++++++-- doc/aria2c.1.html | 88 ++++++++++++++++++++++++++++++++++++++++++++++- doc/aria2c.1.txt | 41 ++++++++++++++++++++++ 4 files changed, 189 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index dbe307bd..d62afff9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-01-19 Tatsuhiro Tsujikawa + + Documented exit codes. + * doc/aria2c.1.txt + 2009-01-18 Tatsuhiro Tsujikawa Added --bt-max-peers option to specify the maximum number of peers diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 85108dab..83f33209 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -1,11 +1,11 @@ .\" Title: aria2c .\" Author: .\" Generator: DocBook XSL Stylesheets v1.73.2 -.\" Date: 01/16/2009 +.\" Date: 01/19/2009 .\" Manual: .\" Source: .\" -.TH "ARIA2C" "1" "01/16/2009" "" "" +.TH "ARIA2C" "1" "01/19/2009" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -1578,6 +1578,60 @@ Specify comma\-separated hostname or domains to which proxy should not be used\& \fB\-\-no\-proxy\fR overrides this value\&. .RE +.SH "EXIT CODES" +Because aria2 can handle multiple downloads at once, it encounters lots of errors in a session\&. aria2 returns the following exit codes based on the last error encountered\&. +.PP +0 +.RS 4 +If all downloads are successful\&. +.RE +.PP +1 +.RS 4 +If an unknown error occurs\&. +.RE +.PP +2 +.RS 4 +If time out occurs\&. +.RE +.PP +3 +.RS 4 +If a resource is not found\&. +.RE +.PP +4 +.RS 4 +If aria2 sees the specfied number of "resource not found" error\&. See +\fB\-\-max\-file\-not\-found\fR +option)\&. +.RE +.PP +5 +.RS 4 +If a download aborts because download speed is too slow\&. See +\fB\-\-lowest\-speed\-limit\fR +option) +.RE +.PP +6 +.RS 4 +If network problem occurs\&. +.RE +.PP +7 +.RS 4 +If there are unfinished downloads\&. This error is only reported if all finished downloads are successful and there are unfinished downloads in a queue when aria2 exits by pressing Ctrl\-C by an user or sending TERM or INT signal\&. +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +Note +An error occurred in a finished download will not be reported as exit status\&. +.sp .SH "RESOURCES" Project web site: http://aria2\&.sourceforge\&.net/ .sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 32a842f5..2352c8ad 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -2024,6 +2024,92 @@ no_proxy [DOMAIN,…] +

EXIT CODES

+
+

Because aria2 can handle multiple downloads at once, it encounters +lots of errors in a session. aria2 returns the following exit codes +based on the last error encountered.

+
+
+0 +
+
+

+ If all downloads are successful. +

+
+
+1 +
+
+

+ If an unknown error occurs. +

+
+
+2 +
+
+

+ If time out occurs. +

+
+
+3 +
+
+

+ If a resource is not found. +

+
+
+4 +
+
+

+ If aria2 sees the specfied number of "resource not found" error. + See --max-file-not-found option). +

+
+
+5 +
+
+

+ If a download aborts because download speed is too slow. + See --lowest-speed-limit option) +

+
+
+6 +
+
+

+ If network problem occurs. +

+
+
+7 +
+
+

+ If there are unfinished downloads. This error is only reported if + all finished downloads are successful and there are unfinished + downloads in a queue when aria2 exits by pressing Ctrl-C by an user + or sending TERM or INT signal. +

+
+
+
+ + + +
+
Note
+		An error occurred in a finished download will not be reported +as exit status.
+
+

RESOURCES

Project web site: http://aria2.sourceforge.net/

@@ -2066,7 +2152,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index b9b31c68..7bd507fc 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -1018,6 +1018,47 @@ no_proxy [DOMAIN,...]:: Overrides no-proxy value in configuration file. The command-line option *--no-proxy* overrides this value. +EXIT CODES +---------- + +Because aria2 can handle multiple downloads at once, it encounters +lots of errors in a session. aria2 returns the following exit codes +based on the last error encountered. + +0:: + If all downloads are successful. + +1:: + If an unknown error occurs. + +2:: + If time out occurs. + +3:: + If a resource is not found. + +4:: + If aria2 sees the specfied number of "resource not found" error. + See *--max-file-not-found* option). + +5:: + If a download aborts because download speed is too slow. + See *--lowest-speed-limit* option) + +6:: + If network problem occurs. + +7:: + If there are unfinished downloads. This error is only reported if + all finished downloads are successful and there are unfinished + downloads in a queue when aria2 exits by pressing Ctrl-C by an user + or sending TERM or INT signal. + +[NOTE] +An error occurred in a finished download will not be reported +as exit status. + + RESOURCES --------- Project web site: http://aria2.sourceforge.net/[]