Difference between revisions of "Compiling Inkscape"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Poppler: added xpdf-headers compilation error fix)
 
(43 intermediate revisions by 16 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.
+
<mark>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. </mark>
  
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 at Sourceforge
+
<mark> '''If you've come here without reading the Getting Started page, [https://inkscape.org/develop/getting-started/ please do so first], as it mentions some important things that this page does not.'''
rather than inlining them here. 
+
</mark>
  
= Notes =
 
Inkscape needs automake1.7 or automake1.8 to compile NOT automake1.9 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.
+
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 [https://inkscape.org/contribute/report-bugs/ 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 ==
  
= OS &amp; 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]]
 
 
* [[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.7.tar.gz
 
*  Unpack it
 
**  tar zxf gc6.7.tar.gz
 
*  Configure and build it
 
**  cd gc6.7
 
**  ./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.0/
 
 
 
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]] ==
 
 
 
Source: http://ftp.gnome.org/pub/GNOME/sources/glibmm/2.8/
 
 
 
== [[GtkMM]] ==
 
 
 
Source: http://ftp.gnome.org/pub/GNOME/sources/gtkmm/2.8/
 
 
 
== caiormm ==
 
 
 
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 ==
 
 
 
Source: http://poppler.freedesktop.org/
 
 
 
Note: there seems to be an incompatibility with recent versions of poppler. See the following bugreport: https://bugs.launchpad.net/inkscape/+bug/254849
 
 
 
Also, the <code>-DPOPPLER_NEW_GFXFONT</code> hack does not seem to work with vanilla 0.46, you should obtain a snapshot version instead.
 
 
 
There is a compilation error due to a mis-configured Poppler build/install - you will see the following errors:
 
  
<pre>In file included from extension/internal/pdfinput/svg-builder.cpp:19:
+
== Dependencies ==
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>
 
  
The fix is to rebuild Poppler with <code>--enable-xpdf-headers</code> added to the configuration. See https://bugs.launchpad.net/inkscape/+bug/254849/comments/5 for a more complete story.
+
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 =
+
== Developer Compilation ==
  
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.
+
Plain vanilla compilation is done as documented in INSTALL.
  
But if you're going to be doing a lot of development, there's some tricks and techniques you should know,
+
Now, you should use [[CMake]] to compile Inkscape:
to get best results.
+
<pre>
 +
mkdir build
 +
cd build
 +
cmake ..
 +
make
 +
</pre>
  
#  Turn off optimization
+
For old versions of inkscape before 0.92, you can still use autoconf:
#  Use ccache for faster compilation
+
<pre>
# Set up a separate build directory (nice for testing both gcc and g++, or cross compiling)
+
./autogen.sh # optionally
#  Use the -j N flag to optimize for the number of processors in your machine, with N = 1 + no. proc's
+
./configure
 +
make
 +
</pre>
  
Example:  Setting up both gcc and g++ build environments (in separate tree), and using ccache for faster
+
Then, to run tests and install Inkscape, you may do:
compilations on a dual-processor machine, with no optimization, assuming /bin/bash:
+
<pre>
 +
make check
 +
sudo make install || su -c "make install"
 +
</pre>
  
mkdir build-gcc build-g++
+
See INSTALL.md for more on that.
cvs checkout inkscape
 
cd inkscape
 
libtoolize --copy --force
 
./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
 
  
 +
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.
  
Turning off just optimization (which can produce strange results in debuggers):
+
# 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 ninja or the make -j N flag to increment the number of threads available to make, with N = 1 + number of processors.
  
  export CXXFLAGS='-g -O0 -Wall'
+
Example: Setting up the build environment (in separate tree), and using ccache for faster
export CFLAGS='-g -O0 -Wall'
+
compilations on a dual-processor machine, with no optimization and full debug symbols, assuming /bin/bash:
./configure
+
<pre>
 +
mkdir build
 +
git clone https://gitlab.com/inkscape/inkscape.git
 +
cd build
 +
cmake ../inkscape -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_BUILD_TYPE=Debug -G Ninja
 +
ninja
 +
</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 07:57, 20 August 2020

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.


If you've come here without reading the Getting Started page, please do so first, as it mentions some important things that this page does not.


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.md 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 ninja or the make -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
git clone https://gitlab.com/inkscape/inkscape.git
cd build
cmake ../inkscape -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_BUILD_TYPE=Debug -G Ninja
ninja

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