Update ChangeLog, AUTHORS.
[erlware-mode.git] / README
blob363f203a3bfeeb84b11ffcebc4dbacfb3b737cc9
1 User configuration notes
2 ========================
4 Below is a quick guide to necessary configurations for getting
5 started with the Erlang mode for Emacs. Please refer to the
6 Users guide and reference manual in the documentation for the
7 Erlang/OTP application tools for more information.
9 You can obtain a copy of the Erlang man pages here:
11     http://www.erlang.org/download
13 Note for the man page menus to be populated, the Erlang
14 man pages must be in uncompressed form.
16 Additional documenation for this mode can be found here:
18     http://erlware.org/tools/erlware-mode
21 For UNIX users
22 --------------
24 To set up the Erlang Emacs mode on UNIX systems, edit/create the file
25 .emacs in the your home directory.
27 Below is a complete example of what should be added to a user's .emacs
28 provided that OTP is installed in the directory /usr/local/otp:
29         
30       (setq load-path (cons "<path-to-mode>/erlware-mode" load-path))
31       (setq erlang-man-root-dir "/usr/local/otp")
32       (setq exec-path (cons "/usr/local/otp/bin" exec-path))
33       (require 'erlang-start)
35 For XEmacs, you use add-to-list to modify the load path:
37       (add-to-list 'load-path "<path-to-mode>/erlware-mode")
39 If your XEmacs system already has the default erlang mode on
40 the search path, you may need to put the erlware path at the
41 front of the search path:
43       (push "<path-to-mode>/erlware-mode" load-path)
46 For Windows users
47 -----------------
49 To set up the Erlang Emacs mode on Windows systems, edit/create the
50 file .emacs, the location of the file depends on the configuration of
51 the system. If the HOME environment variable is set, Emacs will look
52 for the .emacs file in the directory indicated by the HOME variable.
53  If HOME is not set, Emacs will look for the .emacs file in C:\.
55 Below is a complete example of what should be added to a user's .emacs
56 provided that OTP is installed in the directory C:\Program
57 Files\erl-<Ver>:
59       (setq load-path (cons  "<path-to-mode>/erlware-mode" load-path))
60       (setq erlang-man-root-dir "C:/Program Files/erl<Ver>")
61       (setq exec-path (cons "C:/Program Files/erl<Ver>/bin" exec-path))
62       (require 'erlang-start)
64 For XEmacs, you use add-to-list to modify the load path:
66       (add-to-list 'load-path "<path-to-mode>/erlware-mode")
68 If your XEmacs system already has the default erlang mode on
69 the search path, you may need to put the erlware path at the
70 front of the search path:
72       (push "<path-to-mode>/erlware-mode" load-path)