summaryrefslogtreecommitdiffstats
path: root/docs/en/erlang.mk/1/guide/installation/index.html
blob: c909fec1ebdfde0cbf067b9054d9dd3f8a9a4b73 (plain) (blame)
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<!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: Installation</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>Installation</span></h1>

<div class="sect1">
<h2 id="_on_unix">On Unix</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk requires GNU Make to be installed. While it will
currently work with GNU Make 3.81, support for this version
is deprecated and will be removed in 2017. We recommend
GNU Make 4.1 or later.</p></div>
<div class="paragraph"><p>Git and Erlang/OTP must also be installed.</p></div>
<div class="paragraph"><p>Some functionality requires that Autoconf 2.59 or later be
installed, in order to compile Erlang/OTP. Erlang/OTP may
have further requirements depending on your needs.</p></div>
<div class="paragraph"><p>Some packages may require additional libraries.</p></div>
<div class="sect3">
<h4 id="_linux">Linux</h4>
<div class="paragraph"><p>The commands to install packages vary between distributions:</p></div>
<div class="listingblock">
<div class="title">Arch Linux</div>
<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>$ pacman -S erlang git make</tt></pre></div></div>
</div>
<div class="sect3">
<h4 id="_freebsd">FreeBSD</h4>
<div class="paragraph"><p>FreeBSD comes with binary and source packages:</p></div>
<div class="listingblock">
<div class="title">Install binary packages</div>
<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>$ pkg install erlang git gmake</tt></pre></div></div>
<div class="paragraph"><p>On FreeBSD the <code>make</code> command is BSD Make. Use <code>gmake</code> instead.</p></div>
</div>
<div class="sect3">
<h4 id="_os_x_and_macos">OS X and macOS</h4>
<div class="paragraph"><p>While Apple distributes their own GNU Make, their version is
very old and plagued with numerous bugs. It is recommended
to install a more recent version from either Homebrew or
MacPorts:</p></div>
<div class="listingblock">
<div class="title">Homebrew</div>
<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>$ brew install erlang git homebrew/dupes/make</tt></pre></div></div>
<div class="paragraph"><p>Homebrew installs GNU Make as <code>gmake</code>. The <code>make</code> command
is the one provided by Apple.</p></div>
<div class="listingblock">
<div class="title">MacPorts</div>
<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>$ sudo port install erlang git gmake</tt></pre></div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_on_windows">On Windows</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk can be used on Windows inside an MSYS2 environment.
Cygwin, MSYS (the original) and native Windows (both Batch
and PowerShell) are currently not supported.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">Erlang.mk expects Unix line breaks in most of the files
(LF instead of CRLF). Make sure to configure your text editor
adequately.</td>
</tr></table>
</div>
<div class="paragraph"><p>The rest of this section details how to setup Erlang/OTP and
MSYS2 in order to use Erlang.mk.</p></div>
<div class="sect3">
<h4 id="_installing_erlang_otp">Installing Erlang/OTP</h4>
<div class="paragraph"><p>Erlang.mk requires Erlang/OTP to be installed. The OTP team
provides binaries of Erlang/OTP for all major and minor releases,
available from the <a href="http://www.erlang.org/download.html">official download page</a>.
It is recommended that you use the 64-bit installer unless
technically impossible. Please follow the instructions from
the installer to complete the installation.</p></div>
<div class="paragraph"><p>The OTP team also provides a short guide to
<a href="http://www.erlang.org/download.html">installing Erlang/OTP on Windows</a>
if you need additional references.</p></div>
<div class="paragraph"><p>You can install Erlang/OTP silently using the <code>/S</code> switch
on the command line:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>C:\Users\essen\Downloads&gt; otp_win64_18.0.exe /S</code></pre>
</div></div>
</div>
<div class="sect3">
<h4 id="_installing_msys2">Installing MSYS2</h4>
<div class="paragraph"><p>The only supported environment on Windows is MSYS2. MSYS2 is
a lightweight Unix-like environment for Windows that comes
with the Arch Linux package manager, <code>pacman</code>.</p></div>
<div class="paragraph"><p>The MSYS2 project provides a <a href="http://msys2.github.io">one click installer</a>
and instructions to set things up post-installation.</p></div>
<div class="paragraph"><p>It is currently not possible to use the installer silently.
Thankfully, the MSYS2 project provides an archive that can
be used in lieu of the installer. The archive however requires
<em>7zip</em> to decompress it.</p></div>
<div class="paragraph"><p>First, download the
<a href="http://sourceforge.net/projects/msys2/files/Base/x86_64/msys2-base-x86_64-20150512.tar.xz/download">MSYS2 base archive</a>
and extract it under <em>C:\</em>. Assuming you downloaded the
archive as <em>msys2.tar.xz</em> and put it in <em>C:\</em>, you can
use the following commands to extract it:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>C:\&gt; 7z x msys2.tar.xz
C:\&gt; 7z x msys2.tar &gt; NUL</code></pre>
</div></div>
<div class="paragraph"><p>Then you can run the two commands needed to perform the
post-installation setup:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>C:\&gt; C:\msys64\usr\bin\bash -lc "pacman --needed --noconfirm -Sy bash pacman pacman-mirrors msys2-runtime"
C:\&gt; C:\msys64\usr\bin\bash -lc "pacman --noconfirm -Syu"</code></pre>
</div></div>
</div>
<div class="sect3">
<h4 id="_installing_the_required_msys2_packages">Installing the required MSYS2 packages</h4>
<div class="paragraph"><p>After following these instructions, you can install GNU Make,
Git and any other required softwares. From an MSYS2 shell,
you can call <code>pacman</code> directly:</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>$ pacman -S git make</tt></pre></div></div>
<div class="paragraph"><p>You can use <code>pacman -Ss</code> to search packages. For example,
to find all packages related to GCC:</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>$ pacman -Ss gcc</tt></pre></div></div>
<div class="paragraph"><p>If you are going to compile C/C++ code, you will need to
install this package, as Erlang.mk cannot use the normal
"gcc" package:</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>$ pacman -S mingw-w<span style="color: #993399">64</span>-x86_64-gcc</tt></pre></div></div>
<div class="paragraph"><p>You can also run commands under the MSYS2 environment from
the Windows command line or batch files. This command will
install GNU Make and Git:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>C:\&gt; C:\msys64\usr\bin\bash -lc "pacman --noconfirm -S git make"</code></pre>
</div></div>
<div class="paragraph"><p>You can use similar <code>bash</code> commands if you need to run programs
inside the MSYS2 environment from a batch file.</p></div>
</div>
<div class="sect3">
<h4 id="_gotchas">Gotchas</h4>
<div class="paragraph"><p>While most of the basic functionality will just work, there are
still some issues. Erlang.mk needs to be fixed to pass the
right paths when running Erlang scripts. We are working on it.
Erlang.mk is fully tested on both Linux and Windows, but is
lacking tests in the areas not yet covered by this guide,
so expect bugs to be fixed as more tests are added.</p></div>
</div>
</div>
</div>



	
		
		

		<nav style="margin:1em 0">
			

			
				<a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/getting_started/">
					Getting started
				</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 &copy; Loïc Hoguin 2012-2016</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>