Inkscape Wiki - User contributions [en]

CompilingMacOsX

2012-03-23T12:11:39Z

Herrdeh:

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf bzr</pre>


Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
bzr branch lp:inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoid documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code]  or create a local branch of the current state of the [http://inkscape.org/bzr.php?lang=en BZR repository] using [http://bazaar.canonical.com/ bazaar].  Bazaar is not pre-installed on Leopard - it is recommended to install a current version with MacPorts (<tt>sudo port install bzr</tt>).
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from a [http://inkscape.org/bzr.php?lang=en bzr branch] or checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua from scratch, 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

If you want to use bazaar in order to keep your sources up to date, install it:

<pre>
sudo port install bzr
</pre>

How to use bazaar, have a look here: [[Working with Bazaar]].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# autogen
sudo ./osx-build.sh a

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].
* Mac OS X native (aqua), PPC-only, Tiger-only build of 0.47, can be retrieved here: [http://verkehrsplanung.com/Inkscape_aqua_PPC_047.zip]. NOT FOR PRODUCTIVE USE - JUST TESTING! - (Nevertheless I'm doing quite a bit productive work on it… (-;)

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

=See also=
*[[Compiling Inkscape]]

[[Category:Developer Documentation]]

CompilingMacOsX

2010-03-24T09:18:32Z

Herrdeh:

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua from scratch, 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

If you want to use bazaar in order to keep your sources up to date, install it:

<pre>
sudo port install bzr
</pre>

How to use bazaar, have a look here: [[Working with Bazaar]].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].
* Mac OS X native (aqua), PPC-only, Tiger-only build of 0.47, can be retrieved here: [http://verkehrsplanung.com/Inkscape_aqua_PPC_047.zip]. NOT FOR PRODUCTIVE USE - JUST TESTING! - (Nevertheless I'm doing quite a bit productive work on it… (-;)

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-03-24T08:45:07Z

Herrdeh: /* Building Aqua from scratch, 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua from scratch, 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

If you want to use bazaar in order to keep your sources up to date, install it:

<pre>
sudo port install bzr
</pre>

How to use bazaar, have a look here: [[Working with Bazaar]].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].
* A PPC-only build of 0.47, made on Tiger, can be retrieved here: [http://verkehrsplanung.com/Inkscape_aqua_PPC_047.zip]. NOT FOR PRODUCTIVE USE - JUST TESTING! - (Nevertheless I'm doing quite a bit productive work on it… (-;)

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-03-24T08:35:48Z

Herrdeh: /* User Examples */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua from scratch, 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

If you want to use bazaar in order to keep your sources up to date, install it:

<pre>
sudo port install bzr
</pre>

How to use bazaar, have a look here: [[Working with Bazaar]].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

# or all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].
* A PPC-only build of 0.47, made on Tiger, can be retrieved here: [http://verkehrsplanung.com/Inkscape_aqua_PPC_047.zip]. NOT FOR PRODUCTIVE USE - JUST TESTING! - (Nevertheless I'm doing quite a bit productive work on it… (-;)

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-03-24T08:31:45Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua from scratch, 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

If you want to use bazaar in order to keep your sources up to date, install it:

<pre>
sudo port install bzr
</pre>

How to use bazaar, have a look here: [[Working with Bazaar]].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

# or all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

Working with Bazaar

2010-03-24T07:22:45Z

Herrdeh: /* First steps */

==Bazaar concepts==

It is assumed that you are familiar with the basic concepts of version control, like working copy, committing, updating, conflicts. There will be a section that explains the basic functionality soon.

; '''Branch'''
: is a working copy of the project's code. Typically you use one branch per set of related changes, for example a new output extension. Once your work is finished, you ''merge'' your branch into a larger project. Initially, there is only one branch, the trunk; all other branches are its (probably indirect) descendants. To create a new branch, you have to copy an existing one.
; '''Checkout'''
: is a copy of code contained in a branch that is not stored on your computer (a remote branch). Committing to a checkout will immediately apply the changes to the remote branch. Commits will not succeed if somebody else modified the branch while you were working - you need to have an up-to-date working copy - or when you're offline.
:When branches A and B have a common ancestor branch but each contain changes not present in the other, they have '''diverged'''. For example, when you work on an improved rectangle tool in your own branch and at the same time somebody else applies a PDF export bugfix to the trunk, your rectangle tool branch becomes diverged from the trunk.
; '''Trunk'''
: is the main branch, which represents cutting-edge working code. You should start from it when doing any new development.
; '''Merge'''
: is the process of reconciling changes made between two branches since they diverged. This operation is asymmetric. When you merge A into B, all changes made to A since it was branched from B are applied to B. A is not changed. When you work on some feature, you typically work in a branch, periodically merging the trunk into your branch (to sync up with the latest changes), then you merge your work into the trunk. Merging is similar to applying a patch - it only changes your working copy. To apply a merge, you need to commit the changes it introduced. Merging un-diverges branches.
; '''Repository'''
: is a place where branches of a project are stored. Having a shared repository reduces the storage requirements of multiple branches of one project. Instead of O(number of branches) space, the Bazaar data takes up O(total size of changes in all branches) space.
; '''Bind'''
: is the process of converting a non-diverged local branch into a checkout of the remote branch.
; '''Push'''
: is the process of publishing an exact copy (a mirror) of your branch in some other location. The difference between pushing and checkouts is that a checked out remote branch is updated every time you commit, while a pushed remote branch is updated only when you push to it - you can commit any amount of changes between pushes. You can only push to a branch if the mirror has not diverged from your local copy. This can happen if more than 1 person can push to the same location.
; '''Pull'''
: is the process of creating a local exact copy (mirror) of a branch, in principle a reverse of pushing.

==First steps==

First you need to tell Bazaar your name. This will appear on all your commits. You should use your real e-mail, but you can obfuscate it if you are afraid of spam.

Obfuscated e-mail examples:
$ bzr whoami "John Q. Public <john dot q dot public at-sign bigmail dot com>"
$ bzr whoami "John Q. Public <removethis.john.q.public@bigmail.com>"
Unobfuscated e-mail example:
$ bzr whoami "John Q. Public <john.q.public@bigmail.com>"

If you have an account on launchpad and want to commit changes there, you need to specify your launchpad login:
$ bzr launchpad-login johnq

Then fetch Inkscape's trunk
$ bzr branch lp:inkscape

To carry out a later update of Inkscape's trunk
$ bzr pull lp:inkscape

==Using a centralized (SVN-like) workflow==

In this case, every commit that you make is immediately sent to the central repository. There are two ways of achieving this:

===SVN-style checkout===

Get the latest Inkscape code as a checkout, rather than a branch:
$ bzr checkout lp:inkscape

Now work as in SVN:
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

If you add new files, add them to version control with <tt>bzr add ''file''</tt>. You can recursively add all new files by writing simply <tt>bzr add</tt> in the top level directory.

===Binding a BZR branch===

Get Inkscape's code the regular bzr way:
$ bzr branch lp:inkscape

Then transform your banch into a checkout:
$ cd inkscape
$ bzr bind lp:inkscape

Now work as in SVN:
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

===Differences from SVN===

* Commits will fail if your checkout is not up to date, even if there would be no conflicts.
* The revision number is an attribute of the working tree, not of individual files. It is not possible to have different portions of the working tree at different revisions.
* <tt>bzr commit ''file''</tt> works like <tt> svn commit ''file'' && svn update ''project-root''</tt>. After a successful partial commit, the entire tree's revision is increased by 1.
* No special server is needed to publish a branch. You can push branches to anywhere, including simple FTP shares. In our scenario, Launchpad works like a central repository, but it's not required to publish everything there.
* You create branches locally. To simulate creating a SVN-style branch on Launchpad, you need to create a local branch, push it, then bind it to the pushed location.


==Using a decentralized workflow==

In this case you will be working locally until you are ready to publish your changes. The basic idea is to perform the work in a ''branch'' of the Inkscape repository, since committing to a branch stores the changes locally in the branch itself. Then, to share the work with the rest of the Inkscape community, the changes in the branch are merged across to a ''checkout'' of the Inkscape repository. As the previous centralized workflow section describes, committing to a checkout sends the changes directly to the remote repository, making them part of the official Inkscape codebase.

'''NOTE:''' this workflow has been updated to avoid the "other people's commits become subrevisions of your commit" problem.

This will assume this directory layout:
inkscape
+-trunk
| +-doc
| +-share
| +-src
| +-po
| +-...
+-myproject
+-some-other-branch

In this layout, "trunk" is the checkout used for uploading changes to the central Inkscape repository, while "myproject" and "some-other-branch" are local branches used for working on specific features.

===Repository setup===

To speed things up, it's good to create a local shared repository. This way revision histories will only be stored in one place, instead of in every branch, so local branching will be faster and the branches will take up less space.

Create a shared repository and enter it:
$ bzr init-repo --rich-root inkscape
$ cd inkscape

===Working locally===

Get Inkscape's code
$ bzr branch lp:inkscape myproject

Now work:
$ cd myproject
... work work work ...
$ bzr commit -m "Some changes"
... more work work work ...
$ bzr commit -m "More changes"
... create new file ...
$ bzr add new-file.c
$ bzr commit -m "Added new file with kittens"

===Advanced local features===

To undo a commit:
$ bzr uncommit
This will leave your working tree in the state it was just before you wrote "bzr commit". This is useful for example if you forgot to add a file, and want to keep a clean revision history. This will NOT work on a trunk checkout.

Let's say you started from r770 200 local commits, but you decided that what you did since r954 is completely wrong. You want to go back to revision 825 and do it differently. Here's one way to do this. First branch locally to preserve your work (maybe later you'll find out there's some way to save it). Then uncommit everything up to r954 and revert.
$ bzr branch myproject myproject-dead-end
$ cd myproject
$ bzr uncommit -r 954
$ bzr revert

A different scenario: let's say that commit 1524 introduced a bug, but there were 50 other commits since then and you only want to revert the changes introduced by 1524.
$ bzr merge -r1524..1523

Sometimes a big change gets committed while you are working on a feature. If you want to check whether your code still works after the big change, merge from trunk.
$ bzr merge

In this case, you can omit where you are merging from, because the default is to merge from the branch you started from (the parent).

===Publishing your work on Launchpad===

To publish branches on Launchpad, you have to add an SSH key to your account. If you don't have one yet, generate it:
$ ssh-keygen
... follow instructions ...

Once you created the key, go to your Launchpad profile page, edit SSH keys and paste the contents of the key file (by default it's in <tt>~/.ssh/id_rsa</tt> or <tt>~/.ssh/id_dsa</tt>) into the window. You can now use the Launchpad integration features.

Login to Launchpad, if you didn't do it yet. You only need to do this once on each computer. You need to use your login name, not the display name.
$ bzr launchpad-login johnq

Publish your branch on Launchpad.
$ bzr push lp:~johnq/inkscape/myproject

The push location will be saved. After more commits, you can simply write
$ bzr push

It's sometimes convenient to update the Launchpad copy after each commit. To save on typing, you can bind your working tree to the remote branch. This way every commit will be immediately published on the remote branch. Note that you won't be able to commit while offline.
$ bzr bind :push

===Putting your work in the trunk===

Once your new killer feature is ready, you need to merge your changes into a checkout of the trunk. If you don't have one, do (in the directory ''containing'' myproject):
$ bzr checkout lp:inkscape trunk
$ cd trunk

If you already have one on hand, make sure it's up to date:
$ cd trunk
$ bzr update

Now that you have a local checkout of the current trunk:
$ bzr merge ../myproject
$ bzr commit -m'added my feature'

WARNING: There is an alternative method that consists of merging trunk into your local branch, then pushing the result as trunk. Do not do this! It obfuscates the revision history.

===Working with patch files===

If you don't have permission to commit to the trunk, you can bundle your branch's changes into a patch instead:
$ bzr send -o mychanges.patch

To apply patches produced by the above command, just do this:
$ bzr merge somechanges.patch

===Local branching===

Naturally, all this also works locally. For example, when you're in the <tt>inkscape</tt> directory, you can write <tt>bzr branch trunk export-dialog</tt> to create a new branch of the trunk called <tt>export-dialog</tt>, where you'll work only on improving the export dialog. Similarly, you can merge between local branches.

==Best Practices for Inkscape Project==

===Registering Bugfixes===

Launchpad will automatically mark a bug "Fix Available" (rather than "Fix Committed") once somebody commits using the flag --fixes, e.g. (if you fix those two bugs in one commit):
bzr commit --fixes lp:123456 --fixes lp:123457 -m 'patch description'
Then, bugs can be changed automatically from "Fix Available" to "Fix Released"

[http://doc.bazaar-vcs.org/bzr.dev/en/tutorials/using_bazaar_with_launchpad.html#changing-the-state-in-launchpad-while-committing-in-bazaar Read more: "Changing the state in Launchpad while committing in Bazaar"]

===Proper way of merging===

To repeat, NEVER do something like:
$ bzr branch lp:inkscape myproject
... work ...
$ bzr commit
$ bzr merge # NOOOO!!! We are doomed!
$ bzr push lp:inkscape

It will obfuscate the revision history: trunk commits that happened between the time you branched and the time you pushed will get grouped into one. Do the merge the other way around:
$ bzr branch lp:inkscape myproject
$ cd myproject
... work ...
$ bzr commit
$ cd ../trunk
$ bzr merge ../myproject # correct!
$ bzr commit

You'll need a trunk checkout, but the revision history will be much less confusing, and it's useful to have a trunk checkout anyway.

==External links==
* [http://doc.bazaar-vcs.org/latest/en/ Bazaar manual]

CompilingMacOsX

2010-03-24T07:20:18Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

If you want to use bazaar in order to keep your sources up to date, install it:

<pre>
sudo port install bzr
</pre>

How to use bazaar, have a look here: [[Working with Bazaar]].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

# or all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-03-24T07:17:27Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.
Make sure you checked the optional install of MacOSX10.4u.sdk - this especially applies for Snow Leopard 10.6.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

# If you want to use bazaar in order to keep your sources up to date:
# How to use bazaar, have a look here: [[Working with Bazaar]].

sudo port install bzr

sudo port install librsvg libwpd libwpg libcroco

# older versionsof gtk2 than 2.18.8 need to be patched according to these instructions:
# http://trac.macports.org/ticket/22451

# so rather make sure you installed the latest gtk2 >=2.18.8:

sudo port install gtk2 +quartz+no_x11

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# If your building runs through smoothly, you can automate the build process for the next version by doing all at once:

# or all at once:

sudo ./osx-build.sh a c b i -py ../../../python/ p d

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-03-19T21:32:46Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Configure or build can fail on OS X Tiger and Leopard due to broken <tr1/unordered_set> header files because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either

a) install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts and make it the default compiler with MacPorts 'gcc_select' or

b) patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 as described in [[HashtableFixOSX]]

; gcc/g++ versions by Apple known to fail to compile Inkscape 0.47+devel bzr revno >= 8976 are
: powerpc-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 (Apple Computer, Inc. build 5370)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. If necessary, uninstall a former version of gtk2 with

sudo port -f uninstall gtk2 ,

cd ~/ports/x11/gtk2/ and

# (re)install (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk-engines2

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-23T11:21:47Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

Known workarounds if configure or build fails due to broken <tr1/unordered_set> header files:

'''Mac OS X 10.4 Tiger''':
TODO

'''Mac OS X 10.5.8 Leopard''' with Xcode 3.1.4:
If Inkscape 0.47+devel fails to configure with "error: You have a broken version of the <tr1/unordered_set> header. …" or fails to build with the [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. If necessary, uninstall a former version of gtk2 with

sudo port -f uninstall gtk2 ,

cd ~/ports/x11/gtk2/ and

# (re)install (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to uncomment (enable) the configure option --enable-osxapp
# (line 24), if neccessary. I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-15T17:53:39Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

'''Note:''' If Inkscape 0.47+devel fails to build on Mac OS X 10.5.8 Leopard (Xcode 3.1.4) with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. If necessary, uninstall a former version of gtk2 with

sudo port -f uninstall gtk2 ,

cd ~/ports/x11/gtk2/ and

# (re)install (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24). I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-13T13:30:11Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

'''Note:''' If Inkscape 0.47+devel fails to build on Mac OS X 10.5.8 Leopard (Xcode 3.1.4) with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. Then uninstall gtk2 with sudo port -f uninstall gtk2 (if necessary),

cd ~/ports/x11/gtk2/ and

# reinstall (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24). I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution than this very brutal hack.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-12T14:53:50Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

'''Note:''' If Inkscape 0.47+devel fails to build on Mac OS X 10.5.8 Leopard (Xcode 3.1.4) with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. Then uninstall gtk2 with sudo port -f uninstall gtk2 (if necessary),

cd ~/ports/x11/gtk2/ and

# reinstall (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24). I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

# edit <path-to-inkscape-sources>/packaging/macosx/Resources/bin/inkscape and
# uncomment line 33:

# export DYLD_LIBRARY_PATH="$TOP/lib"

cd <path-to-inkscape-sources>/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and add at line 45

killall X11

# Hopefully more skilled people than me will find a nicer solution.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-11T18:14:50Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

'''Note:''' If Inkscape 0.47+devel fails to build on Mac OS X 10.5.8 Leopard (Xcode 3.1.4) with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. Then uninstall gtk2 with sudo port -f uninstall gtk2 (if necessary),

cd ~/ports/x11/gtk2/ and

# reinstall (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24). I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

cd path-to-inkscape-sources/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously), edit
inkscape.app/Contents/Resources/script and comment the line

# open-x11 /tmp/getdisplay.sh || \

# (in my script it's line 30)

# Probabely there is a nicer solution…

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-11T15:47:46Z

Herrdeh: /* Building Aqua February 2010 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

'''Note:''' If Inkscape 0.47+devel fails to build on Mac OS X 10.5.8 Leopard (Xcode 3.1.4) with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372]. (Maybe this is obsolete by Feb, 2010).

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. Then uninstall gtk2 with sudo port -f uninstall gtk2 (if necessary),

cd ~/ports/x11/gtk2/ and

# reinstall (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24). I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

# or double click the inkscape image in path-to-inkscape-sources/Build/bin

# (This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

cd path-to-inkscape-sources/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously (very ugly and brutal hack -
may more skilled people be so kind and find a more elegant solution), edit
inkscape.app/Contents/Resources/script and add

# killall X11

# behind the line

export DISPLAY=`cat /tmp/display.$UID`

The new line is #39 in my build. Sorry - there must be a much nicer solution.

</pre>
In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2010-02-11T15:44:29Z

Herrdeh: /* Building Aqua November 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gsl gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*Xcode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, Xcode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)
* Working version of the <tt><tr1/unordered_set></tt> and <tt><tr1/unordered_map></tt> headers.

'''Note:''' If Inkscape 0.47+devel fails to build on Mac OS X 10.5.8 Leopard (Xcode 3.1.4) with an [[build failure in tr1/hashtable|error]] in <tt>/usr/include/c++/4.0.0/tr1/hashtable</tt> it is necessary to either patch the installed <tt>tr1/hashtable</tt> header file of libstdc++-v3 or install a [http://trac.macports.org/wiki/UsingTheRightCompiler newer version of GCC] via MacPorts. The build failure occurs because Apple's default compiler ([http://gcc.gnu.org/gcc-4.0/ GNU Compiler Collection 4.0.1]) and libstdc++ library ([http://gcc.gnu.org/libstdc++/ GNU Standard C++ Library v3]) installed by Xcode 3.1.x have never been fully updated to the last released version of the [http://gcc.gnu.org/gcc-4.0/changes.html#4.0.1 GCC 4_0 release series].

; gcc/g++ versions by Apple known to fail to compile (bzr revno >= 8976)
: i686-apple-darwin9-g++-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5493)
: i686-apple-darwin9-g++-4.2.1 (GCC) 4.2.1 (Apple Inc. build 5577)

Steps to replace the faulty header file on OS X 10.5.8 with Xcode 3.1.4 installed:

#Download [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc%2B%2B-v3/include/tr1/hashtable?revision=104939&view=co SVN revision 104939] of <tt>tr1/hashtable</tt> from the [http://gcc.gnu.org/viewcvs/branches/gcc-4_0-branch/libstdc++-v3/include/tr1/hashtable?view=log gcc-4_0-branch SVN repository]
#Replace Apple's version with the downloaded file from SVN revision 104939 and restore file permissions and ownership:
:*Replace file (assuming the new file is located in ~/Downloads):
<pre>$ sudo mv /usr/include/c++/4.0.0/tr1/hashtable /usr/include/c++/4.0.0/tr1/hashtable-orig
$ sudo cp ~/Downloads/hashtable /usr/include/c++/4.0.0/tr1</pre>
:*Check new file:
<pre>$ ls -l /usr/include/c++/4.0.0/tr1/hashtable</pre>
:*Change permissions/ownership if needed:
<pre>$ sudo chmod 644 /usr/include/c++/4.0.0/tr1/hashtable
$ sudo chown root:wheel /usr/include/c++/4.0.0/tr1/hashtable</pre>

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new MacPorts installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed MacPorts, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause MacPorts to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the MacPorts libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second MacPorts tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let's say I want to install a new tree for native versions in /opt/local-native. I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can omit the +universal if you only want to build inkscape for your host architecture.
You should also set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks installed by this MacPorts (for example by python) don't clash with your standard MacPorts tree.

Then you need to have only one version of the port command in the PATH at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the native version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here. Omit them when editing your shell configuration file and put everything on one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua February 2010 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ Xcode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2-clearlooks

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

# At the moment (11-Feb-2010) gtk2 needs to be patched, according to
# http://trac.macports.org/ticket/22451

# 1. Create a folder in your home directory e.g. /Users/<Username>/ports to act as the local
# repository

# 2. download
# http://trac.macports.org/attachment/ticket/22451/modified-gtk2-port.tar.bz
# unpack it and put the occuring folder called "x11" into the "ports" folder you created

# 3. Edit the file /opt/local/etc/macports/sources.conf and add a line
# file:///Users/mark/ports before the rsync://... line (this means Macports will use locally modified
# ports in preference to ports of the same name in the global repository, in our case port 'gtk2')

# 4. cd to /Users/<Username>mark/ports and type

portindex

# to get Macports to index this local version of gtk2

# 5. Then uninstall gtk2 with sudo port -f uninstall gtk2 (if necessary),

cd ~/ports/x11/gtk2/ and

# reinstall (from the local repository) using

sudo port install -f gtk2 +quartz+no_x11

# ++++++++++++++++++++++++++++++++++++++++++++++++++++

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24)

# I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

(This may not work - not reason to fall into despair so far, just go ahead an pack it…)

# Build a Mac OS X package:

# download python packages at http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# put the contents in a folder named "python" and put it somewhere - the following command
# expects it in the folder in which the inkscape sources folder lives

cd path-to-inkscape-sources/packaging/macosx

# and pack:

./osx-build.sh p -py ../../../python/

# To avoid X11 from launching simultaneously (very ugly and brutal hack -
may more skilled people be so kind and find a more elegant solution), edit
inkscape.app/Contents/Resources/script and add

# killall X11

# behind the line

export DISPLAY=`cat /tmp/display.$UID`

The new line is #39 in my build. Sorry - there must be a much nicer solution.

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well - it still has the disadvantage not to be portable to another machine, because some libraries are not compiled into the app bundle. Work is in progress…

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-28T18:15:50Z

Herrdeh: /* Compiling Inkscape with native GTK using MacPorts [experimental] */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

++++++++++++++++++++++++++++++++++++++++++++++++++++

addition in Nov-2009 by Wolf:
Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

++++++++++++++++++++++++++++++++++++++++++++++++++++

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua November 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24)

# I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-23T20:26:59Z

Herrdeh: /* Building Aqua November 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua November 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what was to do on a G4 (PPC) with Mac OS X 10.4.11:

Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD.

Install [http://www.macports.org macports], retrieve the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# Edit the file osx-build.sh to remove the configure option --enable-osxapp
# (line 24)

# I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-23T17:50:26Z

Herrdeh: /* Building Aqua November 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua November 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed [http://www.macports.org macports], retrieved the inkscape sources.

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

Edit the file osx-build.sh to remove the configure option --enable-osxapp
(line 24)

# I used TextWrangler for this, pico or another command line editor will do the same.

# Back to the terminal:

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-23T17:40:24Z

Herrdeh: /* Building Aqua November 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua November 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed [http://www.macports.org macports], retrieved the inkscape sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

As the author of this lines knows very little about compiling etc., I do recommend to send requests for support to the devel mailing list (mailto: inkscape-devel@lists.sourceforge.net). I'm reading there and may occasionally have the chance to answer some questions.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-23T17:33:40Z

Herrdeh: /* Building Aqua September 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua November 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed macports, retrieved the sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-23T17:33:11Z

Herrdeh: /* Compiling Inkscape with native GTK using MacPorts [experimental] */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

Meanwhile building a native inkscape aqua version is quite easy - dont be afraid! I do ask every Mac OS X user to try it and to file or to support bug reports. The more bug report come in, the quicker we'll have a really working inkscape aqua. I'll try to provide binaries, but making them seem to be a bit more tricky. Here is a set of instructions - should be quite comprehensive: [[#Building Aqua November 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua September 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed macports, retrieved the sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-23T17:26:55Z

Herrdeh: /* Building Aqua September 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

A more recent attempt is described here: [[#Building Aqua September 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua September 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed macports, retrieved the sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"
# ++++++++++++++++++++++++++++++++++++++++++++++++++++

cd path-to-inkscape-sources/packaging/macosx

# configure it:
sudo ./osx-build.sh c

# build it:
sudo ./osx-build.sh b

# install it:
sudo ./osx-build.sh i

# test it:
cd ../../Build/bin/./inkscape

or double click the inkscape image in path-to-inkscape-sources/Build/bin

</pre>

In the end this procedure works pretty straightforward, delivering a native inkscape which works fairly well.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-11-21T12:58:21Z

Herrdeh: /* Building Aqua September 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

A more recent attempt is described here: [[#Building Aqua September 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua September 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed macports, retrieved the sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"

export LIBPREFIX="/opt/local"
export CPATH="$LIBPREFIX/include"
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"

sudo ./autogen.sh

sudo ./configure --disable-static --enable-shared --prefix=/Users/bub/Desktop

export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin

sudo ./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native

cd packaging/macosx

# build it:
sudo ./osx-build.sh u a c b i

# test it:
cd ../../Build/bin/./inkscape
</pre>

That was the result of quite a lot of trial and error. I'm not sure this will work from scratch again, probabely there are some mistakes in my records. In the case of doubt, please keep to the instructions given above.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-09-29T11:04:03Z

Herrdeh: /* Compiling Inkscape with native GTK using MacPorts [experimental] */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

A more recent attempt is described here: [[#Building Aqua September 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua September 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed macports, retrieved the sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"

export LIBPREFIX="/opt/local"
export CPATH="$LIBPREFIX/include"
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"

sudo ./autogen.sh

sudo ./configure --disable-static --enable-shared --prefix=/Users/bub/Desktop

sudo export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin

./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native

# build it:
./osx-build.sh u a c b i

# test it:
cd ../../Build/bin/./inkscape
</pre>

That was the result of quite a lot of trial and error. I'm not sure this will work from scratch again, probabely there are some mistakes in my records. In the case of doubt, please keep to the instructions given above.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-09-29T07:57:01Z

Herrdeh: /* Building Aqua September 2009 */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

A more recent attempt is described here: [[CompilingMacOsX#Building Aqua September 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua September 2009 ==
As I had a nicely working X11 version, I didnt care about compiling for X11, so this is an aqua-only procedure, which fairly started from scratch.

Here is what I did on a G4 (PPC) with Mac OS X 10.4.11:

Installed macports, retrieved the sources. Then moved to ''Inkscape_sources_folder''/packaging/macosx, edited the file osx-build.sh to remove the configure option --enable-osxapp

In order to install gtk2 on a PowerPC, you may have to apply this workaround: [http://trac.macports.org/ticket/20372].

Then copy into the terminal:

<pre>sudo port install autoconf automake

sudo port install librsvg libwpd libwpg libcroco

sudo port install libxslt boost boehmgc gtkmm lcms intltool popt

sudo port install cairo +quartz+no_x11 cairomm pango +quartz+no_x11 poppler +quartz gtk2 +quartz

sudo port install gsl

sudo port install hicolor-icon-theme

sudo port install subversion

sudo port install libxml2 libxslt

# optional to speed up the compiling process:
sudo port install ccache
export CC="ccache gcc"
export CXX="ccache g++"

export LIBPREFIX="/opt/local"
export CPATH="$LIBPREFIX/include"
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"

sudo ./autogen.sh

sudo ./configure --disable-static --enable-shared --prefix=/Users/bub/Desktop

sudo export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin

./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native

# build it:
./osx-build.sh u a c b i

# test it:
cd ../../Build/bin/./inkscape
</pre>

That was the result of quite a lot of trial and error. I'm not sure this will work from scratch again, probabely there are some mistakes in my records. In the case of doubt, please keep to the instructions given above.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-09-29T07:38:18Z

Herrdeh: /* Compiling Inkscape with native GTK using MacPorts [experimental] */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

A more recent attempt is described here: [[CompilingMacOsX#Building Aqua September 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

== Building Aqua September 2009 ==
In September 2009 there was another attempt.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]

CompilingMacOsX

2009-09-29T07:34:58Z

Herrdeh: /* Compiling Inkscape with native GTK using MacPorts [experimental] */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt poppler boost \
gnome-vfs libgnomeprintui automake autoconf subversion</pre>

Note: subversion is pre-installed on Leopard, so you may be fine leaving subversion out of the port install command chain.

Grab a cup of coffee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. ([http://www.finkproject.org/ Fink] was used in the past but it no longer meets Inkscape's needs currently.)

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gtk-engines2 intltool libxslt lcms popt boost gsl</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X, though at least it should install fine]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo</code> : ps and pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.
If you're unsure about MacPorts commands, you can find a guide that is easy to skim here: [http://guide.macports.org/ MacPorts Guide]

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

More recent (Sep 2008) pre-packaged nightly builds for Mac OS X also feature additional dependencies:
<pre>sudo port install librsvg libwpd libwpg libcroco</pre>

NB: At the time of editing (2008-12-01) there was a problem fetching "lzmautils" as the URL MacPorts tried to use as download source dies in a timeout.
As this package is needed as a dependency for one or more packages noted above you need to download the source tarball of lzmautils from somewhere else (for example, from [ftp://sunfreeware.mirrors.tds.net/pub/sunfreeware/SOURCES/lzma-4.32.7.tar.gz here]) and put that into the local MacPorts repository at "/opt/local/var/macports/distfiles/lzmautils". You should now be able to run the commands above.

Also make sure that you have "libxml2" and "libxslt" installed with MacPorts. This should have been installed previously, either directly or as a dependency.
You will need those later to compile the "lxml" Python module if you want to use Python effects. First check what's installed and if they are missing from your MacPorts repository install them by doing:

<pre>port installed
sudo port install libxml2 libxslt</pre>

== Pre-compiling the Python modules ==

If you cannot use the pre-built Python modules from [http://inkscape.modevia.com/macosx-snap/?C=M;O=D Modevia], say, because you're using an unsupported Python version or you just want to install from source you need to pre-compile both modules.

In case you are using a Python version installed through MacPorts do a search for both modules and install the ones suitable for the Python version activated within MacPorts.
<pre>port search lxml numpy</pre>

If you are using Leopard's default Python 2.5.1 installation or a more recent one (e.g. MacPython 2.6) you will need to compile both modules outside of MacPorts. Download both modules from [http://pypi.python.org PyPI] if they are available there for your Python version. At the time of editing (2008-12-01) both modules were only available through SVN for Python 2.6.

There are lots of tutorials for building and installing the "numpy" module. One good place to start looking is the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] entry referenced at the end of this guide.

Building the "lxml" module deviates a little from the standard way, so if you cannot install it try the following command:
<pre>cd /path/to/lxml/source
sudo python setup.py install \
--with-xslt-config=/opt/local/bin/xslt-config \
--with-xml2-config=/opt/local/bin/xml2-config</pre>

This tells it to use the libxml2 and libxslt packages we installed earlier with MacPorts instead of Mac OS X' default versions, which have been known to cause problems when trying to build "lxml".

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the .app-bundle building script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]] in this guide) to copy the "lxml" and "numpy" dirs from the standard installation destination (by default "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/Library/Python/2.5/site-packages/" for Leopard's default Python 2.5.1 installation) to either
* the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions") if all you care about is getting the Inkscape build to work with your Python version. This method is more foolproof but supports only one Python version.
* the "site-packages" folder inside the Inkspace.app bundle. The "site-packages" folder is the right place for putting your pre-compiled Python modules if you want to redistribute your build. Make a subfolder within "site-packages" with the name of your arch ("i386" for Intel, "PPC" for PowerPC or type <code>arch</code> into a Terminal window) and another subfolder within the arch folder with the name of your Python version (e.g. "2.5" or "2.6" etc.). This allows you to include support for multiple Python versions with your Inkscape build. Note, however, that if someone has multiple Python versions installed they may run into problems with the PATH order exported by the internal script ("Inkspace.app/Contents/Resources/bin/inkscape") responsible for preparing the Inkscape launch environment.

Armed with this knowledge you should be able to take care of the "...needs the fantastic libxml2 wrapper..." message when executing Python effects. Normally the <code>osx-app.sh</code> script (detailed [[CompilingMacOsX#Creating_an_.app_bundle|later]]) should take care of this for you, but if for whatever reason it didn't you know how to copy the modules manually.

For further info refer to the [[GettingEffectsWorking#on_Mac_OS_X|Getting Effects Working]] section of this wiki.

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# 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"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

If you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

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

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

Here's an example which covers most options that can be set:
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/ --with-xft \
--with-gnome-vfs --with-python=/path/to/python/modules --enable-osxapp --enable-lcms \
--enable-poppler-cairo --enable-inkboard</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All essential steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to know how to use it just type:
<pre>./osx-build.sh help</pre>

NB: Excluded steps involve Pre-compiliation of the Python modules and installing the additional nightly build features.

= Compiling a Universal Binary of Inkscape with X11, using MacPorts=

These instructions should work on both 10.4 and 10.5 machines with the latest Xcode version installed.

== Build Universal dependencies ==

The easiest way to do this is to create a new Macports installation. It is recommended that you install macports from source into a long prefix (of 50 character) such as "/opt/local-macports-with-a-really-long-directory-name/" -- this will allow enough space to later perform path rewriting on all the bundled libraries.

Once you have installed Macports, edit the $PREFIX/etc/macports/variants.conf file to have the following line:
<pre>+universal</pre>
This will cause Macports to install the Universal variant of each package you later ask it to install.

If you already have non-universal versions of some ports installed, for each of these you may need to deactivate the port and rebuild it, e.g.
<pre>sudo port -f uninstall cairo
sudo port clean cairo
sudo port -v install cairo +universal</pre>

== Build Universal Inkscape ==

First, Set your SDK, 10.5 for Leopard, 10.4u for TIger:

<CODE>export SDK=/Developer/SDKs/MacOSX10.5.sdk</code>     (For Leopard) 
<CODE>export SDK=/Developer/SDKs/MacOSX10.4u.sdk</code>     (For Tiger) 

Then, set up your environment to point to the Macports libraries:
<pre>export MACPORTS="/opt/local"
export PATH=$MACPORTS/bin:$MACPORTS/sbin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/local/bin:/usr/sbin
# automake seach path
export CPATH="$MACPORTS/include"
# configure search path
export CPPFLAGS="-I$MACPORTS/include"
export LDFLAGS="-L$MACPORTS/lib"
# compiler arguments
export CFLAGS="-O3 -Wall -isysroot $SDK -arch ppc -arch i386"
export CXXFLAGS="$CFLAGS"</pre>

The final step is to configure and compile Inkscape. Inkscape must be configured with the following options:

<code>--enable-osxapp</code>     Sets the correct path for Inkscape to be used from an .app bundle 
<code>--disable-dependency-tracking</code>     Dependency tracking can't be used when compiling universal binaries.

Inkscape can then be built (with make), installed, and packaged into a Universal .app bundle using the standard .app bundle building instruction above.

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

A more recent attempt is described here: [[CompilingMacOsX#Building Aqua September 2009]]

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+no_x11 cairomm pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Installing a second Macports tree (recommended approach) ==
Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>

You can set this second tree up to always build packages with specific variants. For example, you can edit the /opt/local-native/etc/macports/variants.conf file to have the following line:
<pre>+universal +no_x11 +quartz</pre>
You can remove the +universal if you only want to build inkscape for your host architecture.
You may also need to set alternate applications_dir and frameworks_dir variables in the /opt/local-native/etc/macports/macports.conf file so that applications and frameworks install by this macports (for example by python) don't clash with your standard macports tree.

Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathnative="export PATH=/opt/local-native/bin:/opt/local-native/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html 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 ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html 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.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ 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 [http://gimp-app.sourceforge.net/gimp.app.howto.txt 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.

[[Category:Developer Documentation]]