Grammatical Framework Download and Installation


%!style:../css/style.css
%!postproc(html): <TITLE> <meta name = "viewport" content = "width = device-width"><TITLE>
%!postproc(html): <TD><B> <TH>
%!postproc(html): </B></TD> </TH>
%!postproc(html): <H1> <H1><a href="../"><IMG src="../doc/Logos/gf0.png"></a>

**GF 3.4** was released on 31 January 2013.

What's new? See the [Release notes release-3.4.html].


== Binary packages ==

| **Platform** | **Download** | **How to install**
| ... | ... | ...

More packages might be added later.

===Notes===

The Windows package is installed by just unpacking it anywhere. 
It finds the libraries relative to the ``.exe`` file.

%The ``.deb`` packages work on Ubuntu 12.04 and 12.10.

%The ``.pkg`` package works on MacOS X 10.6 (Snow Leopard).
The MacOS tar package works on 10.6 (Leopard), 10.7 (Lion)
and 10.8 (Mountain Lion)

The MacOS and Linux ``.tar.gz`` packages are designed to be installed in ``/usr/local``.
You can install them in other locations, but then you need to set the
``GF_LIB_PATH`` environment variable:

```
  export GF_LIB_PATH=/usr/local/share/gf-3.4/lib
```

where ``/usr/local`` should be replaced with the path to the location where you
unpacked the package.


==Installing the latest release from source==

[GF is on Hackage http://hackage.haskell.org/package/gf], so the prodedure is
fairly simple:

+ Install the [Haskell Platform http://hackage.haskell.org/platform]
  version 2012.4.0.0 (see notes 2&3 below)
+ ``cabal update``
+ On Linux: install some C libraries from your Linux distribution
  (see note 1 below)
+ ``cabal install gf``


You can also download the full source package from here:
[``gf-3.4.tar.gz`` gf-3.4.tar.gz].

=== Notes ===

The above steps installs GF for a single user.
% and does not require root privileges.
The executables are put in ``$HOME/.cabal/bin``
(or, with recent versions of the Haskell platform on Mac OS X,
in ``$HOME/Library/Haskell/bin``), so it is a good
idea to put a line in your ``.bash_profile`` to add that directory to you path:

```
  PATH=$HOME/.cabal/bin:$PATH
```
or
```
  PATH=$HOME/Library/Haskell/bin:$PATH
```

**Note 1**.
GF uses [``haskeline`` http://hackage.haskell.org/package/haskeline], which
on Linux depends on some non-Haskell libraries that
won't be installed automatically by cabal, and therefore need to be installed
manually. Here is one way to do this:

- On Ubuntu: ``sudo apt-get install libghc6-terminfo-dev``
- On Fedora: ``sudo yum install ghc-terminfo-devel``


**Note 2**.
GF 3.4 does **not** compile with the most recent versions of GHC (>=7.6).
We recommend using GHC 7.4 (which is part of the Haskell Platform 2012.4.0.0).
Older versions of GHC (6.12 and 7.0) still works for the most part.
(For example, there is a issue with error reporting in ``gf -server``
when compiled with GHC 7.0.)
%GF does **not** compile with the most recent versions of Alex (>=3.0).

**Note 3**.
[The Haskell Platform for Mac OS X http://hackage.haskell.org/platform/mac.html]
page states that you need Xcode 3.2 or later, but in fact it appears you need
Xcode 3.2.3 or later. If you have Xcode 3.2.2, you can get an error from the
linker: ``ld: unknown option: -no_pie``.

==Installing from the latest developer code==

The first time:
%, assuming you already have the Haskell Platform and darcs

```
  darcs get --lazy http://www.grammaticalframework.org/ GF
  cd GF
  cabal install
```

Subsequently:

```
  cd GF
  darcs pull -a
  cabal install
```

The above notes for installing from source apply also in this case.
For more info, see the [GF Developers Guide ../doc/gf-developers.html].

==Older releases==

- [GF 3.3.3 index-3.3.3.html] (March 2012).
- [GF 3.3 index-3.3.html] (October 2011).
- [GF 3.2.9 index-3.2.9.html] source-only snapshot (September 2011).
- [GF 3.2 index-3.2.html] (December 2010).
- [GF 3.1.6 index-3.1.6.html] (April 2010).
- [GF 3.1 old-index.html] (December 2009).


--------------------

[www.grammaticalframework.org http://www.grammaticalframework.org]