1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<meta name="generator" content="Hugo 0.17" />
<title>Nine Nines: Escripts</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=1" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>Escripts</span></h1>
<div class="paragraph"><p>Escripts are an alternative to release. They are meant to be
used for small command line executables written in Erlang.</p></div>
<div class="paragraph"><p>They are not self-contained, unlike <a href="../relx">releases</a>.
Erlang must be installed for them to run. This however means
that they are fairly small compared to releases.</p></div>
<div class="paragraph"><p>For self-contained executables, check <a href="../sfx">self-extracting releases</a>.</p></div>
<div class="sect1">
<h2 id="_requirements">Requirements</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk uses <code>p7zip</code> by default to generate the escript
archive. Make sure it is installed. On most systems the
package is named <code>p7zip</code>; on Ubuntu you need <code>p7zip-full</code>.</p></div>
<div class="paragraph"><p>If <code>p7zip</code> is unavailable, <code>zip</code> may be used by setting
the <code>ESCRIPT_ZIP</code> variable. For example:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ make escript <span style="color: #009900">ESCRIPT_ZIP</span><span style="color: #990000">=</span>zip</tt></pre></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_generating_an_escript">Generating an escript</h2>
<div class="sectionbody">
<div class="paragraph"><p>Run the following command to generate an escript:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ make escript</tt></pre></div></div>
<div class="paragraph"><p>This will by default create an escript with the same name as
the project, in the project’s directory. If the project is
called <code>relx</code> then the escript will be in <code>./relx</code>.</p></div>
<div class="paragraph"><p>You can run the escript as you would any executable:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ <span style="color: #990000">.</span>/relx</tt></pre></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration">Configuration</h2>
<div class="sectionbody">
<div class="paragraph"><p>You can change the name of the escript by setting <code>ESCRIPT_NAME</code>.
The name determines both the default output file name and the
entry module containing the function <code>main/1</code>.</p></div>
<div class="paragraph"><p><code>ESCRIPT_FILE</code> can be set if you need a different file name
or location.</p></div>
<div class="paragraph"><p>The escript header can be entirely customized. The first line
is the shebang, set by <code>ESCRIPT_SHEBANG</code>. The second line is
a comment, set by <code>ESCRIPT_COMMENT</code>. The third line is the
arguments the VM will use when running the escript, set by
<code>ESCRIPT_EMU_ARGS</code>.</p></div>
<div class="paragraph"><p>Finally, <code>ESCRIPT_ZIP</code> can be set to customize the command used
to create the zip file. Read on for more information.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_extra_files">Extra files</h2>
<div class="sectionbody">
<div class="paragraph"><p>Generating an escript is a two-part process. First, a zip file
is created with the contents of the escript. Then a header is
added to this file to create the escript.</p></div>
<div class="paragraph"><p>It is possible to add commands that will be executed between
the two steps. You can for example add extra files to the zip
archive:</p></div>
<div class="listingblock">
<div class="content"></div></div>
<div class="paragraph"><p>The <code>ESCRIPT_ZIP</code> variable contains the command to run to add
files to the zip archive <code>ESCRIPT_ZIP_FILE</code>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_optimizing_for_size">Optimizing for size</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk will by default compile BEAM files with debug
information. You may want to disable this behavior to obtain
smaller escript files. Simply set <code>ERLC_OPTS</code> to a value that
does not include <code>+debug_info</code>.</p></div>
</div>
</div>
<nav style="margin:1em 0">
<a style="float:left" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/sfx/">
Self-extracting releases
</a>
<a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/compat/">
Compatibility with other build tools
</a>
</nav>
</div>
<div class="span3 sidecol">
<h3>
Erlang.mk
1
User Guide
</h3>
<ul>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/erlang.mk/1/guide">1</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2016</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
