Difference between revisions of "CompilingMacOsX"

From Inkscape Wiki
Jump to navigation Jump to search
(Added DarwinPorts HowTo (unfinished))
(Update homebrew instructions for gtk4)
 
(195 intermediate revisions by 29 users not shown)
Line 1: Line 1:
== Compiling Inkscape ==
__TOC__


=== Requirements ===
<span style="color:darkred;font-weight:bold">Section about MacPorts IS OUTDATED AND UNMAINTAINED!</span>
To compile Inkscape from source you will need:
<span style="color:darkgreen;font-weight:bold">Section about HomeBrew IS UP TO DATE as of Oct 30, 2024</span>
*Mac OS X 10.3 (Power PC) or higher
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://www.inkscape.org/cvs-snap/ SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*XCode 2.3 on OS X 10.4 (gcc 4.0.1)


To install inkscape dependencies you can use:
= Using MacPorts =
*Fink with an [http://fink.sourceforge.net/faq/usage-fink.php?phpLang=en#unstable unstable installation] (does not provide support for loudmouth, the librarie that Inkboard uses, therefore you won't be able to use Inkboard)
*[http://darwinports.opendarwin.org/ DarwinPorts]


=== Preparing the build using Fink ===
If you can build successfully with MacPorts, please update this file and remove above comment.


====Installing dependencies====
<ol>
Inkscape can be installed via Fink. Therefore, as for any other package, Fink provides you with a list of its dependencies:
<li>Download and install [http://www.macports.org/ MacPorts]
<pre>fink show-deps inkscape</pre>
<li>Edit the MacPorts variants config (optional).
<br>Add this line to <code>/opt/local/etc/macports/variants.conf</code>
<pre>-x11 +quartz</pre>
<li>In Terminal (Applications>Utilities>Terminal) type
<syntaxhighlight lang="bash">sudo port install \
    adwaita-icon-theme \
    boehmgc \
    boost \
    cairo \
    ccache \
    cmake \
    double-conversion \
    gdl3 \
    gettext \
    gsl \
    gtkmm3 \
    gtk-osx-application-gtk3 \
    lcms2 \
    libsoup \
    libxslt \
    ninja \
    poppler \
    potrace \
    py-lxml \
    py-numpy \
    -x11 +quartz
</syntaxhighlight>
<li>In Terminal, get Inkscape
<syntaxhighlight lang="bash">git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git</syntaxhighlight>
<li>And build inkscape
<syntaxhighlight lang="bash">
# use a clean MacPorts environment (optional)
LIBPREFIX="/opt/local"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"


Some are mandatory and you must install them:
# where to install
<pre>fink install gtkmm2.4-dev  gconf2-dev gtkspell2-dev intltool libbonobo2-dev libxslt gc automake1.8</pre>
PREFIX="$PWD/install-prefix"
You need version 1.8 of automake 1.8 (and not 1.9, the latest in Fink)


Some provide additional functionality in Inkscape
# where to build
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
mkdir build
* <code>boost >= 1.32</code> : auto-organisation of connectors
cd build
* <code>gnome-vfs2</code>
* <code>gnome-print</code>
* <code>lcms</code> : color management via LittleCMS
<pre>fink install aspell-dev boost gnome-vfs2-dev gnome-print-dev lcms</pre>


You may also need to build popt from source (tested on 10.4):
cmake \
[ftp://ftp.rpm.org/pub/rpm/dist/rpm-4.1.x/popt-1.7.tar.gz]
    -G Ninja \
    -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
    -DCMAKE_INSTALL_PREFIX="$PREFIX" \
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
    -DWITH_OPENMP=OFF \
    ../inkscape


====Setting the build environment====
ninja
Fink's hierarchy is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here. You can create a file named <code>set_env_variables.sh</code> and copy/paste this inside:
ninja install
<pre>
</syntaxhighlight>
#!/bin/bash
''Note: Using [https://en.wikipedia.org/wiki/Ccache ccache] and [https://ninja-build.org/ ninja] is not required, but very common because it speeds up compilation.''
FINK="/sw"
<li>Run Inkscape
export CFLAGS="-O3 -Wall"
<syntaxhighlight lang="bash">
export CXXFLAGS="$CFLAGS"
$PREFIX/bin/inkscape
export CPPFLAGS="-I$FINK/include"
</syntaxhighlight>
export LDFLAGS="-L$FINK/lib"
</ol>
export CPATH="$FINK/include"
export PATH="/usr/X11R6/bin:$PATH"
export LIBRARY_PATH="/usr/X11R6/lib:$FINK/lib"
export PKG_CONFIG_PATH="$FINK/lib/pkgconfig"
</pre>


In addition, you must make sure that Inkscape is compiled with the compiler version that Fink uses, otherwise Inkscape will not link properly. To determine which compiler to use type:
= Using Homebrew =
<pre>head -n 5 $FINK/etc/fink.conf | grep "Distribution"</pre>
If your fink distribution is 10.4 add:
<pre>
export CC="gcc-4.0"
export CXX="g++-4.0"
</pre>
to <code>set_env_variables.sh</code>, else (10.3, 10.4-transitional) add:
<pre>
export CC="gcc-3.3"
export CXX="g++-3.3"
</pre>


You can also use <code>ccache</code> (<code>fink install ccache</code>) to speed up the compilation a bit. To do so, modify the compiler lines accordingly:
Prerequisites:
<pre>
* Xcode (AppStore)
export CC="ccache gcc-??"
* Xcode command line tools (<code>xcode-select --install</code>)
export CXX="ccache g++-??"
* HomeBrew
</pre>


Eventually, open a Terminal and, in the directory where you created the file <code>set_env_variables.sh</code>, type:
If you are using [https://brew.sh/ Homebrew] instead, you can still use the above guidelines with small modifications.
<pre>source set_env_variables.sh</pre>
(Make sure you don't have any MacPorts stuff in your PATH.)
You are ready for to compile and install Inkscape.


List of '''packages''' to install with brew
(for Inkscape on master branch using GTK4):


=== Preparing the build using DarwinPorts ===
<syntaxhighlight lang="bash">
====Installing dependencies====
brew install \
You can use DarwinPorts to list Inkscape dependencies:
    adwaita-icon-theme \
<pre>port deps inkscape</pre>
    bdw-gc \
Some are mandatory and you can install them with the command:
    boost \
<pre>sudo port install boehmgc gtkmm intltool libxslt</pre>
    cairomm \
Others provide additional functionality to Inkscape:
    ccache \
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
    cmake \
* <code>boost</code> : auto-organisation of connectors
    double-conversion \
* <code>gnome-vfs</code>
    gettext \
* <code>libgnomeprintui</code>
    gsl \
* <code>lcms</code> : color management via LittleCMS
    gspell \
* <code>loudmouth</code> : jabber library used by InkBoard
    gtkmm4 \
<pre>sudo port install aspell boost gnome-vfs libgnomeprintui lcms loudmouth</pre>
    gtksourceview5 \
    imagemagick \
    intltool \
    lcms2 \
    libomp \
    libsoup@2 \
    libxslt \
    ninja \
    pkg-config \
    poppler \
    potrace
</syntaxhighlight>


====Setting the build environment====
You may substitute <code>imagemagick</code> with <code>graphicsmagick</code>.


Some keg-only libraries need to be added to <code>$PKG_CONFIG_PATH</code>


Some libraries can cause trouble if they are picked up from the SDK instead of Homebrew (observed with <code>libxslt</code> and <code>libxml2</code>). Adding them to <code>$PKG_CONFIG_PATH</code> should fix this.


Check out the source if you haven't already:


=== Configuring ===
<syntaxhighlight lang="bash">git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git</syntaxhighlight>


You might need to build the configure script first (if you compile Inkscape for the first time). Cd to Inkscape's source directory and run:
Then <code>cd inkscape</code> and follow the steps below.
<pre>./autogen.sh</pre>


Then run the configure script:
Tested with:
<pre>./configure --prefix=/path/to/build/products/ --enable-osxapp</pre>
* M1 MacBook Air with macOS 11.6 and Inkscape 1.2-dev
* M2 MacBook Air with macOS 13.0.1 and Inkscape 1.2.1, 1.2.x from git.
* M2 Mac Mini with macOS 14.2 and Inkscape 1.4-dev. (After adding pkg-config.)
* VM with macOS 15.1 and Inkscape 1.5-dev (master branch)


The <code>--prefix</code> option sets the directory where the build products are placed. It must be somewhere you have write access to. The option <code>--enable-osxapp</code> allows you to package Inkscape into an <code>.app</code> bundle in order to access it like a regular OS X application. Remove this option if you only want to build Inskscape, not to package it afterwards. Of course you can add here classic configuration options such as <code>--enable-lcms</code> for color management or <code>--enable-inkboard</code> for whiteboard functionality.
<syntaxhighlight lang="bash">
# use a clean Homebrew environment (optional)
LIBPREFIX="/opt/homebrew"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"


=== Building and Installing ===
# keg-only libraries
export PKG_CONFIG_PATH="$LIBPREFIX/opt/icu4c/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libsoup@2/lib/pkgconfig"


Just run:
# prevent picking up libxslt and libxml2 from the (wrong) SDK
<pre>
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxslt/lib/pkgconfig"
make
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxml2/lib/pkgconfig"
make install
</pre>


# where to install
PREFIX="$PWD/install-prefix"


===Automated compilation===
mkdir -p build
You can try downloading a bash script which automates the processes of updating Inkscape from the svn repository, setting the build environment, building and producing a package of Inkscape. Modify it with your favorite text editor in order to set a correct install prefix and to change configuration options according to your needs.
cd build
Two scripts are prodived, depending on wether you use Fink or DarwinPorts.
[http://jo.irisson.free.fr/dropbox/inkscape/osxmake_fink.sh]
[http://jo.irisson.free.fr/dropbox/inkscape/osxmake_dp.sh]


To use this script, place it in the directory where Inkscape source code is and make it executable
cmake \
<pre>chmod +x osxmake_???.sh</pre>
    -G Ninja \
To obtain help on how to use it run it with the <code>-h</code> option:
    -DCMAKE_SHARED_LINKER_FLAGS="-L$LIBPREFIX/lib" \
<pre>./osxmake_???.sh -h</pre>
    -DCMAKE_EXE_LINKER_FLAGS="-L$LIBPREFIX/lib" \
To run the whole process use the command:
    -DCMAKE_INSTALL_PREFIX=$PREFIX \
<pre>./osxmake_???.sh -s -a -c -b -i -p</pre>
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
    -DWITH_DBUS=OFF \
    ..


== Packaging Inkscape into an .app bundle ==
ninja
ninja install
</syntaxhighlight>


=Packaging=


=== Creating the .app and a simple .dmg ===
If <code>$PREFIX/bin/inkscape</code> works when executed and you want to turn it into an app or a DMG, have a look at the files inside the <code>inkscape/packaging/macos</code> directory. More info can be found on upstream mibap:


Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, the process is fully automatized. You just have to open a Terminal, cd to Inkscape's sources directory and type:
* https://github.com/dehesselle/mibap
<pre>
cd packaging
./osx-app.sh -s /path/to/build/products/bin/inkscape ../Info.plist macosx
</pre>
The <code>-s</code> options produces an app bundle stripped of debugging information (which is therefore smaller). Omit this option if you want to keep debugging info.


Either way, this creates two files in current directory: Inkscape.app that you can copy to your Applications directory and Inkscape.dmg for distribution.
Follow the steps to install the toolset, package the app, and create a DMG. In case you use upstream mibap, you will get the app under <code>/Users/Shared/work/mibap-*/</code> and you will get a DMG file in the same place you ran <code>./build_inkscape.sh</code>.


 
=See also=
=== Creating a more complete .dmg ===
* [[Tracking Dependencies]]
 
* [[Extension requirements]]
The steps that used to comprise this section have since been integrated into the official Inkscape.app build script, refered to above.
*[[Compiling Inkscape]]
 
*[[Notes on Packaging for OS X]]
== Enabling python effects ==
* https://github.com/valerioa/Inkscape-MacOS-Curated-Build
 
* [https://github.com/ipatch/homebrew-us-05/blob/master/inkscape/inkscape-building-for-macOS.md ipatch's collection of notes] about building Inkscape using Homebrew
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but not with pyXML which is needed by Inkscape effects.
You can install a binary version downloadable with the developement builds of Inkscape:
 
:http://inkscape.modevia.com/macosx-snap/?M=D
 
Or you can install it from source:
# 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 the number of your operating system (10.3 for Panther, 10.4 for Tiger. 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<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.
 
== 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]]
[[Category:Developer Documentation]]

Latest revision as of 02:45, 31 October 2024

Section about MacPorts IS OUTDATED AND UNMAINTAINED! Section about HomeBrew IS UP TO DATE as of Oct 30, 2024

Using MacPorts

If you can build successfully with MacPorts, please update this file and remove above comment.

  1. Download and install MacPorts
  2. Edit the MacPorts variants config (optional).
    Add this line to /opt/local/etc/macports/variants.conf 
    -x11 +quartz
  3. In Terminal (Applications>Utilities>Terminal) type 
    sudo port install \
     adwaita-icon-theme \
     boehmgc \
     boost \
     cairo \
     ccache \
     cmake \
     double-conversion \
     gdl3 \
     gettext \
     gsl \
     gtkmm3 \
     gtk-osx-application-gtk3 \
     lcms2 \
     libsoup \
     libxslt \
     ninja \
     poppler \
     potrace \
     py-lxml \
     py-numpy \
     -x11 +quartz
  4. In Terminal, get Inkscape 
    git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git
  5. And build inkscape 
    # use a clean MacPorts environment (optional)
LIBPREFIX="/opt/local"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"

# where to install
PREFIX="$PWD/install-prefix"

# where to build
mkdir build
cd build

cmake \
    -G Ninja \
    -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
    -DCMAKE_INSTALL_PREFIX="$PREFIX" \
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
    -DWITH_OPENMP=OFF \
    ../inkscape

ninja
ninja install

    Note: Using ccache and ninja is not required, but very common because it speeds up compilation.

  6. Run Inkscape 
    $PREFIX/bin/inkscape

Using Homebrew

Prerequisites:

  • Xcode (AppStore)
  • Xcode command line tools (xcode-select --install)
  • HomeBrew

If you are using Homebrew instead, you can still use the above guidelines with small modifications. (Make sure you don't have any MacPorts stuff in your PATH.)

List of packages to install with brew (for Inkscape on master branch using GTK4): 

brew install \
    adwaita-icon-theme \
    bdw-gc \
    boost \
    cairomm \
    ccache \
    cmake \
    double-conversion \
    gettext \
    gsl \
    gspell \
    gtkmm4 \
    gtksourceview5 \
    imagemagick \
    intltool \
    lcms2 \
    libomp \
    libsoup@2 \
    libxslt \
    ninja \
    pkg-config \
    poppler \
    potrace

You may substitute imagemagick with graphicsmagick.

Some keg-only libraries need to be added to $PKG_CONFIG_PATH

Some libraries can cause trouble if they are picked up from the SDK instead of Homebrew (observed with libxslt and libxml2). Adding them to $PKG_CONFIG_PATH should fix this.

Check out the source if you haven't already: 

git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git

Then cd inkscape and follow the steps below.

Tested with:

  • M1 MacBook Air with macOS 11.6 and Inkscape 1.2-dev
  • M2 MacBook Air with macOS 13.0.1 and Inkscape 1.2.1, 1.2.x from git.
  • M2 Mac Mini with macOS 14.2 and Inkscape 1.4-dev. (After adding pkg-config.)
  • VM with macOS 15.1 and Inkscape 1.5-dev (master branch)
# use a clean Homebrew environment (optional)
LIBPREFIX="/opt/homebrew"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"

# keg-only libraries
export PKG_CONFIG_PATH="$LIBPREFIX/opt/icu4c/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libsoup@2/lib/pkgconfig"

# prevent picking up libxslt and libxml2 from the (wrong) SDK
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxslt/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxml2/lib/pkgconfig"

# where to install
PREFIX="$PWD/install-prefix"

mkdir -p build
cd build

cmake \
    -G Ninja \
    -DCMAKE_SHARED_LINKER_FLAGS="-L$LIBPREFIX/lib" \
    -DCMAKE_EXE_LINKER_FLAGS="-L$LIBPREFIX/lib" \
    -DCMAKE_INSTALL_PREFIX=$PREFIX \
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
    -DWITH_DBUS=OFF \
    ..

ninja
ninja install

Packaging

If $PREFIX/bin/inkscape works when executed and you want to turn it into an app or a DMG, have a look at the files inside the inkscape/packaging/macos directory. More info can be found on upstream mibap:

Follow the steps to install the toolset, package the app, and create a DMG. In case you use upstream mibap, you will get the app under /Users/Shared/work/mibap-*/ and you will get a DMG file in the same place you ran ./build_inkscape.sh.

See also

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