Add perldoc

git-svn-id: svn://svn.debian.org/pgp-tools/trunk@9 b513b33f-fedd-0310-b452-c3deb5f4c849

diff --git a/caff/caff b/caff/caff
index 80bbf98d332bd1a8fdbc216efd89782ba6f7f8d8..9e9942e648d623b4b5a2ded0118d02e09ff5094f 100755 (executable)
--- a/caff/caff
+++ b/caff/caff
@@ -1,6 +1,6 @@
 #!/usr/bin/perl -w
 
-# caff  --  CA - fire and forget
+# caff  --  CA - Fire and Forget
 # $Id$
 #
 # Copyright (c) 2004 Peter Palfrader <peter@palfrader.org>
@@ -29,6 +29,113 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+=pod
+
+=head1 NAME
+
+caff -- CA - Fire and Forget
+
+=head1 SYNOPSIS
+
+=over
+
+=item B<caff> [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
+
+=back
+
+=head1 DESCRIPTION
+
+CA Fire and Forget is a script that helps you in keysigning.  It takes a list
+of keyids on the command line, fetches them from a keyserver and calls 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, pruned from all but self
+sigs and sigs done by you.
+
+=head1 OPTIONS
+
+=over
+
+=item B<-u> I<yourkeyid>
+
+Select the key that is used for signing, in case you have more than one key.
+
+=back
+
+=head1 FILES
+
+=over
+
+=item $HOME/.caffrc  -  configuration file
+
+=back
+
+=head1 CONFIGURATION FILE OPTIONS
+
+The configuration file is a perl script that sets values in the hash B<%CONFIG>.
+
+Example:
+
+       $CONFIG{'owner'}       = 'Peter Palfrader';
+       $CONFIG{'email'}       = 'peter@palfrader.org';
+
+=head2 Valid keys
+
+=over
+
+=item B<caffhome> [string]
+
+Base directory for the files caff stores.  Default: B<$HOME/.caff/>.
+
+=item B<owner> [string]
+
+Your name.  B<REQUIRED>.
+
+=item B<email> [string]
+
+Your email address, used in From: lines.  B<REQUIRED>.
+
+=item B<keyid> [list of keyids]
+
+A list of your keys.  This is used to determine which signatures to keep
+in the pruning step.  If you select a key using B<-u> it has to be in
+this list.  B<REQUIRED>.
+
+=item B<export-sig-age> [seconds]
+
+Don't export UIDs by default, on which your latest signature is older
+than this age.  Default: B<24*60*60> (i.e. one day).
+
+=item B<keyserver> [string]
+
+Keyserver to download keys from.  Default: B<subkeys.pgp.net>.
+
+=item B<gpg> [string]
+
+Path to the GnuPG binary.  Default: B<gpg>.
+
+=item B<gpg-sign> [string]
+
+Path to the GnuPG binary which is used to sign keys.  Default: what
+B<gpg> is set to.
+
+=item B<gpg-sdelsig> [string]
+
+Path to the GnuPG binary which is used to split off signatures.  This is
+needed while the upstream GnuPG is not fixed  (there are 2 bugs in the
+Debian Bug Tracking System).  Default: what B<gpg> is set to.
+
+=item B<secret-keyring> [string]
+
+Path to your secret keyring.  Default: B<$HOME/.gnupg/secring.gpg>.
+
+=back
+
+=head1 AUTHOR
+
+Peter Palfrader <peter@palfrader.org>
+
+=cut
+
 use strict;
 use IO::Handle;
 use English;
@@ -51,7 +158,7 @@ sub load_config() {
                die "Couldn't parse $config: $EVAL_ERROR\n" if $EVAL_ERROR;
        };
 
-       die ("caffhome is not defined.\n") unless defined $CONFIG{'caffhome'};
+       $CONFIG{'caffhome'}=$ENV{'HOME'}.'/.caff' unless defined $CONFIG{'caffhome'};
        die ("owner is not defined.\n") unless defined $CONFIG{'owner'};
        die ("email is not defined.\n") unless defined $CONFIG{'email'};
        die ("keyid is not defined.\n") unless defined $CONFIG{'keyid'};