cgit.sxemacs.org Git - packages/blob - xemacs-packages/mailcrypt/INSTALL

   1 System Requirements
   2 ===================
   3
   4 Mailcrypt is designed for use with FSF Emacs 19.29 (and higher) or
   5 XEmacs 19.13 (and higher).  Mailcrypt absolutely requires at least FSF
   6 Emacs 19.28 or XEmacs 19.12.  With some effort, earlier versions might
   7 be made to work, but this is not supported.
   8
   9 Mailcrypt is also designed for use with PGP version 2.6 or higher,
  10 with the exception of 2.6ui (which is really just 2.3a in disguise).
  11 It is trivial to make Mailcrypt work with earlier versions, however;
  12 see below.
  13
  14 Basic Installation
  15 ==================
  16
  17 The simplest way to build and install Mailcrypt is:
  18
  19   1. `cd' to the Mailcrypt source directory and type `./configure' to
  20      configure Mailcrypt for your system.
  21
  22   2. Look at the program names in mc-pgp.el and mc-pgp5.el to make
  23      sure that they are correct.  On my system, for example, I call
  24      PGP 2.6.3 as "pgp2".  If you call PGP 2.6.x as "pgp", then you
  25      are probably OK.
  26
  27   3. Type `make' to build the byte-compiled Lisp files.
  28
  29   4. Type `make install' to install the Mailcrypt Lisp files and Info
  30      manual.
  31
  32 Load Path
  33 =========
  34
  35 If you use VM, RMAIL, MH-E, or GNUS and the respective package is not
  36 in your default load-path, Mailcrypt may fail to byte compile
  37 correctly.  (Emacs does not load your `.emacs' file when run in batch
  38 mode.)  If this applies to you, edit Mailcrypt's `load-path.hack' file
  39 to add the appropriate directory to the load-path during byte
  40 compilation.
  41
  42 In addition, PGP 5.0 support requires the file timer.el, which should
  43 be included in FSF Emacs, but is NOT included with Xemacs.  This file
  44 is included with Mailcrypt, and will be installed if the timer library
  45 isn't found in the load path.  If you already have timer.el, but it is
  46 in an unusual place, edit the file `load-path.hack' file accordingly.
  47
  48 Installation Names
  49 ==================
  50
  51 By default, `make install' will install the package's files in
  52 `/usr/local/info' and `/usr/local/share/emacs/site-lisp'.  You can
  53 specify an installation prefix other than `/usr/local' by giving
  54 `configure' the option `--prefix=PATH'.
  55
  56 If your installed copy of Emacs is named something other than `emacs'
  57 or `xemacs', you will need to tell `make' where to find it so that it
  58 can correctly byte-compile the Mailcrypt sources.
  59
  60 For example, to force the use of XEmacs you might do this:
  61
  62         ./configure
  63         make EMACS=xemacs
  64         make install
  65
  66 or this (for users of the Bourne shell and derivatives):
  67
  68         EMACS=xemacs ./configure
  69         make
  70         make install
  71
  72 or this (for users of *ugh* the C shell and derivatives):
  73
  74         setenv EMACS xemacs
  75         ./configure
  76         make
  77         make install
  78
  79 Also, the `--prefix=PATH' option to `configure' may not be general
  80 enough to set the paths you want.  If not, you can pass variables to
  81 the `make' command to control the installation.  For a complete list
  82 of tweakable variables, look in the makefile.
  83
  84 For example, to put the Lisp files in `$HOME/elisp' and the Info file
  85 in `$HOME/info', you would type:
  86
  87         ./configure
  88         make
  89         make lispdir=$HOME/elisp infodir=$HOME/info install
  90
  91 If you want to supply special flags to emacs for compiling the
  92 elisp files, you would type:
  93
  94         ./configure
  95         make EMACSFLAGS="-q -no-site-file"
  96         make install
  97
  98 FSF Emacs 19.28
  99 ===============
 100
 101 Mailcrypt's installation procedure assumes the directory structure
 102 used by FSF Emacs 19.29 (e.g., `/usr/local/share/emacs/site-lisp').
 103 If you are using 19.28, you will need to use an installation command
 104 like the following:
 105
 106         make datadir=/usr/local/lib install
 107
 108 This is the *only* special action required to install Mailcrypt for
 109 FSF Emacs 19.28.
 110
 111 FSF Emacs 20.3 or higher
 112 ========================
 113
 114 To use Mailcrypt with rmail, put the following in your .emacs:
 115
 116      (add-hook 'rmail-show-message-hook 'mc-install-read-mode)
 117
 118 Don't use the following, which worked for older emacsen:
 119
 120      (add-hook 'rmail-mode-hook 'mc-install-read-mode)
 121
 122
 123 XEmacs 19.12
 124 ============
 125
 126 Mailcrypt requires the `easymenu' package, which is bundled with FSF
 127 Emacs 19.28 (and higher) and with XEmacs 19.13 (and higher).  If you
 128 are using XEmacs 19.12, you will need to obtain a copy of this package
 129 and install it somewhere in your load-path.  The easiest way is to go
 130 to
 131
 132         ftp://archive.cis.ohio-state.edu/pub/gnu/emacs/elisp-archive/
 133
 134 and obtain the latest version of `auc-menu.el'.  Install it in your
 135 load path under the name `easymenu.el'.  (Don't ask why.)
 136
 137 Obsolete PGP versions
 138 =====================
 139
 140 Versions of PGP prior to 2.6 (including version 2.6ui, which is just a
 141 hacked 2.3a) do not support the "+comment" option, which Mailcrypt
 142 uses for gratuitous advertising.  To use Mailcrypt with such a version
 143 (or just to suppress the message), add the following line to your
 144 `.emacs' file:
 145
 146         (setq mc-pgp-comment nil)
 147
 148 PGP 5.0 Support
 149 ===============
 150
 151 Starting with Mailcrypt 3.5b1, Mailcrypt can support both older (2.6.*)
 152 and newer (5.0) versions of PGP.  Support for PGP 5.0 is limited, and
 153 excludes key snarfing, among other things.  All of the same keymaps and
 154 functions are used as in Mailcrypt 3.4; nothing should have changed
 155 for the end user.  (Note: *please* send me suggestions and patches
 156 to <mailto:lbudney@pobox.com> if you have improvements or fixes you
 157 would make!)
 158
 159 To use Mailcrypt 3.5b1 and higher, you must include two lines like the
 160 following in your .emacs file:
 161
 162         (load-library "mailcrypt")
 163         (mc-setversion "5.0") ;; Alternately, "2.6" or "gpg"
 164
 165 The function mc-setversion is interactive, and can be used at any time
 166 to toggle between PGP versions.  A nice future enhancement would be to
 167 add this option to the PGP menu.
 168
 169 GPG (Gnu Privacy Guard) Support
 170 ===============================
 171
 172 Starting with Mailcrypt 3.5b7, there is alpha support for gnupg. Almost
 173 everything available to pgp2 is available, with the notable exception
 174 of automatic key fetching. There are some bugs and limitations in the
 175 current gpg support. See README.gpg for details.
 176
 177 To use GPG by default, add this to your .emacs file:
 178
 179         (load-library "mailcrypt")
 180         (mc-setversion "gpg")
 181
 182 Most mailcrypt commands will let you set the encryption scheme on the
 183 fly: use a double prefix argument. For example, to sign a message,
 184 use C-u C-u C-c / s, and you will be asked for a scheme and a user id.
 185
 186 The GPG home page is at
 187 <http://www.d.shuttle.de/isil/crypt/gnupg.html>. The source is available
 188 at <ftp://ftp.guug.de/pub/gcrypt/>.
 189
 190 Suggestions/Bug Reports
 191 =======================
 192
 193 Send all suggestions for fixes, etc to <mailto:lbudney@pobox.com>.