1
0
mirror of https://github.com/moparisthebest/wget synced 2024-07-03 16:38:41 -04:00

Document exit codes.

This commit is contained in:
Micah Cowan 2009-08-27 23:57:09 -07:00
parent b014f8fae9
commit 4198c7239f
3 changed files with 117 additions and 53 deletions

View File

@ -1,3 +1,9 @@
2009-08-27 Micah Cowan <micah@cowan.name>
* texi2pod.pl: Handle @asis in table-element formatting.
* wget.texi (Exit Status): Document new exit codes.
2009-08-02 Micah Cowan <micah@cowan.name> 2009-08-02 Micah Cowan <micah@cowan.name>
* wget.texi (Option Syntax): "This is a complete equivalent of" -> * wget.texi (Option Syntax): "This is a complete equivalent of" ->

View File

@ -288,8 +288,13 @@ while(<$inf>) {
/^\@itemx?\s*(.+)?$/ and do { /^\@itemx?\s*(.+)?$/ and do {
if (defined $1) { if (defined $1) {
my $thing = $1;
if ($ic =~ /\@asis/) {
$_ = "\n=item $thing\n";
} else {
# Entity escapes prevent munging by the <> processing below. # Entity escapes prevent munging by the <> processing below.
$_ = "\n=item $ic\&LT;$1\&GT;\n"; $_ = "\n=item $ic\&LT;$thing\&GT;\n";
}
} else { } else {
$_ = "\n=item $ic\n"; $_ = "\n=item $ic\n";
$ic =~ y/A-Ya-y/B-Zb-z/; $ic =~ y/A-Ya-y/B-Zb-z/;
@ -309,11 +314,12 @@ die "No filename or title\n" unless defined $fn && defined $tl;
$sects{NAME} = "$fn \- $tl\n"; $sects{NAME} = "$fn \- $tl\n";
$sects{FOOTNOTES} .= "=back\n" if exists $sects{FOOTNOTES}; $sects{FOOTNOTES} .= "=back\n" if exists $sects{FOOTNOTES};
for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT FILES for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT EXITSTATUS
BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) { FILES BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
if(exists $sects{$sect}) { if(exists $sects{$sect}) {
$head = $sect; $head = $sect;
$head =~ s/SEEALSO/SEE ALSO/; $head =~ s/SEEALSO/SEE ALSO/;
$head =~ s/EXITSTATUS/EXIT STATUS/;
print "=head1 $head\n\n"; print "=head1 $head\n\n";
print scalar unmunge ($sects{$sect}); print scalar unmunge ($sects{$sect});
print "\n"; print "\n";

View File

@ -98,7 +98,7 @@ Info entry for @file{wget}.
* Examples:: Examples of usage. * Examples:: Examples of usage.
* Various:: The stuff that doesn't fit anywhere else. * Various:: The stuff that doesn't fit anywhere else.
* Appendices:: Some useful references. * Appendices:: Some useful references.
* Copying this manual:: You may give out copies of Wget and of this manual. * Copying this manual:: You may give out copies of this manual.
* Concept Index:: Topics covered by this manual. * Concept Index:: Topics covered by this manual.
@end menu @end menu
@ -246,6 +246,7 @@ the command line.
* FTP Options:: * FTP Options::
* Recursive Retrieval Options:: * Recursive Retrieval Options::
* Recursive Accept/Reject Options:: * Recursive Accept/Reject Options::
* Exit Status::
@end menu @end menu
@node URL Format, Option Syntax, Invoking, Invoking @node URL Format, Option Syntax, Invoking, Invoking
@ -1935,7 +1936,7 @@ If, for whatever reason, you want strict comment parsing, use this
option to turn it on. option to turn it on.
@end table @end table
@node Recursive Accept/Reject Options, , Recursive Retrieval Options, Invoking @node Recursive Accept/Reject Options, Exit Status, Recursive Retrieval Options, Invoking
@section Recursive Accept/Reject Options @section Recursive Accept/Reject Options
@table @samp @table @samp
@ -2030,6 +2031,57 @@ This is a useful option, since it guarantees that only the files
@c man end @c man end
@node Exit Status, , Recursive Accept/Reject Options, Invoking
@section Exit Status
@c man begin EXITSTATUS
Wget may return one of several error codes if it encounters problems.
@table @asis
@item 0
No problems occurred.
@item 1
Generic error code.
@item 2
Parse error---for instance, when parsing command-line options, the
@samp{.wgetrc} or @samp{.netrc}...
@item 3
File I/O error.
@item 4
Network failure.
@item 5
SSL verification failure.
@item 6
Username/password authentication failure.
@item 7
Protocol errors.
@item 8
Server issued an error response.
@end table
With the exceptions of 0 and 1, the lower-numbered exit codes take
precedence over higher-numbered ones, when multiple types of errors
are encountered.
In versions of Wget prior to 1.12, Wget's exit status tended to be
unhelpful and inconsistent. Recursive downloads would virtually always
return 0 (success), regardless of any issues encountered, and
non-recursive fetches only returned the status corresponding to the
most recently-attempted download.
@c man end
@node Recursive Download, Following Links, Invoking, Top @node Recursive Download, Following Links, Invoking, Top
@chapter Recursive Download @chapter Recursive Download
@cindex recursion @cindex recursion