forked from elixir-lang/elixir-lang.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIEx.html
More file actions
135 lines (103 loc) · 3.76 KB
/
Copy pathIEx.html
File metadata and controls
135 lines (103 loc) · 3.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html>
<html>
<head>
<title>IEx</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="content">
<h1>
IEx
</h1>
<div id="moduledoc" class="docstring">
<p>This module implements Interactive Elixir.</p>
<p>The interactive elixir needs to be set as the
proper <code>-user</code> when starting the Erlang VM and
so can be done with the help of IEx.CLI.</p>
<p>If possible, Elixir will start a tty (smart terminal)
which makes all control commands available in tty
available to the developer.</p>
<p>In case <code>tty</code> is not available (for example, Windows),
a dumb terminal version is started instead.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/iex/lib/iex.ex#L3" target="_blank" class="view_source">Source</a>
<h2>Functions summary</h2>
<ul class="summary">
<li>
<span class="summary_signature">
<a href="#after_spawn/0">after_spawn/0</a>
</span>
</li>
<li>
<span class="summary_signature">
<a href="#after_spawn/1">after_spawn/1</a>
</span>
</li>
<li>
<span class="summary_signature">
<a href="#inspect_opts/0">inspect_opts/0</a>
</span>
</li>
<li>
<span class="summary_signature">
<a href="#inspect_opts/1">inspect_opts/1</a>
</span>
</li>
<li>
<span class="summary_signature">
<a href="#started?/0">started?/0</a>
</span>
</li>
</ul>
<div id="functions_details" class="details_list">
<h2>Functions</h2>
<div class="detail">
<p class="signature" id="after_spawn/0">
<strong>after_spawn()</strong>
</p>
<div class="docstring"><p>Returns registered after spawn callbacks.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/iex/lib/iex.ex#L29" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="after_spawn/1">
<strong>after_spawn(fun)</strong>
</p>
<div class="docstring"><p>Registers a function to be invoked after IEx process is spawned.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/iex/lib/iex.ex#L22" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="inspect_opts/0">
<strong>inspect_opts()</strong>
</p>
<div class="docstring"><p>Returns currently registered inspect options.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/iex/lib/iex.ex#L51" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="inspect_opts/1">
<strong>inspect_opts(opts)</strong>
</p>
<div class="docstring"><p>Registers options used on inspect.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/iex/lib/iex.ex#L44" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="started?/0">
<strong>started?()</strong>
</p>
<div class="docstring"><p>Returns true if IEx was properly started.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/iex/lib/iex.ex#L37" target="_blank" class="view_source">Source</a>
</div>
</div>
</div>
</body>
</html>