.\"     Title: bbackupctl
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 03/28/2023
.\"    Manual: Box Backup
.\"    Source: Box Backup 0.11
.\"
.TH "BBACKUPCTL" "8" "03/28/2023" "Box Backup 0\.11" "Box Backup"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
bbackupctl - Control the Box Backup client daemon
.SH "SYNOPSIS"
.HP 11
\fBbbackupctl\fR [\-q] [\-c\ config\-file] command
.SH "DESCRIPTION"
.PP
\fBbbackupctl\fR
sends commands to a running
\fBbbackupd\fR
daemon on a client machine\. It can be used to force an immediate backup, tell the daemon to reload its configuration files or stop the daemon\. If
\fBbbackupd\fR
is configured in snapshot mode, it will not back up automatically, and the
\fBbbackupctl\fR
must be used to tell it when to start a backup\.
.PP
Communication with the bbackupd daemon takes place over a local socket (not over the network)\. Some platforms (notably Windows) can\(aqt determine if the user connecting on this socket has the correct credentials to execute the commands\. On these platforms, ANY local user can interfere with bbackupd\. To avoid this, remove the CommandSocket option from bbackupd\.conf, which will also disable bbackupctl\. See the Client Configuration page for more information\.
.PP
\fBbbackupctl\fR
needs to read the
\fBbbackupd\fR
configuration file to find out the name of the CommandSocket\. If you have to tell
\fBbbackupd\fR
where to find the configuration file, you will have to tell
\fBbbackupctl\fR
as well\. The default on Unix systems is usually
\fI/etc/box/bbackupd\.conf\fR\. On Windows systems, it is
\fIbbackupd\.conf\fR
in the same directory where
\fBbbackupd\.exe\fR
is located\. If
\fBbbackupctl\fR
cannot find or read the configuration file, it will log an error message and exit\.
.PP
\fBbbackupctl\fR
usually writes error messages to the console and the system logs\. If it is not doing what you expect, please check these outputs first of all\.
.PP
\fB\-q\fR
.RS 4
Run in quiet mode\.
.RE
.PP
\fB\-c\fR config\-file
.RS 4
Specify configuration file\.
.RE
.SS "Commands"
.PP
The following commands are available in bbackupctl:
.PP
\fBterminate\fR
.RS 4
This command cleanly shuts down
\fBbbackupd\fR\. This is better than killing or terminating it any other way\.
.RE
.PP
\fBreload\fR
.RS 4
Causes the
\fBbbackupd\fR
daemon to re\-read all its configuration files\. Equivalent to
\fBkill \-HUP\fR\.
.RE
.PP
\fBsync\fR
.RS 4
Initiates a backup\. If no files need to be backed up, no connection will be made to the server\.
.RE
.PP
\fBforce\-sync\fR
.RS 4
Initiates a backup, even if the
\fISyncAllowScript\fR
says that no backup should run now\.
.RE
.PP
\fBwait\-for\-sync\fR
.RS 4
Passively waits until the next backup starts of its own accord, and then terminates\.
.RE
.PP
\fBwait\-for\-end\fR
.RS 4
Passively waits until the next backup starts of its own accord and finishes, and then terminates\.
.RE
.PP
\fBsync\-and\-wait\fR
.RS 4
Initiates a backup, waits for it to finish, and then terminates\.
.RE
.SH "FILES"
.PP
\fI/etc/box/bbackupd\.conf\fR
.SH "SEE ALSO"
.PP
\fBbbackupd.conf\fR(5),
\fBbbackupd-config\fR(8),
\fBbbackupctl\fR(8)
.SH "AUTHORS"
.PP
Ben Summers
.PP
Per Thomsen
.PP
James O\(aqGorman