Difference between revisions of "CompilingMacOsX"

From Inkscape Wiki
Jump to navigation Jump to search
 
(171 intermediate revisions by 26 users not shown)
Line 1: Line 1:
== Compiling Inkscape ==
+
= Using MacPorts =
  
=== Requirements ===
+
<ol>
To compile Inkscape from source you will need:
+
<li>Download and install [http://www.macports.org/ MacPorts]
*Mac OS X 10.3 (Power PC) or higher
+
<li>Edit the MacPorts variants config (optional).
*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].
+
<br>Add this line to <code>/opt/local/etc/macports/variants.conf</code>
*XCode 2.3 on OS X 10.4 (gcc 4.0.1)
+
<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"
  
To install inkscape dependencies you can use:
+
# where to install
*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)
+
PREFIX="$PWD/install-prefix"
*[http://darwinports.opendarwin.org/ DarwinPorts]
 
  
=== Preparing the build using Fink ===
+
# where to build
 +
mkdir build
 +
cd build
  
====Installing dependencies====
+
cmake \
Inkscape can be installed via Fink. Therefore, as for any other package, Fink provides you with a list of its dependencies:
+
    -G Ninja \
<pre>fink show-deps inkscape</pre>
+
    -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
 +
    -DCMAKE_INSTALL_PREFIX="$PREFIX" \
 +
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
 +
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
 +
    -DWITH_OPENMP=OFF \
 +
    ..
  
Some are mandatory and you must install them:
+
ninja
<pre>fink install gtkmm2.4-dev  gconf2-dev gnome-vfs2-dev\
+
ninja install
  gtkspell2-dev intltool lcms libbonobo2-dev libxslt gc</pre>
+
</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>
  
Some provide additional functionality in Inkscape
+
= Using Homebrew =
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
 
* <code>boost >= 1.32</code> : auto-organisation of connectors [Note: is boost still needed?]
 
* <code>gnome-print</code>
 
<pre>fink install aspell-dev boost gnome-print-dev</pre>
 
  
If you use [http://en.wikipedia.org/wiki/MMX MMX optimization] (available on Intel processors) you need version 1.8.5 of automake (and not 1.9.6 which is the latest in Fink). Otherwise you will need suppress the check on the version of automake (see the Configuring section).
+
If you are using [https://brew.sh/ Homebrew] instead, you can still use the above guidelines with small modifications.
<pre>fink install automake1.8</pre>
 
  
====Setting the build environment====
+
List of '''packages''' to install with brew
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:
 
<pre>
 
#!/bin/bash
 
FINK="/sw"
 
export CFLAGS="-O3 -Wall"
 
export CXXFLAGS="$CFLAGS"
 
export CPPFLAGS="-I$FINK/include"
 
export LDFLAGS="-L$FINK/lib"
 
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:
+
<syntaxhighlight lang="bash">
<pre>head -n 5 $FINK/etc/fink.conf | grep "Distribution"</pre>
+
brew install \
If your fink distribution is 10.4 add:
+
    adwaita-icon-theme \
<pre>
+
    bdw-gc \
export CC="gcc-4.0"
+
    boost \
export CXX="g++-4.0"
+
    cairomm \
</pre>
+
    ccache \
to <code>set_env_variables.sh</code>, else (10.3, 10.4-transitional) add:
+
    cmake \
<pre>
+
    double-conversion \
export CC="gcc-3.3"
+
    gdl \
export CXX="g++-3.3"
+
    gettext \
</pre>
+
    graphicsmagick \
 +
    gsl \
 +
    gtk-mac-integration \
 +
    gtkmm3 \
 +
    gtkspell3 \
 +
    imagemagick \
 +
    intltool \
 +
    lcms2 \
 +
    libsoup \
 +
    libsvg-cairo \
 +
    libxslt \
 +
    ninja \
 +
    poppler \
 +
    potrace
 +
</syntaxhighlight>
  
You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>fink install ccache</code>) to speed up the compilation a bit. To do so, modify the compiler lines accordingly:
+
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>
 
export CC="ccache gcc-??"
 
export CXX="ccache g++-??"
 
</pre>
 
  
Eventually, open a Terminal and, in the directory where you created the file <code>set_env_variables.sh</code>, type:
+
Modify the script in step 5 by changing <code>LIBPREFIX="/usr/local"</code> and adding the following line to the cmake arguments:
<pre>source set_env_variables.sh</pre>
 
  
You are ready to configure, compile and install Inkscape. Go to the section 'Configuring' now.
+
<syntaxhighlight lang="bash">
 +
    -DIntl_INCLUDE_DIR="/usr/local/opt/gettext/include" \
 +
</syntaxhighlight>
  
=== Preparing the build using DarwinPorts ===
+
=See also=
====Installing dependencies====
+
* [[Tracking Dependencies]]
You can use DarwinPorts to list Inkscape dependencies:
+
* [[Extension requirements]]
<pre>port deps inkscape</pre>
+
*[[Compiling Inkscape]]
Some are mandatory and you can install them with the command:
+
*[[Notes on Packaging for OS X]]
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt</pre>
+
* https://github.com/valerioa/Inkscape-MacOS-Curated-Build
Others provide additional functionality to Inkscape:
+
* [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
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
 
* <code>boost</code> : auto-organisation of connectors
 
* <code>gnome-vfs</code>
 
* <code>libgnomeprintui</code>
 
* <code>loudmouth</code> : jabber library used by InkBoard
 
<pre>sudo port install aspell boost gnome-vfs libgnomeprintui loudmouth</pre>
 
 
 
====Setting the build environment====
 
 
 
 
 
 
 
 
 
=== Configuring ===
 
 
 
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:
 
<pre>./autogen.sh</pre>
 
 
 
Then run the configure script:
 
<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 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.
 
 
 
=== Building and Installing ===
 
 
 
Just run:
 
<pre>
 
make
 
make install
 
</pre>
 
 
 
 
 
===Automated compilation===
 
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.
 
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
 
<pre>chmod +x osxmake_???.sh</pre>
 
To obtain help on how to use it run it with the <code>-h</code> option:
 
<pre>./osxmake_???.sh -h</pre>
 
To run the whole process use the command:
 
<pre>./osxmake_???.sh -s -a -c -b -i -p</pre>
 
 
 
== Packaging Inkscape into an .app bundle ==
 
 
 
 
 
=== Creating the .app and a simple .dmg ===
 
 
 
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 -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.
 
 
 
 
 
=== Creating a more complete .dmg ===
 
 
 
The steps that used to comprise this section have since been integrated into the official Inkscape.app build script, refered to above.
 
 
 
== Enabling python effects ==
 
 
 
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 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