aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/shell.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-10-22 23:23:18 +0200
committerLoïc Hoguin <[email protected]>2015-10-22 23:23:18 +0200
commitd7b4e589f1716e2de5087a491ea1701d294dccbc (patch)
tree8df323b5a46e67dc9cb07ca67db7e1f5a6304384 /doc/src/guide/shell.asciidoc
parenta9dd1a433c0a3ba4f9c82bfff17924d9d4702eee (diff)
downloaderlang.mk-d7b4e589f1716e2de5087a491ea1701d294dccbc.tar.gz
erlang.mk-d7b4e589f1716e2de5087a491ea1701d294dccbc.tar.bz2
erlang.mk-d7b4e589f1716e2de5087a491ea1701d294dccbc.zip
Add shell chapter and tests
Diffstat (limited to 'doc/src/guide/shell.asciidoc')
-rw-r--r--doc/src/guide/shell.asciidoc44
1 files changed, 42 insertions, 2 deletions
diff --git a/doc/src/guide/shell.asciidoc b/doc/src/guide/shell.asciidoc
index a5643c2..083c160 100644
--- a/doc/src/guide/shell.asciidoc
+++ b/doc/src/guide/shell.asciidoc
@@ -1,5 +1,45 @@
== Erlang shell
-// @todo Write it.
+Erlang.mk provides a convenient target for starting a shell
+with all the paths set properly to experiment with your code.
-Placeholder chapter.
+=== Configuration
+
+The `SHELL_DEPS` variable can be used to define dependencies
+that are only to be used when the `make shell` command is called.
+For example, if you want to use _kjell_ as your shell:
+
+[source,make]
+SHELL_DEPS = kjell
+
+Dependencies are downloaded and compiled the first time you
+run the `make shell` command.
+
+You can customize the executable used to start the Erlang shell.
+To continue with our example, if you want to use _kjell_ as your
+shell, you also need to change `SHELL_ERL` and point it to the
+`kjell` executable:
+
+[source,make]
+SHELL_ERL = $(DEPS_DIR)/kjell/bin/kjell
+
+You can specify additional options to be used when starting the
+shell using the `SHELL_OPTS` variable:
+
+[source,make]
+SHELL_OPTS = -setcookie chocolate
+
+Any of the usual `erl` options can be used, including `-eval`:
+
+[source,make]
+SHELL_OPTS = -eval 'my_app:run()'
+
+=== Usage
+
+To start the shell, all you need is the following command:
+
+[source,bash]
+$ make shell
+
+The shell can be stopped as usual with a double Ctrl+C or the
+command `q().`.