summaryrefslogtreecommitdiff
path: root/debian/bbackupctl.8
diff options
context:
space:
mode:
Diffstat (limited to 'debian/bbackupctl.8')
-rw-r--r--debian/bbackupctl.881
1 files changed, 81 insertions, 0 deletions
diff --git a/debian/bbackupctl.8 b/debian/bbackupctl.8
new file mode 100644
index 00000000..17568448
--- /dev/null
+++ b/debian/bbackupctl.8
@@ -0,0 +1,81 @@
+.\" 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 bbackupctl 8 "Oct 9, 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
+bbackupctl \- control command of the client daemon of the Box Backup system
+.SH SYNOPSIS
+.B bbackupctl
+.RI "[-q] [-c config_file] command"
+.SH DESCRIPTION
+This manual page documents briefly the
+.B bbackupctl
+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.
+\fbbbackupctl\fP can be used to send commands to the client daemon of the Box
+Backup system.
+.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 command
+.RS
+.TP
+.B sync
+Start the synchronization with the remote store. The goal is mainly to
+implement snapshot mode backup. When the daemon is configured to run is
+this mode, this command is used to launch the synchronization via a cron job.
+.TP
+.B force-sync
+Force the start of the synchronization with the remote store, even if
+the return value of the script indicated by the config file parameter
+SyncAllowScript says not to run the sync.
+.TP
+.B reload
+Tell the daemon to reload its configuration file.
+.TP
+.B terminate
+Terminate the daemon.
+.TP
+.B wait-for-sync
+Wait until the next synchronization start, then exit the command. With this you
+can obtain a synchronous backup, when the command exits you know that the
+remote store is in sync with your local data (be careful that recently
+modified files will not be immediatly uploaded to the store, see MinimumFileAge
+and MaxUploadWait config file parameters).
+.SH FILES
+.TP
+.I /etc/boxbackup/bbackupd.conf
+Default configuration file for bbackupctl.
+.SH SEE ALSO
+.BR bbackupd (8),
+.BR bbackupquery (8),
+.BR bbackupd-config (8).
+.br
+.SH AUTHOR
+This manual page was written by Jérôme Schell <jerome@myreseau.org>
+(with the help of the online documentation located at
+http://www.fluffy.co.uk/boxbackup/)
+for the Debian GNU/Linux system (but may be used by others).