.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH bbackupquery 8 "Oct  10, 2005"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
bbackupquery \- utility to execute queries on a remote Box Backup store
.SH SYNOPSIS
.B bbackupquery
.RI "[-q] [-c config_file] [commands...]"
.SH DESCRIPTION
This manual page documents briefly the
.B bbackupquery
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fbbbackupquery\fP can be used to perform operation on a remote Box Backup
store. It can naviguate through the remote store tree, list or retrieve last
or old revisions of files and directories, get quota usage for the account
and compare remote and local data.
.SH OPTIONS
.TP
.B -q
Run in quiet mode. Reduce the output of the program.
.TP
.B -c config_file
Use an alternate configuration file instead of the default one.
.TP
.B commands
Commands to run on the server. If no command is specified, bbackupquery
will enter interactive mode where commands can be entered at the prompt.
In interactive mode, issuing "help [command]" will display additionnal
options supported by each command.
.sp 1
Available commands are:
.RS
.TP
.B list, ls
Display a listing of files and directories of the current working directory.
.TP
.B cd
Change directory in the remote tree.
.TP
.B pwd
Print current remote directory.
.TP
.B lcd
Change directory in the local tree.
.TP
.B sh
Execute a shell command on the local side.
.TP
.B get
Retrieve a file from the store to the local filesystem.
.TP
.B restore
Restore a directory from the remote store to the local filesystem.
.TP
.B compare
Compare the remote current data with local data.
.TP
.B getobject
For debuging purpose only. Retrieve an object from the store in its raw form.
.TP
.B usage
Display usage statistics on the store for the current account.
.TP
.B quit
Disconnect from the store and exit the program.
.SH SEE ALSO
.BR bbackupd (8),
.BR bbackupd-config (8),
.BR bbackupctl (8).
.br
.SH AUTHOR
This manual page was written by J\['e]r\[^o]me Schell <jerome@myreseau.org>
(with the help of the online documentation located at
http://www.boxbackup.org/)
for the Debian GNU/Linux system (but may be used by others).