wiki:ManualPages
close Warning: Error with navigation contributor "AccountModule"

Version 1 (modified by chris, 10 years ago) (diff)

document bbackupd

Manual Pages

This is a brief overview of the programs that make up Box Backup, with links to the relevant manual pages for each program for more information.

bbackupd

Name

bbackupd -- The client backup daemon

Synopsis

bbackupd [options] [config file]

Description

bbackupd runs on client computers in the background, finding new files to back up. When it is time for a backup, bbackupd will connect to the server (bbstored) to upload the files.

A running bbackupd daemon can be controlled with the bbackupctl command, to make it shut down, reload its configuration, or start an immediate backup.

bbackupd need to be configured to tell it which files to back up, how often, and to which server (running bbstored). See the Client Configuration page for more information.

bbackupd usually writes log messages to the system logs, using the facility local5, which you can use to filter them to send them to a separate file. It can also write them to the console, see options below. If bbackupd is not doing what you expect, please check the logs first of all.

Options

bbackupd now has built-in help (in trunk and 0.11 and above) which may be more up-to-date with options than this manual page. You can access it with the -h or /? option.

-c <file>:: Use the specified configuration file. If -c is omitted, the last argument is the configuration file. If none is specified, the default is used, which is normally /etc/box/bbackupd.conf, but is also shown by the -h option. -D:: Debugging mode. Do not fork into the background (do not run as a daemon). Not available on Windows. -F:: No-fork mode. Same as -D for bbackupd. Not available on Windows. -k:: Keep console open after fork, keep writing log messages to it. Not available on Windows. -q:: Run more quietly. Reduce verbosity level by one. Available levels are NOTHING, FATAL, ERROR, WARNING, NOTICE, INFO, TRACE, EVERYTHING. Default level is NOTICE in non-debugging builds. Use once to drop to WARNING level, twice for ERROR level, four times for no logging at all. -v:: Run more verbosely. Increase verbosity level by one. Use once to raise to INFO level, twice for TRACE level, three times for EVERYTHING (currently the same as TRACE). -V:: Run at maximum verbosity (EVERYTHING level). -t <tag>:: Tag each console message with specified marker. Mainly useful in testing when running multiple daemons on the same console. -T:: Timestamp each line of console output. -s:: Run as a Windows Service (Windows only). For internal use by Service Control Manager only. -i:: Install Windows Service (Windows only). Creates a service entry in Service Control Manager. You may want to specify a configuration file as well, using the -c option. -r:: Remove Windows Service (Windows only). Removes the service entry in Service Control Manager. -S <name>:: Sets the service name for -i and -r options. This allows you to have multiple independent Box Backup services in the Service Control Manager. If you do this, you should really use a different configuration file for each instance.