Difference between revisions of "CompilingMacOsX"

From Inkscape Wiki
Jump to navigation Jump to search
(slight refactoring of the page to add --enable-osxapp)
 
 
(206 intermediate revisions by 33 users not shown)
Line 1: Line 1:
= Compiling and Packaging Inkscape under Mac OS X =
+
= Using MacPorts =
  
== Before you start ==
+
<ol>
If you want an Official Release, note that from version 0.42 of Inkscape a Mac OS X package (in .dmg form) will be available. In addition, regular Development Versions will be build. Both can be downloaded from Inkscape's downloads page:
+
<li>Download and install [http://www.macports.org/ MacPorts]
 +
<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"
  
:http://www.inkscape.org/download.php
+
# where to install
 +
PREFIX="$PWD/install-prefix"
  
Inkscape for Mac OS X is an X client: it runs under the [http://en.wikipedia.org/wiki/X_Window_System X Windows System]. You will need an X Windows Server installed for it to work. You can get Apple's X Server (requires Mac OS X 10.3 or above) here:
+
# where to build
 +
mkdir build
 +
cd build
  
:http://www.apple.com/downloads/macosx/apple/x11formacosx.html
+
cmake \
 +
    -G Ninja \
 +
    -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
 +
    -DCMAKE_INSTALL_PREFIX="$PREFIX" \
 +
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
 +
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
 +
    -DWITH_OPENMP=OFF \
 +
    ..
  
----
+
ninja
 +
ninja install
 +
</syntaxhighlight>
 +
''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.''
 +
<li>Run Inkscape
 +
<syntaxhighlight lang="bash">
 +
$PREFIX/bin/inkscape
 +
</syntaxhighlight>
 +
</ol>
  
== Compiling How To ==
+
= Using Homebrew =
  
'''Note''': You could use the [http://fink.sourceforge.net/pdb/package.php/inkscape Inkscape package] from the [http://fink.sourceforge.net Fink project] to install Inkscape from source but this package is usally older that the precompiled Development Versions and even that the Official Release so this does not seem useful.
+
If you are using [https://brew.sh/ Homebrew] instead, you can still use the above guidelines with small modifications.
  
'''Requirements''':
+
List of '''packages''' to install with brew
#Mac OS X 10.3 of higher
 
#A full [http://fink.sourceforge.net/faq/usage-fink.php?phpLang=en#unstable unstable fink] installation
 
#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/ CVS snapshot] or a copy of the [http://sourceforge.net/cvs/?group_id=93438 cvs repository] (the module name is "inkscape")
 
  
'''Installing dependencies''':
+
<syntaxhighlight lang="bash">
 +
brew install \
 +
    adwaita-icon-theme \
 +
    bdw-gc \
 +
    boost \
 +
    cairomm \
 +
    ccache \
 +
    cmake \
 +
    double-conversion \
 +
    gdl \
 +
    gettext \
 +
    graphicsmagick \
 +
    gsl \
 +
    gtk-mac-integration \
 +
    gtkmm3 \
 +
    gtkspell3 \
 +
    imagemagick \
 +
    intltool \
 +
    lcms2 \
 +
    libsoup \
 +
    libsvg-cairo \
 +
    libxslt \
 +
    ninja \
 +
    poppler \
 +
    potrace
 +
</syntaxhighlight>
  
In a Terminal type:
+
Since '''Homebrew''' only offers <code>gettext</code> as a keg (not linked to <code>/usr/local</code>) an extra option needs to be passed on to <code>cmake</code>.
<pre>
 
fink install �
 
        intltool �
 
        glib2 glib2-dev glib2-shlibs �
 
        gtk+2 gtk+2-shlibs gtk+2-dev �
 
        libpng3 libpng3-shlibs �
 
        libsigc++2 libsigc++2-shlibs �
 
        gtkmm2.4 gtkmm2.4-dev gtkmm2.4-shlibs �
 
        libtool14 libtool14-shlibs �
 
        libxml2 libxml2-shlibs �
 
        popt popt-shlibs �
 
        gc gc-shlibs automake1.8
 
</pre>
 
  
You need automake 1.8 and not the latest in fink (1.9.6-1). Fink installs many packages from source so this is usually long.
+
Modify the script in step 5 by changing <code>LIBPREFIX="/usr/local"</code> and adding the following line to the cmake arguments:
  
'''Setting the build environment''':
+
<syntaxhighlight lang="bash">
 +
    -DIntl_INCLUDE_DIR="/usr/local/opt/gettext/include" \
 +
</syntaxhighlight>
  
You need set the following environment variables (taken right out of fink's <code>.info</code> file) for the compilation to work. They are in bash syntax. You can create a file named <code>set_variables</code> for example and copy/paste this inside:
+
=See also=
<pre>
+
* [[Tracking Dependencies]]
#!/bin/bash
+
* [[Extension requirements]]
FINK="/sw"
+
*[[Compiling Inkscape]]
export LIBRARY_PATH="/usr/X11R6/lib:$FINK/lib"
+
*[[Notes on Packaging for OS X]]
export CPATH="$FINK/include"
+
* https://github.com/valerioa/Inkscape-MacOS-Curated-Build
export PATH="/usr/X11R6/bin:$PATH"
+
* [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
export CC="gcc"
 
export CXX="g++"
 
export CPPFLAGS="-I$FINK/include"
 
export LDFLAGS="-L$FINK/lib"
 
export CFLAGS="-O3 -Wall"
 
export CXXFLAGS="$CFLAGS"
 
</pre>
 
  
Optionaly, to speed up the compilation a bit you could use <code>ccache</code> if you have it installed:
+
[[Category:Developer Documentation]]
<pre>
 
export CC="ccache gcc"
 
export CXX="ccache g++"
 
</pre>
 
 
 
'''Note''': Inkscape won't link properly on OS X 10.4.x using gcc 4 (the default) since many of the libraries it needs in fink are still built with gcc-3.3.  Thus, Tiger users will probably want to modify a couple of lines:
 
<pre>
 
export CC="gcc-3.3"
 
export CXX="g++-3.3"
 
</pre>
 
 
 
Then, open a Terminal and, in the directory where you created the file <code>set_variables</code>, type:
 
<pre>
 
bash
 
source set_variables
 
</pre>
 
 
 
Then you need to build the configure script. Cd to Inkscape's source directory and run:
 
<pre>
 
autogen.sh
 
</pre>
 
 
 
'''Configuring''':
 
 
 
Cd to Inkscape's sources directory and type
 
<pre>
 
./configure --prefix=/path/to/build/products/ --enable-osxapp
 
</pre>
 
The <code>--prefix</code> option sets the directory where the build products are placed. It must be somwhere you have write access to. The option --enable-osxapp 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.
 
 
 
'''Building''':
 
<pre>
 
make
 
make install
 
</pre>
 
 
 
'''Packaging''':
 
 
 
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:
 
<pre>
 
cd packaging
 
./osx-app.sh /path/to/build/products/bin/inkscape ../Info.plist macosx
 
</pre>
 
 
 
You will end up with two files in current directory: Inkscape.app that you can copy to your Applications directory and Inkscape.dmg for distribution.
 
 
 
-- Kees Cook, Michael Wybrow, Jean-Olivier Irisson
 
 
 
----
 
 
 
== Interesting links ==
 
 
 
Some packaging links:
 
http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html
 
http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/
 
http://gimp-app.sourceforge.net/gimp.app.howto.txt
 

Latest revision as of 17:26, 18 April 2020

Using MacPorts

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

If you are using Homebrew instead, you can still use the above guidelines with small modifications.

List of packages to install with brew

brew install \
    adwaita-icon-theme \
    bdw-gc \
    boost \
    cairomm \
    ccache \
    cmake \
    double-conversion \
    gdl \
    gettext \
    graphicsmagick \
    gsl \
    gtk-mac-integration \
    gtkmm3 \
    gtkspell3 \
    imagemagick \
    intltool \
    lcms2 \
    libsoup \
    libsvg-cairo \
    libxslt \
    ninja \
    poppler \
    potrace

Since Homebrew only offers gettext as a keg (not linked to /usr/local) an extra option needs to be passed on to cmake.

Modify the script in step 5 by changing LIBPREFIX="/usr/local" and adding the following line to the cmake arguments:

    -DIntl_INCLUDE_DIR="/usr/local/opt/gettext/include" \

See also