@@ -1,3 +1,9 @@

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

diff --git a/backup/iwjbackup.txt b/backup/iwjbackup.txt
index 4ee23545b62140e47dceabf659a51495ee43683f..39000ee29c74221a4dfa55a15d3b3f14b7ae9a00 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
@@ -54,18 +57,34 @@ In the fsys.* files:
    run things on a remote machine:
      prefix <prefix-name> <command-part>
   Other lines should be of the form
-    <directory name>   <backup-type>
-  for local backups, or 
-    <directory name>   <backup-type>   <prefix-name>
+    [<device name>:]<directory name> <backup-type>[,<options>]
+  for local backups, or
+    [<device name>:]<directory name> <backup-type>[,<options>] <prefix-name>
   for remote backups.
 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), and `zafio' (uses
-afio to compress each file as it is backed up).  Only `dump' type
-backups perform incremental backups.
+<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.
+
+<options> is a comma-separated list of <option> or <option>=<value>.
+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.
 
 expected-diffs is a config file to indicate which 
 filesystems should *not* be backed up. The scripts do a config