set paths on remote commands

[chiark-utils.git] / backup / iwjbackup.txt

diff --git a/backup/iwjbackup.txt b/backup/iwjbackup.txt
index 5de4276dcb28d30b13ee6edb7646c9b1de5dac59..5362fd1343b1978504e54af1d7fdb0599e2d824e 100644 (file)
--- a/backup/iwjbackup.txt
+++ b/backup/iwjbackup.txt
@@ -15,6 +15,9 @@ brought down to do backups. The defaults are fine.
 settings.pl: generic config file: in particular, the name of the tape
 device is set here.
 
+settings.sh: generic config file for shell scripts.  Currently only
+contains some options for the lvm snapshotter.
+
 tape.*: conventionally, each tape you're going to use in the backup
 cycle has a tape number, a name and a config file.  The tape numbers
 in use at Relativity are digit strings like `512'.  The name is a
@@ -61,20 +64,37 @@ In the fsys.* files:
 The file (including any included files) must end with the word 'end'
 on a line of its own.
 
-Valid values for <backup-type> are `cpio' (uses cpio to produce
-tar-format backups), `dump' (uses dump to dump entire filesystems;
-<directory name> should be a mount-point for this), `zafio' (uses afio
-to compress each file as it is backed up), and `ntfsimage' (for NTFS
-volumes, requires device name).  Only `dump' type backups perform
-incremental backups.
+Valid values for <backup-type> are
+  cpio
+    uses cpio to produce tar-format backups
+  dump
+    uses dump to dump entire filesystems
+    <directory name> should be a mount-point
+  gtar
+    uses GNU tar to produce GNU tar format backups and -N-based
+    semi-incrementals (not --incremental or --listed-incremental)
+  zafio
+    uses afio to compress each file as it is backed up
+  ntfsimage
+    for NTFS volumes, requires device name
+Only `dump' and `gtar' type backups perform any kind of incremental
+backups.
 
 <options> is a comma-separated list of <option> or <option>=<value>.
-The only currently support options are gz[i][=<compressionlevel>], to
-indicate that the whole stream should be compressed with gzip.  The
-compression level defaults to 1 if gz is specified by the level isn't.
-gzi appliies only to the incrementals; gz applies to both unless gzi
-is also specified.  compression level 0 means not to run gzip at all
-and is the default if gz[i] is not mentioned.
+Options supported:
+
+  gz[i][=<compressionlevel>]
+    Indicates that the whole stream should be compressed with gzip.
+    The compression level defaults to 1 if gz is specified by the
+    level isn't.  gzi appliies only to the incrementals; gz applies to
+    both unless gzi is also specified.  compression level 0 means not
+    to run gzip at all and is the default if gz[i] is not mentioned.
+
+  snap=<snapkind>
+    Indicates that the filesystem should be frozen before the backup
+    by using /etc/chiark-backup/snap/<snapkind>.  See the head comment
+    in /etc/chiark-backup/snap/lvm for details of how this works.
+    When snap= is used, the block device must be specified.
 
 expected-diffs is a config file to indicate which 
 filesystems should *not* be backed up. The scripts do a config