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

Documented exit codes.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-01-19 13:46:39 +00:00
parent ca2567f2a2
commit c38a2491a6
4 changed files with 189 additions and 3 deletions

View File

@ -1,3 +1,8 @@
2009-01-19 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented exit codes.
* doc/aria2c.1.txt
2009-01-18 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Added --bt-max-peers option to specify the maximum number of peers

View File

@ -1,11 +1,11 @@
.\" Title: aria2c
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" 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

View File

@ -2024,6 +2024,92 @@ no_proxy [DOMAIN,&#8230;]
</dd>
</dl></div>
</div>
<h2 id="_exit_codes">EXIT CODES</h2>
<div class="sectionbody">
<div class="para"><p>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.</p></div>
<div class="vlist"><dl>
<dt>
0
</dt>
<dd>
<p>
If all downloads are successful.
</p>
</dd>
<dt>
1
</dt>
<dd>
<p>
If an unknown error occurs.
</p>
</dd>
<dt>
2
</dt>
<dd>
<p>
If time out occurs.
</p>
</dd>
<dt>
3
</dt>
<dd>
<p>
If a resource is not found.
</p>
</dd>
<dt>
4
</dt>
<dd>
<p>
If aria2 sees the specfied number of "resource not found" error.
See <strong>--max-file-not-found</strong> option).
</p>
</dd>
<dt>
5
</dt>
<dd>
<p>
If a download aborts because download speed is too slow.
See <strong>--lowest-speed-limit</strong> option)
</p>
</dd>
<dt>
6
</dt>
<dd>
<p>
If network problem occurs.
</p>
</dd>
<dt>
7
</dt>
<dd>
<p>
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.
</p>
</dd>
</dl></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">An error occurred in a finished download will not be reported
as exit status.</td>
</tr></table>
</div>
</div>
<h2 id="_resources">RESOURCES</h2>
<div class="sectionbody">
<div class="para"><p>Project web site: <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a></p></div>
@ -2066,7 +2152,7 @@ files in the program, then also delete it here.</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-01-16 00:56:38 JST
Last updated 2009-01-19 22:45:44 JST
</div>
</div>
</body>

View File

@ -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/[]