aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-11-01 12:45:55 +0200
committerLoïc Hoguin <[email protected]>2016-11-01 12:45:55 +0200
commit468a3b4e23def6c894c1164551536dd4bba84e66 (patch)
tree3d2d60503d7a5918c82b68d2efbc4c2ca2790ae4
parentb5e50a342f7312330dc56026c223b1f17bab1fbf (diff)
downloaderlang.mk-468a3b4e23def6c894c1164551536dd4bba84e66.tar.gz
erlang.mk-468a3b4e23def6c894c1164551536dd4bba84e66.tar.bz2
erlang.mk-468a3b4e23def6c894c1164551536dd4bba84e66.zip
Document ESCRIPT_ZIP=zip and Ubuntu's p7zip-full
[ci-skip]
-rw-r--r--doc/src/guide/escripts.asciidoc11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/src/guide/escripts.asciidoc b/doc/src/guide/escripts.asciidoc
index eebd6d8..722dcc6 100644
--- a/doc/src/guide/escripts.asciidoc
+++ b/doc/src/guide/escripts.asciidoc
@@ -10,8 +10,17 @@ that they are fairly small compared to releases.
For self-contained executables, check xref:sfx[self-extracting releases].
+=== Requirements
+
Erlang.mk uses `p7zip` by default to generate the escript
-archive. Make sure it is installed.
+archive. Make sure it is installed. On most systems the
+package is named `p7zip`; on Ubuntu you need `p7zip-full`.
+
+If `p7zip` is unavailable, `zip` may be used by setting
+the `ESCRIPT_ZIP` variable. For example:
+
+[source,bash]
+$ make escript ESCRIPT_ZIP=zip
=== Generating an escript