diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/installation')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/installation/index.html | 204 |
1 files changed, 58 insertions, 146 deletions
diff --git a/docs/en/erlang.mk/1/guide/installation/index.html b/docs/en/erlang.mk/1/guide/installation/index.html index 867fb9ed..e1d4284e 100644 --- a/docs/en/erlang.mk/1/guide/installation/index.html +++ b/docs/en/erlang.mk/1/guide/installation/index.html @@ -62,183 +62,95 @@ <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"> +<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> +<p>Git and Erlang/OTP must also be installed.</p> +<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> +<p>Some packages may require additional libraries.</p> <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 +<p>The commands to install packages vary between distributions:</p> +<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 class="paragraph"><p>Alpine Linux and other distributions based on BusyBox come -with an incompatible <code>awk</code> program. Installing the GNU Awk -(<code>gawk</code> on Alpine) solves this issue.</p></div> -</div> -<div class="sect3"> +<pre><tt>$ pacman -S erlang git make</tt></pre> +</div></div> +<p>Alpine Linux and other distributions based on BusyBox come with an incompatible <code>awk</code> program. Installing the GNU Awk (<code>gawk</code> on Alpine) solves this issue.</p> <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 +<p>FreeBSD comes with binary and source packages:</p> +<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"> +<pre><tt>$ pkg install erlang git gmake</tt></pre> +</div></div> +<p>On FreeBSD the <code>make</code> command is BSD Make. Use <code>gmake</code> instead.</p> <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 +<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 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 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 +<pre><tt>$ brew install erlang git make</tt></pre> +</div></div> +<p>Homebrew installs GNU Make as <code>gmake</code>. The <code>make</code> command is the one provided by Apple.</p> +<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"> +<pre><tt>$ sudo port install erlang git gmake</tt></pre> +</div></div> <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"> +<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> +<p>NOTE: Erlang.mk expects Unix line breaks in most of the files (LF instead of CRLF). Make sure to configure your text editor adequately.</p> +<p>The rest of this section details how to setup Erlang/OTP and MSYS2 in order to use Erlang.mk.</p> <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> otp_win64_18.0.exe /S</code></pre> -</div></div> -</div> -<div class="sect3"> +<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> +<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> +<p>You can install Erlang/OTP silently using the <code>/S</code> switch on the command line:</p> +<div class="listingblock"><div class="content"><pre>C:\Users\essen\Downloads> otp_win64_18.0.exe /S</pre></div></div> <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:\> 7z x msys2.tar.xz -C:\> 7z x msys2.tar > 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:\> C:\msys64\usr\bin\bash -lc "pacman --needed --noconfirm -Sy bash pacman pacman-mirrors msys2-runtime" -C:\> C:\msys64\usr\bin\bash -lc "pacman --noconfirm -Syu"</code></pre> -</div></div> -</div> -<div class="sect3"> +<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> +<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> +<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> +<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 class="listingblock"><div class="content"><pre>C:\> 7z x msys2.tar.xz +C:\> 7z x msys2.tar > NUL</pre></div></div> +<p>Then you can run the two commands needed to perform the post-installation setup:</p> +<div class="listingblock"><div class="content"><pre>C:\> C:\msys64\usr\bin\bash -lc "pacman --needed --noconfirm -Sy bash pacman pacman-mirrors msys2-runtime" +C:\> C:\msys64\usr\bin\bash -lc "pacman --noconfirm -Syu"</pre></div></div> <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 +<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 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 +<pre><tt>$ pacman -S git make</tt></pre> +</div></div> +<p>You can use <code>pacman -Ss</code> to search packages. For example, to find all packages related to GCC:</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>$ 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 +<pre><tt>$ pacman -Ss gcc</tt></pre> +</div></div> +<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 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:\> C:\msys64\usr\bin\bash -lc "pacman --noconfirm -S git make"</code></pre> +<pre><tt>$ pacman -S mingw-w<font color="#993399">64</font>-x86_64-gcc</tt></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"> +<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 class="listingblock"><div class="content"><pre>C:\> C:\msys64\usr\bin\bash -lc "pacman --noconfirm -S git make"</pre></div></div> +<p>You can use similar <code>bash</code> commands if you need to run programs inside the MSYS2 environment from a batch file.</p> <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> +<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> + |