Some Notes of the Herbrip program
=================================

File: NOTES
By: Philip Hunt
Altered: 28-Jan-2002


Executable programs
===================

These are all stored in the src/ directory.

herbrip - the main Herbrip program. Just type this at the command
   line to get usage information.


herbrip_pin - "Procmail Incoming". This program can be invoked
   by Procmail for each incoming email, to process it for Herbrip.
   Usage:
   
      herbrip_pin <incoming_mail >incoming_mail_processed


herbrip_csm - "Capture Sendmail". This program is used to "capture"
   outgoing emails that would otherwise have gone to sendmail.
   Usage:
   
      herbrip_csm address@of.recipient <outgoing_mail
   

prpick - "Print pickled". This program prettyprints a file containing
   pickled Python data. it is useful for reading the <public_keys>
   and <private_keys> files.
   Usage:
   
      prpick filename


Some notes on files and formats
===============================

In .herbivore/:

.herbivore/README: human-readable comments

.herbivore/public_keys
   List of incoming public keys from incoming email
   Each record consists of key and email address (later
   will add time received and other info)
   
.herbivore/secret_keys
   Public/private keypairs. To start will contain my
   pub/priv keypair. later, herbrip/herbivore will add timestamp
   and expiry date info and the ability to change and keys.
   
   Stored as a pickled python dictionary. d-keys are:
     'public', 'private'  (& more later)

.herbivore/config
   Configuration file. This contains the values of several variables
   that define how Herbrip behaves. It is a Python source code file,
   so the syntax is the same as the Python language.

.herbivore/event.log
   When Herbrip does things, it writes a record in this file. This
   may be useful for debugging. What is logged? This is determined by
   the (log) and (logItems) variables in <config>.


;end.
