.\" Copyright (c) 2010, Stefano Rivera
.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
.TH IBID-DB "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
.SH NAME
ibid-db \- Database management utility for Ibid
.SH SYNOPSIS
.B ibid-db command
.RI [ options ...]
.SH DESCRIPTION
This utility is for offline management of your Ibid bot's database.
Used for import, export, and upgrades.
.P
The export format is DBMS-agnostic and can be used to migrate between different
databases.
.SH COMMANDS
.TP
\fB\-e\fR \fIFILE\fR, \fB\-\-export\fR=\fIFILE\fR
Export DB contents to \fIFILE\fR.
Export format is JSON.
.IP
FILE can be \fB\-\fR for stdin/stdout or can end in \fB.gz\fR for automatic
gzip compression.
.TP
\fB\-i\fR \fIFILE\fR, \fB\-\-import\fR=\fIFILE\fR
Import DB contents from \fIFILE\fR as exported by this utility.
.IP
FILE can be \fB\-\fR for stdin/stdout or can end in \fB.gz\fR for automatic
gzip compression.
.IP
.B Note:
The DB must be empty first.
.TP
\fB\-u\fR, \fB\-\-upgrade\fR
Upgrade DB schema to the latest version.
You need to run this after upgrading your bot.
.IP
.B Note:
You should backup first.
.SH OPTIONS
.TP
\fB\-\-version\fR
Show the program's version and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show a help message and exit.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Turn on debugging output to stderr.
.SH FILES
.TP
.I ibid.ini
Locates the database to act upon by looking for the \fB[databases].ibid\fR value
in the bot configuration file in the current directory.
.SH SEE ALSO
.BR ibid (1),
.BR ibid.ini (5),
.BR ibid-setup (1),
.UR http://ibid.omnia.za.net/
.BR http://ibid.omnia.za.net/