Difference between revisions of "Compiling Inkscape"

From Inkscape Wiki
Jump to navigation Jump to search
m (→‎Developer Compilation: update 'cvs' -> 'bzr')
(cleanup outdated details)
 
(20 intermediate revisions by 9 users not shown)
Line 1: Line 1:
Hopefully, Inkscape will compile right out of the box. If it doesn't, well that's what this page is for.
+
Hopefully, Inkscape will compile right out of the box, according to the 'Getting Started' instructions on https://inkscape.org/develop/getting-started/ . If it doesn't, well that's what this page is for.
  
Jot down notes, questions, findings, tips, etc. here on things you run into. It's a good idea to
+
Jot down notes, questions, findings, tips, etc. here on things you run into. It's a good idea to make mention of what version of the code you're trying to compile, the distribution you're running, and other such information that might be pertinent.
make mention of what version of the code you're trying to compile, the distribution you're running,
 
and other such information that might be pertinent.
 
  
If legitimate bugs are found or patches developed, please move them to the tracker at Sourceforge
+
If legitimate bugs are found or patches developed, please move them to the [https://inkscape.org/contribute/report-bugs/ tracker] rather than inlining them here.   
rather than inlining them here.   
 
  
= Notes =
+
== Notes ==
Inkscape needs automake 1.7, 1.8 or 1.10 and higher. Please consider NOT using automake1.9, because it has a bug ( link: http://sourceforge.net/mailarchive/message.php?msg_id=10288631 ) that prevents compiling of Inkscape. If you have already tried to do a $ make with automake1.9 then $ ./autogen.sh from your inkscape-cvs dir and proceed as normal. (On the other hand, I've repeatedly built it with automake-1.9.4. ralf)
 
  
You may want to also [http://wiki.inkscape.org/wiki/index.php/OtherProjects#Inkscape_Plugins.2C_Scripts.2C_and_Templates add plugins] during or after compiling.
+
Please use CMake instead of Automake for Inkscape 0.92 onwards.
 +
 
 +
CMake is a crossplatform makefile generator similar to autotools. It tests dependencies and creates makefiles to be used with make.
 +
 
 +
Please see the [[CMake]] wiki page.
 +
 
 +
== OS & Distribution Specific ==
  
= OS & Distribution Specific =
 
 
* '''Linux'''
 
* '''Linux'''
** [[CompilingAutopackage|Autopackage]] (multi-distro)
 
** [[CompilingFedora|Fedora]]
 
** [[CompilingGentoo|Gentoo]]
 
** [[CompilingDebian|Debian]]
 
 
** [[CompilingUbuntu|Ubuntu]]
 
** [[CompilingUbuntu|Ubuntu]]
** [[CompilingYellowDog|Yellow Dog]]
 
** [[CompilingSuse|Suse]]
 
 
** [[CompilingSlackware|Slackware]]
 
** [[CompilingSlackware|Slackware]]
** [[CompilingYoper|Yoper]]
 
** [[CompilingMandrake|Mandrakelinux]]
 
** [[CompilingRHEL|Red Hat Enterprise Linux Version #4]]
 
 
* [[CompilingMacOsX|Mac OS X]]
 
* [[CompilingMacOsX|Mac OS X]]
* [[Win32Port|Windows]]
+
* [[Compiling Inkscape on Windows|Windows]]
* [[CompilingSPARC|SPARC]]
+
* [[Compiling Inkscape on Chrome OS|Chrome OS]]
* [[CompilingSunSolaris|Sun Solaris]]
+
* '''Cross-compiling'''
* [[CompilingStatic|Static Compiles]]
+
** [[CrossCompilingOsX|For OS X (from Linux)]]
 +
** [[CrossCompilingWindows|For Windows (from Linux)]]
  
= Package Config (pkg-config) =
+
== Package Config (pkg-config) ==
  
 
If you must compile and install any of these from source, you may find an error like this when trying to
 
If you must compile and install any of these from source, you may find an error like this when trying to
 
compile them or Inkscape itself:
 
compile them or Inkscape itself:
 
+
<pre>
checking for gtk+-2.0 >= 2.0.0  libxml-2.0 >= 2-2.4.24  sigc++-1.2  gtkmm-2.0... Package gtkmm-2.0 was not found in the pkg-config search path.
+
checking for gtk+-2.0 >= 2.0.0  libxml-2.0 >= 2-2.4.24  sigc++-1.2  gtkmm-2.0... Package gtkmm-2.0 was not found in the pkg-config search path.
Perhaps you should add the directory containing `gtkmm-2.0.pc'
+
Perhaps you should add the directory containing `gtkmm-2.0.pc'
to the PKG_CONFIG_PATH environment variable
+
to the PKG_CONFIG_PATH environment variable
No package 'gtkmm-2.0' found
+
No package 'gtkmm-2.0' found
 +
</pre>
  
 
A solution is to set the PKG_CONFIG_PATH variable as so:
 
A solution is to set the PKG_CONFIG_PATH variable as so:
 +
* for Bash: <code>export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig</code>
 +
* for csh: <code>setenv PKG_CONFIG_PATH /usr/local/lib/pkgconfig:/usr/lib/pkgconfig</code>
  
for bash:
+
A good place to put this line is in your .bashrc or .cshrc file.
    export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig
 
for csh:
 
    setenv PKG_CONFIG_PATH /usr/local/lib/pkgconfig:/usr/lib/pkgconfig
 
 
 
A good place to put this line is in your .bashrc or .cshrc file
 
 
 
= Getting and Installing Source packages =
 
 
 
If your distro does not have some packages available (like many don't, ie, Fedora Core 2), you must often download
 
source packages and build and install them yourself.  Actually this is not that hard, and is similar to
 
doing a Gentoo 'emerge.'
 
 
 
* Usually you download a file with a name like somepackage-1.0.tar.gz.  Unpack it with
 
 
 
    $ tar zxf somepackage-1.0.tar.gz
 
    or
 
    $ tar jxf somepackage-1.0.tar.bz2
 
 
 
* Then 'cd' into the new directory.
 
 
 
* Configure it with the command:
 
 
 
    $ ./configure
 
 
 
* Build it with:
 
 
 
    $ make
 
 
 
* As the 'root' user,  install it with:
 
 
 
    # make install
 
 
 
== Boehm-GC ==
 
 
 
Source: http://www.hpl.hp.com/personal/Hans_Boehm/gc/gc_source
 
 
 
*  Download this file:
 
**  http://www.hpl.hp.com/personal/Hans_Boehm/gc/gc_source/gc6.8.tar.gz
 
*  Unpack it
 
**  tar zxf gc6.8.tar.gz
 
*  Configure and build it
 
**  cd gc6.8
 
**  ./configure --disable-shared --enable-static
 
**  make
 
*  Install it
 
**  su    (or however else you become root)
 
**  make install
 
 
 
Binaries:  If searching for a package for GC, the name of it is sometimes:
 
 
 
* gc
 
* libgc
 
* gc-devel
 
* libgc-devel
 
* boehm-gc  (on Gentoo)
 
* debian/ubuntu:  sudo apt-get install libgc-dev
 
 
 
== libSigc++ ==
 
 
 
Source: http://ftp.gnome.org/pub/GNOME/sources/libsigc++/2.2/libsigc++-2.2.3.tar.bz2
 
 
 
With this file, and for GlibMM and GtkMM below, it is usually desirable for us developers to
 
build this C++ library statically.  This removes a dependency that might be difficult for an
 
end-user during installation.  Configure it with:
 
 
 
    ./configure --enable-static --disable-shared
 
 
 
== GlibMM ==
 
Try to match your Glib2 version with GlibMM's version. For example, if your Glib2 is 2.16.6, download glibmm-2.16.4.tar.bz2.
 
 
 
Latest source: http://ftp.gnome.org/pub/GNOME/sources/glibmm/
 
 
 
== GtkMM ==
 
Usually you can try the latest version of GtkMM, but if you get version mismatch errors, try older releases.
 
 
 
Source: http://ftp.gnome.org/pub/GNOME/sources/gtkmm/2.12/gtkmm-2.12.7.tar.bz2
 
 
 
== cairomm ==
 
 
 
if you got prompted about cairomm, try first solve your cairo version, so you can grab [http://www.cairographics.org/releases/ there] a compatible version.
 
 
 
 
 
== Boost ==
 
 
 
Many users have reported when building from source that after installing the above dependencies, the configure script still requires a "boost" package. It can be found below, but even after installing, you will need to create a symlink to allow the configure script to find it:
 
 
 
'''ln -s /usr/local/include/boost_1_xx_x/boost /usr/local/include/boost'''
 
 
 
Source: http://www.boost.org/users/download/
 
  
== Poppler ==
+
== Dependencies ==
  
Source: http://poppler.freedesktop.org/
+
If your distro does not have some packages available (like many don't, ie, Fedora Core 2), you must often download and build source packages and/or install them yourself. See [[Tracking Dependencies]].
  
Poppler is required for PDF import. There are several potential issues:
+
== Developer Compilation ==
* Some Linux distributions do not ship the Xpdf headers required by Inkscape. In such cases, you need to recompile Poppler, passing --enable-xpdf-headers on the configure line. See [https://bugs.launchpad.net/inkscape/+bug/254849 this wishlist bug]. This typically manifests in error messages like this:
 
<pre>In file included from extension/internal/pdfinput/svg-builder.cpp:19:
 
extension/internal/pdfinput/svg-builder.h:32:23: error: CharTypes.h: No such file or directory
 
...
 
make[2]: *** [extension/internal/pdfinput/svg-builder.o] Error 1
 
make[2]: Leaving directory `/tmp/build/inkscape-0.46/src'
 
make[1]: *** [all-recursive] Error 1
 
make[1]: Leaving directory `/tmp/build/inkscape-0.46'
 
make: *** [all] Error 2</pre>
 
* Inkscape 0.47 does not compile with Poppler >= 0.12.2. If you need to compile Inkscape on such systems, use the development version from Bazaar, where this bug is fixed. See [https://bugs.launchpad.net/inkscape/+bug/487038 the bug report] for details and a minimal patch.
 
* Inkscape compiled with Poppler <= 0.12.1 will run on systems with Poppler >= 0.12.2, but the PDF import function will crash instantly. This problem does not concern Windows users, since the correct Poppler version is contained in the Windows installer package. This cannot be fixed on Inkscape's side: those two versions of Poppler are not ABI compatible, yet share the same soname. See [https://bugs.launchpad.net/inkscape/+bug/258504 this bug] for more details.
 
* Poppler's Xpdf headers are not guaranteed to be API-compatible between releases. It's likely that future Poppler versions will break PDF import in some way. PDF import works at least up to 0.12.4 but might not work with later versions.
 
  
= Developer Compilation =
+
Plain vanilla compilation is done as documented in INSTALL.
  
Plain vanilla compilation is done as documented in INSTALL; ./autogen.sh (optionally); ./configure; make; su && make test; make install (optional).  See INSTALL for more on that.
+
Now, you should use [[CMake]] to compile Inkscape:
 +
<pre>
 +
mkdir build
 +
cd build
 +
cmake ..
 +
make
 +
</pre>
  
But if you're going to be doing a lot of development, there's some tricks and techniques you should know,
+
For old versions of inkscape before 0.92, you can still use autoconf:
to get best results.
+
<pre>
 +
./autogen.sh # optionally
 +
./configure
 +
make
 +
</pre>
  
#  Turn off optimization
+
Then, to run tests and install Inkscape, you may do:
#  Use ccache for faster compilation
+
<pre>
#  Set up a separate build directory (nice for testing both gcc and g++, or cross compiling)
+
make check
#  Use the -j N flag to optimize for the number of processors in your machine, with N = 1 + no. proc's
+
sudo make install || su -c "make install"
 +
</pre>
  
Example:  Setting up both gcc and g++ build environments (in separate tree), and using ccache for faster
+
See INSTALL for more on that.
compilations on a dual-processor machine, with no optimization, assuming /bin/bash:
 
  
mkdir build-gcc build-g++
+
But if you're going to be doing a lot of development, there's some tricks and techniques you should know, to get best results.
bzr branch lp:inkscape
 
cd inkscape
 
./autogen.sh
 
cd ../build-gcc
 
CFLAGS='-g -O0 -Wall' CC='ccache gcc' ../inkscape/configure
 
cd ../build-g++
 
CXXFLAGS='-g -O0 -Wall' CXX='ccache g++' ../inkscape/configure
 
cd ../build-gcc && make -j 3
 
cd ../build-g++ && make -j 3
 
  
 +
# Turn off optimization.
 +
# Use ccache for faster compilation.
 +
# Set up a separate build directory (nice for testing both gcc and g++, or cross-compiling).
 +
# Use the -j N flag to increment the number of threads available to make, with N = 1 + number of processors.
  
Turning off just optimization (which can produce strange results in debuggers):
+
Example:  Setting up the build environment (in separate tree), and using ccache for faster
 +
compilations on a dual-processor machine, with no optimization and full debug symbols, assuming /bin/bash:
 +
<pre>
 +
mkdir build
 +
bzr checkout lp:inkscape
 +
cd inkscape
 +
./autogen.sh
 +
cd ../build
 +
export CFLAGS="-g -O0 -Wall" CC="ccache gcc"
 +
export CXXFLAGS="-g -O0 -Wall" CXX="ccache g++"
 +
../inkscape/configure
 +
make -j 3 -k
 +
</pre>
  
export CXXFLAGS='-g -O0 -Wall'
+
Turning off just optimization:
export CFLAGS='-g -O0 -Wall'
+
<pre>
./configure
+
export CXXFLAGS="-g -O0 -Wall"
 +
export CFLAGS="-g -O0 -Wall"
 +
./configure
 +
</pre>
  
See [[TestingInkscape]] for information on building and executing (unit) tests.
+
See [[Testing Inkscape]] for information on building and executing (unit) tests.
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]

Latest revision as of 15:00, 28 May 2019

Hopefully, Inkscape will compile right out of the box, according to the 'Getting Started' instructions on https://inkscape.org/develop/getting-started/ . If it doesn't, well that's what this page is for.

Jot down notes, questions, findings, tips, etc. here on things you run into. It's a good idea to make mention of what version of the code you're trying to compile, the distribution you're running, and other such information that might be pertinent.

If legitimate bugs are found or patches developed, please move them to the tracker rather than inlining them here.

Notes

Please use CMake instead of Automake for Inkscape 0.92 onwards.

CMake is a crossplatform makefile generator similar to autotools. It tests dependencies and creates makefiles to be used with make.

Please see the CMake wiki page.

OS & Distribution Specific

Package Config (pkg-config)

If you must compile and install any of these from source, you may find an error like this when trying to compile them or Inkscape itself:

checking for gtk+-2.0 >= 2.0.0  libxml-2.0 >= 2-2.4.24  sigc++-1.2  gtkmm-2.0... Package gtkmm-2.0 was not found in the pkg-config search path.
Perhaps you should add the directory containing `gtkmm-2.0.pc'
to the PKG_CONFIG_PATH environment variable
No package 'gtkmm-2.0' found

A solution is to set the PKG_CONFIG_PATH variable as so:

  • for Bash: export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig
  • for csh: setenv PKG_CONFIG_PATH /usr/local/lib/pkgconfig:/usr/lib/pkgconfig

A good place to put this line is in your .bashrc or .cshrc file.

Dependencies

If your distro does not have some packages available (like many don't, ie, Fedora Core 2), you must often download and build source packages and/or install them yourself. See Tracking Dependencies.

Developer Compilation

Plain vanilla compilation is done as documented in INSTALL.

Now, you should use CMake to compile Inkscape:

mkdir build
cd build
cmake ..
make

For old versions of inkscape before 0.92, you can still use autoconf:

./autogen.sh # optionally
./configure
make

Then, to run tests and install Inkscape, you may do:

make check
sudo make install || su -c "make install"

See INSTALL for more on that.

But if you're going to be doing a lot of development, there's some tricks and techniques you should know, to get best results.

  1. Turn off optimization.
  2. Use ccache for faster compilation.
  3. Set up a separate build directory (nice for testing both gcc and g++, or cross-compiling).
  4. Use the -j N flag to increment the number of threads available to make, with N = 1 + number of processors.

Example: Setting up the build environment (in separate tree), and using ccache for faster compilations on a dual-processor machine, with no optimization and full debug symbols, assuming /bin/bash:

mkdir build
bzr checkout lp:inkscape
cd inkscape
./autogen.sh
cd ../build
export CFLAGS="-g -O0 -Wall" CC="ccache gcc"
export CXXFLAGS="-g -O0 -Wall" CXX="ccache g++"
../inkscape/configure
make -j 3 -k

Turning off just optimization:

export CXXFLAGS="-g -O0 -Wall"
export CFLAGS="-g -O0 -Wall"
./configure

See Testing Inkscape for information on building and executing (unit) tests.