NAME
hellanzb - a nzb downloader and post processor
SYNOPSIS
hellanzb [options] [remote-call] [remote-call-options]
DESCRIPTION
Python application designed for *nix environments that retrieves nzb
files and fully processes them. The goal being to make getting files
from Usenet as hands-free as possible. Once fully installed, all thats
required is moving an nzb file to the queue directory. The rest;
fetching, par-checking, un-raring, etc. is taken care of by hellanzb.
OPTIONS
hellanzb will by default (no remote-call specified) start its one and
only queue daemon. Specifying a remote call will attempt to talk to
that already running queue daemon via XML-RPC.
remote-calls (via XML-RPC):
cancel Cancel the current download and move the current NZB to
Hellanzb.TEMP_DIR
clear Clear the current nzb queue. Specify True as the second argument
to clear anything currently downloading as well (like the cancel
call)
continue
Continue downloading after being paused
dequeue nzbid
Remove the NZB with specified ID from the queue
down nzbid [shift]
Move the NZB with the specified ID down in the queue. The
optional second argument specifies the number of spaces to shift
by (Default: 1)
enqueue nzbfile
Add the specified NZB file to the end of the queue
enqueuenewzbin nzbid
Download the NZB with the specified NZB ID from www.newzbin.com,
and enqueue it
force nzbid
Force hellanzb to begin downloading the NZB with the specified
ID immediately, interrupting the current download
last nzbid
Move the NZB with the specified ID to the end of the queue
list [excludeids]
List the NZBs in the queue, along with their NZB IDs. Specify
True as the second argument to exclude the NZB ID in the listing
maxrate [newrate]
Return the Hellanzb.MAX_RATE (maximum download rate) value.
Specify a second argument to change the value -- a value of zero
denotes no maximum rate
move nzbid index
Move the NZB with the specified ID to the specified index in the
queue
next nzbid
Move the NZB with the specified ID to the beginning of the queue
pause Pause downloading
process archivedir
Post process the specified directory. The -p option is
preferable -- it will do this for you, or use the current
process if this XML-RPC call fails
setrarpass nzbid pass Set the rarPassword for the NZB with the
specified ID
shutdown
Shutdown hellanzb. Will quietly kill any post processing threads
that may exist
status Return hellanzb’s current status text
up nzbid [shift]
Move the NZB with the specified ID up in the queue. The optional
second argument specifies the number of spaces to shift by
(Default: 1)
options:
--version
show program’s version number and exit
-h, --help
show this help message and exit
-c CONFIGFILE, --config=CONFIGFILE
specify the configuration file
-l LOGFILE, --log-file=LOGFILE
specify the log file (overwrites the Hellanzb.LOG_FILE config
file setting)
-d DEBUGLOGFILE, --debug-file=DEBUGLOGFILE
specify the debug log file (turns on debugging output/overwrites
the Hellanzb.DEBUG_MODE config file setting)
-D, --daemon
run hellanzb as a daemon process (fork and exit)
-p POSTPROCESSDIR, --post-process-dir=POSTPROCESSDIR
post-process the specified nzb archive dir either in an already
running hellanzb (via xmlrpc) if one is available, otherwise in
the current process. then exit
-P RARPASSWORD, --rar-password=RARPASSWORD
when used with the -p option, specifies the nzb archive’s rar
password
-L, --local-post-process
when used with the -p option, do the post processing work in the
current process (do not attempt to contact an already running
queue daemon)
-r RPCSERVER, --rpc-server=RPCSERVER
specify the rpc server hostname (overwrites
Hellanzb.XMLRPC_SERVER config file setting)
-s RPCPASSWORD, --rpc-password=RPCPASSWORD
specify the rpc server password (overwrites
Hellanzb.XMLRPC_PASSWORD config file setting)
-t RPCPORT, --rpc-port=RPCPORT
specify the rpc server port (overwrites Hellanzb.XMLRPC_PORT
config file setting)
FILES
$HOME/.hellanzb/hellanzb.conf
User specific configuration file.
/etc/hellanzb.conf
Default configuration file for all users (will be overrided by
the file above).
AUTHOR
This manual page was written by Adam Cecile <gandalf@le-vert.net> for
the Debian system (but may be used by others). Permission is granted
to copy, distribute and/or modify this document under the terms of the
GNU General Public License, Version 2 or any later version published by
the Free Software Foundation On Debian systems, the complete text of
the GNU General Public License can be found in /usr/share/common-
licenses/GPL.
SEE ALSO
Homepage: http://www.hellanzb.com/