Inkscape Wiki - User contributions [en]

CompilingMacOsX

2008-12-02T03:18:23Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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>

I 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-02T03:17:41Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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>

I 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-02T03:15:24Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 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 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>

I 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-02T02:57:59Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 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 the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

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>

I 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T05:31:22Z

Andreb: /* Configuring */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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.

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 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 the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

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>

I 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T05:23:12Z

Andreb: /* Configuring */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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.

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 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 the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

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>

I 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T03:52:23Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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.

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 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 the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

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>

I 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 --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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T03:32:50Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 a different MacPorts Python version) you need to search MacPorts for both "numpy" and "lxml" and install the ones suitable for the Python version active 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 here is the command you need:
<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.

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 later in this guide) to copy both 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 the "extensions" folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

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>

I 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 --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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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]]

Extension requirements

2008-12-01T03:26:10Z

Andreb: /* Binary packages */

== Setting Up Effects in Inkscape ==

For effects to work you need to be using inkscape .42 or later.

For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]

If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

=== Unhide the Effects menu ===

This is only necessary in verions .41+CVS to .45.

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects". Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
Important note: From version .44 onwards, Inkscape now includes python in the download, and has effects enabled by default. Therefore these steps are outdated and no longer needed.

# Download [http://www.python.org/download/ Python]
# Install python and remember the directory you set it to install to. (e.g. C:\Python24 )
# Set your path variable in Windows. For Windows 2000 or XP read [http://support.microsoft.com/default.aspx?scid=kb;en-us;310519&sd=tech Microsofts instructions] or do
## Right Click My Computer
## Properties
## Advanced Tab
## Environment Variables
## In the system variables section select the one named PATH and hit edit.
## Find the end of all the values in there and add ";*path to python*" where *path to python* is the directory you told python to install to (ie c:\program files\python24)
## hit Ok, Ok, Apply
For more general instructions (including instructions for Windows 95,98,ME,NT,2000 and XP) look at the [http://www.chem.gla.ac.uk/%7Elouis/software/faq/q1.html University of Glasgow's] instructions, just remember that you want to set the PATH varable to the python directory. If there is already a path variable, don't delete it, but just add a semicolon and then the full path to the python directory at the end (e.g. PATH = C:\somthing else ; C:\python_directory)
# Reboot
# Download and Install [http://sourceforge.net/project/showfiles.php?group_id=6473 PyXML] for whatever version Python you chose to install

To get the effects menu showing up:
# Load Inscape
# Go to File > Inkscape Preferences (Shift+Ctrl+P)
# Select the "Misc" tab and tick "Enable script effects..."
# Restart Inkscape

If that didn't work, you may like to try to edit the preferences manually:
# Go to your preferences.xml file (Documents and Settings/USERNAME/Application Data/Inkscape/preferences.xml)
# Search for "id="extensions".
# If you find it: Add the following line above that "show-effects-menu="1".
# If you can't find it just add
<group
show-effects-menu="1"
id="extensions" />
Save the file, start up inkscape and use those sweet effects

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for an install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd</code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the site-packages directory of your Python install. This is /Library/Python/2.*/site-packages for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2008-12-01T03:22:51Z

Andreb: /* Compiling from source */

== Setting Up Effects in Inkscape ==

For effects to work you need to be using inkscape .42 or later.

For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]

If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

=== Unhide the Effects menu ===

This is only necessary in verions .41+CVS to .45.

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects". Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
Important note: From version .44 onwards, Inkscape now includes python in the download, and has effects enabled by default. Therefore these steps are outdated and no longer needed.

# Download [http://www.python.org/download/ Python]
# Install python and remember the directory you set it to install to. (e.g. C:\Python24 )
# Set your path variable in Windows. For Windows 2000 or XP read [http://support.microsoft.com/default.aspx?scid=kb;en-us;310519&sd=tech Microsofts instructions] or do
## Right Click My Computer
## Properties
## Advanced Tab
## Environment Variables
## In the system variables section select the one named PATH and hit edit.
## Find the end of all the values in there and add ";*path to python*" where *path to python* is the directory you told python to install to (ie c:\program files\python24)
## hit Ok, Ok, Apply
For more general instructions (including instructions for Windows 95,98,ME,NT,2000 and XP) look at the [http://www.chem.gla.ac.uk/%7Elouis/software/faq/q1.html University of Glasgow's] instructions, just remember that you want to set the PATH varable to the python directory. If there is already a path variable, don't delete it, but just add a semicolon and then the full path to the python directory at the end (e.g. PATH = C:\somthing else ; C:\python_directory)
# Reboot
# Download and Install [http://sourceforge.net/project/showfiles.php?group_id=6473 PyXML] for whatever version Python you chose to install

To get the effects menu showing up:
# Load Inscape
# Go to File > Inkscape Preferences (Shift+Ctrl+P)
# Select the "Misc" tab and tick "Enable script effects..."
# Restart Inkscape

If that didn't work, you may like to try to edit the preferences manually:
# Go to your preferences.xml file (Documents and Settings/USERNAME/Application Data/Inkscape/preferences.xml)
# Search for "id="extensions".
# If you find it: Add the following line above that "show-effects-menu="1".
# If you can't find it just add
<group
show-effects-menu="1"
id="extensions" />
Save the file, start up inkscape and use those sweet effects

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for and install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd</code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the site-packages directory of your Python install. This is /Library/Python/2.*/site-packages for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

CompilingMacOsX

2008-12-01T03:20:34Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 a different Python version) you need to search MacPorts for both "numpy" and "lxml" and install the ones suitable for the Python version active within MacPorts.
<pre>port search lxml numpy</pre>

If you are using a more recent Python version (say, 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 Python 2.6. At the time of editing (2008-12-01) however 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 here is the command you need:
<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.

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 later in this guide) to copy both the "lxml" and "numpy" dir from the standard installation destination (normally "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/System/Library/Frameworks/Python.framework/Versions/Current/Extras/lib/python" for Leopards default Python installation) to the extensions folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

== 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>

I 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 --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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T03:09:11Z

Andreb: /* Pre-compiling the Python modules */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 a different Python version) you need to search MacPorts for both "numpy" and "lxml" and install the ones suitable for the Python version active within MacPorts.
<pre>port search lxml numpy</pre>

If you are using a more recent Python version (say, 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 Python 2.6. At the time of editing (2008-12-01) however both modules were only available through SVN for Python 2.6.

There are enough tutorials for building and installing the "numpy" module but building the "lxml" module deviates a little from the standard way, so here is the command you need:
<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.

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the Inkscape.app building script (detailed later in this guide) to copy both the "lxml" and "numpy" dir from the standard installation destination (normally "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages" for MacPython 2.6 and "/System/Library/Frameworks/Python.framework/Versions/Current/Extras/lib/python" for Leopards default Python installation) to the extensions folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

== 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>

I 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 --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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T03:02:22Z

Andreb: /* Configuring */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 a different Python version) you need to search MacPorts for both "numpy" and "lxml" and install the ones suitable for the Python version active within MacPorts.
<pre>port search lxml numpy</pre>

If you are using a more recent Python version (say, 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 Python 2.6. At the time of editing (2008-12-01) however both modules were only available through SVN for Python 2.6.

There are enough tutorials for building and installing the "numpy" module but building the "lxml" module deviates a little from the standard way, so here is the command you need:
<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.

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the Inkscape.app building script (detailed later in this guide) to copy both the "lxml" and "numpy" dir from the standard installation destination (normally "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages") to the extensions folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

== 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>

I 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 --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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T01:19:04Z

Andreb: /* Automated build script */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 a different Python version) you need to search MacPorts for both "numpy" and "lxml" and install the ones suitable for the Python version active within MacPorts.
<pre>port search lxml numpy</pre>

If you are using a more recent Python version (say, 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 Python 2.6. At the time of editing (2008-12-01) however both modules were only available through SVN for Python 2.6.

There are enough tutorials for building and installing the "numpy" module but building the "lxml" module deviates a little from the standard way, so here is the command you need:
<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.

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the Inkscape.app building script (detailed later in this guide) to copy both the "lxml" and "numpy" dir from the standard installation destination (normally "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages") to the extensions folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

== 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>

I 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>

== 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-12-01T01:13:31Z

Andreb: /* Installing dependencies */

= 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 +pdf 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 +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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 a different Python version) you need to search MacPorts for both "numpy" and "lxml" and install the ones suitable for the Python version active within MacPorts.
<pre>port search lxml numpy</pre>

If you are using a more recent Python version (say, 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 Python 2.6. At the time of editing (2008-12-01) however both modules were only available through SVN for Python 2.6.

There are enough tutorials for building and installing the "numpy" module but building the "lxml" module deviates a little from the standard way, so here is the command you need:
<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.

If you are compiling the Python modules outside of MacPorts you will need to make a mental note for after running the Inkscape.app building script (detailed later in this guide) to copy both the "lxml" and "numpy" dir from the standard installation destination (normally "/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/site-packages") to the extensions folder inside the Inkscape.app bundle ("Inkscape.app/Contents/Resources/extensions").
This should take care of the "...needs fantastic libxml2 wrapper..." message when executing Python effects.

== 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>

I 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>

== 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 these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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

2008-11-30T23:57:46Z

Andreb: /* For the impatient */

= 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 +pdf 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 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]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf 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.

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>

== 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>

I 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>

== 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 these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= 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.

== Update Macport sources ==

The port descriptions in Macports do not currently all compile properly with their Universal variants. For this reason, we currently use a modified set of some of the portfiles that will compile a universal libraries. Work is being done to integrate these changes into Macports itself.

You can use our modified portfiles by adding our ports to your sources:

1. Checkout our ports directory:
<pre>svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/experimental/trunk/mjwybrow/ports ports</pre>

2. Edit your sources list to include this directory:
<pre>sudo vim /opt/local/etc/macports/sources.conf</pre>
And add the following line *before* the existing rsync source:
<pre>file:///Users/YOURUSERNAME/directory/to/ports</pre>

3. Run the portindex command in the checked-out port directory:
<pre>portindex</pre>

4. Run port sync
<pre>sudo port sync</pre>

== Build Universal dependencies ==

You should now be able to compile Inkscape's essential dependencies as Universal libraries on either 10.4 or 10.5, by giving the "+universal" option for each, e.g.
<pre>sudo port -v install poppler +universal gtk2 +universal ...</pre>

If you already have non-universal versions of these ports installed 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 user 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!

== 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+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

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>
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 portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/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.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= 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]]