Install Apertium core by compiling - Revision history

Ilnar.salimzyan at 02:55, 27 July 2022

2022-07-27T02:55:52Z

Naan Dhaan: /* Configure, build and install */

2021-05-25T09:48:18Z

Configure, build and install

Amuritna: /* Configure, build and install */ dealing with pkg-config

2018-11-18T15:26:53Z

Configure, build and install: dealing with pkg-config

Shardulc: GitHub migration

2018-03-09T02:31:03Z

GitHub migration

Rcrowther at 15:26, 27 April 2017

2017-04-27T15:26:51Z

Rcrowther at 13:24, 24 April 2017

2017-04-24T13:24:00Z

Rcrowther at 13:22, 24 April 2017

2017-04-24T13:22:12Z

Rcrowther: Filter out installation info

2017-04-22T17:29:10Z

Filter out installation info

New page

Either you are planning to work on Apertium core, or have an operating system not covered by packaging, or virtual environments (check the [[Install overview]]).

==Unix (GNU/Linux, Apple, BSD)==
{{TOCD}}
The below instructions are built from GNU/Linux material, but should be much the same on Apple, BSD, and other Unix-like systems.

===Install the prerequisites===
Install prerequisites,

*[[Prerequisites for nix|*nix (in general)]]

====Notes for different systems====
These notes have been made at different times. Some may be out-of-date. However, if you are having difficulties, they may contain some tips,

*[[Prerequisites for Debian|Ubuntu / Debian / other Debian-based]]
*[[Prerequisites for RPM|RHEL / CentOS / Fedora / OpenSUSE]]
*[[Prerequisites for openSUSE|openSUSE]]
*[[Prerequisites for Mac OS X|Mac OS X]]
*[[Prerequisites for Arch Linux|Arch Linux]]
*[[Prerequisites for Gentoo|Gentoo]]
*[[Prerequisites for FreeBSD|FreeBSD]] (untested)
*[[Prerequisites for Slackware|Slackware]]
*[[Apertium_on_SliTaz|SliTaz]]
*[[Apertium_on_Mageia|Mageia]]

=== Use Subversion to download the code ===
The main code,

<pre>
svn checkout https://svn.code.sf.net/p/apertium/svn/trunk/lttoolbox
svn checkout https://svn.code.sf.net/p/apertium/svn/trunk/apertium
svn checkout https://svn.code.sf.net/p/apertium/svn/trunk/apertium-lex-tools
</pre>

* ''Note 1: Please make sure that the directory where you put these files (i.e. where you run the <code>svn</code> command) doesn't contain spaces and other special characters. That may cause errors while compiling/linking.''
* ''Note 2: Sourceforge (https://sourceforge.net/projects/apertium/) naturally provides a full tarball download. Do not use this. The links above have a different address to the main Sourceforge address. They poke nto the SVN repository. The tarball compiles using './configure' instead of './autogen.sh'. Only packagers would be interested in using this.''

===Set up environment===
By default, Apertium is installed under the directory <code>/usr/local</code>, which requires root (sudo) access when installing. If that's fine with you, begin by pasting these lines into your terminal:

<pre>
LD_LIBRARY_PATH=/usr/local/lib:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH
PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:${PKG_CONFIG_PATH}
export PKG_CONFIG_PATH
</pre>

You should also put those lines in your <code>~/.bashrc</code> so you don't have to paste them into every terminal you open.

However, if you want Apertium installed somewhere else or don't want to install it as root, instead paste these lines into your terminal:

<pre>
PREFIX=$HOME/local # or wherever you want apertium stuff installed
LD_LIBRARY_PATH=$PREFIX/lib:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH
PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig:${PKG_CONFIG_PATH}
export PKG_CONFIG_PATH
</pre>

You should also put those lines in your <code>~/.bashrc</code> so you don't have to paste them into every terminal you open.

===Configure, build and install===
The next step is to configure, build and install each of the modules you checked out, in this order:
# <code>lttoolbox</code>
# <code>apertium</code>
# <code>apertium-lex-tools</code>

<code>cd</code> to each of the directories before you run the the commands shown below.

If you didn't specify <code>$PREFIX</code> above, or don't know what this means, then do this in each directory,

<pre>
./autogen.sh
make
sudo make install
sudo ldconfig
</pre>

If you specified a <code>$PREFIX</code> (e.g. to avoid installing as root), then you need to reset the prefix on 'autogen', so do this in each directory,

<pre>
./autogen.sh --prefix=$PREFIX
make
make install
ldconfig -n $PREFIX/lib
</pre>

(If you're on a Mac, you don't need to do <code>ldconfig</code>, don't worry that it fails.)

If you had any trouble, see [[Installation troubleshooting]].

==Windows==
If you do not want to use the [[Apertium VirtualBox]], you can compile Apertium for Windows using Cygwin; documentation for how to compile on Windows manually is at [[Apertium on Windows]].

There is also a script at [[Apertium guide for Windows users]], but it is currently out-of-date and in need of updating.

==Troubleshooting==
Compiles go wrong. Of course they do,
* Search the page [[Installation Troubleshooting]] for your error message.

==Continuing==
One way to test you have something, immediately, it to try invoke a tool. Without language data you can't see a translation, but you can see the help. Try,

<pre>
lt-proc
</pre>

You may want to write a new language pair, but you could download a language pair to test the install. Follow the instructions for [[Install language data by compiling]]. Or, if your system has packaging, download a language package (but beware, a package manager may pull in a old package of Apertium core, too).

[[Category:Installation]]
[[Category:Documentation in English]]

@@ Line 26: / Line 26: @@
 *[[Apertium_on_SliTaz|SliTaz]]
 *[[Apertium_on_Mageia|Mageia]]
+*[[Apertium_on_Alpine_Linux|Alpine]]
 === Use git to download the code ===

@@ Line 6: / Line 6: @@
 The below instructions are built from GNU/Linux material, but should be much the same on Apple, BSD, and other Unix-like systems.
-If you are on an Apple system, you may want to look at the detailed [[Install Apertium core by compiling#Apple systems |links below]].
+If you are on an Apple system, you may want to look at  [[Prerequisites for Mac OS X]] then [[Apertium on Mac OS X]] before returning here.
 ===Install the prerequisites===
@@ Line 106: / Line 106: @@
 There is also a script at [[Apertium guide for Windows users]], but it is currently out-of-date and in need of updating.
-==Apple systems==
-If you do not want to use the [[Apertium VirtualBox]], you can compile Apertium on an Apples OS, [[Prerequisites for Mac OS X]] then [[Apertium on Mac OS X]].

@@ Line 1: / Line 1: @@
-Either you are planning to work on Apertium core, or have an operating system not covered by packaging, or virtual environments (check the [[Install overview]]).
+Either you are planning to work on Apertium core, or have an operating system not covered by packaging, or virtual environments (check the [[Installation | Install overview]]).
@@ Line 5: / Line 5: @@
 {{TOCD}}
 The below instructions are built from GNU/Linux material, but should be much the same on Apple, BSD, and other Unix-like systems.
+If you are on an Apple system, you may want to look at the detailed [[Install Apertium core by compiling#Apple systems |links below]].
 ===Install the prerequisites===
@@ Line 103: / Line 105: @@
 There is also a script at [[Apertium guide for Windows users]], but it is currently out-of-date and in need of updating.
+==Apple systems==
+If you do not want to use the [[Apertium VirtualBox]], you can compile Apertium on an Apples OS, [[Prerequisites for Mac OS X]] then [[Apertium on Mac OS X]].

@@ Line 96: / Line 96: @@
 (If you're on a Mac, you don't need to do <code>ldconfig</code>, don't worry that it fails.)
+To compile process-tagger-output, do this in apertium-lex-tools directory,
+<pre>
+cd scripts
+make
+</pre>
+To install IRSTLM or yasmet along with apertium-lex-tools, add <code>--with-yasmet</code> and <code>--with-irstlm</code> to <code>./autogen.sh</code> for yasmet and IRSTLM respectively
 If you had any trouble, see [[Installation troubleshooting]].

@@ Line 81: / Line 81: @@
 sudo ldconfig
 </pre>
+When doing this, you might encounter a "cannot find pkg-config" error or something similar. You can solve this by installing pkg-config: <code>sudo apt-get install pkg-config</code>
 If you specified a <code>$PREFIX</code> (e.g. to avoid installing as root), then you need to reset the prefix on 'autogen', so do this in each directory,
@@ Line 97: / Line 99: @@
 If you had any trouble, see [[Installation troubleshooting]].
 ==Windows==
 If you do not want to use the [[Apertium VirtualBox]], you can compile Apertium for Windows using Cygwin; documentation for how to compile on Windows manually is at [[Apertium on Windows]].

@@ Line 28: / Line 28: @@
-=== Use Subversion to download the code ===
+=== Use git to download the code ===
 The main code,
 <pre>
-svn checkout https://svn.code.sf.net/p/apertium/svn/trunk/lttoolbox
+git clone https://github.com/apertium/lttoolbox.git
-svn checkout https://svn.code.sf.net/p/apertium/svn/trunk/apertium
+git clone https://github.com/apertium/apertium.git
-svn checkout https://svn.code.sf.net/p/apertium/svn/trunk/apertium-lex-tools
+git clone https://github.com/apertium/apertium-lex-tools.git
 </pre>
-* ''Note 1: Please make sure that the directory where you put these files (i.e. where you run the <code>svn</code> command) doesn't contain spaces and other special characters. That may cause errors while compiling/linking.''
+* ''Note: Please make sure that the directory where you put these files (i.e. where you run the <code>git</code> command) doesn't contain spaces and other special characters. That may cause errors while compiling/linking.''
-* ''Note 2: Sourceforge (https://sourceforge.net/projects/apertium/)  naturally provides a full tarball download. Do not use this. The links above have a different address to the main Sourceforge address. They poke nto the SVN repository. The tarball compiles using './configure' instead of './autogen.sh'. Only packagers would be interested in using this.''
 ===Set up environment===

@@ Line 119: / Line 119: @@
 lt-proc
 </pre>
+If you know you need the HFST or CG3 modules, see [[Installation of grammar libraries]]. You may also be interested in the many tips at [[Bash completion]].
 You may want to write a new language pair, but you could download a language pair to test the install. Follow the instructions for [[Install language data by compiling]]. Or, if your system has packaging, download a language package (but beware, a package manager may pull in a old package of Apertium core, too).