.\" man page for axelq .\" (C) 2001 Sjoerd Hemminga .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, but .\" WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU .\" General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program; if not, write to the Free Software .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 .\" USA .TH AXELQ 1 "May 10, 2003" axelq "Linux User Manuals" .SH NAME axelq \- A queue manager for the popular download accelerator axel .SH SYNOPSIS .BI "axelq [ \-f " "file " "] [ \-e " "url " "] [ \-r ] [ \-c ]" .SH DESCRIPTION .B axelq takes care of download queues for .BR axel "(1). " axel (1) is a small download accelerator. Small as it is, .BR axel (1) does not include support for queues. Queues are not really important to a download accelerator, since its main purpose is to speed up downloads. However it can be very useful to have queues. This is were .BR axelq " kicks in." .B axelq uses a file (the queue-file, by default .IR ~/.axelq ) to store URLs. When told, .B axelq will read a line and give it to .BR axel (1), which will initiate a download. When .BR axel (1) is done, .B axelq removes the download and fetches the next queue entry and feeds it to the accelerator. It continues to do so, until interrupted. When this happens, .B axelq detects so and will terminate as well. Note that 'interrupted' does not mean that .BR axel (1) detected an error. If it does, .B axelq will be notified and will take appropriate action, according to its settings. .B axelq configuration is stored in two files. .I /etc/axelq.rc and .IR ~/.axelqrc . These are small sh-shell scripts that .B axelq runs to get its settings. These settings are described in the Usage-section. .SH OPTIONS .TP .B \-f file Specifies the queue-file to use. Default is .IR ~/.axelq . .TP .B \-e url Enqueue url. url is put at the end of the queue. If you are not sure if url is in the queue or not, just enqueue it and clean .RB ( \-c ) it later. .TP .B \-r Run. This will initiate the downloads in the queue-file and will continue until it either is interrupted or all the downloads are completed. .TP .B \-c Clean the queue-file. This will sort the downloads in alphabetical order and then delete the doubles. It is probably not a good idea to use this if you prioritized your queue-file. .TP .B \-h, \-\-help Displays the command-line options. .TP .B \-v, \-\-version Outputs the version number of .BR axelq . .SH USAGE The configuration files .IR /etc/axelq.rc " and " ~/.axelqrc are in fact sh-shell scripts. .B axelq runs them to parse some settings. The order of importance is as follows (the lower settings override the higher ones): .TP 1. axelq defaults .TP 2. system-wide configuration .RI ( /etc/axelq.rc ) .TP 3. personal configuration .RI ( ~/.axelqrc ) .TP 4. command-line parameters .PP In the configuration files you can use the following settings to make life easier: .TP .BI qfile\= queue Where .I queue is the filename of the queue-file. .TP .BI failaction\= action .I action can be one of the following four words: ask remove move maintain. .B failaction tells axelq what to do if a download fails. remove deletes the file from the queue. move will put this download to the end of the queue, causing axelq to retry when all other downloads are done. maintain will make axelq leave the download where it is. This means that axelq will retry immediately. You can make axelq ask what to do every time it encounters an error, by specifying ask. .B IMPORTANT NOTE I highly recommend keeping this to its default, ask. maintain will cause axelq to keep trying until it succeeds. This sucks up unnecessary bandwidth if the download is not available. This is rude towards the maintainer of the server. move will work like maintain if there is only one download in the queue. So, please .B do NOT specify move or maintain as your default! .TP .BI command\= command .BR axelq " will run" .IR command " when it initiates a download." At installation time this is set to wherever axel was or to axel. You can add options to this, but remember to quote it. .SH FILES .I /etc/axelq.rc .br .I ~/.axelqrc .SH COPYRIGHT axelq is Copyright 2001-2003 James Budworth This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. axel is Copyright 2001-2003 Wilmer van der Gaast .br You can download axel at .SH REPORTING BUGS Please report bugs to .SH AUTHOR James Budworth .SH SEE ALSO .BR axel (1)