Improve docs and copyright

diff --git a/chiark-cryptdisk/README b/chiark-cryptdisk/README
index 3b56ef1..5f7d22e 100644 (file)
--- a/chiark-cryptdisk/README
+++ b/chiark-cryptdisk/README
@@ -1,20 +1,43 @@
+=======================================================================
+I. Setup
+
 1. Teach the scripts how to detect your backup drive.
    This typically means figuring out the kernel module needed 
    See /usr/lib/chiark-cryptdisk/search-for-sata.
-   Set the module name in /etc/chiark-cryptdisk/config.
+   Set the module name (and your other preferences) in
+   /etc/chiark-cryptdisk/config.
 
 2. Create an initial key with chiark-cryptdisk-make-key
+
 3. Create one or more backup drives using chiark-cryptdisk-initialisedisk.
    We recommend you use the --fill option which fills the encrypted drive
    with zeroes (i.e. what looks to an observer like random data) before
    creating the filesystem on it.
+
 4. Every now and then - perhaps before adding a new drive - roll over to
    a new key, with chiark-cryptdisk-make-key.
 
-XXX TODO: Add hdparm -qf DEVICE and hdparm -Y DEVICE to make it flush and sleep?
+Keys are stored in /etc/chiark-cryptdisk/keys. YOU MUST BACK THIS
+DIRECTORY UP BY OTHER MEANS; without a copy, you will be unable to read
+your backups if you ever need to rely on them!  Put it on a USB stick,
+burn it onto a CD, doesn't quite matter what, but you will need the
+contents of that directory - along with the scripts in this package -
+if you need to mount a cryptdisk on another system or restore from it.
+
+=======================================================================
+II. Interacting with the encrypted drives
+
+* To mount the drive, run `/usr/lib/chiark-cryptdisk/examine' as root.
+  If you want to mount it read-write, add the option `--rw'.
+
+* How you back up your data is up to you, but see below.
+
+* When you are finished, run `/usr/lib/chiark-cryptdisk/umount'.
 
-Depends: dmsetup, bsdmainutils, cryptsetup
+We provide /usr/lib/chiark-cryptdisk/chiark-cryptdisk-backup[.withlock]
+as a suggestion for an integrated backup script, suitable for running from
+root's crontab; take careful note of its use of rsync's `--link-dest'
+mode.
 
-Keys are stored in /etc/chiark-cryptdisk/keys. YOU MUST BACK THIS DIRECTORY UP BY OTHER MEANS; without a copy, you will be unable to read your backups if you ever need to rely on them!
-Put it on a USB stick, burn it onto a CD, doesn't quite matter what, but you will need the contents of that directory - along with the scripts in this package - if you need to mount a cryptdisk on another system or restore from it.
+=======================================================================
 

diff --git a/chiark-cryptdisk/TODO b/chiark-cryptdisk/TODO
new file mode 100644 (file)
index 0000000..e17e087
--- /dev/null
+++ b/chiark-cryptdisk/TODO
@@ -0,0 +1,4 @@
+* Make preferences go via debconf
+* Automatically purge old backups according to some appropriate
+  (user-specified?) rule
+* Improve reporting

diff --git a/debian/copyright b/debian/copyright
index f498e04..ce23c62 100644 (file)
--- a/debian/copyright
+++ b/debian/copyright
@@ -11,7 +11,8 @@ chiark-utils-maint@chiark.greenend.org.uk.
 The software included is:
 
 chiark-cryptdisk: encrypted backup drive scripts
- Copyright Ian Jackson <ian@chiark.greenend.org.uk>
+ Copyright 2001-2010 Ian Jackson <ian@chiark.greenend.org.uk>
+ Portions copyright 2007-2010 W Ross Younger <ryounger@chiark.greenend.org.uk>
 
 The chiark utilities are all free software; you can redistribute them
 and/or modify them under the terms of the GNU General Public License

diff --git a/debian/rules b/debian/rules
index 188b9e1..fcc0159 100755 (executable)
--- a/debian/rules
+++ b/debian/rules
@@ -44,7 +44,7 @@ binary-arch: build install
        dh_testdir
        dh_testroot
        dh_installdebconf
-       dh_installdocs chiark-cryptdisk/README
+       dh_installdocs chiark-cryptdisk/README chiark-cryptdisk/TODO
 #      dh_installexamples
 #      dh_installcron
        dh_installman