diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/escripts/index.html')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/escripts/index.html | 213 |
1 files changed, 0 insertions, 213 deletions
diff --git a/docs/en/erlang.mk/1/guide/escripts/index.html b/docs/en/erlang.mk/1/guide/escripts/index.html deleted file mode 100644 index bacb0248..00000000 --- a/docs/en/erlang.mk/1/guide/escripts/index.html +++ /dev/null @@ -1,213 +0,0 @@ -<!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"> - - <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=5" 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="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> - -<p>Escripts are an alternative to release. They are meant to be used for small command line executables written in Erlang.</p> -<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> -<p>For self-contained executables, check <a href="../sfx">self-extracting releases</a>.</p> -<h2 id="_requirements">Requirements</h2> -<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> -<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 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 <font color="#009900">ESCRIPT_ZIP</font><font color="#990000">=</font>zip</tt></pre> -</div></div> -<h2 id="_generating_an_escript">Generating an escript</h2> -<p>Run the following command to generate an escript:</p> -<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> -<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> -<p>You can run the escript as you would any executable:</p> -<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>$ <font color="#990000">.</font>/relx</tt></pre> -</div></div> -<h2 id="_configuration">Configuration</h2> -<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> -<p><code>ESCRIPT_FILE</code> can be set if you need a different file name or location.</p> -<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> -<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> -<h2 id="_extra_files">Extra files</h2> -<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> -<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 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><font color="#990000">escript-zip::</font> - <font color="#009900">$(verbose)</font> <font color="#009900">$(ESCRIPT_ZIP)</font> <font color="#009900">$(ESCRIPT_ZIP_FILE)</font> priv/templates<font color="#990000">/*</font></tt></pre> -</div></div> -<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> -<h2 id="_optimizing_for_size">Optimizing for size</h2> -<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> - - - - - - - - - - - - <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/kerl/"> - OTP version management - </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> - -<h3 id="_like_my_work__donate">Like my work? Donate!</h3> -<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> -<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> -<input type="hidden" name="cmd" value="_donations"> -<input type="hidden" name="business" value="[email protected]"> -<input type="hidden" name="lc" value="FR"> -<input type="hidden" name="item_name" value="Loic Hoguin"> -<input type="hidden" name="item_number" value="99s"> -<input type="hidden" name="currency_code" value="EUR"> -<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> -<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> -<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> -</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> - - - -</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-2018</p> - </div> - </div> - </div> - </footer> - - - <script src="/js/custom.js"></script> - </body> -</html> - - |