[[Category:Developers/Packaging]]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 for Mac. It is a single, stand-alone bundle which uses the native quartz windowing system of Mac OS X instead of X11.
'''Notice:''' this page describes the [http://gtk-osx.sourceforge.net/ GTK-OSX] port of GRAMPS to Mac, which has not been thoroughly tested. Everything should work just as it does on Linux, but you are encouraged to make backups to protect your data. Time Machine will do very nicely. == Before installation ==
'''Notice:Mac OS X versions''' This page is in transition at the moment; a new set of binaries There are separate downloads for 3Apple computers that have Intel and PowerPC (PPC) processors.2.4 You will be available shortly. The build instructions will be changed first, as they will enable you need to build chose the appropriate one for your own 3processor.2.4 bundle from sources. Most If you are not sure which type of issues below apply only to Apple computer you have, click on the Apple icon at the 3top left corner of your computer screen and choose "About This Mac".1.2 build and The line starting "Processor" will tell you which type of processor you have been corrected for 3.2.4.
'''Note:''' The 3PPC download should run on Mac OS 10.1.2 installer left out two files:#''_strptime.py''. You can get the file from [http://www.gramps-project.org/bugs/view.php?id=3177 here].#''keysyms.py''. You can get the file from [http://www.gramps-project.org/bugs/view.php?id=3157 here]5 (Leopard) on PPC computers.
The GTK-OSX port of GRAMPS for Intel download, current version ({{Version_Mac}}) should run on Mac is a singleOS X 10.5 (Leopard), 10.6 (Snow Leopard), stand-alone bundle which uses the native quartz windowing system instead of X1110.7 (Lion). 10.8 (Mountain Lion) and 10.9 (Mavericks) on Intel computers.
The pre-built Gramps application doesn't work on earlier versions of Mac GRAMPS is available for both Intel and PPC Macs. OS X 10.5 (Leopard) is presently required; , because it needs WebKitGtk , and that doesn't presently work on earlier versionsoperating systems. The distribution page carries both a binary application that should work as soon as it is downloadedVersions of Gramps before 3. == How to Download and run the binary GRAMPS application for Mac == '''File structure:''' GRAMPS database and settings files can be found at the following places in the Mac file system (GRAMPS Version 3.2.5):<br>* The GRAMPS database with the user1 didn'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 t work on "Gramps.app"Lion, select "Show Package Content" from the menu, the start-up settings are found in the file Contents/MacOS/Gramps. '''Download:''' Select one of [http://sourceforge.net/projects/gramps/files/Stable/ Intel] or [http://sourceforge.net/projects/gramps/files/Stable/ PPC]. You'll get except for a download windowspecial beta package provided as an interim measure. 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 doesn't open it automatically) and drag the Gramps application wherever you like. Once installed on your computer, it opens like any other applicationAll 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:''' The GRAMPS application takes per default its working language from the System Preferences - International (Languages & Text in Snow Leopard) settings. It will search the list in order and select the first one for which there is a Gramps translation. It is, however, possible to decouple the language that you use for GRAMPS from your system language setting by modifying the GRAMPS start-up settings file. Find the "Gramps.app" file (generally in /Applications). Right click (CTRL-click) on the file and select ""Show Package Content" from the menu. Open Contents/MacOS/Gramps with a text editor (e. g. XCode for syntax highlighting). Add the following two lines after the default language selection routines at line 105:
unset LANG export LANG=<locale>= Installing Gramps ==
For example, use "export LANG=fr_FR'''Download:''' Select one of [http://sourceforge.UTF-8" for a French speaking GRAMPS running on an English MacOSnet/projects/gramps/files/Stable/{{version_Mac}}/{{filename_mac_intel}}. Save the file. Check which locales are installed on your Mac and how they are called by typing "locale -a" in the Terminal application.<br>For more information on language choices in GRAMPS see the following wiki page: dmg Intel {{version_Mac}}] or [http://wwwsourceforge.net/projects/gramps-project/files/Stable/4.org0.1/wiki/index{{filename_mac_ppc}}.dmg Power PC 4.0.php?title=Howto:Change_the_language_of_reports#Run_GRAMPS_in_a_different_language Run_GRAMPS_in_a_different_language1]. You'll get a download window. Once it's downloaded, you can open the dmg (just double click on it in Finder if your browser doesn't open it automatically) and drag the Gramps application wherever you like. Once installed on your computer, it opens 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 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.neofficeneooffice.org / NeoOffice], a more mac-friendly version) and [http://www.graphviz.org/ Graphviz] to produce work on your reports, but they are both straightforwardafter 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 find them to [http://wiki.services.openoffice.org/wiki/Dictionaries download 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>You* The GRAMPS database with the user'll find error messages in 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 console log, which you environment variable LANG) can view with 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/UtilitiesMacOS/ConsoleGramps.app == Advanced setup ==
==Bugs==All of Usually, the known bugs in 3.1.2 have been corrected in 3.2.4. There default settings will no doubt be new ones; report them in the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis].The 3.1.2 bugs are described at [[Mac gtk-osx port bugs]]correct, but occasionally you may need to set things up differently.
==Updates=='''Language:''' Normally, GRAMPS sets up languages and formats from system preferences (Language and Text on Snow Leopard and Lion; International on Leopard). There are three main settings:* On the first pane (Language(s)) 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 (second pane in Leopard) (Formats) one can select a country/Region 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'''.
If you want to run GRAMPS stores all its internal data in ~/Library/Application Supportwith different language or locale settings than you use for your system settings, you can use the "defaults" program from Terminal.app (Applications:Utilities:Terminal. Soapp): defaults write -app Gramps AppleLanguages "(de, to upgrade a en)" defaults write -app Gramps AppleLocale "de_DE" defaults write -app Gramps application bundle AppleCollationOrder "de"AppleLanguages corresponds to a newer version, just throw the old application in the Trash. Make a backup copy of your datalanguage list, just in case, then download AppleLocale to the new version of the application and just use it. If you don't like the new version and want the old one backFormat country/Region, throw the new version in the Trash and fetch AppleCollationOrder selects the old one back from the Trashway that lists are sorted. The Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get InfoYou need not set them all.
==Building GRAMPS from Scratch==To read the setting use: defaults read -app Grampsthis gave "Can't determine domain name for application Gramps; defaults unchanged" for me; if you have problems you can use defaults read org.gramps-project.gramps
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 the C libraries Gramps uses, like gtkThe settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist
This is a commandTo remove the special settings 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://developerChange the language of reports]] has more information on language features in Gramps.apple.com/technologies/xcode.html Apple]When reading it, though you must register as a Mac developerremember 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 LANG variable.
Next=== 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, read so you can download them [httpshttp://sourceforgearchive.netservices.openoffice.org/appspub/tracmirror/gtk-osxOpenOffice.org/contrib/wikidictionaries/Build the build instructions for Gtk-OSXhere]. You need to install them in /Library/Dictionaries, and you'''''especially the Prerequisites'''''ll need to authenticate as an administrator to do so. Download If you have one of them installed and run know how to make symbolic links from the [http:command line, you'll find them in Contents/share/downloads.sourceforge.netuno_packages/sourceforgecache/gtkuno_packages, scattered about in the hash-osx/gtk-osx-build-setupnamed directories. You'll need to link both the aff and dic files (e.sh gtk-osx-build-installg.sh] script, which will set up jhbuild for youen_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 something seems to <tt>sdk_setup</tt> looks like setup_sdk(targetgo wrong ="10.5", sdk_version="10.5", architectures=[i386])(If you're building on a PPC, you don't need to worry about this.)
If youYou're not familiar with using ll find error messages in the unix command lineconsole log, which you might find the frequent use of "~" below puzzling. It refers to the user's home directory (mine is can view with /Applications/UsersUtilities/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 elseConsole.app
jhbuild is installed All of the known bugs in 3.1.2 have been corrected in ~/3.2.local/Source, 4 and produces a binary which appears later. There will no doubt be new ones; report them in ~the usual way on [http://www.localgramps-project.org/binbugs/my_view_page.php Mantis] ([[Using the bug tracker]] instructions). YouWhen reporting what you'll want re sure is an OSX specific bug, please set the Platform field to add ~/"mac" (no quotes, caps, or spaces!) so that I can find it easily.local/bin to your path: export PATH=~/The 3.1.local/bin2 bugs are described at [[Mac OS X:Build from source:gtk-osx:$PATHbugs]].
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 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 ~.== Updates ==
The Gtk-OSX build instructions are very straightforwardGRAMPS stores all its internal data in ~/Library/Application Support. So, but we need to deviate from them upgrade a bit Gramps application bundle to keep from doing things more than oncea 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 the application and just use it. Run If you don't like the new version and want the following commands old one back, throw the new version in the Trash and fetch the old one back from the terminal:Trash. The Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get Info.
jhbuild bootstrap jhbuild build gettext-fw jhbuild --moduleset=~/gramps-mac/gramps.modules build berkeleydb jhbuild build python 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 in .jhbuildrc-custom; gramps doesn't version its installations, so the most recent will overwrite the previous build. == Bundling ==The next step is to create an application bundle. You'll need ige-mac-bundler, so follow the instructions in the [https[Category:Developers//sourceforge.net/apps/trac/gtk-osx/wiki/Bundle Gtk-OSX WikiPackaging]] 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[[Category: jhbuild shell ige-mac-bundler ~/gramps-mac/gramps.bundle You'll have an application bundle named Gramps.app on your desktop. == Packaging ==To make an uploadable disk image, create a folder named "Gramps-arch-version", replacing "arch" with either Intel or PPC and "version" with the current version number. Drag your app bundle to this directory. Open your build directory and copy (option-drag) the files "FAQ", "COPYING", "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 so that it's meaning is more clear to users who aren't familiar with the GPL. Now open Applications>Utilities>Disk Utility and select File>New Image From Folder and select your folder, then approve the name and location. You'll have a dmg ready for distribution. Good Luck!Documentation]]
