Revision as of 21:18, 30 March 2021

Using MacPorts

Download and install MacPorts
Edit the MacPorts variants config (optional).
Add this line to /opt/local/etc/macports/variants.conf
```
-x11 +quartz
```

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

In Terminal, get Inkscape

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

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.

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 (for Inkscape 1.1):

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

You may substitute imagemagick with graphicsmagick.

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="$LIBPREFIX/opt/gettext/include" \

@@ Line 1: / Line 1: @@
-== Requirements ==
+= Using MacPorts =
-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 ==
+<ol>
+<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"
-=== Installing dependencies ===
+# where to install
-You can use DarwinPorts to list Inkscape dependencies:
+PREFIX="$PWD/install-prefix"
-<pre>port deps inkscape</pre>
-Some are mandatory and you can install them with the command:
+# where to build
-<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>
+mkdir build
+cd build
-Others provide additional functionality to Inkscape:
+cmake \
-* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
+    -G Ninja \
-* <code>boost</code> : auto-organisation of connectors [Note: is boost still needed?]
+    -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
-* <code>libgnomeprintui</code>
+    -DCMAKE_INSTALL_PREFIX="$PREFIX" \
-* <code>loudmouth</code> : jabber library used by InkBoard
+    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
-<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>
+    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
+    -DWITH_OPENMP=OFF \
+    ../inkscape
+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>
-=== For the impatient ===
+= Using Homebrew =
-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
+If you are using [https://brew.sh/ Homebrew] instead, you can still use the above guidelines with small modifications.
-<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 ===
+List of '''packages''' to install with brew
-If you want to know what you do or to understand how the build script works, please read the following paragraphs.
+(for Inkscape 1.1):
-==== Setting the build environment ====
+<syntaxhighlight lang="bash">
-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.
+brew install \
-<pre>export LIBPREFIX="/opt/local"
+    adwaita-icon-theme \
-#  automake seach path
+    bdw-gc \
-export CPATH="$LIBPREFIX/include"
+    boost \
-#  configure search path
+    cairomm \
-export CPPFLAGS="-I$LIBPREFIX/include"
+    ccache \
-export LDFLAGS="-L$LIBPREFIX/lib"
+    cmake \
-#  compiler arguments
+    double-conversion \
-export CFLAGS="-O3 -Wall"
+    gettext \
-export CXXFLAGS="$CFLAGS"
+    gsl \
-</pre>
+    gspell \
+    gtk-mac-integration \
+    gtkmm3 \
+    imagemagick \
+    intltool \
+    lcms2 \
+    libomp \
+    libsoup \
+    libxslt \
+    ninja \
+    poppler \
+    potrace
+</syntaxhighlight>
-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:
+You may substitute <code>imagemagick</code> with <code>graphicsmagick</code>.
-<pre>export CC="ccache gcc"
-export CXX="ccache g++"</pre>
-=== Configuring ===
+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>.
-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.
+Modify the script in step 5 by changing <code>LIBPREFIX="/usr/local"</code> and adding the following line to the cmake arguments:
-<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>:
+<syntaxhighlight lang="bash">
-<pre>./configure {...} --enable-osxapp</pre>
+    -DIntl_INCLUDE_DIR="$LIBPREFIX/opt/gettext/include" \
+</syntaxhighlight>
-If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.
+=See also=
+* [[Tracking Dependencies]]
-Other configuration options can be set, check the list of options by issuing:
+* [[Extension requirements]]
-<pre>./configure --help</pre>
+*[[Compiling Inkscape]]
+*[[Notes on Packaging for OS X]]
+* https://github.com/valerioa/Inkscape-MacOS-Curated-Build
-=== Building and Installing ===
+* [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
-Just run:
-<pre>make
-make install</pre>
-=== Creating an .app bundle ===
-== Compiling a universal binary of Inkscape using the all-in-one build script ==
-Michael's text to go here
-== Compiling Inkscape as a native application (no X11) ==
-Derek Hinchliffe's text to go here
-== Packaging Inkscape into an .app bundle and distributing a .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/install/prefix/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.
-== 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 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.
-== 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]]

Difference between revisions of "CompilingMacOsX"

Revision as of 21:18, 30 March 2021

Using MacPorts

Using Homebrew

See also

Navigation menu

Search