From 959cb1e4d3bdc1d28ccf5000941e7346315b0343 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kan=20Mattsson?= Date: Fri, 28 Apr 2017 12:49:25 +0200 Subject: Improvements of escript documentation --- erts/doc/src/escript.xml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'erts') 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 @@

escript provides support for running short Erlang programs without having to compile them first, and an easy way to retrieve the command-line arguments.

+ +

It is possible to bundle escript(s) with an Erlang + runtime system to make it self-sufficient and relocatable. In such + a standalone system, the escript(s) should be located in + the top bin directory of the standalone system and given + .escript as file extension. Further the (built-in) + escript program should be copied to the same directory and + given the scripts original name (without the .escript + extension). This will enable use of the bundled Erlang runtime + system.

+ +

The (built-in) escript 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 escript program itself. But for + standalone systems with one or more escripts it may be the case + that the escript program in your path actually starts the + runtime system bundled with the escript. This is intentional, and + typically happens when the standalone system bin directory is not + in the execution path (as it may cause its erl program to + override the desired one) and the escript(s) are referred to via + symbolic links from a bin directory in the path.

-- cgit v1.2.3