aboutsummaryrefslogtreecommitdiffstats
path: root/guide/shell.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-04 12:04:40 +0200
committerLoïc Hoguin <[email protected]>2018-06-04 12:04:40 +0200
commit4684b443bbe71bd9b7acd7a4b5aec5160031ae71 (patch)
tree164bee29e055c40a176b568b0076627602632266 /guide/shell.html
parent75a6ce5f30ab530b2f38ea06262cff0d3a78643a (diff)
downloaderlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.tar.gz
erlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.tar.bz2
erlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.zip
Update user guide
Diffstat (limited to 'guide/shell.html')
-rw-r--r--guide/shell.html4
1 files changed, 3 insertions, 1 deletions
diff --git a/guide/shell.html b/guide/shell.html
index 791a2ee..0d389a5 100644
--- a/guide/shell.html
+++ b/guide/shell.html
@@ -42,7 +42,9 @@ To continue with our example, if you want to use <span class="emphasis"><em>kjel
shell, you also need to change <code class="literal">SHELL_ERL</code> and point it to the
<code class="literal">kjell</code> executable:</p><pre class="programlisting">SHELL_ERL = $(DEPS_DIR)/kjell/bin/kjell</pre><p>You can specify additional options to be used when starting the
shell using the <code class="literal">SHELL_OPTS</code> variable:</p><pre class="programlisting">SHELL_OPTS = -setcookie chocolate</pre><p>Any of the usual <code class="literal">erl</code> options can be used, including <code class="literal">-eval</code>:</p><pre class="programlisting">SHELL_OPTS = -eval 'my_app:run()'</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_3"></a>17.2. Usage</h2></div></div></div><p>To start the shell, all you need is the following command:</p><pre class="programlisting">$ make shell</pre><p>The shell can be stopped as usual with a double Ctrl+C or the
-command <code class="literal">q().</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="tests.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="eunit.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+command <code class="literal">q().</code>.</p><p>Note that the <code class="literal">shell</code> target does not build the application. To do it,
+use either the <code class="literal">app</code> target or, if you want to include also test
+modules, the <code class="literal">test-build</code> target.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="tests.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tests.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="eunit.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
</main>
</body>
</html>