CompilingMacOsX

Compiling Inkscape

Requirements

To compile Inkscape from source you will need:

• Mac OS X 10.3 (Power PC) or higher
• Inkscape's source code. You can get the official release source code, a SVN snapshot or a copy of the SVN repository.
• XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)

To install Inkscape dependencies you can use either:

• Fink with an unstable installation. But notice that Fink does not provide a loudmouth package, the librarie that Inkboard uses, therefore you won't be able to use Inkboard and that GTK versions are old.
• DarwinPorts. This is the preferred method though there are still problems when bundling Inkscape compiled with DarwinPorts. Please help us investigate this.

Preparing the build using Fink

Installing dependencies

Fink provides an Inkscape pacakage. Therefore, as for any other package, Fink provides you with a list of its dependencies:

fink show-deps inkscape

Some are mandatory and you must install them:

fink install gtkmm2.4-dev  gconf2-dev gnome-vfs2-dev\
   gtkspell2-dev intltool lcms libbonobo2-dev libxslt gc

Some provide additional functionality in Inkscape

• aspell : check spelling of text elements [Note: I have never seen it working on OS X]
• boost >= 1.32 : auto-organisation of connectors [Note: is boost still needed?]
• gnome-print

fink install aspell-dev boost gnome-print-dev

If you use MMX optimization (available on Intel processors) you need version 1.8.5 of automake (and not 1.9.6 which is the latest in Fink). Otherwise you will need suppress the check on the version of automake (see the Configuring section).

fink install automake1.8

Setting the build environment

Fink's hierarchy is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here. You can create a file named set_env_variables.sh and copy/paste this inside:

#!/bin/bash
LIBPREFIX="/sw"
#  automake seach path
export CPATH="$LIBPREFIX/include"
#  configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
#  compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"

In addition, you must make sure that Inkscape is compiled with the compiler version that Fink uses, otherwise Inkscape will not link properly. To determine which compiler to use type:

head -n 5 $FINK/etc/fink.conf | grep "Distribution"

If your fink distribution is 10.4 add:

export CC="gcc-4.0"
export CXX="g++-4.0"

to set_env_variables.sh, else (10.3, 10.4-transitional) add:

export CC="gcc-3.3"
export CXX="g++-3.3"

You can also use ccache (fink install ccache) to speed up the compilation a bit. To do so, modify the compiler lines accordingly:

export CC="ccache gcc-??"
export CXX="ccache g++-??"

Eventually, open a Terminal and, in the directory where you created the file set_env_variables.sh, type:

source set_env_variables.sh

You are ready to configure, compile and install Inkscape. Go to the section 'Configuring' now.

Preparing the build using DarwinPorts

Installing dependencies

You can use DarwinPorts to list Inkscape dependencies:

port deps inkscape

Some are mandatory and you can install them with the command:

sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt

Others provide additional functionality to Inkscape:

• aspell : check spelling of text elements [Note: I have never seen it working on OS X]
• boost : auto-organisation of connectors [Note: is boost still needed?]
• libgnomeprintui
• loudmouth : jabber library used by InkBoard

sudo port install aspell boost libgnomeprintui loudmouth

Using MMX optimization (available on Intel processors only) requires that you use automake 1.8 but only automake 1.9.6 is available in DarwinPorts. Therefore, unless you install version 1.8.5 by hand ([1]) you will need to disable MMX optimization and to disable the check on automake version during the configure step.

Automake in DarwinPorts is currently 1.10, which currently does not work for our build. However Automake 1.7 does work, and is in DarwinPorts as 'automake17'.

Configuring

First, if you have and Intel processor, you need to decide if you use MMX optimization or not. If you have a G3/G4/G5 processor you cannot use it anyway. [Note: please someone confirm that MMX optimization is available on Mac Intel processors] If you do not use MMX optimization, you can use automake 1.9 and you need to disable the check on automake version in autogen.sh by commenting the lines (around line 110):

    # Exclude automake 1.9.[0-6]
    if expr $VER \>= 1.9.0 >/dev/null && expr $VER \<= 1.9.6 >/dev/null ; then
        echo
        echo "  You must have automake less than 1.9.0 or newer than 1.9.6"
        echo "  Get ftp://ftp.gnu.org/pub/gnu/automake/automake-1.8.5.tar.gz"
        echo "  (or a newer version of 1.8 if it is available)"
        DIE=1
    fi

Then, you might need to build the configure script (if you compile Inkscape for the first time for example). Cd to Inkscape's source directory and run:

./autogen.sh

Then run the configure script with the options --disable-static --enable-shared and --prefix which sets the directory where the build products are placed. It must be somewhere you have write access to.

./configure --disable-static --enable-shared --prefix=/path/to/build/products/

If you decided to disable MMX optimization on Intel procesors, add the --disable-mmx option.

I you want to package Inkscape into an .app bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option --enable-osxapp [Note: this is currently broken when using DarwinPorts]:

./configure --prefix=/path/to/build/products/ --enable-osxapp

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add --enable-inkboard.

Other configuration options can be set, check the list of options by using:

./configure --help

Building and Installing

Just run:

make
make install

Automated compilation

You can try downloading a bash script which automates the processes of updating Inkscape from the svn repository, setting the build environment, building and producing a package of Inkscape. Modify it with your favorite text editor in order to set a correct installation prefix and to change configuration options according to your needs. Two scripts are prodived, depending on wether you use Fink [2] or DarwinPorts [3].

To use one of these scripts, place it in the directory where Inkscape source code is and make it executable

chmod +x osxmake_???.sh

To obtain help on how to use it run it with the -h option:

./osxmake_???.sh -h

To run the whole process use the command:

./osxmake_???.sh -s -a -c -b -i -p

Packaging Inkscape into an .app bundle and distributing a .dmg

Assuming that you have used the --enable-osxapp option during configure, the process is fully automatized. You just have to open a Terminal, cd to Inkscape's sources directory and type:

cd packaging
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx

The -s options produces an app bundle stripped of debugging information (which is therefore smaller). Omit this option if you want to keep debugging info.

Either way, this creates two files in current directory: Inkscape.app that you can copy to your Applications directory and Inkscape.dmg for distribution.

Enabling python effects

Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but not with pyXML which is needed by Inkscape effects. You can install a binary version downloadable with the developement builds of Inkscape:

http://inkscape.modevia.com/macosx-snap/?M=D

Or you can install it from source:

1. download the source code from sourceforge
2. unpack the .tar.gz file
3. cd into the newly created directory
4. set the variable MACOSX_DEPLOYMENT_TARGET to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:

   export MACOSX_DEPLOYMENT_TARGET=10.?

5. move the python files and build C extensions by just typing

   python setup.py build

6. install (the install is system wide so you need administrator rights)

   sudo python setup.py install

   and type your password.

Links

Apple Documentation

• Introduction to Runtime Configuration Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

Packaging

• Sveinbjorn Thordarson's Website The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
• Creating OS X application bundles step by step Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
• Bringing your Java Application to Mac OS X I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
• The Gimp .app Howto This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.