Name

bbackupctl — Control the bbackupd daemon

Synopsis

bbackupctl [-q] [-c config-file] command

Description

bbackupctl lets the user control the bbackupd daemon on a client machine. The main use is to force a sync with the store server. This is especially important if bbackupd(8) is configured to do snapshot backups. In that case bbackupctl is the only way to effect a backup.

Communication with the bbackupd daemon takes place over a local socket. Some platforms (notably Windows) can't determine if the user connecting on this socket has the correct credentials to execute the commands, leaving a rather sizeable security hole open. To avoid this, unset the CommandSocket parameter in bbackupd.conf(5). That disables the command socket, so bbackupd is secure. This does, however, render bbackupctl unusable.

Options

  • -q -- quiet. Do not output status messages.

  • -c config_file -- Use a different config file from the default one. Can be a full or a relative path.

Commands

The following commands are available in bbackupctl:

  • terminate

    This command stops the bbackupd server. This is the equivalent of killing (kill -KILL) the bbackupd process.

  • reload

    Causes the bbackupd daemon to re-read all its configuration files. Equivalent to kill -HUP.

  • sync

    Initiates a backup to the store of whatever needs to be backed up.

Author

Ben Summers and contributors. For help, please go to the Wiki, or subscribe to the Box Backup mailing list.

See Also

bbackupd.conf(5)

bbackupd(8)

Files

bbackupctl uses the Box Backup client configuration file, usually located in /etc/box/bbackupd.conf. On Windows this file is usually located in the installation directory, and is named bbackupd.conf as well.

Bugs

If you find a bug in Box Backup, and you want to let us know about it, join the mailing list, and send a description of the problem there.

To report a bug, give us at least the following information:

  • The version of Box Backup you are running

  • The platform you are running on (Hardware and OS), for both client and server.

  • If possible attach your config files (bbstored.conf, bbackupd.conf) to the bug report.

  • Also attach any log file output that helps shed light on the problem you are seeing.

  • And last but certainly not least, a description of what you are seeing, in as much detail as possible.