Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 89 lines (68 sloc) 3.413 kb
da8d627 @massemanet some cosmetic changes
massemanet authored
1 distel -- Distributed Emacs Lisp for Erlang.
a8f577f import from cvs
Luke Gorrie authored
2 ------------------------------------------------------------
3
4 Distel is a library for Emacs<->Erlang communication, plus a suite of
5 tools built on top of it, such as a debugger front-end. It works by
6 using the Erlang distribution protocol to connect Emacs with regular
7 Erlang nodes, turning it into a very convenient user-interface
8 toolkit.
9
10 After the INSTALL procedure, you will have an extended Erlang mode any
11 time you edit erlang files. You can see that this is enabled from the
12 mode-line string "Erlang EXT", instead of just "Erlang". To see the
13 available commands, use `describe-mode' (C-h m), which describes all
14 the currently activated modes. Near the bottom of its output you will
15 find this description:
16
17 Extensions to erlang-mode for communicating with a running Erlang node.
18
d15406e @massemanet updated the docs from its mint OTP R8 condition...
massemanet authored
19 These commands generally communicate with an Erlang node. The first
20 time you use one, you will be prompted for the name of the node to
21 use.
22
23 Here's a subset of the available commands. Use `describe-mode' (C-h m)
24 on any Distel buffer when you want to know what commands are
25 available.
26
23dab48 @massemanet fixed some compiler warnings
massemanet authored
27 C-c C-d n - set the erlang node name
28 C-c C-d g - upload the distel modules to the erlang node
29
d15406e @massemanet updated the docs from its mint OTP R8 condition...
massemanet authored
30 M-/ - Complete a module or remote function name.
31 M-. - Jump from a function call to its definition.
32 M-, - Jump back from a function definition (multi-level).
33 C-c C-d : - Evaluate an erlang expression from the minibuffer.
34 C-c C-d f - Refactor expressions in the region as a new function.
35 C-c C-d F - Find a module.
36 C-c C-d i - Toggle debug interpretping of the module.
37 C-c C-d b - Toggle a debugger breakpoint at the current line.
38 C-c C-d p - Profile (with fprof) an expression from the minibuffer.
39 C-c C-d L - Reload an Erlang module.
40 C-c C-d r - Reload all Erlang modules that are out of date.
41 C-c C-d w - Who calls function under point.
42 C-c C-d H - Show the html documentation for a function.
43 C-c C-d Z - Show the signature for a function.
44
45 To get more information about a particular command, use "C-h k"
46 followed by the command's key sequence. For general information about
47 Emacs' online help, use "C-h ?".
a8f577f import from cvs
Luke Gorrie authored
48
49 If you want to write new commands of your own, the programmer's manual
50 tells you how. You can make a postscript copy with "make postscript",
51 or an Info version with "make info" and "make info_install".
52
53 For more background about the "Session" commands, have a look in
54 README.ie-session.
55
d15406e @massemanet updated the docs from its mint OTP R8 condition...
massemanet authored
56 Hope you enjoy, and please send hacks or feedback to luke@bluetail.com(*)!
a8f577f import from cvs
Luke Gorrie authored
57
d15406e @massemanet updated the docs from its mint OTP R8 condition...
massemanet authored
58 PS: The "dynamic TAGS" with M-. and M-, is the coolest bit to get
a8f577f import from cvs
Luke Gorrie authored
59 started with!
60
61 Compatibility notes:
62
63 The profiler front end requires >= R8B (to get fprof)
64 The debugger front end requires >= R8B-1
65
d15406e @massemanet updated the docs from its mint OTP R8 condition...
massemanet authored
66 Distel itself is not formally tested, but it has enough savvy users
67 that it'll typically run on the last 2 versions of Erlang and Emacs
68 (as of 2008 OTP R11/R12 and Emacs 21/22).
69
70 (*) Luke Gorrie is unfortunately no longer involved with Distel, and
71 Blutail no longer exists...
72 there is of course the distel-hackers mailing list;
73 https://lists.sourceforge.net/lists/listinfo/distel-hackers
a8f577f import from cvs
Luke Gorrie authored
74
d15406e @massemanet updated the docs from its mint OTP R8 condition...
massemanet authored
75 and the issue tracker at google;
76 http://code.google.com/p/distel
4c9fd2c @massemanet some more doc. added some text to some error messages.
massemanet authored
77
78 FAQ
79 1. Can't handle event closed in state derl-recv-challenge-ack
80
81 this is what you get if the erlang node and the distel node disagree
82 one what cookie to use.
83
84 Use (in erl)
85 erlang:get_cookie()
86 and (in emacs)
87 M-x erl-get-cookie
88 to check the cookies.
Something went wrong with that request. Please try again.