aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRickard Green <[email protected]>2017-05-02 15:26:39 +0200
committerRickard Green <[email protected]>2017-05-02 15:26:39 +0200
commit46367af7321bfb8c323705917469d923b2c8bf94 (patch)
tree8b67138ad19194d9639927215ff7c812a521175b
parent1b9d9234e096fbbccdf12081e27be14b14297876 (diff)
parent959cb1e4d3bdc1d28ccf5000941e7346315b0343 (diff)
downloadotp-46367af7321bfb8c323705917469d923b2c8bf94.tar.gz
otp-46367af7321bfb8c323705917469d923b2c8bf94.tar.bz2
otp-46367af7321bfb8c323705917469d923b2c8bf94.zip
Merge branch 'hm/escript-doc'
* hm/escript-doc: Improvements of escript documentation
-rw-r--r--erts/doc/src/escript.xml22
1 files changed, 22 insertions, 0 deletions
diff --git a/erts/doc/src/escript.xml b/erts/doc/src/escript.xml
index 1d5d280338..bbb00fd14a 100644
--- a/erts/doc/src/escript.xml
+++ b/erts/doc/src/escript.xml
@@ -35,6 +35,28 @@
<p><c>escript</c> provides support for running short Erlang programs
without having to compile them first, and an easy way to retrieve the
command-line arguments.</p>
+
+ <p>It is possible to bundle <c>escript</c>(s) with an Erlang
+ runtime system to make it self-sufficient and relocatable. In such
+ a standalone system, the <c>escript</c>(s) should be located in
+ the top <c>bin</c> directory of the standalone system and given
+ <c>.escript</c> as file extension. Further the (built-in)
+ <c>escript</c> program should be copied to the same directory and
+ given the scripts original name (without the <c>.escript</c>
+ extension). This will enable use of the bundled Erlang runtime
+ system.</p>
+
+ <p>The (built-in) <c>escript</c> program first determines which
+ Erlang runtime system to use and then starts it to execute your
+ script. Usually the runtime system is located in the same Erlang
+ installation as the <c>escript</c> program itself. But for
+ standalone systems with one or more escripts it may be the case
+ that the <c>escript</c> program in your path actually starts the
+ runtime system bundled with the escript. This is intentional, and
+ typically happens when the standalone system <c>bin</c> directory is not
+ in the execution path (as it may cause its <c>erl</c> program to
+ override the desired one) and the <c>escript</c>(s) are referred to via
+ symbolic links from a <c>bin</c> directory in the path.</p>
</description>
<funcs>