Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

bbackupctl(8) [debian man page]

BBACKUPCTL(8)							    Box Backup							     BBACKUPCTL(8)

NAME

       bbackupctl - Control the Box Backup client daemon

SYNOPSIS

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

DESCRIPTION

       bbackupctl sends commands to a running bbackupd 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 bbackupd is configured in snapshot mode, it will not back up automatically, and the
       bbackupctl must be used to tell it when to start a backup.

       Communication with the bbackupd daemon takes place over a local socket (not over the network). Some platforms (notably Windows) can't
       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.

       bbackupctl needs to read the bbackupd configuration file to find out the name of the CommandSocket. If you have to tell bbackupd where to
       find the configuration file, you will have to tell bbackupctl as well. The default on Unix systems is usually /etc/box/bbackupd.conf. On
       Windows systems, it is bbackupd.conf in the same directory where bbackupd.exe is located. If bbackupctl cannot find or read the
       configuration file, it will log an error message and exit.

       bbackupctl 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.

       -q
	   Run in quiet mode.

       -c config-file
	   Specify configuration file.

   Commands
       The following commands are available in bbackupctl:

       terminate
	   This command cleanly shuts down bbackupd. This is better than killing or terminating it any other way.

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

       sync
	   Initiates a backup. If no files need to be backed up, no connection will be made to the server.

       force-sync
	   Initiates a backup, even if the SyncAllowScript says that no backup should run now.

       wait-for-sync
	   Passively waits until the next backup starts of its own accord, and then terminates.

       wait-for-end
	   Passively waits until the next backup starts of its own accord and finishes, and then terminates.

       sync-and-wait
	   Initiates a backup, waits for it to finish, and then terminates.

FILES

       /etc/box/bbackupd.conf

SEE ALSO

       bbackupd.conf(5), bbackupd-config(8), bbackupctl(8)

AUTHORS

       Ben Summers

       Per Thomsen

       James O'Gorman

Box Backup 0.11 						    10/28/2011							     BBACKUPCTL(8)

Check Out this Related Man Page

BBSTORED-CERTS(8)						    Box Backup							 BBSTORED-CERTS(8)

NAME

       bbstored-certs - Manage certificates for the Box Backup system

SYNOPSIS

       bbstored-certs certs-dir command [arguments]

DESCRIPTION

       bbstored-certs creates and signs certificates for use in Box Backup. It allows the user to create and sign the server keys, as well as
       signing client keys.

       All commands must be followed by the certs-dir, which is the directory in which the certificates are stored.

   Commands
       There are 3 commands:

       init
	   Create the certs-dir, and generate the server keys for bbstored.  certs-dir cannot exist before running the command.

       sign-server servercsrfile
	   Sign the server certificate. The servercsrfile is the file generated by the init command.

       sign clientcsrfile
	   Sign a client certificate. The clientcsrfile is generated during client setup. See bbackupd-config(8). Send the signed certificate back
	   to the client, and install according to the instructions given by bbackupd-config.

FILES

       raidfile-config(8) generates the raidfile.conf(5) file.

BUGS

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

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

       o   The version of Box Backup you are running

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

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

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

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

SEE ALSO

       bbstored-config(8), bbstored.conf(5), bbstoreaccounts(8)

AUTHORS

       Ben Summers

       Per Thomsen

       James O'Gorman

NOTES

	1. mailing list
	   http://lists.warhead.org.uk/mailman/listinfo/boxbackup

Box Backup 0.11 						    10/28/2011							 BBSTORED-CERTS(8)
Man Page