README

   1 User configuration notes
   2 ========================
   3
   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.
   8
   9
  10 For UNIX users
  11 --------------
  12
  13 To set up the Erlang Emacs mode on UNIX systems, edit/create the file
  14 .emacs in the your home directory.
  15
  16 Below is a complete example of what should be added to a user's .emacs
  17 provided that OTP is installed in the directory /usr/local/otp:
  18
  19       (setq load-path (cons "<path-to-mode>/erlware-mode" load-path))
  20       (setq erlang-root-dir "/usr/local/otp")
  21       (setq exec-path (cons "/usr/local/otp/bin" exec-path))
  22       (require 'erlang-start)
  23
  24 For XEmacs, you use add-to-list to modify the load path:
  25
  26       (add-to-list 'load-path "<path-to-mode>/erlware-mode")
  27
  28 If your XEmacs system already has the default erlang mode on
  29 the search path, you may need to put the erlware path at the
  30 front of the search path:
  31
  32       (push "<path-to-mode>/erlware-mode" load-path)
  33
  34
  35 For Windows users
  36 -----------------
  37
  38 To set up the Erlang Emacs mode on Windows systems, edit/create the
  39 file .emacs, the location of the file depends on the configuration of
  40 the system. If the HOME environment variable is set, Emacs will look
  41 for the .emacs file in the directory indicated by the HOME
  42 variable. If HOME is not set, Emacs will look for the .emacs file in
  43 C:\.
  44
  45 Below is a complete example of what should be added to a user's .emacs
  46 provided that OTP is installed in the directory C:\Program
  47 Files\erl-<Ver>:
  48
  49       (setq load-path (cons  "<path-to-mode>/erlware-mode" load-path))
  50       (setq erlang-root-dir "C:/Program Files/erl<Ver>")
  51       (setq exec-path (cons "C:/Program Files/erl<Ver>/bin" exec-path))
  52       (require 'erlang-start)
  53
  54 For XEmacs, you use add-to-list to modify the load path:
  55
  56       (add-to-list 'load-path "<path-to-mode>/erlware-mode")
  57
  58 If your XEmacs system already has the default erlang mode on
  59 the search path, you may need to put the erlware path at the
  60 front of the search path:
  61
  62       (push "<path-to-mode>/erlware-mode" load-path)