View source for Hacking:Building

<div style="color:red">This page is a work in progress!!
It's based on [http://lightningismyname.blogspot.com/p/compiling-gimp.html this page]</div>
This page contains things that you should know in order to build GIMP.
__TOC__
== GIMP's dependencies ==
Gimp depends on the following common libraries for it's core:
* [[Wikipedia:GLib|GLib]] – a library used by many gnome applications, containing utilities and common data structures for programs written in C. 
* [[Wikipedia:GObject|GObject]] - a library for implemnting objects (as in Object-Oriented-Programming) in C.
* [[Wikipedia:GTK+|GTK+]] – a graphical toolkit for building cross-platform user interfaces.
* [[Wikipedia:Cairo_(graphics)|Cairo]] – a 2D graphics library, used for drawing some of GIMP’s widget and also used by Gtk+.
* Python-Cairo: Python bindings for Cairo
* [[Wikipedia:Pango|Pango]] – a library for laying out and rendering text, used also in Gtk+.

GIMP's core depends also on two libraries which are mainly (but not only) intended to be used with GIMP:
* [[Wikipedia:GEGL|GEGL]] – a graph based image processing library, heavily used in GIMP’s core.
:To build GIMP 2.10, you need the GEGL version from git branch 'gegl-0-4'.
:To build GIMP master (= the development version of GIMP), you need the GEGL version from git branch 'master'.
* [[Wikipedia:GEGL#babl|babl]] – a library for converting between pixel formats, heavily used by GIMP when communicating with GEGL. 

GIMP also needs For MyPaint brushes, libmypaint. he libmypaint repository is hosted at: https://github.com/mypaint/libmypaint

If installing from repository, do not install the master branch! Checkout the tag "v1.3.0" instead, or simply install from a tarball or from your favorite package manager.

We also need the mypaint-brushes data package:https://github.com/mypaint/mypaint-brushes. If installing from repository, install from branch "v1.3.x" or the particular tag "v1.3.0". In particular do not install from master
which installs brushes incompatible with GIMP.
Also this is a data packages and therefore it will install the
pkg-config file inside `$PREFIX/share/pkgconfig/`. If you install
mypaint-brushes from repository in a non-standard prefix, you will
have to make sure your $PKG_CONFIG_PATH environment variable also
lists `$PREFIX/share/pkgconfig/`.

Some of GIMP's plugins depend on (at least) the following libraries
* [[Wikipedia:librsvg|librsvg]] – a library for rendering [[Wikipedia:Scalable_Vector_Graphics|SVG]] files. 
* [http://www.libpng.org/pub/png/libpng.html libpng] – a library for reading and writing [[Wikipedia:Portable_Network_Graphics|PNG]] image files. Used by Gtk+, GIMP and GEGL.
* [http://libexif.sourceforge.net/ libexif] - a library for manipulating exif data (image metadata).
* [http://wvware.sourceforge.net/libwmf.html libwmf] - a library for working with [[Wikipedia:Windows Metafile|WMF]] files.
* [http://www.libtiff.org/ libtiff] - a library for reading and writing [[Wikipedia:Tagged_Image_File_Format|TIFF]] image files.
* [http://libjpeg.sourceforge.net/ libjpeg] - a library for reading and writing [[Wikipedia:JPEG|JPEG]] image files.
* [http://www.littlecms.com/ liblcms] - the Little Color Management System, a library for working with color profiles.


See also the file [https://gitlab.gnome.org/GNOME/gimp/blob/gimp-2-10/INSTALL.in INSTALL]. 
In GIMP master these informations are in the file [https://gitlab.gnome.org/GNOME/gimp/blob/master/INSTALL.in INSTALL.in] - expect to have to build GIMP first to then know the necessary dependencies for building GIMP ...

== Build system ==
=== Building from a Tarball vs. building from latest source (Git) ===
There are 2 types of build we can do:
* A build from Tarball - Tarballs (or in short, TARs) are files which pack together many folders and files, and the term of building from a Tarball refers to building from a package of code that you download from the program's website, for an official release of the program.
You can download tarballs from:
<pre>http://download.gimp.org/pub/babl/
http://download.gimp.org/pub/gegl/
http://download.gimp.org/pub/gimp/</pre>
* A build from Git - The latest source of programs is hosted in a version control system (in our case, the version control is called Git) and you can download the updated source directly from these. The source there is the most up-to-date, and it's sometimes unstable.
It matters to us, in the fact that building from Git requires an additional step (detailed below) and it usually requires more tools.
You can check out the git sources from:
<pre>git clone git@gitlab.gnome.org:GNOME/babl.git
git clone git@gitlab.gnome.org:GNOME/gegl.git
git clone git@gitlab.gnome.org:GNOME/gimp.git</pre>

=== The build process ===
GIMP, together with GEGL and babl, all use the Gnu build system. This means that compiling them basically consists of 4 steps:
# autogen.sh script - This script generates the ./configure script for the next step<pre>./autogen.sh</pre>In many cases, the autogen script also runs the configure script (see the next step) so we can usually pass arguments to it that will be passed to the configure script. '''This step is only needed when building from Git (and not from a Tarball)!'''
# configure script - This script does many checks to check which compilers and libraries you have available, which features are enabled and not, etc. When it finishes, it generates the Makefile's which are used by the make tool.<pre>./configure</pre>Usually you can see all the options that you can specify to the script, by running<pre>./configure --help</pre>One option that we'll use through all of the building tutorials, is the --prefix option<pre>./configure --prefix=/PATH/TO/INSTALL/FOLDER</pre>The path given there is used to specify where do we want the compiled result to be installed to. This is useful when you want to install to places other than the default, for example when we are doing beta-builds and we don't want them to conflict with our existing installation. This can also be used on Linux/Unix system to install into the home-directory, in cases one does not have root access.<br />'''If you are doing anything other than simply building <u>from a tarball</u>, do not run the configure script directly! Instead, run the autogen script and let it call the configure script for you!''' This is because there are some changes in the code (either locally, or in Git between tarball releases) that will not be handled correctly without the autogen script! (Thanks to schumaml from the GIMP IRC for pointing that out)
# make - The make tool uses files called Makefile, which are present at each directory, in order to call the compilers and other tools and use them on the apropriate source files<pre>make</pre>We can speed up the process by running several jobs at once (this is useful when we have a processor with several cores). For example, if we want to run 4 jobs at once, we'll do<pre>make -j4</pre>
# Now, we finally install the compiled result by invoking the make tool again, with the "install" target<pre>make install</pre>

== Additional notes ==
=== GIMP ===
* To compile GIMP you need Perl and intltool
* To compile GIMP's Python support, you need PyGTK (a Python package)
* Linking static versions of the most libraries (i.e. libgevix2) is not supported by GIMP. Use their dynamic versions.

=== GEGL ===
* To compile GEGL from Git, you need Ruby (a language interpreter)

== Specific Builds ==
* [[Hacking:Building/Linux]] - Building GIMP on Linux
* [[Hacking: Building/Mac OSX]] - Building GIMP on the Mac platform
* [[Hacking:Building/Windows]] - Building GIMP on Windows