ECB - the Emacs Code Browser

Node:GNU Emacs Installation, Previous:XEmacs Installation, Up:Installation

Installation of ECB for GNU Emacs users

Basic requirement: ECB requires an Emacs-version >= 21!

IMPORTANT: If you are a XEmacs-user please read XEmacs Installation before proceeding with the following instructions!

Using the new cedet 1.0 suite: From beginning with version 2.01 ECB supports the next generation of the cedet-tools. But before the cedet 1.0 suite becomes stable this means that ECB runs correctly with loaded cedet 1.0 but the ECB-upgrading feature (see Downloading new versions) does not support autom. upgrading to latest available cedet versions. This will be first available after first stable release of the new cedet-library 1.0.

So, if the cedet 1.0 suite is loaded then the min- and max-version of semantic, eieio and speedbar (mentioned in the Requirements-section of the file README) have no relevance! If the new cedet 1.0 suite should be used then just install and load cedet 1.0 like described in the cedet-installation-instructions and go one with step 3. But ensure you have loaded - as described in the cedet-INSTALL-file - the file /path/to/cedet/common/cedet.el because otherwise cedet is not properly installed and ECB can not savely recognize that the new cedet-suite is loaded and should be used.

Download and unpack the ECB archive (probably you have already done this :-)
Read the file README in the ECB-directory and install the required semantic-, eieio- and speedbar-version¹.
Please note: ECB maybe requires a newer version of these libraries than shipped with (X)Emacs. You have to install exactly a version ECB requires and also to make sure that the correct version is loaded into (X)Emacs!
But ECB performs two autom checks:
- At load-time: It checks if the packages semantic, eieio and speedbar are at least installed so ECB can be loaded. If not it offers to download and install them.
- At start-time: It checks if the correct versions of semantic, eieio and speedbar are installed and gives you proper feedback. See Download required packages.
So if you are not sure if you have installed the required packages at all or if you have installed the correct versions of these packages then do not worry about this, just go on with the following installation steps: If ECB is missing something it will give you proper feedback and support not later than at load-time or start-time!
Add the new ECB-directory to your load-path variable.
You MUST add the ECB-install-directory to the load-path either by changing the load-path variable directly in your .emacs or site-lisp/site-start.el or by working with a file subdirs.el².
So for example the needed entry for your .emacs-file could be:
```
(add-to-list 'load-path
             "/path/to/your/ecb/installation/directory")
```
ATTENTION: ECB is NOT properly installed if it's directory is not added to load-path and for example just loaded by
```
(load-file "/path/to/ecb/ecb.el")
```
Do not do this!
Load ECB by adding code to your .emacs:
If you want to load the complete ECB at (X)Emacs-loadtime (Advantage: All ECB-options available after loading ECB. Disadvantage: Increasing loadtime³):
```
(require 'ecb)
```
If you want to load the ECB first after starting it by ecb-activate (Advantage: Fast loading⁴. Disadvantage: ECB- and semantic-options first available after starting ECB):
```
(require 'ecb-autoloads)
```
This loads all available autoloads of ECB, e.g. ecb-activate, ecb-minor-mode, ecb-byte-compile and ecb-show-help.
Regardless which method you prefer: In both cases the used statement must be placed after the statement of step 3!
Restart (X)Emacs.

ECB is now ready for use and can be activated by calling M-x ecb-activate or ecb-minor-mode. Now you can either starting using ECB or you can do these optional installation steps:

Reading the online help with ecb-show-help
Maybe you are interested to read the online-help of ECB before first start.
Bytecompiling ECB with ecb-byte-compile
This byte compiles ECB. You can safely ignore all messages if there are any. (You can also bytecompile ECB from the command-line either by using the Makefile or by using the batch-file make.bat; just read the comments in that file you choose.)
Installing the Info-help of ECB
The ECB distribution contains a subdirectory info-help which contains the online-help of ECB in Info-format. You can install this online help so it's available in the Top-directory of Info. There are two ways to do this:
- Use "install-info" (recommended):
  1. Copy the files of the subdirectory info-help into the info-directory of Emacs
  2. Install the file info-help/ecb.info with the command "install-info" (if available on your system) in the dir-file.
  The supplied Makefile offers a target install-help which does both of these steps. You have just to call make install-help with the correct EMACSINFOPATH set (see the comment in Makefile). Here is an example:
```
make EMACSINFOPATH=/path/to/emacs/info install-help
```
- Manual Installation:
  Copy the files of the subdirectory info-help into the info-directory of Emacs and modify the file dir manually.
But it doesn't matter if you do not execute this step (8.) because the online help of ECB is always available though, see ecb-show-help (see Interactive ECB commands).

Footnotes

The speedbar-version shipped with GNU Emacs <= 21.3 does not satisfy the requirements for this feature - download a newer one!
This works at least for Emacs but XEmacs may have slightly different mechanisms; see the XEmacs documentation
Cause of full loading of ECB itself and also the packages semantic, eieio and speedbar regardless if ECB is started.
ECB, semantic, eieio and speedbar are first loaded after starting ECB or with other words: ECB and semantic are not loaded if you do not use/need them