X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=chiark-utils.git;a=blobdiff_plain;f=backup%2Fiwjbackup.txt;h=775e65aa2e2ffc44f2e48567a88a91cd579c9dbf;hp=ff4d860e35fda97cf23fa06b74d0779eadcc2c58;hb=e912e652c5a4d03307b47a209baa6dec5877ae45;hpb=5be70e1e6615ac811f61b760548022239141ac7b

diff --git a/backup/iwjbackup.txt b/backup/iwjbackup.txt
index ff4d860..775e65a 100644
--- a/backup/iwjbackup.txt
+++ b/backup/iwjbackup.txt
@@ -2,12 +2,9 @@ iwjbackup.txt
 documentation file
 Copyright - AND NO WARRANTY - see notes at bottom of file for details.
 
-This is a quick summary of the backup scripts, and some comments on  and my config files:
-it's a bit patchy and might have the odd ommission. The canonical
-source is the sources, as always :->
-
-
-WARNING - this file is out of date !
+This is a quick summary of the backup scripts, and some comments on
+some of the config files: it's a bit patchy and might have the odd
+ommission. The canonical source is the sources, as always :->
 
 
 To run, the contents of /etc/chiark-backup should be:
@@ -18,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
@@ -57,18 +57,43 @@ 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.
+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>.
+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
@@ -99,6 +124,10 @@ Useful scripts (all in /usr/bin):
 backup-checkallused: this only does a check of the configuration
 files.  It should give a cryptic summary of the configuration and
 print 'configuration ok'. If not, fix your config files :->
+You have to create the file /var/lib/chiark-backup/last-tape
+containing the id of a tape; this helps backup-checkallused know where
+to start iterating over tapes.  Any tapeid will do.  (But don't make
+it the same as the one you want to back up to first.)
 
 backup-loaded: this tells the scripts that a currently unlabelled tape
 should be treated as tape X: eg:
@@ -131,7 +160,7 @@ To use this you'll need to configure init:
   # Runlevel 5 is set up to run a reduced level of services during
   # backups. (currently this means: no squid, no webserver, no newsserver)
   # We also run the backup script automatically on entering runlevel 5:
-  dm:5:once:/usr/local/lib/backup/driver </dev/tty8 >/dev/tty8 2>&1
+  dm:5:once:backup-driver </dev/tty8 >/dev/tty8 2>&1
 
  * takedown can be run from the command line or via cron.