Node:Installation, Next:Setting up Emacs, Previous:Install and first steps, Up:Install and first steps
IMPORTANT: The following steps 1 to 8. describe installation
tasks if you got the archive in the format available at the ECB
website. If you use XEmacs and got ECB as a regular XEmacs-package
(e.g. downloaded and installed by the net-installer or package-manager
of XEmacs) then there is nothing to do for you, but you can
immediately start ECB with ecb-activate
or read the online-help
with ecb-show-help
!
README
in the ECB-directory and install the
required semantic- and eieio-version.
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 checks auto. during start-time if the correct versions of semantic and eieio are installed and gives you proper feedback. See Download required packages.
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
1.
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!
.emacs
:
If you want to load the complete ECB at (X)Emacs-loadtime (Advantage:
All ECB-options available after loading ECB. Disadvantage: Increasing
loadtime2):
(require 'ecb)
If you want to load the ECB first after starting it by
ecb-activate
(Advantage: Fast loading3.
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
.
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:
ecb-show-help
Maybe you are interested to read the online-help of ECB before first start.
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.)
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:
info-help
into the
info-directory of Emacs
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
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).
This works at least for Emacs 20.X and Emacs 21.X but XEmacs may have slightly different mechanisms; see the XEmacs documentation
Cause of full loading of ECB itself and also the packages semantic and eieio regardless if ECB is started.
ECB, semantic and eieio are first loaded after starting ECB or with other words: ECB and semantic are not loaded if you do not use/need them