GNU Info

(bbdb.info)Initial Configuration

---

Prev: XEmacs Package Up: Installation

---

Enter node , (file) or (file)node

Initial Configuration
---------------------

   The simplest way to configure the BBDB is to include the following
forms in your Emacs configuration file:

     `(require 'bbdb)'
     `(bbdb-initialize)'

   Note:  The forms above replace the autoloads needed for previous
versions of the BBDB.

   This will set up the BBDB for basic querying and record manipulation
(the Core Functionality referred to in the Prerequisites section).  It
will not enable any of the mailreader-, newsreader- or other
package-specific BBDB features.  To enable some or all of these
features, the `(bbdb-initialize)' form can be enable as shown below.
Alternatively, the features can be enabled manually as described in the
following sections.

Modifying `(bbdb-initialize)'
-----------------------------

   The `bbdb-initialize' function can be used to enable the various
package-specific BBDB functions.  This feature activation is
accomplished through the passing of symbols which tell the function
which features to activate.  These symbols are outlined below and in the
Emacs documentation for the `bbdb-initialize'(1)

Initialization symbols for mail and news readers
................................................

`gnus'
     Initialize support for Gnus(2).  If you pass the `gnus' symbol,
     you should  probably also pass the `message' symbol.

`mh-e'
     Initialize support for the MH-E mail reader.

`rmail'
     Initialize support for the RMAIL mail reader.

`sendmail'
     Initialize support for sendmail (`M-x mail')

`vm'
     Initialize support for the VM mail reader.(3)

Initialization symbols for other packages
.........................................

`message'
     Initialize support for Message mode (the mail composition program
     included with Gnus).

`reportmail'
     Initialize support for the Reportmail mail notification package.

`sc'
     Initialize support for the Supercite message citation package.
     Additional initialization is required for Supercite to work with
     the  BBDB.  Note: Supercite Prep.

`w3'
     Initialize support for Web browsers.

Initialization example
......................

   To initialize support for Gnus 5.5, Message mode, Supercite, and Web
browsers, the following forms would be used:

     (require 'bbdb)
     (bbdb-initialize 'gnus 'message 'sc 'w3)

Manual initialization
.....................

   If your initialization needs exceed those provided by
`bbdb-initialize', refer to the following sections for a description of
the procedures necessary for enabling BBDB support for the packages
listed above.  The procedures described are the same as those carried
out by the `bbdb-initialize' function when passed the appropriate
symbols.  That is, the procedure listed in the RMAIL Prep section below
is the same as than executed by `bbdb-initialize' when the `rmail'
symbol is passed.

Mail and News readers:

Gnus Prep

Initializing BBDB support for Gnus

MH-E Prep

Initializing BBDB support for MH-E

RMAIL Prep

Initializing BBDB support for RMAIL

Sendmail Prep

Initializing BBDB support for Sendmail

VM Prep

Initializing BBDB support for VM

Other packages:

Message Prep

Initializing BBDB support for Message mode

Reportmail Prep

Initializing BBDB support for Reportmail

Supercite Prep

Initializing BBDB support for Supercite

Web Browser Prep

Initializing BBDB support for Web Browsers

   ---------- Footnotes ----------

   (1) This documentation can be accessed by typing `C-h f
bbdb-initialize RET'.

   (2) If you are using GNUS (not Gnus),  and if your GNUS version is
3.14 or older, use the `Gnus' (note  the capitalization) symbol.

   (3) For the VM  initialization to work properly, you must either call
`bbdb-initialize' with the `vm' symbol from within your VM
initialization file (`~/.vm'), or you must call  `bbdb-insinuate-vm'
manually from within your VM initialization  file.