From f47e6362bebb9d0df354b1c00dad3906c10ea351 Mon Sep 17 00:00:00 2001 From: weasel Date: Tue, 29 Jun 2004 13:02:34 +0000 Subject: [PATCH] Add perldoc git-svn-id: svn://svn.debian.org/pgp-tools/trunk@9 b513b33f-fedd-0310-b452-c3deb5f4c849 --- caff/caff | 111 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 109 insertions(+), 2 deletions(-) diff --git a/caff/caff b/caff/caff index 80bbf98..9e9942e 100755 --- 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 @@ -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 [-u I] I [I ..] + +=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 + +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 [string] + +Base directory for the files caff stores. Default: B<$HOME/.caff/>. + +=item B [string] + +Your name. B. + +=item B [string] + +Your email address, used in From: lines. B. + +=item B [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. + +=item B [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 [string] + +Keyserver to download keys from. Default: B. + +=item B [string] + +Path to the GnuPG binary. Default: B. + +=item B [string] + +Path to the GnuPG binary which is used to sign keys. Default: what +B is set to. + +=item B [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 is set to. + +=item B [string] + +Path to your secret keyring. Default: B<$HOME/.gnupg/secring.gpg>. + +=back + +=head1 AUTHOR + +Peter Palfrader + +=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'}; -- 2.39.5