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

   1 This file has three sets of installation instructions: with `make',
   2 without `make', and uncompiled. Please follow the appropriate set of
   3 instructions. If you plan on running BBDB directly from CVS, please
   4 check the additional instructions below.
   5
   6 ===============================================================================
   7
   8 Running BBDB from CVS:
   9
  10   *** PLEASE NOTE ****
  11   This applies to the master CVS tree at sourceforge, not the XEmacs CVS tree.
  12   *** PLEASE NOTE ***
  13
  14   This is not recommended, unless you're a BBDB developer. You will
  15   need to either install the GNU autoconf package, or download the
  16   pregenerated copy of configure from the BBDB website. If you choose
  17   the former option, you'll need to run `autoconf' to generate the
  18   configure script. Thereafter, follow the appropriate set of
  19   instructions below.
  20
  21 ===============================================================================
  22
  23 To compile and install the BBDB on systems with `make':
  24
  25   1) Configure the compilation process:
  26
  27        First of all, you should run the `configure' script at the toplevel of
  28        the distribution. This script will perform a number of checks on your
  29        system and generate the Makefile's accordingly.
  30
  31        The `configure' script comes with a number of options that might be of
  32        interest to you:
  33
  34        `--with-emacs=PROG' lets you select an Emacs program to use. By
  35          default, "emacs" and "xemacs" will be tried in that order.
  36
  37        `--with-{gnus,mhe,vm}-dir=DIR' let you specify the paths where Gnus,
  38          MH-E and VM can respectively be found, if Emacs can't find them by
  39          itself (like, if they're not in the load-path by default).
  40
  41        `--with-other-dirs=DIRS' lets you specify additional paths (space or
  42          colon spearated) to find other libraries that might be needed (see
  43          the "Byte Compiling the Lisp files" section of the BBDB manual for
  44          more information).
  45
  46          NOTE: Gnu Emacs 19.34 users should add the path to Custom 1.9962
  47          here if they plan to build Gnus support.  Gnus support will not build
  48          under Gnu Emacs 19.34 without Custom 1.9962.
  49
  50        `--with-package-dir=DIR' lets you specify the installation path for
  51          for XEmacs package installation. By default,
  52          "/usr/local/lib/xemacs/site-packages" is used.
  53
  54        `--with-symlinks' will make the installation process use symbolic links
  55          to the sources instead of copying the files.
  56
  57        `--with-linkpath=PATH' lets you specify the path to link from, if your
  58          `pwd' command doesn't work properly.
  59
  60
  61   2) Build the BBDB:
  62
  63        To build the BBDB with support for all of the supported mail
  64        and news programs (gnus, mh-e, rmail, and vm), issue the
  65        command 'make all'.  (The BBDB also supports sendmail mode -
  66        support for it is automatically compiled in, regardless of the
  67        build options supplied) To build with support only for gnus,
  68        mh-e, rmail, and/or vm, issue the 'make' command with one or
  69        more of the following arguments: 'gnus', 'mh-e', 'rmail',
  70        and/or 'vm'.  To build the BBDB without support for any mail
  71        program (except for sendmail mode), issue the command
  72        'make bbdb'.
  73
  74
  75   3) Install the BBDB:
  76
  77        The three most typical installations are outlined below:
  78
  79         a) In-place.
  80              i)   Follow steps 1 and 2
  81              ii)  Add the lisp subdirectory to the Emacs load-path
  82              iii) Add the tex subdirectory to the TeX
  83                   search path (can be done by adding the complete path
  84                   to the tex subdirectory to the environment variable
  85                   TEXINPUTS)
  86              iv)  Add the texinfo directory to the Info search path.
  87         b) "Normal".
  88              i)   Follow steps 1 and 2.
  89              ii)  Copy the .el and .elc files from the lisp
  90                   subdirectory to a directory on the Emacs load-path
  91                   (or make a new directory, copy the files to it, and
  92                   add the new directory to the load-path).
  93              iii) Copy the .tex files from the tex subdirectory to a
  94                   directory on the TeX search path (or make a new
  95                   directory, copy the files to it, and add the new
  96                   directory to the TeX search path.
  97              iv)  Copy the .info and .info-* files from the texinfo
  98                   subdirectory to a directory on the Info search path
  99                   (or make a new directory, copy the files to it, and
 100                   add the new directory to the Info search path)
 101         c) XEmacs Package
 102              NOTE: This installation option is only available to users
 103                    running XEmacs 20.3 or higher.
 104              i)    Follow steps 1 and 2.
 105              ii)   Issue the 'make install-pkg' command.
 106
 107
 108
 109 To compile and install the BBDB on systems without `make':
 110
 111   If at all possible, use make to automatically build the BBDB as
 112   outlined above.  While it looks like there are fewer steps in the
 113   non-make instructions below, they're more tedious and involved.
 114
 115   1) Compile the .el files using the byte-compile-file function in
 116      Emacs.
 117
 118   2) Install the BBDB as outlined in step 3 above.
 119
 120 ===============================================================================
 121
 122 To run BBDB uncompiled:
 123
 124   Again, this is really not recommended, although it will generate a
 125   more meaningful stacktrace if you happen to run into a problem. In
 126   order to run BBDB uncompiled, you'll need to do two things:
 127
 128   1) Generate bbdb-autoloads.el
 129      You can do this by typing 'make autoloads' in the main BBDB
 130      directory. Note that this will require you to have previously run
 131      configure to generate Makefiles.
 132
 133   2) Add .../bbdb/lisp to your load path
 134      You need to make sure that the lisp subdirectory of the BBDB
 135      source is in your load path so that Emacs can find the BBDB
 136      files.
 137
 138   Since arbitrary chunks of the BBDB are macros, you'll probably find
 139   the uncompiled version slower than the compiled version.
 140
 141 ===============================================================================
 142
 143 ***************************************************************************
 144 *                                                                         *
 145 *         THE BBDB INITIALIZATION PROCEDURE CHANGED IN 1.57unoff.         *
 146 *                                                                         *
 147 *                              YOU *MUST* ADD                             *
 148 *                                                                         *
 149 *   (require 'bbdb)                                                       *
 150 *   (bbdb-initialize)                                                     *
 151 *                                                                         *
 152 *   TO YOUR BBDB INITIALIZATION CODE.  THIS TAKES THE PLACE OF ALL BBDB   *
 153 *    AUTOLOADS.  IT DOES *NOT* TAKE THE PLACE OF THE INSINUATION CODE.    *
 154 *                                                                         *
 155 *       If you do not add this code, you will receive keymap errors       *
 156 *                          (among other things)                           *
 157 *                                                                         *
 158 ***************************************************************************
 159
 160 For information on post-installation BBDB configuration and setup, see
 161 the info file. (M-x bbdb, and press 'i' in the BBDB info window)
 162
 163 Questions, Comments, Suggestions, and Bug Reports may be directed to
 164 the BBDB mailing list at bbdb-info@lists.sourceforge.net.  To
 165 subscribe, send mail to bbdb-info-request@lists.sourceforge.net, with
 166 'subscribe' as the subject.