The This page describes the installation of the ready-to-run Gramps application for Mac OS X. This is also known as the GTK-OSX port of GRAMPS Gramps for Mac . It is a single, stand-alone bundle which uses the native quartz windowing system of Mac OS X instead of X11.
Mac GRAMPS is available for both Intel and PPC Macs. OS X 10.5 (Leopard) is presently required; WebKitGtk doesn't presently work on earlier versions. The distribution page carries both a binary application that should work as soon as it is downloaded. == Before installation ==
=== OSX 10'''Mac OS X versions''' There are separate downloads for Apple computers that have Intel and PowerPC (PPC) processors. You will need to chose the appropriate one for your processor. If you are not sure which type of Apple computer you have, click on the Apple icon at the top left corner of your computer screen and choose "About This Mac". The line starting "Processor" will tell you which type of processor you have.7 Lion ===
Gramps 3.3The PPC download should run on Mac OS 10.1 runs correctly 5 (Leopard) on Lion. Earlier versions do not, except for a special beta package provided as an interim measure. All Lion users should upgrade to 3.3.1 as soon as pracicalPPC computers.
== How to Download and The Intel download, current version ({{Version_Mac}}) should run the binary GRAMPS application for on Mac ==OS X 10.5 (Leopard), 10.6 (Snow Leopard), 10.7 (Lion). 10.8 (Mountain Lion) and 10.9 (Mavericks) on Intel computers.
'''File structure:''' GRAMPS database and settings files can be found at the following places in the Mac file system (GRAMPS Version 3.2.5 and later):<br>* The GRAMPS database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb.<br>* Setting files (inipre-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32<br>* Start-up settings for GRAMPS (for e. g. the environment variable LANG) can be accessed through built Gramps.app (generally in /Applications): Right click application doesn't work on "Gramps.app"earlier versions of Mac OS X, select "Show Package Content" from the menubecause it needs WebKitGtk, the start-up settings are found in the file Contents/MacOS/Grampsand that doesn't work on earlier operating systems. '''Download:''' Select one Versions of [http://sourceforgeGramps before 3.net/projects/gramps/files/Stable/ Intel] or [http://sourceforge.net/projects/gramps/files/Stable/ PPC]. You'll get a download window3. Once it's downloaded (it may take a while, they're 38M each), you can open the dmg (just double click on it in Finder if your browser doesn1 didn't open it automatically) and drag the Gramps application wherever you like. Once installed work on your computerLion, it opens like any other applicationexcept for a special beta package provided as an interim measure. All Lion users should upgrade to {{Version_Mac}} as soon as practical.
'''Back up your databases:''' If you're using Time Machine, that's already taken care of. (You do test your Time Machine backups periodically, right?) But it doesn't hurt to have a spare copy set aside before starting up a new version. If you've been using the Gtk-OSX build, version 3.2.4 or later, just copy Library/Application Support/gramps/grampsdb. (Right click/option click and select "Make a copy" from the menu. It will be named grampsdb(2).
'''New Version Notice:''' The new (If you are upgrading from the pre-built Gramps Application version 3.2.4 3 or earlier (or a build from source version) and later) builds will default to using your Library/Application Support/gramps folder, which, if you want to keep your old database and settings, you'll need to createa Library/Application Support/gramps folder with your existing data in it. Unless you've changed the location in Preferences, they're the data is in a hidden folder in your home directory called ".gramps". Select a Finder window and select Go>Go to Folder from the menu. Type "/Users/yourname/.gramps" in the dialog box that opens up, and click on "Go". (Yes, subsitute your userid for "yourname".) The hidden folder will appear, highlighted and open. Option-drag the whole thing to Library/Application Support (the one in your home folder, not the one in your boot drive's "root" directory). Slow-double-click on the new copy so that you can edit the name and delete the '.' at the beginning to unhide it.
'''Language:''' Normally, GRAMPS sets up languages and formats from system preferences (Language and Text on Snow Leopard and Lion; Internationalization on Leopard). There are three main settings: On the first pane (Languages) is a list of languages. GRAMPS will go down the list and select the first one for which it has a translation to select the language in which all menus, labels, and messages are presented. On the right side of that pane at the bottom is an "Order for Sorted Lists" listbox which sets the way that lists are alphabetically sorted. Finally, in the third pane (Formats) one can select a country which determines things like month and day names, whether a comma, dot, or space is used to separate thousands or decimal fractions, and so on.== Installing Gramps ==
If you want to run GRAMPS with different language From the '''[[Download#Mac_OS_X]]''' page select either the Intel version or locale settings than you use for your system settingsPower PC version. You'll get a download window. Once it's downloaded, you can use open the "defaults" program from Terminal.app dmg (Applications:Utilities:Terminal.app): defaults write -app Gramps AppleLanguages "(de, enjust double click on it in Finder if your browser doesn't open it automatically)" defaults write -app Gramps AppleLocale "de_DE" defaults write -app Gramps AppleCollationOrder "de"AppleLanguages corresponds to the language list, AppleLocale to the Format country, and AppleCollationOrder selects the way that lists are sorted. You need not set them all. To remove drag the special settings defaults delete -app Gramps AppleLanguages (or AppleLocale or AppleCollation)application wherever you like. [[Howto:Change the language of reports]] has more information Once installed on language features in Gramps. When reading your computer, it, remember that AppleLanugages (which corresponds to the language list on the Languages & Text system preference pane) sets the LANGUAGE environment variable and AppleLocale (Formats in the Languages & Test pane) sets the LANG variableopens like any other application.
'''Links with other programs:''' Double clicking an image in the media reference editor should bring up Apple Preview, or a similar program, to view the image. Clicking the view button in an internet reference should bring up the URL in the default browser. Clicking the Google Maps button in the Places display should bring up the map in the browser.
GRAMPS Gramps doesn't use the X11 Mac package. It's useful to install [http://www.documentfoundation.org/download/ LibreOffice], [http://www.calligra-suite.org/ Calligra] (or [http://www.neooffice.org/ NeoOffice], a more mac-friendly version) to work on your reports after saving them from Gramps.
'''Dictionaries:''' The spelling checker uses MySpell dictionaries -- the same ones that [http://www.documentfoundation.org/download/ LibreOffice] and NeoOffice use. Unfortunately, they bury them in their application bundles, so you can download them [http://wiki.services.openoffice.org/wiki/Dictionaries here]. You need to install them in /Library/Dictionaries, and you'll need to authenticate as an administrator to do so. If you have one of them installed and know how to make symbolic links from the command line, you'll find them in Contents/share/uno_packages/cache/uno_packages, scattered about in the hash-named directories. You'll need to link both the aff and dic files (e.g., en_US.aff and en_US.dic).== What goes where ==
=== If something seems to go wrong ==='''File structure:''' Gramps database and settings files can be found at the following places in the Mac file system (Gramps Version 3.2.5 and later):<br>* The Gramps database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb.<br>* Setting files (ini-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32<br>* Start-up settings for Gramps (for e. g. the environment variable LANG) can be accessed through Gramps.app (generally in /Applications): Right click on "Gramps.app", select "Show Package Content" from the menu, the start-up settings are found in the file Contents/MacOS/Gramps.
You'll find error messages in the console log, which you can view with /Applications/Utilities/Console.app== Advanced setup ==
==Bugs==Usually, the default settings will be correct, but occasionally you may need to set things up differently.
All of the known bugs in 3.1.2 have been corrected in 3.2.4 '''Language:''' Normally, Gramps sets up languages and formats from system preferences (Language and Text on Snow Leopard and laterLion; International on Leopard). There will no doubt be new ones; report them in are three main settings:* On the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis] first pane (Language([[Using the bug tracker]] instructionss))is a list of languages. When reporting what youGramps will go down the list and select the first one for which it has a translation to select the '''language in which all menus, labels, and messages'''re sure are presented.* On the right side of that pane at the bottom is an OSX specific bug"Order for sorted lists" listbox which sets the way that '''lists are alphabetically sorted'''.* Finally, please set in the Platform field to "mac" third pane (second pane in Leopard) (no quotesFormats) one can select a country/Region which determines things like '''month and day names, whether a comma, capsdot, or spaces!) space is used to separate thousands or decimal fractions, and so that I can find it easily. The 3.1.2 bugs are described at [[Mac gtk-osx port bugs]]on'''.
==Updates==If you want to run Gramps with different language or locale settings than you use for your system settings, you can use the "defaults" program from Terminal.app (Applications:Utilities:Terminal.app): defaults write -app Gramps AppleLanguages "(de, en)" defaults write -app Gramps AppleLocale "de_DE" defaults write -app Gramps AppleCollationOrder "de"AppleLanguages corresponds to the language list, AppleLocale to the Format country/Region, and AppleCollationOrder selects the way that lists are sorted. You need not set them all.
GRAMPS stores all its internal data in ~/Library/Application Support. So, to upgrade a Gramps application bundle to a newer version, just throw the old application in the Trash. Make a backup copy of your data, just in case, then download the new version of To read the application and just setting use it. If you don: defaults read -app Grampsthis gave "Can't like the new version and want the old one back, throw the new version in the Trash and fetch the old one back from the Trash. The determine domain name for application Gramps version is shown in Finder ; defaults unchanged" for me; if you have problems you can use column view; otherwise right click on it and select Get Info defaults read org.gramps-project.gramps
==Building GRAMPS from Scratch==The settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist
Building Gramps from scratch is useful to produce a version not currently available as a binary (for example, a PPC version) or to produce a complete environment for debugging and further development, including debugging of all To remove the C libraries Gramps uses, like gtk.special settings This is a command defaults delete -line process. It's not too difficult, but you'll be using Terminal.app, not XCode. Unfortunately, Gtk has so far resisted efforts to get it to successfully cross-compile PPC on Intel Gramps AppleLanguages (or AppleLocale or vice-versa, so the whole process must be repeated on machines of each architecture. '''''WebKit will not build on 10.4 (TigerAppleCollation) or earlier systems, nor will it build against a 10.4 SDK. You must be running 10.5 (Leopard) or newer for this procedure to succeed!'''''
You'll need XCode, Apple's development environment. There's a copy on your OS X distribution DVD, or you can download the latest version from [http[Howto://developer.apple.com/technologies/xcode.html AppleChange the language of reports]], though you must register as a Mac developerhas more information on language features in Gramps. For Lion usersWhen reading it, XCode is available for free from remember that AppleLanguages (which corresponds to the language list on the Languages & Text system preference pane) sets the LANGUAGE environment variable and AppleLocale (Formats in the Languages & Test pane) sets the App StoreLANG variable.
Next, read === Dictionaries === The spelling checker uses MySpell dictionaries -- the same ones that [http://livewww.gnomedocumentfoundation.org/GTK%2Bdownload/OSX/Building the build instructions for Gtk-OSXLibreOffice]and NeoOffice use. Unfortunately, '''''especially the Prerequisites'''''. Download and run the they bury them in their application bundles, so you can download them [http://gitarchive.services.gnomeopenoffice.org/browsepub/mirror/OpenOffice.org/gtk-osxcontrib/plaindictionaries/gtk-osx-build-setuphere].sh gtk-osx-build-You need to installthem in /Library/Dictionaries, and you'll need to authenticate as an administrator to do so.sh] scriptIf you have one of them installed and know how to make symbolic links from the command line, which will set up jhbuild for you'll find them in Contents/share/uno_packages/cache/uno_packages, scattered about in the hash-named directories. You'll need to link both the aff and dic files (e.g., en_US.aff and en_US.dic).
''It's important that jhbuild is not confused by any existing MacPorts or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account.== Bugs ==
If you are building for distribution, especially if you are running Snow Leopard on a 64-bit capable machine (Core2Duo, Core i5 or i7, or any Xeon) you should edit the file ~/.jhbuildrc-custom so that the call to <tt>sdk_setup</tt> looks like setup_sdk(target="10.5", sdk_version="10.5", architectures=["i386"])Lion doesn't support SDKs older than 10.6, so in that case the line should be: setup_sdk(targetIf something seems to go wrong ="10.6", sdk_version="10.6", architectures=["i386"])(If you're building on a PPC, you don't need to worry about this.)
If you're not familiar with using the unix command line, you might find the frequent use of "~" below puzzling. It refers to the user's home directory (mine is /Users/john; if your name is John, then yours probably is too.) You can use it that way in commands if your current directory is somewhere else. jhbuild is installed in ~/Source/jhbuild, and produces a binary which appears in ~/.local/bin. You'll want to add ~/.local/bin to your path: export PATH=~/.local/bin:$PATH Next, you'll need to get a local copy of the gramps mac configuration stuff from svn (if you already have a gramps svn sandbox, then skip this step and substitute the path to it where appropriate below): svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk/mac gramps-macThat will make a current copy from the repository in your current directory, which we'll assume to be ~. The Gtk-OSX build instructions are very straightforward, but we need to deviate from them a bit to keep from doing things more than once. Run the following commands from the terminal: jhbuild bootstrapNow we need to build berkeleydb: jhbuild --moduleset=~/gramps-mac/gramps.modules build berkeleydbAnd rebuild python to include the bsddb module (it will notice that we have berkeleydb and do it automatically) jhbuild --moduleset=bootstrap.modules buildone --force pythonNow we're ready to build everything else: jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-core meta-gtk-osx-python gramps jhbuild by default puts everything it is building in ~/gtk (controlled by the hidden files ~/.jhbuildrc and ~/.jhbuildrc-custom ). ~/gtk/source contains the downloaded sources, and ~/gtk/inst contains the built libraries and applications. More is built than is needed in the final Gramps application - for example, the build tools are themselves built. At this point, you can do jhbuild shell gramps at the command line and run gramps. Most everything will work (see the note about spelling dictionaries above). Once you've done this once, you can generally get away with just running jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-core meta-gtk-osx-python grampsto update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself. If you want to build the svn trunk, you can substitute "gramps-svn" for "gramps". If you want to have both installed, you'll need to set up separate prefixes find error messages in .jhbuildrc-custom; gramps doesn't version its installations, so the most recent will overwrite the previous build. ==== Gramps 3.3 and EXIF Editing ==== Gramps 3.3.0 introduced a new module, EXIF Editingconsole log, which has two tricky dependencies, which JHBuild doesn't know how to handle yet. In order to evade the persnickityness of jhbuild's dependencies, they're given as "soft" dependencies -- you have to add them to your modules list. If you don't, Gramps will still build fine, you'll just get a warning notice about Exiv2 not being installed. '''Warning:'''Boost-python will not successfully build with either the 10.6 (Snow Leopard) or 10.7 (Lion) SDKs. With 10.7 it won't build at all; with 10.6, it will build but will crash Python on import. Consequently you can't build EXIF editing using Lion, since earlier SDKs are not available. The first is [http://www.boost.org/libs/python/doc/ Boost-python], a python interface for C++ provided as part of [http://www.boost.org/ Boost]. It uses its own build system, bjam. Since jhbuild doesn't know how to use bjam, it will download the package for you, then error out. Select item 4, "start a shell", and do the following: cd tools/build/v2 ./bootstrap.sh --view with-toolset=darwin ./bjam --prefix="$PREFIX" install cd ..Applications/..Utilities/.. bjam toolset=darwin address-model=32 --prefix=$PREFIX --with-python --cmd-or-prefix=$PYTHON cxxflags="$CXXFLAGS" cflags="$CFLAGS" linkflags="$LDFLAGS" install Once that's done, quit the shell and select "2" (ignore error) twice to move on to the next library, [http://tilloy.net/dev/pyexiv2/ PyExiv2], which also uses a different build system, [http://www.scons.org/ SCons]. The SCons folks are bright enough to use distutils, which JHBuild ''can'' handle, so that gets built and installed for you. JHBuild will stop again after downloading and extracting PyExiv for you, so once again select "4" to start a shell and run the following: export CXXFLAGS="$CXXFLAGS -I$PREFIX/include" export CFLAGS="$CFLAGS -I$PREFIX/include" export LDFLAGS="$LDFLAGS -lpython2.7" scons scons install ln $PREFIX/lib/python2.7/site-packages/libexiv2python.dylib $PREFIX/lib/python2.7/site-packages/libexiv2python.so install_name_tool -id python2.7/site-packages/libexiv2python.dylib $PREFIX/lib/python2.7/site-packages/libexiv2python.dylibQuit the shell and pick "2" a few more times to move on to the next module. == Bundling ==The next step is to create an application bundle. You'll need ige-mac-bundler, so follow the instructions in the [https://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle Gtk-OSX Wiki] to download and install it. You may need to edit <tt>~/gramps-mac/Info.plist</tt> to update the version number and copyright information. Now open a jhbuild shell and run the bundler: jhbuild shell chmod +w $PREFIX/lib/libpython2.6.dylib ige-mac-bundler ~/gramps-mac/gramps.bundle You'll have an application bundle named GrampsConsole.app on your desktop. == Packaging ==
To make an uploadable disk image, create a folder named "All of the known bugs in previous version have been corrected in Gramps-arch-version", replacing "arch" with either Intel or PPC {{Version_Mac}} and "version" with later. There will no doubt be new ones; report them in the current version numberusual way on [http://www.gramps-project. Drag your app bundle to this directoryorg/bugs/my_view_page. Open your build directory and copy php Mantis] (option-drag[[Using the bug tracker]] instructions) . When reporting what you're sure is an OSX specific bug, please set the files Platform field to "FAQmac"(no quotes, "COPYING"caps, "README", and "NEWS" to the Gramps folder you just made. Rename each to have a ".txt" extension so that they're readable with QuickLook. You might also rename COPYING to License.txt or spaces!) so that I can find it's meaning is more clear to users who aren't familiar with the GPLeasily.
Now open Applications>Utilities>Disk Utility and select File>New Image From Folder and select your folderPrevious Gramps version 3.2.4, then approve the name and location. You'll have a dmg ready for distributionbugs are described at [[Mac OS X:Build from source:gtk-osx:bugs]].
Good Luck!== Updates ==
'''Note:''' The 3.1.2 installer left out two files:#''_strptime.py''. You can get the file from [http:Gramps stores all its internal data in ~/Library/wwwApplication Support.gramps-projectSo, to upgrade a Gramps application bundle to a newer version, just throw the old application in the Trash.org/bugs/viewMake a backup copy of your data, just in case, then download the new version of the application and just use it.php?id=3177 here].# If you don''keysyms.py''. You can get t like the new version and want the old one back, throw the new version in the Trash and fetch the file old one back from [http://wwwthe Trash.gramps-project.org/bugs/The Gramps version is shown in Finder if you use column view.php?id=3157 here]; otherwise right click on it and select Get Info.
[[Category:Developers/Packaging]]
[[Category:Documentation]]
