diff options
author | Loïc Hoguin <[email protected]> | 2016-11-05 14:26:30 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-11-05 14:26:30 +0200 |
commit | b051513f18653113ac2c23008836c500e1425283 (patch) | |
tree | ce5ca5f3d2f399fbfdf1fc994bf57a43cd60b037 /docs/en/erlang.mk/1/guide/sfx.asciidoc | |
parent | 87182b2ff15eecca272589f8e2960dffe52ce6ec (diff) | |
download | ninenines.eu-b051513f18653113ac2c23008836c500e1425283.tar.gz ninenines.eu-b051513f18653113ac2c23008836c500e1425283.tar.bz2 ninenines.eu-b051513f18653113ac2c23008836c500e1425283.zip |
Update docs
Diffstat (limited to 'docs/en/erlang.mk/1/guide/sfx.asciidoc')
-rw-r--r-- | docs/en/erlang.mk/1/guide/sfx.asciidoc | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/en/erlang.mk/1/guide/sfx.asciidoc b/docs/en/erlang.mk/1/guide/sfx.asciidoc new file mode 100644 index 00000000..aae2c8d4 --- /dev/null +++ b/docs/en/erlang.mk/1/guide/sfx.asciidoc @@ -0,0 +1,49 @@ +[[sfx]] +== Self-extracting releases + +Erlang.mk allows you to package xref:relx[Relx releases] as +self-extracting archives. These archives contain all the +files in the release and come in the form of a script that +will extract and run the release automatically. + +This allows you to package the release as a single file +that can then be executed. + +This feature is currently experimental. Feedback is much +appreciated. + +=== Generating the self-extracting archive + +To generate a self-extracting release, all you need to do +is pass the `SFX=1` variable to Make when you build the +release: + +[source,bash] +$ make SFX=1 + +This will create a self-extracting archive in +`$RELX_OUTPUT_DIR/<name>.run`. For example if the release +is named `hello_world` and `$RELX_OUTPUT_DIR` is the default, +the file will be located at `_rel/hello_world.run`. + +=== Running the release + +Simply execute the script to get started: + +[source,bash] +---- +$ ./_rel/hello_world.run +Exec: /tmp/tmp.3eeEq7E1ta/erts-8.1/bin/erlexec ... +Root: /tmp/tmp.3eeEq7E1ta +/tmp/tmp.3eeEq7E1ta +Erlang/OTP 19 [erts-8.1] [source] [64-bit] [smp:4:4] ... + +Eshell V8.1 (abort with ^G) +(hello_world@localhost)1> +---- + +As you can see the archive is extracted to a temporary +directory before the release can be started. + +The self-extracting script currently only supports starting +the release in `console` mode. |