From: Mark Wooding <mdw@distorted.org.uk>
Date: Mon, 28 Jan 2013 10:04:55 +0000 (+0000)
Subject: Merge branch 'staging'
X-Git-Tag: 1.0.0~11
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/rsync-backup/commitdiff_plain/1c9c923af8ab55f91a9875d135e7189395302334?hp=-c

Merge branch 'staging'

* staging:
  Maintain an index of backup artifacts.
  rsync-backup.8: Put the variables in alphabetical order.
  rsync-backup.in: Missing `NAME' section.
---

1c9c923af8ab55f91a9875d135e7189395302334
diff --combined rsync-backup.8
index 1311403,aa7821f..714b63f
--- a/rsync-backup.8
+++ b/rsync-backup.8
@@@ -5,6 -5,8 +5,8 @@@
  \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
  ..
  .TH rsync-backup 8 "7 October 2012" rsync-backup
+ .SH NAME
+ rsync-backup \- back up files using rsync
  .SH SYNOPSIS
  .B rsync-backup
  .RB [ \-nv ]
@@@ -200,7 -202,6 +202,7 @@@ o
  Expiry considers each existing dump against the policy lines in order:
  the last applicable line determines the dump's fate \(en so you should
  probably write the lines in decreasing order of duration.
 +.RS
  .PP
  Groups of
  .B retain
@@@ -225,7 -226,6 +227,7 @@@ is th
  policy: at the start of each
  .B host
  stanza, the policy is reset to the default.
 +.RE
  .TP
  .BI "retry " count
  The
@@@ -253,11 -253,42 +255,42 @@@ counter
  The following shell variables may be overridden by the configuration
  file.
  .TP
+ .B HASH
+ The hash function to use for verifying archive integrity.  This is
+ passed to the
+ .B \-H
+ option of
+ .BR fshash ,
+ so it must name one of the hash functions supported by your Python's
+ .B hashlib
+ module.
+ The default is
+ .BR sha256 .
+ .TP
+ .B INDEXDB
+ The name of a SQLite database initialized by
+ .BR update-bkp-index (8)
+ in which an index is maintained of which dumps are on which backup
+ volumes.  If the file doesn't exist, then no index is maintained.  The
+ default is
+ .IB localstatedir /lib/bkp/index.db
+ where
+ .I localstatedir
+ is the state directory configured at build time.
+ .TP
  .B MAXLOG
  The number of log files to be kept for each filesystem.  Old logfiles
  are deleted to keep the total number below this bound.  The default
  value is 14.
  .TP
+ .B METADIR
+ The metadata directory for the currently mounted backup volume.
+ The default is
+ .IB mntbkpdir /meta
+ where
+ .I mntbkpdir
+ is the backup mount directory configured at build time.
+ .TP
  .B RSYNCOPTS
  Command-line options to pass to
  .BR rsync (1)
@@@ -303,16 -334,11 +336,11 @@@ wher
  .I mntbkpdir
  is the backup mount directory configured at build time.
  .TP
- .B HASH
- The hash function to use for verifying archive integrity.  This is
- passed to the
- .B \-H
- option of
- .BR fshash ,
- so it must name one of the hash functions supported by your Python's
- .B hashlib
- module.  The default is
- .BR sha256 .
+ .B VOLUME
+ The name of the current volume.  If this is left unset, the volume name
+ is read from the file
+ .IB METADIR /volume
+ once at the start of the backup run.
  .SS Hook functions
  The configuration file may define shell functions to perform custom
  actions at various points in the backup process.
@@@ -444,14 -470,12 +472,15 @@@ named with the date at which the dump w
  .IB yyyy \(en mm \(en dd
  format), together with associated files named
  .IB date .* \fR.
 +There is also a symbolic link
 +.B last
 +referring to the most recent backup of the filesystem.
  .SH SEE ALSO
  .BR fshash (1),
  .BR lvm (8),
  .BR rfreezefs (8),
  .BR rsync (1),
- .BR ssh (1).
+ .BR ssh (1),
+ .BR update-bkp-index (8).
  .SH AUTHOR
  Mark Wooding, <mdw@distorted.org.uk>