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 You can obtain a copy of the Erlang man pages here:
  10
  11     http://www.erlang.org/download
  12
  13 Note for the man page menus to be populated, the Erlang
  14 man pages must be in uncompressed form.
  15
  16 Additional documenation for this mode can be found here:
  17
  18     http://erlware.org/tools/erlware-mode
  19
  20
  21 For UNIX users
  22 --------------
  23
  24 To set up the Erlang Emacs mode on UNIX systems, edit/create the file
  25 .emacs in the your home directory.
  26
  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)
  34
  35 For XEmacs, you use add-to-list to modify the load path:
  36
  37       (add-to-list 'load-path "<path-to-mode>/erlware-mode")
  38
  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:
  42
  43       (push "<path-to-mode>/erlware-mode" load-path)
  44
  45
  46 For Windows users
  47 -----------------
  48
  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:\.
  54
  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>:
  58
  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)
  63
  64 For XEmacs, you use add-to-list to modify the load path:
  65
  66       (add-to-list 'load-path "<path-to-mode>/erlware-mode")
  67
  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:
  71
  72       (push "<path-to-mode>/erlware-mode" load-path)