summaryrefslogtreecommitdiff
path: root/INSTALL
blob: c60f602c9667e6278ccb811a04c9df93ff1043aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
To compile and install the BBDB on systems with `make':

  1) Configure the compilation process
       Edit the Makefile, setting (if necessary) the paths to the Mail
       and News reader(s), the XEmacs package installation paths (if
       applicable), and the miscellaneous (but still important) build
       tool names and paths.

       NOTE:  Gnu Emacs 19.34 users should add the path to Custom
       1.9962 if they plan to build Gnus support.  Gnus support will
       not build under Gnu Emacs 19.34 without Custom 1.9962.

  2) Build the BBDB
       To build the BBDB with support for all of the supported mail
       and news programs (gnus, mh-e, rmail, and vm), issue the
       command 'make all'.  (The BBDB also supports send-mail mode -
       support for it is automatically compiled in, regardless of the
       build options supplied) To build with support only for gnus,
       mh-e, rmail, and/or vm, issue the 'make' command with one or
       more of the following arguments: 'gnus', 'mh-e', 'rmail',
       and/or 'vm'.  To build the BBDB without support for any mail
       program (except for send-mail mode), issue the command
       'make bbdb'.

  3) Install the BBDB
       The three most typical installations are outlined below:

        a) In-place.
             i)   Follow steps 1 and 2
             ii)  Add the lisp subdirectory to the Emacs load-path
             iii) Add the tex subdirectory to the TeX
                  search path (can be done by adding the complete path
                  to the tex subdirectory to the environment variable
                  TEXINPUTS)
             iv)  Add the texinfo directory to the Info search path.
        b) "Normal".
             i)   Follow steps 1 and 2.
             ii)  Copy the .el and .elc files from the lisp
                  subdirectory to a directory on the Emacs load-path
                  (or make a new directory, copy the files to it, and
                  add the new directory to the load-path).
             iii) Copy the .tex files from the tex subdirectory to a
                  directory on the TeX search path (or make a new
                  directory, copy the files to it, and add the new
                  directory to the TeX search path.
             iv)  Copy the .info and .info-* files from the texinfo
                  subdirectory to a directory on the Info search path
                  (or make a new directory, copy the files to it, and
                  add the new directory to the Info search path)
        c) XEmacs Package
             NOTE: This installation option is only available to users 
                   running XEmacs 20.3 or higher.  At the time of this 
                   writing, this includes only XEmacs beta testers.
             i)    Follow steps 1 and 2, making sure to set the
                   appropriate variables in the XEmacs package
                   section.
             ii)   Issue the 'make install-pkg' command.

To compile and install the BBDB on systems without `make':

  If at all possible, use make to automatically build the BBDB as
  outlined above.  While it looks like there are fewer steps in the
  non-make instructions below, they're more tedious and involved.

  1) Compile the .el files using the byte-compile-file function in
     Emacs.

  2) Install the BBDB as outlined in step 3 above.


***************************************************************************
*                                                                         *
*         THE BBDB INITIALIZATION PROCEDURE CHANGED IN 1.57unoff.         *
*                                                                         *
*                              YOU *MUST* ADD                             *
*                                                                         *
*   (require 'bbdb)                                                       *
*   (bbdb-initialize)                                                     *
*                                                                         *
*   TO YOUR BBDB INITIALIZATION CODE.  THIS TAKES THE PLACE OF ALL BBDB   *
*    AUTOLOADS.  IT DOES *NOT* TAKE THE PLACE OF THE INSINUATION CODE.    *
*                                                                         *
*       If you do not add this code, you will receive keymap errors       *
*                          (among other things)                           *
*                                                                         *
***************************************************************************

For information on post-installation BBDB configuration and setup, see 
the info file.

Questions, Comments, Suggestions, and Bug Reports may be directed to
the BBDB mailing list at bbdb-info@xemacs.org.  To subscribe, send
mail to bbdb-info-request@xemacs.org, with 'subscribe' as the subject.