| 1 |
.\"
|
| 2 |
.\"man-page for Axel
|
| 3 |
.\"
|
| 4 |
.\"Derived from the man-page example in the wonderful book called Beginning
|
| 5 |
.\"Linux Programming, written by Richard Stone and Neil Matthew.
|
| 6 |
.\"
|
| 7 |
.TH AXEL 1
|
| 8 |
|
| 9 |
.SH NAME
|
| 10 |
\fBAxel\fP \- A light download accelerator for Linux.
|
| 11 |
|
| 12 |
.SH SYNOPSIS
|
| 13 |
.B axel
|
| 14 |
[\fIOPTIONS\fP] \fIurl1\fP [\fIurl2\fP] [\fIurl...\fP]
|
| 15 |
|
| 16 |
.SH DESCRIPTION
|
| 17 |
Axel is a program that downloads a file from a FTP or HTTP server through
|
| 18 |
multiple connection, each connection downloads its own part of the file.
|
| 19 |
|
| 20 |
Unlike most other programs, Axel downloads all the data directly to the
|
| 21 |
destination file, using one single thread. It just saves some time at the
|
| 22 |
end because the program doesn't have to concatenate all the downloaded
|
| 23 |
parts.
|
| 24 |
|
| 25 |
.SH OPTIONS
|
| 26 |
.PP
|
| 27 |
One argument is required, the URL to the file you want to download. When
|
| 28 |
downloading from FTP, the filename may contain wildcards and the program
|
| 29 |
will try to resolve the full filename. Multiple URL's can be specified
|
| 30 |
as well and the program will use all those URL's for the download. Please
|
| 31 |
note that the program does not check whether the files are equal.
|
| 32 |
|
| 33 |
.PP
|
| 34 |
Other options:
|
| 35 |
|
| 36 |
.TP
|
| 37 |
\fB\-\-max\-speed=x\fP, \fB\-s\ x\fP
|
| 38 |
You can specify a speed (bytes per second) here and Axel will try
|
| 39 |
to keep the average speed around this speed. Useful if you don't want
|
| 40 |
the program to suck up all of your bandwidth.
|
| 41 |
|
| 42 |
.TP
|
| 43 |
\fB\-\-num\-connections=x\fP, \fB\-n\ x\fP
|
| 44 |
You can specify an alternative number of connections here.
|
| 45 |
|
| 46 |
.TP
|
| 47 |
\fB\-\-output=x\fP, \fB\-o\ x\fP
|
| 48 |
Downloaded data will be put in a local file with the same name,
|
| 49 |
unless you specify a different name using this option. You can
|
| 50 |
specify a directory as well, the program will append the filename.
|
| 51 |
|
| 52 |
.TP
|
| 53 |
\fB\-\-search[=x]\fP, \fB-S[x]\fP
|
| 54 |
Axel can do a search for mirrors using the filesearching.com search
|
| 55 |
engine. This search will be done if you use this option. You can specify how
|
| 56 |
many different mirrors should be used for the download as well.
|
| 57 |
|
| 58 |
The search for mirrors can be time\-consuming because the program tests
|
| 59 |
every server's speed, and it checks whether the file's still available.
|
| 60 |
|
| 61 |
.TP
|
| 62 |
\fB\-\-no\-proxy\fP, \fB\-N\fP
|
| 63 |
Don't use any proxy server to download the file. Not possible when a
|
| 64 |
transparent proxy is active somewhere, of course.
|
| 65 |
|
| 66 |
.TP
|
| 67 |
\fB\-\-verbose\fP
|
| 68 |
If you want to see more status messages, you can use this option. Use it
|
| 69 |
more than once if you want to see more.
|
| 70 |
|
| 71 |
.TP
|
| 72 |
\fB\-\-quiet\fP, \fB-q\fP
|
| 73 |
No output to stdout.
|
| 74 |
|
| 75 |
.TP
|
| 76 |
\fB\-\-alternate\fP, \fB-a\fP
|
| 77 |
This will show an alternate progress indicator. A bar displays the progress
|
| 78 |
and status of the different threads, along with current speed and an
|
| 79 |
estimate for the remaining download time.
|
| 80 |
|
| 81 |
.TP
|
| 82 |
\fB\-\-header=x\fP, \fB\-H\ x\fP
|
| 83 |
Add an additional HTTP header. This option should be in the form "Header:
|
| 84 |
Value". See RFC 2616 section 4.2 and 14 for details on the format and
|
| 85 |
standardized headers.
|
| 86 |
|
| 87 |
.TP
|
| 88 |
\fB\-\-user-agent=x\fP, \fB\-U\ x\fP
|
| 89 |
Set the HTTP user agent to use. Some websites serve different content based upon
|
| 90 |
this parameter. The default value will include "Axel", its version and the
|
| 91 |
platform.
|
| 92 |
|
| 93 |
.TP
|
| 94 |
\fB\-\-help\fP, \fB\-h\fP
|
| 95 |
A brief summary of all the options.
|
| 96 |
|
| 97 |
.TP
|
| 98 |
\fB\-\-version\fP, \fB\-V\fP
|
| 99 |
Get version information.
|
| 100 |
|
| 101 |
.SH NOTE
|
| 102 |
Long (double dash) options are supported only if your platform knows about
|
| 103 |
the getopt_long call. If it does not (like *BSD), only the short options can
|
| 104 |
be used.
|
| 105 |
|
| 106 |
.SH RETURN VALUE
|
| 107 |
The program returns 0 when the download was succesful, 1 if something really
|
| 108 |
went wrong and 2 if the download was interrupted. If something else comes back,
|
| 109 |
it must be a bug..
|
| 110 |
|
| 111 |
.SH EXAMPLES
|
| 112 |
.nf
|
| 113 |
axel ftp://ftp.{be,nl,uk,de}.kernel.org/pub/linux/kernel/v2.4/linux-2.4.17.tar.bz2
|
| 114 |
.fi
|
| 115 |
|
| 116 |
This will use the Belgian, Dutch, English and German kernel.org mirrors to
|
| 117 |
download a Linux 2.4.17 kernel image.
|
| 118 |
|
| 119 |
.nf
|
| 120 |
axel \-S4 ftp://ftp.kernel.org/pub/linux/kernel/v2.4/linux-2.4.17.tar.bz2
|
| 121 |
.fi
|
| 122 |
|
| 123 |
This will do a search for the linux-2.4.17.tar.bz2 file on filesearching.com
|
| 124 |
and it'll use the four (if possible) fastest mirrors for the download.
|
| 125 |
(Possibly including ftp.kernel.org)
|
| 126 |
|
| 127 |
(Of course, the commands are a single line, but they're too long to fit on
|
| 128 |
one line in this page.)
|
| 129 |
|
| 130 |
.SH FILES
|
| 131 |
.PP
|
| 132 |
\fI/etc/axelrc\fP System-wide configuration file
|
| 133 |
.PP
|
| 134 |
\fI~/.axelrc\fP Personal configuration file
|
| 135 |
.PP
|
| 136 |
These files are not documented in a man\-page, but the example file which
|
| 137 |
comes with the program contains enough information, I hope. The position
|
| 138 |
of the system-wide configuration file might be different.
|
| 139 |
|
| 140 |
.SH COPYRIGHT
|
| 141 |
Axel is Copyright 2001-2002 Wilmer van der Gaast.
|
| 142 |
|
| 143 |
.SH BUGS
|
| 144 |
Please report bugs at https://alioth.debian.org/tracker/?group_id=100070&atid=413085.
|
| 145 |
|
| 146 |
.SH AUTHORS
|
| 147 |
Wilmer van der Gaast. <wilmer@gaast.net>
|
Parent Directory
| 
Revision Log