Difference between revisions of "CompilingMacOsX"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Installing dependencies: placed boost as a mandatory dependency)
(Moved to GitLab)
Tag: Replaced
 
(169 intermediate revisions by 29 users not shown)
Line 1: Line 1:
== Requirements ==
{{MovedToOtherSite|topic=compiling Inkscape|new_url=https://gitlab.com/inkscape/inkscape/-/blob/master/doc/building/mac.md|new_site=GitLab}}
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.
 
== Compiling Inkscape using Mac/DarwinPorts ==
 
=== Installing dependencies ===
You can use DarwinPorts 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 gnome-vfs intltool libxslt lcms popt boost</pre>
 
Others provide additional functionality to Inkscape:
* <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
<pre>sudo port install aspell libgnomeprintui loudmouth</pre>
 
=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>
 
Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>
 
=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.
 
==== Setting the build environment ====
DarwinPorts'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 probably need to build 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 do it), 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 /path/to/install/prefix/bin/inkscape ../Info.plist macosx</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 independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
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, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.
 
== Compiling a universal binary of Inkscape using the all-in-one build script ==
 
To build a universal build of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc).  You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).
 
This process is relatively untested, as it is only being used by Michael Wybrow  for official Inkscape release builds.  If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).
 
The process is:
        export PREFIX=/your/install/prefix
        export UNIVERSAL_BUILD=Yes
        ./build-gtk bootstrap
        ./build-gtk build inkscape
 
== Compiling Inkscape as a native application (no X11) ==
 
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:
      export PREFIX=/your/install/prefix
      ./build-gtk bootstrap
      ./build-gtk build inkscape
 
== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] and [http://numpy.scipy.org/ numpy].
 
=== Binary packages ===
You can install a binary version compiled by us (thanks to krolco for the Intel version) downloadable with the developement builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus) and numpy (numpy) to /Library/Python/2.3/site-packages/ (there is a link in the dmg on which the folders can be droped).
 
On OS X 10.3, the _xmlplus and numpy folders should be copied to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages.  This is a symlink back to /Library/Python/2.3 (note lack of "site-packages"!).
 
=== Compiling from source ===
If you prefer or if you are on an Intel machine, you can install them from source, it is really easy.
 
==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.
 
==== numpy ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.
 
== Links ==
 
=== 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]]

Latest revision as of 17:53, 14 June 2025

The Inkscape Wiki is no longer used to host information about compiling Inkscape.

You can now find related information at GitLab.

This page is kept for historical reasons, e.g. to document specific decisions in Inkscape development.

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=CompilingMacOsX&oldid=123276"