When Emacs is started up, it normally runs a file
~/.emacs located in your home directory. This file
should contain all of your personal customisations written as a series of
Elisp commands. In order to install the Haskell mode, you have to tell
Emacs where to find it. This is done by adding some commands to the init
~stands for your home directory.
Assuming you have placed the basic
haskell-mode.el and the modules you want to use in
~/lib/emacs, add the following command to
your init file (
adding the following lines according to which modules you want to use:
(add-hook 'haskell-mode-hook 'turn-on-haskell-doc-mode) (add-hook 'haskell-mode-hook 'turn-on-haskell-indent) (add-hook 'haskell-mode-hook 'turn-on-haskell-simple-indent)
Note that the two indentation modules are mutually exclusive - add at
Note that the line of code for simple indentation is commented out
(using a preceeding
;) in preference for the more
advanced indentation module. Installation is now complete!
The other modules are automatically loaded when needed in the following way:
(add-hook 'haskell-mode-hook 'font-lock-mode)
M-x imenuor bind
imenuto a key. E.g.
(global-set-key [(control meta down-mouse-3)] 'imenu)or you can also add it to the menubar with
(add-hook 'haskell-mode-hook 'imenu-add-menubar-index)
For those interested, each command above shall now be explained.
We must ensure that the directory
haskell-mode.el is on
load-path of Emacs. You can examine the value of
load-path by typing
C-h v load-path in
an Emacs session. Supposing that you've
haskell-mode.el in the
~/lib/emacs, if this directory is not on
load-path we add it with:
(setq load-path (cons "~/lib/emacs" load-path))
setq sets the value of a variable, and the
cons takes an element and a list and creates
a new list with the former as head and the latter as tail, as in
It is possible (and desirable) for Emacs to enter a specific mode
according to the name of the file being edited/visited.
auto-mode-alist tells Emacs what mode to run
according to which regular expression matches the filename. We wish
to run the Haskell mode on all files ending
.hi (interface file)
.gs (Gofer file), and to run the Haskell mode for
literate scripts on all files ending in
.lgs. To do this, we need to add pairs of the
(regexp . mode-function). We use
append to append a list of three such pairs
to the end of the value of
auto-mode-alist. A list in
Elisp is written within round parantheses with elements separated by
whitespace. A list is treated as a function application unless it is
', which is what we do.
In order for Emacs to know where to find the definition of our mode
literate-haskell-mode, we must use the
autoload. Both mode functions can be found in
haskell-mode.el which was downloaded in the
first installation step (the
.el extension is left off
and assumed by Emacs). As we have already ensured that this file is
load-path we need only give the filename and not
the directory. Its use is quite straightforward but for further
information, see its documentation by entering
f autoload in an Emacs session.
turn-on-haskell-module turns on
the corresponding module. Adding such a function as a hook to the
Haskell mode will turn on that module when the mode is used.
Note that each of these modules may slow down Emacs, especially for
Most customisations are on the functionality of a particular module. See the documentation of that module for information on its customisation.
Any problems, do mail and we will try our best to help you!
Haskell Mode Home Page.