Improved documentation around the public key import bug

[pgp-tools.git] / caff / README

diff --git a/caff/README b/caff/README
index ef02f8dfbe42782d076298b4cf41271f2fb3865f..8bd828beda7a7811d46b2a50e4479f274fc241e3 100644 (file)
--- a/caff/README
+++ b/caff/README
@@ -6,7 +6,6 @@ GnuPG so that you can sign it.  It then mails each key to all its
 email addresses - only including the one UID that we send to in each
 mail.
 
-
 Features:
  * Easy to setup.
  * Attaches only the very UID that we send to in the mail.
@@ -17,10 +16,8 @@ Features:
  * Creates proper PGP MIME messages.
  * Uses separate GNUPGHOME for all its operations.
 
-Caveats:
- * Requires a gpg patch for now, until 2 bugs are fixed:
-     http://bugs.debian.org/252917    gnupg: --with-colons and --edit delsigs
-     http://bugs.debian.org/254072    gpg should flush stdout before prompting in --edit
+Special Requirements:
+ * GnuPG 1.3.92 or later.
 
 Discussion:
 
@@ -36,7 +33,25 @@ systems.
 
 
 
-Dependencies: gnupg (>= 1.2), perl, libgnupg-interface-perl, libmime-perl, libmailtools-perl (>= 1.62), mailx
+Dependencies: gnupg (>= 1.3.92), perl, libgnupg-interface-perl, libmime-perl, libmailtools-perl (>= 1.62), mailx
+
+
+INSTALLATION NOTES
+
+After creating a ~/.caffrc from the template, caff almost works out of the box.
+
+It has a problem, though: your personal public key is not imported in the caff
+working keyring.  Do fix it, do this:
+
+Considering you have this:
+
+   $CONFIG{'caffhome'}    = $ENV{'HOME'}.'.caff';
+
+Do:
+
+   gpg --export <your-key-id> | gpg --import --homedir ~/.caff/gnupghome
+
+This is a workaround for a bug which is already noted in the TODO list.
 
 -- 
 Peter