summaryrefslogtreecommitdiff
path: root/debian/bbackupd-config.8
diff options
context:
space:
mode:
Diffstat (limited to 'debian/bbackupd-config.8')
-rw-r--r--debian/bbackupd-config.878
1 files changed, 78 insertions, 0 deletions
diff --git a/debian/bbackupd-config.8 b/debian/bbackupd-config.8
new file mode 100644
index 00000000..c4e58cf0
--- /dev/null
+++ b/debian/bbackupd-config.8
@@ -0,0 +1,78 @@
+.\" 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 bbackupd-config 8 "Oct 10, 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
+bbackupd-config \- utility to configure the client daemon of the Box Backup system
+.SH SYNOPSIS
+.B bbackupd-config
+.RI "config_file backup_mode account_number server_hostname working_directory backup_directory [backup_directory...]"
+.SH DESCRIPTION
+This manual page documents briefly the
+.B bbackupd-config
+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.
+\fbbbackupd-config\fP can be used to generate the configuration for the client daemon
+of the Box Backup system, bbackupd.
+.SH OPTIONS
+.TP
+.B config_file
+Location of the generated configuration. Generally /etc/boxbackup.
+.TP
+.B backup_mode
+The general behavior of the backup daemon:
+.RS
+.TP
+.B lazy
+In this mode the daemon will scan the backup directories at regular
+interval looking for modified files. Only files over a certain age will
+be uploaded to the remote store.
+.TP
+.B snapshot
+In this mode the daemon will upload a snapshot of the backup directories
+when it is told to do it. Manual or cron invocation via bbackupctl is
+necessary for backup to occur.
+.RE
+.TP
+.B account_number
+The hexadecimal number of the account you are configuring (provided by the
+remote server administrator).
+.TP
+.B server_hostname
+Name of the backup server hosting the remote store.
+.TP
+.B working_directory
+The directory containing management files of the client daemon. Generally /var/lib/bbackupd.
+.TP
+.B backup_directory
+Directory to backup. Multiple directories can be specified separated by white spaces. Be
+careful not to specify directories containing other mount points, this could affect
+the efficiency of the backup.
+.SH SEE ALSO
+.BR bbackupd (8),
+.BR bbackupctl (8),
+.BR bbackupquery (8).
+.br
+.SH AUTHOR
+This manual page was written by J\['e]r\[^o]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).