'\" t
.\"     Title: bantool-ratbox
.\"    Author: Marc `Duck` Dequènes <Duck@DuckCorp.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 2011-11-07
.\"    Manual: System Administration Commands
.\"    Source: ircd ratbox
.\"  Language: English
.\"
.TH "BANTOOL\-RATBOX" "8" "2011\-11\-07" "ircd ratbox" "System Administration Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bantool-ratbox \- Tool used to manage the ban database of the ratbox ircd server\&.
.SH "SYNOPSIS"
.HP \w'\fBbantool\-ratbox\fR\ 'u
\fBbantool\-ratbox\fR \fB\-h\fR
.HP \w'\fBbantool\-ratbox\fR\ 'u
\fBbantool\-ratbox\fR \fB\-i\fR [\fB\-f\fR\ DBFILE] [\fB\-s\fR] [\fB\-p\fR] [\fB\-d\fR] [\fB\-w\fR] [\fB\-v\fR] [OLDCONFDIR]
.HP \w'\fBbantool\-ratbox\fR\ 'u
\fBbantool\-ratbox\fR \fB\-e\fR [\fB\-f\fR\ DBFILE] [\fB\-s\fR] [\fB\-v\fR] [OLDCONFDIR]
.HP \w'\fBbantool\-ratbox\fR\ 'u
\fBbantool\-ratbox\fR \fB\-u\fR [\fB\-f\fR\ DBFILE] [\fB\-s\fR] [\fB\-v\fR]
.SH "DESCRIPTION"
.PP
\fBbantool\-ratbox\fR
is a tool used to import, export, and update the ban database\&. The import/export operation is useful when migrating from an old ircd ratbox server\&. It can also be used to redistribute ban lists and create backups\&. The upgrade operation should be done whenever the ircd server is upgraded\&.
.SH "OPTIONS"
.PP
\fB\-h\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-i\fR
.RS 4
Import the (old) configuration files into the database\&.
.RE
.PP
\fB\-e\fR
.RS 4
Export the database content into configuration files\&.
.RE
.PP
\fB\-u\fR
.RS 4
Upgrade the database\&.
.RE
.PP
\fB\-f\fR \fIDBFILE\fR
.RS 4
Set the database file (defaults to /etc/ircd\-ratbox/ban\&.db)\&.
.RE
.PP
\fB\-s\fR
.RS 4
Reclaim empty slack space the database may be taking up\&.
.RE
.PP
\fB\-p\fR
.RS 4
Dry run, checking configuration, but without touching the database\&.
.RE
.PP
\fB\-d\fR
.RS 4
Allow redondant entries (unlike what the help screen pretends)\&.
.RE
.PP
\fB\-w\fR
.RS 4
Completely wipe the database before importing\&.
.RE
.PP
\fB\-v\fR
.RS 4
Verbose mode (only useful for debugging)\&.
.RE
.PP
\fIOLDCONFDIR\fR
.RS 4
Set the (old) configuration directory (defaults to /etc/ircd\-ratbox)\&.
.RE
.SH "AUTHOR"
.PP
\fBMarc `Duck` Dequènes\fR <\&Duck@DuckCorp\&.org\&>
.RS 4
Original author\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 Marc Dequènes (Duck)
.br
.PP
This manual page was written 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 3 or any later version published by the Free Software Foundation\&.
.PP
On
Debian
systems, the complete text of the GNU General Public License version 3 can be found in /usr/share/common\-licenses/GPL\-3\&.
.sp