summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorRonan Waide <waider@waider.ie>2001-03-26 12:59:18 +0000
committerRonan Waide <waider@waider.ie>2001-03-26 12:59:18 +0000
commitcb39269b15bf1d9fd8f03c68378c0a627d507e4c (patch)
treeef03fa9348cbe0824405f626fdda6e7da0186427 /INSTALL
parent63c9aa53eea2c5d9a6753065ad3fd7c54820336a (diff)
Added instructions for running from CVS and from source.
Removed direction to copy .tex and .el files as they're not required for a working installation.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL72
1 files changed, 54 insertions, 18 deletions
diff --git a/INSTALL b/INSTALL
index 99e4b73..5f4e3e5 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,21 @@
+This file has three sets of installation instructions: with `make',
+without `make', and uncompiled. Please follow the appropriate set of
+instructions. If you plan on running BBDB directly from CVS, please
+check the additional instructions below.
+
+===============================================================================
+
+Running BBDB from CVS:
+
+ This is not recommended, unless you're a BBDB developer. You will
+ need to either install the GNU autoconf package, or download the
+ pregenerated copy of configure from the BBDB website. If you choose
+ the former option, you'll need to run `autoconf' to generate the
+ configure script. Thereafter, follow the appropriate set of
+ instructions below.
+
+===============================================================================
+
To compile and install the BBDB on systems with `make':
1) Configure the compilation process:
@@ -7,7 +25,7 @@ To compile and install the BBDB on systems with `make':
system and generate the Makefile's accordingly.
The `configure' script comes with a number of options that might be of
- interest for you:
+ interest to you:
`--with-emacs=PROG' lets you select an Emacs program to use. By
default, "emacs" and "xemacs" will be tried in that order.
@@ -40,13 +58,13 @@ To compile and install the BBDB on systems with `make':
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 -
+ command 'make all'. (The BBDB also supports sendmail 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
+ program (except for sendmail mode), issue the command
'make bbdb'.
@@ -57,32 +75,26 @@ To compile and install the BBDB on systems with `make':
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.
+ iii) 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
+ ii) Copy the .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 TeX search path.
- iv) Copy the .info and .info-* files from the texinfo
+ directory to the load-path).
+ iii) 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.
i) Follow steps 1 and 2.
ii) Issue the 'make install-pkg' command.
-
+===============================================================================
To compile and install the BBDB on systems without `make':
@@ -95,7 +107,30 @@ To compile and install the BBDB on systems without `make':
2) Install the BBDB as outlined in step 3 above.
+===============================================================================
+
+To run BBDB uncompiled:
+
+ Again, this is really not recommended, although it will generate a
+ more meaningful stacktrace if you happen to run into a problem. In
+ order to run BBDB uncompiled, you'll need to do two things:
+
+ 1) Generate bbdb-autoloads.el
+ You can do this by typing 'make autoloads' in the main BBDB
+ directory. Note that this will require you to have previously run
+ configure to generate Makefiles.
+ 2) Add .../bbdb/lisp to your load path
+ You need to make sure that the lisp subdirectory of the BBDB
+ source is in your load path so that Emacs can find the BBDB
+ files.
+
+ Since arbitrary chunks of the BBDB are macros, you'll probably find
+ the uncompiled version slower than the compiled version.
+
+===============================================================================
+
+Initializing BBDB:
***************************************************************************
* *
* THE BBDB INITIALIZATION PROCEDURE CHANGED IN 1.57unoff. *
@@ -114,9 +149,10 @@ To compile and install the BBDB on systems without `make':
***************************************************************************
For information on post-installation BBDB configuration and setup, see
-the info file.
+the info file. (M-x bbdb, and press 'i' in the BBDB info window)
Questions, Comments, Suggestions, and Bug Reports may be directed to
the BBDB mailing list at bbdb-info@lists.sourceforge.net. To
subscribe, send mail to bbdb-info-request@lists.sourceforge.net, with
'subscribe' as the subject.
+