.TH i 3 "debugger  3.1.1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
i \- Debugger/Interpreter Interface
.SH DESCRIPTION
.LP
The module \fIi\fR provides short forms for some of the functions used by the graphical Debugger and some of the functions in the \fIint\fR module, the Erlang interpreter\&. 
.LP
This module also provides facilities for displaying status information about interpreted processes and break points\&.
.LP
It is possible to attach to interpreted processes by giving the corresponding process identity only\&. By default, an attachment window pops up\&. Processes at other Erlang nodes can be attached manually or automatically\&.
.LP
By preference, these functions can be included in the module \fIshell_default\fR\&. By default, they are\&.

.SH EXPORTS
.LP
.B
im() -> pid()
.br
.RS
.LP
Starts a new graphical monitor\&. This is the Monitor window, the main window of the Debugger\&. All of the Debugger and interpreter functionality is accessed from the Monitor window\&. The Monitor window displays the status of all processes that have been/are executing interpreted modules\&.
.RE
.LP
.B
ii(AbsModules) -> ok
.br
.B
ii(AbsModule) -> {module, Module} | error
.br
.B
ini(AbsModules) -> ok
.br
.B
ini(AbsModule) -> {module, Module} | error
.br
.RS
.TP
Types
AbsModules = [AbsModule]
.br
AbsModule = Module | File
.br
Module = atom()
.br
File = string()
.br
.RE
.RS
.LP
Interprets the specified module(s)\&. \fIii/1\fR interprets the module(s) only at the current node, see int:i/1\&. \fIini/1\fR interprets the module(s) at all known nodes, see int:ni/1\&.
.RE
.LP
.B
iq(AbsModule) -> ok
.br
.B
inq(AbsModule) -> ok
.br
.RS
.TP
Types
AbsModule = Module | File
.br
Module = atom()
.br
File = string()
.br
.RE
.RS
.LP
Stops interpreting the specified module\&. \fIiq/1\fR stops interpreting the module only at the current node\&. \fIinq/1\fR stops interpreting the module at all known nodes\&.
.RE
.LP
.B
il() -> ok
.br
.RS
.LP
Makes a printout of all interpreted modules\&. Modules are printed together with the full path name of the corresponding source code file\&.
.RE
.LP
.B
ip() -> ok
.br
.RS
.LP
Makes a printout of the current status of all interpreted processes\&.
.RE
.LP
.B
ic() -> ok
.br
.RS
.LP
Clears information about processes executing interpreted code byt removing all information about terminated processes\&.
.RE
.LP
.B
iaa(Flags) -> true
.br
.B
iaa(Flags, Function) -> true
.br
.RS
.TP
Types
Flags = [init | break | exit]
.br
Function = {Module, Name, Args}
.br
Module = Name = atom()
.br
Args = [term()]
.br
.RE
.RS
.LP
Sets when and how to automatically attach to a debugged process, see int:auto_attach/2\&. \fIFunction\fR defaults to the standard function used by the Debugger\&.
.RE
.LP
.B
ist(Flag) -> true
.br
.RS
.TP
Types
Flag = all | no_tail | false
.br
.RE
.RS
.LP
Sets how to save call frames in the stack, see int:stack_trace/1\&. 
.RE
.LP
.B
ia(Pid) -> ok | no_proc
.br
.RS
.TP
Types
Pid = pid()
.br
.RE
.RS
.LP
Attaches to the debugged process \fIPid\fR\&. A Debugger Attach Process window is opened for the process\&.
.RE
.LP
.B
ia(X,Y,Z) -> ok | no_proc
.br
.RS
.TP
Types
X = Y = Z = int()
.br
.RE
.RS
.LP
Same as \fIia(Pid)\fR, where \fIPid\fR is the result of calling the shell function \fIpid(X, Y, Z)\fR\&.
.RE
.LP
.B
ia(Pid, Function) -> ok | no_proc
.br
.RS
.TP
Types
Pid = pid()
.br
Function = {Module, Name}
.br
Module = Name = atom()
.br
.RE
.RS
.LP
Attaches to the debugged process \fIPid\fR\&. The interpreter will call \fIspawn(Module, Name, [Pid])\fR (and ignore the result)\&.
.RE
.LP
.B
ia(X,Y,Z, Function) -> ok | no_proc
.br
.RS
.TP
Types
X = Y = Z = int()
.br
Function = {Module, Name}
.br
Module = Name = atom()
.br
.RE
.RS
.LP
Same as \fIia(Pid, Function)\fR, where \fIPid\fR is the result of calling the shell function \fIpid(X, Y, Z)\fR\&. An attached process is expected to call the unofficial \fIint:attached(Pid)\fR function and to be able to handle messages from the interpreter, see \fIdbg_ui_trace\&.erl\fR for an example\&.
.RE
.LP
.B
ib(Module, Line) -> ok | {error, break_exists}
.br
.RS
.TP
Types
Module = atom()
.br
Line = int()
.br
.RE
.RS
.LP
Creates a breakpoint at \fILine\fR in \fIModule\fR\&.
.RE
.LP
.B
ib(Module, Name, Arity) -> ok | {error, function_not_found} 
.br
.RS
.TP
Types
Module = Name = atom()
.br
Arity = int()
.br
.RE
.RS
.LP
Creates breakpoints at the first line of every clause of the \fIModule:Name/Arity\fR function\&.
.RE
.LP
.B
ir() -> ok
.br
.RS
.LP
Deletes all breakpoints\&.
.RE
.LP
.B
ir(Module) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
.RE
.RS
.LP
Deletes all breakpoints in \fIModule\fR\&.
.RE
.LP
.B
ir(Module, Line) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
Line = int()
.br
.RE
.RS
.LP
Deletes the breakpoint located at \fILine\fR in \fIModule\fR\&.
.RE
.LP
.B
ir(Module, Name, Arity) -> ok | {error, function_not_found} 
.br
.RS
.TP
Types
Module = Name = atom()
.br
Arity = int()
.br
.RE
.RS
.LP
Deletes the breakpoints at the first line of every clause of the \fIModule:Name/Arity\fR function\&.
.RE
.LP
.B
ibd(Module, Line) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
Line = int()
.br
.RE
.RS
.LP
Makes the breakpoint at \fILine\fR in \fIModule\fR inactive\&.
.RE
.LP
.B
ibe(Module, Line) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
Line = int()
.br
.RE
.RS
.LP
Makes the breakpoint at \fILine\fR in \fIModule\fR active\&. 
.RE
.LP
.B
iba(Module, Line, Action) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
Line = int()
.br
Action = enable | disable | delete
.br
.RE
.RS
.LP
Sets the trigger action of the breakpoint at \fILine\fR in \fIModule\fR to \fIAction\fR\&.
.RE
.LP
.B
ibc(Module, Line, Function) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
Line = int()
.br
Function = {Module, Name}
.br
Name = atom()
.br
.RE
.RS
.LP
Sets the conditional test of the breakpoint at \fILine\fR in \fIModule\fR to \fIFunction\fR\&.
.LP
The conditional test is performed by calling \fIModule:Name(Bindings)\fR, where \fIBindings\fR is the current variable bindings\&. The function must return \fItrue\fR (break) or \fIfalse\fR (do not break)\&. Use \fIint:get_binding(Var, Bindings)\fR to retrieve the value of a variable \fIVar\fR\&.
.RE
.LP
.B
ipb() -> ok
.br
.RS
.LP
Makes a printout of all existing breakpoints\&.
.RE
.LP
.B
ipb(Module) -> ok
.br
.RS
.TP
Types
Module = atom()
.br
.RE
.RS
.LP
Makes a printout of all existing breakpoints in \fIModule\fR\&.
.RE
.LP
.B
iv() -> atom()
.br
.RS
.LP
Returns the current version number of the interpreter\&. The same as the version number of the Debugger application\&. 
.RE
.LP
.B
help() -> ok
.br
.RS
.LP
Prints help text\&.
.RE
.SH USAGE
.LP
Refer to the Debugger User\&'s Guide for information about the Debugger\&.
.SH SEE ALSO
.LP
\fIint(3)\fR