aboutsummaryrefslogtreecommitdiff
path: root/doc/backup.conf.5in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/backup.conf.5in')
-rw-r--r--doc/backup.conf.5in50
1 files changed, 43 insertions, 7 deletions
diff --git a/doc/backup.conf.5in b/doc/backup.conf.5in
index aa0bfe8..5f3c707 100644
--- a/doc/backup.conf.5in
+++ b/doc/backup.conf.5in
@@ -46,6 +46,39 @@ utilities will first look for an executable file named
If not found, they will fall back to using \fB/usr/bin/ssh\fR. It is
the responsibility of the administrator to provide for authentication
on the remote system, e.g. by using shared-key authentication.
+.TP
+.B backup_retain_interval
+Sets the interval, in weeks, during which old backups and snapshots
+are retained. Empty value or zero means never delete the backups.
+
+This variable is used by
+.BR backup (1),
+which calls
+.BR backup-cleaner (1)
+if it is set.
+.SH S3 SETUP
+To keep archives in a
+.B s3
+bucket you will need the
+.BR s3backer (1)
+utility.
+.TP
+.B backup_bucket_name
+Sets the name of the
+.B s3
+bucket to keep the archives in.
+.TP
+.B backup_mp_s3backer
+Defines mount point for the "raw" bucket.
+
+Default value is
+.BR /mnt/s3backer .
+.TP
+.B backup_mp_s3
+Defines mount point for the actual s3-backed filesystem.
+
+Default value is
+.BR /mnt/s3 .
.SH TAR SETUP
Tar setup variables control additional options and arguments passed to
.BR tar (1).
@@ -180,14 +213,16 @@ Two special variables, called hooks, allow you to supply arbitrary
procedures to be run before and after backup.
.TP
.B prologue_hook
-This variable contains the name of a shell procedure or external
-program to be called before starting backup (or restore). The hook is
-called without arguments. By default, this variable is empty.
+This variable contains a whitespace-separated list of the commands to
+be invoked before starting backup (or restore). The commands are
+started in order of their appearance in the list and are called
+without arguments. By default, this variable is empty.
.TP
.B epilogue_hook
-This variable contains the name of a shell procedure or external
-program to be called after backup (or restore) is finished. The hook
-is called without arguments. By default, this variable is empty.
+This variable contains a whitespace-separated list of the commands to
+be invoked after the backup (or restore) has finished. The commands are
+started in order of their appearance in the list and are called
+without arguments. By default, this variable is empty.
.SH EXAMPLES
A simple configuration file for backing up the contents of
.BR /etc,
@@ -222,7 +257,8 @@ system_files="etc home"
.sp
.SH "SEE ALSO"
.BR restore (1),
-.BR backup (1).
+.BR backup (1),
+.BR backup-cleaner (1).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"

Return to:

Send suggestions and report system problems to the System administrator.