Gramps - User contributions [en]

Mac OS X:Build from source:Application package

2024-06-25T18:37:25Z

Jralls: /* Step 3: Install Gramps dependencies and Gramps */ Override the branch for a master build, otherwise it will checkout maintenance/gramps52

==Building Gramps from Scratch==

Being able to building Gramps from scratch (from the fundamental Python scripts) is useful to produce a version not currently available as a binary for your particular OS platform or version. Or, to produce a complete environment for debugging and further development, including debugging of all the C libraries Gramps uses... like [https://www.gtk.org/ GTK].

This is a "[https://www.cybrary.it/blog/0p3n/command-line-interface-cli-vs-graphical-user-interface-gui/ command line interface]" process. It's not too difficult, but you'll be using [https://wikipedia.org/wiki/Terminal_(macOS) Terminal.app] rather than the [https://wikipedia.org/wiki/Xcode XCode] integrated development environment.

If you're not familiar with using the unix command line, you might find the frequent use of "~" ([https://www.dictionary.com/browse/tilde?s=t tilde]) 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.

=== Step 1: Install Xcode ===

You'll need a compiler. Apple provides two ways to install one: "Command Line Tools" installs just the command-line build environment and puts most of the header files in <tt>/usr/include</tt>. Simply trying to run a program that requires it like <tt>gcc</tt> or <tt>git</tt> should produce a dialog box offering to install them, but if that doesn't work you can run <tt>sudo xcode-select --install</tt>. Apple also has a full-featured integrated development environment called Xcode. It's available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). That probably doesn't matter, since we don't need to run the app, we just need the compilers and software development kit.

=== Step 2: Install jhbuild ===

Next, read [https://wiki.gnome.org/Projects/GTK/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing [https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew], [https://wikipedia.org/wiki/MacPorts MacPorts], or [https://wikipedia.org/wiki/Fink_(software) Fink] installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have any of those installed.

Then follow the steps under [https://wiki.gnome.org/Projects/GTK/OSX/Building#Procedure Procedure]

=== Step 3: Install Gramps dependencies and Gramps ===

gtk-osx-setup.sh installed a template customization file for you <tt>$HOME/.config/jhbuildrc-custom</tt>. Open it in a text editor. <tt>TextEdit.app</tt> will do if you don't have a programming editor installed. Apple also provides <tt>nano</tt> and <tt>vi</tt> that you can run in <tt>Terminal</tt>. Add the following lines:
moduleset = "https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps52/mac/gramps.modules"
modules = ["meta-gtk-osx-bootstrap", "gramps"]
Change <code>gramps52</code> in the first line to whatever release version you want. <code>gramps</code> in the second line will build the latest release tarball in that release series. If you want to build the latest commit use <code>gramps-git</code> instead. If you want to build the master branch (and see below why you might) use
moduleset = "https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules"
modules = ["meta-gtk-osx-bootstrap", "gramps-git"]
branches["gramps"] = master
instead.

Save the changes, start <code>Applications:Utilities:Terminal.app</code> and run
jhbuild build

You may get some build failures for <code>gtk-doc</code> and <code>gtk+-3.0</code> complaining that the <code>pygments</code> and <code>packaging</code> modules can't be found. If that happens select option 4 <tt>Start Shell</tt> and at the prompt run
python3 -mpip install pygments
python3 -mpip install packaging
Doing both at the <code>gtk-doc</code> error will avoid the <code>gtk+-3.0</code> error. Use <kbd>Ctrl D</kbd> to exit the shell and select option 1 to resume the build.
If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps51
To build and install it, you must be in a jhbuild shell to create the correct environment, so first run
jhbuild shell
Then
python3 setup.py install
That last line is a bit obsolete, as is [https://gitlab.gnome.org/GNOME/jhbuild/-/issues/291 <tt>jhbuild</tt>]. At the time of writing <code>python3 setup.py build</code> works and puts gramps where the bundler (see below) expects. It does not create a python wheel. To do that you need Python's <tt>build</tt> package:
python3 -mpip install build
Then you can run
build
install
to create the wheel and install the PyPi way.

Use <kbd>Control D</kbd> to leave the jhbuild shell when you're finished with it.

==== More customizations ====
<tt>jhbuild-custom</tt> is Python and is loaded into <tt>jhbuild</tt> during startup. There are lots of ways to customize it, see the [https://gnome.pages.gitlab.gnome.org/jhbuild/config-reference.html JHBuild Manual] for comprehensive information.

Do be aware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be careful to prefix any top-level variables with '_' ([https://www.dictionary.com/browse/underscore?s=t underscore]).

=== Webkit ===
Gramps has an optional dependency on [https://webkit.org/ WebKit], which is used for the <tt>HtmlView</tt> addon. If for some reason you want to use this addon, add <tt>WebKit2Gtk3</tt> to your list of dependencies but be aware that it may take a long time to build.

== Running Gramps ==
To run your just-built Gramps you need to be in a jhbuild shell, so do
jhbuild shell
We need to tell dlopen how to find the libraries that GObject-Introspection depends on by setting <code>DYLD_LIBRARY_PATH</code>. That environment variable is protected by [https://support.apple.com/en-us/102149 Apple's System Integrity Protection] so we have to include it on the command line that launches Gramps:
DYLD_LIBRARY_PATH=$PREFIX/lib gramps

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/gramps/mac/Info.plist</tt> to update the version number and copyright information.

Now open a jhbuild shell and run the bundler:
jhbuild shell
gtk-mac-bundler ~/gtk/src/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-version", replacing "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 its 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!

[[Category:Developers/General]]

Mac OS X:Build from source:Application package

2024-06-25T17:36:48Z

Jralls: Bring build instructions up to date, add run instructions.

==Building Gramps from Scratch==

Being able to building Gramps from scratch (from the fundamental Python scripts) is useful to produce a version not currently available as a binary for your particular OS platform or version. Or, to produce a complete environment for debugging and further development, including debugging of all the C libraries Gramps uses... like [https://www.gtk.org/ GTK].

This is a "[https://www.cybrary.it/blog/0p3n/command-line-interface-cli-vs-graphical-user-interface-gui/ command line interface]" process. It's not too difficult, but you'll be using [https://wikipedia.org/wiki/Terminal_(macOS) Terminal.app] rather than the [https://wikipedia.org/wiki/Xcode XCode] integrated development environment.

If you're not familiar with using the unix command line, you might find the frequent use of "~" ([https://www.dictionary.com/browse/tilde?s=t tilde]) 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.

=== Step 1: Install Xcode ===

You'll need a compiler. Apple provides two ways to install one: "Command Line Tools" installs just the command-line build environment and puts most of the header files in <tt>/usr/include</tt>. Simply trying to run a program that requires it like <tt>gcc</tt> or <tt>git</tt> should produce a dialog box offering to install them, but if that doesn't work you can run <tt>sudo xcode-select --install</tt>. Apple also has a full-featured integrated development environment called Xcode. It's available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). That probably doesn't matter, since we don't need to run the app, we just need the compilers and software development kit.

=== Step 2: Install jhbuild ===

Next, read [https://wiki.gnome.org/Projects/GTK/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing [https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew], [https://wikipedia.org/wiki/MacPorts MacPorts], or [https://wikipedia.org/wiki/Fink_(software) Fink] installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have any of those installed.

Then follow the steps under [https://wiki.gnome.org/Projects/GTK/OSX/Building#Procedure Procedure]

=== Step 3: Install Gramps dependencies and Gramps ===

gtk-osx-setup.sh installed a template customization file for you <tt>$HOME/.config/jhbuildrc-custom</tt>. Open it in a text editor. <tt>TextEdit.app</tt> will do if you don't have a programming editor installed. Apple also provides <tt>nano</tt> and <tt>vi</tt> that you can run in <tt>Terminal</tt>. Add the following lines:
moduleset = "https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps52/mac/gramps.modules"
modules = ["meta-gtk-osx-bootstrap", "gramps"]
Change <code>gramps52</code> in the first line to whatever release version you want. <code>gramps</code> in the second line will build the latest release tarball in that release series. If you want to build the latest commit use <code>gramps-git</code> instead. If you want to build the master branch (and see below why you might) use
moduleset = "https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules"
modules = ["meta-gtk-osx-bootstrap", "gramps-git"]
instead.

Save the changes, start <code>Applications:Utilities:Terminal.app</code> and run
jhbuild build

You may get some build failures for <code>gtk-doc</code> and <code>gtk+-3.0</code> complaining that the <code>pygments</code> and <code>packaging</code> modules can't be found. If that happens select option 4 <tt>Start Shell</tt> and at the prompt run
python3 -mpip install pygments
python3 -mpip install packaging
Doing both at the <code>gtk-doc</code> error will avoid the <code>gtk+-3.0</code> error. Use <kbd>Ctrl D</kbd> to exit the shell and select option 1 to resume the build.
If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps51
To build and install it, you must be in a jhbuild shell to create the correct environment, so first run
jhbuild shell
Then
python3 setup.py install
That last line is a bit obsolete, as is [https://gitlab.gnome.org/GNOME/jhbuild/-/issues/291 <tt>jhbuild</tt>]. At the time of writing <code>python3 setup.py build</code> works and puts gramps where the bundler (see below) expects. It does not create a python wheel. To do that you need Python's <tt>build</tt> package:
python3 -mpip install build
Then you can run
build
install
to create the wheel and install the PyPi way.

Use <kbd>Control D</kbd> to leave the jhbuild shell when you're finished with it.

==== More customizations ====
<tt>jhbuild-custom</tt> is Python and is loaded into <tt>jhbuild</tt> during startup. There are lots of ways to customize it, see the [https://gnome.pages.gitlab.gnome.org/jhbuild/config-reference.html JHBuild Manual] for comprehensive information.

Do be aware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be careful to prefix any top-level variables with '_' ([https://www.dictionary.com/browse/underscore?s=t underscore]).

=== Webkit ===
Gramps has an optional dependency on [https://webkit.org/ WebKit], which is used for the <tt>HtmlView</tt> addon. If for some reason you want to use this addon, add <tt>WebKit2Gtk3</tt> to your list of dependencies but be aware that it may take a long time to build.

== Running Gramps ==
To run your just-built Gramps you need to be in a jhbuild shell, so do
jhbuild shell
We need to tell dlopen how to find the libraries that GObject-Introspection depends on by setting <code>DYLD_LIBRARY_PATH</code>. That environment variable is protected by [https://support.apple.com/en-us/102149 Apple's System Integrity Protection] so we have to include it on the command line that launches Gramps:
DYLD_LIBRARY_PATH=$PREFIX/lib gramps

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/gramps/mac/Info.plist</tt> to update the version number and copyright information.

Now open a jhbuild shell and run the bundler:
jhbuild shell
gtk-mac-bundler ~/gtk/src/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-version", replacing "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 its 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!

[[Category:Developers/General]]

Download

2022-12-28T00:35:50Z

Jralls: /* macOS */ Add download link for macOS Apple Silicon build.

{{languages|Download}}
[[File:Gramp-Small-background-wiki-2020.jpg|120px|left]]
'''Research, organize and share your family tree with Gramps.'''

Gramps is a free software project and community. We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists. It is a community project, created, developed and governed by genealogists.

{{man note|{{Man menu|Gramps '''Current version: '''{{version}}''' Released: '''2022-02-05'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as [https://www.python.org/doc/sunset-python-2/ Python 2 support dropped]. Uses GTK+ 3 GUI. Default database is now SQLite. Lot of updates see: ''[[Gramps 5.1 Wiki Manual - What's new?|What's new?]]{{-}}
[[File:Linux_220x261.png|128px|link=Download#Linux]] [[File:windows_180x160.png|128px|link=Download#MS_Windows]] [[File:macos_200x200.png|128px|link=Download#macOS]] [[File:Bsd daemon.png|128px|link=Download#BSD]]}}

== Linux ==

[[File:Linux_220x261.png|128px|left|link=Download#Linux]]

Before upgrading your distribution: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Flathub|via Flathub]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==
[[File:windows_180x160.png|128px|left|link=Download#MS_Windows]]

Before downloading the All-In-One software installer bundle for Windows: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

This installer supports Microsoft Windows in all versions [http://windows.microsoft.com/en-au/windows/lifecycle Vista/7] and later. The 64-bit versions of Windows allow more efficient access to more resources.

(''Please note: Gramps prefers the Python-3.5 and Gtk-3.18 libraries and newer. Those libraries have dropped support for Windows XP. But Gramps can still be run on Windows XP with earlier library versions, i.e., Python3.4.4 and Gtk-3.16'')

<big>
*[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]
*[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]</big>


After download: '''double-click to install Gramps'''. By default: new releases will be added in a new directory and earlier installations of Gramps will ''not'' be overwritten; the language will be a [[#Missing_other_languages|mix of British and US English]].

{{man tip|Shortcuts|During installation, one shortcut is placed on the desktop and two shortcuts are added the Start menu. ''Please only use the 'console' secondary shortcut when performing diagnostics requested by a developer.'' 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu| ← for normal use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

Use the Windows AIO (All-In-One) version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO cx freeze-based|this page]] (English only). Or, you might want to look at the description of what is meant by an [[All_In_One_Gramps_Software_Bundle_for_Windows|All In One Bundle.]]

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
If needed, there are alternatives to the All-In-One installer.

==== PortableApps.com ====
[[File:PortableApps_Gramps_Splash.png|right|thumb|450px|When launching the PortableApps fork of Gramps, this splash screen appears.]]
A [https://portableapps.com/apps/education/gramps_portable '''PortableApps''' version] will run from an external device without the requirement of installing on the OS drive. PortableApps installations are not for touchscreen-based mobile devices. They just allow the application to run from external storage, USB thumbdrives.

You can download the '''{{Version_windows_portable}} Gramps Portable version''' from:
* the [https://portableapps.com/apps/education/gramps_portable Gramps Portable project] page in their [https://portableapps.com/apps/education/ Education] category.

Note that '''PortableApps.com''' also has a Legacy 3.4.9 version of Gramps available -- although it is not recommended for general use; just for recovering older format databases.
* [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_3.4.9.paf.exe] (29.0 MB)

[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' '''[https://portableapps.com/forums/support/education Please report packaging issues here]'''

==== Chocolatey NuGet Package ====
You may also install using the alternative independent Gramps Chocolatey NuGet Package

Chocolatey NuGet is a Machine Package Manager, somewhat like apt-get, but built with Windows in mind.

* [https://chocolatey.org/packages/gramps/ Gramps Chocolatey Package]

==== Gramps for Windows with MSYS2 ====

How to use [https://www.msys2.org/ MSYS2] to run latest Gramps development version from source in 64bit Windows.

* [[Gramps for Windows with MSYS2]]

{{-}}

=== Missing other languages ===
[[File:Microsoft Window Gramps AIO Installer Choose Components-Selection-51.png|right|thumb|450px|Microsoft Window Gramps AIO Installer Choose Components-Selection window.]]
The default Gramps AIO installer will embed the US dialect of English for the interface with the British spellcheck dictionary.

If you prefer a different language (or spell with the US or Australian dialects of English), please ensure that you pay special attention to the Choose Components phase of the installation.

To install a language other than English, select from both the '''Translations''' ''and'' '''Dictionaries''' during the Choose Components phase of the installation.

Even your primary language is installed by default, you might anticipate the need to spellcheck Notes in other than the British dialect of English. Be certain to select the appropriate languages from '''Dictionaries'''. Gramps will not access your Operating System's native dictionary.

There is no simple facility for adding interface or dictionary languages after installation.
{{-}}



== macOS ==

[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]

Before downloading the ready-to-run stand-alone bundle: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Tested for compatibility with Apple macOS/Mac OS X versions 10.13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_10.13:_%22High_Sierra%22 High Sierra]) through 13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_13:_%Ventura%22 Ventura]). ''Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.]''

<big>
* [{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]
* [{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_arm}}.dmg Apple Silicon {{version_Mac}}]
</big>

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
Alternatively, Gramps can also be built and installed on macOS using MacPorts.

{{-}}
==== MacPorts ====

MacPorts is a package manager for Apple Mac.

* [[Mac_OS_X:Build_from_source:MacPorts|MacPorts]]

Why use the version from MacPorts? Certain plugins or add-ons require additional supporting software in order to operate. With MacPorts, you can install such software easily (most of the time; there could be exceptions). With the official .dmg installer, installing such additional software is more difficult or impossible.

The [[Addon:Prerequisites_Checker_Gramplet|Prequisites Checker]] can identify if any add-ons have been installed that require such additional software.

{{-}}

==== Homebrew ====

The macOS application bundle can also be installed via the Homebrew package manager as a cask. Note that this is *not* a Homebrew build, it is a repackaging of the same Gramps.app provided in the above dmg. It does not depend on or use any of the Homebrew-built libraries.

[https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew] is an open-source package manager for macOS (and Linux).

See https://github.com/homebrew/

{{-}}

=== Adding additional Spell Checking languages on macOS ===
{{man tip|[[Mac_OS_X:Application_package#Dictionaries|Spell Checking:]]|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== Linux and BSD distributions ==
{{man note|These packages are built and supported by the [https://en.wikipedia.org/wiki/Linux_distribution distros].|If your distribution is not listed you may possibly find it listed on [https://repology.org/metapackage/gramps/versions ''Repology''] Please report any problems with them to the package maintainer.}}
Most Linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

{| {{prettytable}}
!style="width: 85pt;" | Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[File:Debianopenlogo-32.png|link=https://packages.debian.org/search?keywords=gramps]]''' [[Debian]] '''
|Add/Remove Software
|
* Debian 10 ("buster") (old stable): Gramps 5.0.1 
* Debian 10 ("buster")([https://packages.debian.org/buster-backports/gramps backports]) (stable): Gramps 5.1.2
* Debian 11 ("bullseye")(stable): Gramps 5.1.3
* Debian 11 ("bullseye")([https://packages.debian.org/bullseye-backports/gramps backports]): Gramps 5.1.5
* bookworm (testing): Gramps 5.1.5
* [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 5.1.5
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[File:Ubuntu_32x32.png]] '''[https://ubuntu.com/ Ubuntu]'''
|Software Centre
|
* Bionic Beaver (18.04 LTS): Gramps: 5.1.2
* Focal (20.04 LTS): Gramps: 5.1.3
* Hirsute (21.04): Gramps: 5.1.3
* Impish (21.10): Gramps: 5.1.4
* Jammy (Development: 22.04): Gramps: 5.1.5
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]/ (Also see: [https://launchpad.net/~rosco2/+archive/ubuntu/backports Backports])
|-
|[[File:Farm-Fresh linux mint.png]]''' [https://www.linuxmint.com/ Linux Mint]'''
|Software Manager
|
* 19.x(Gramps 4.2.8) 
* 20.x(Gramps 5.1.2) 
|
* Use the "Software Manager" to install a recent version.
* Manually install the most current version of Gramps using the following [https://forums.linuxmint.com/viewtopic.php?t=220159 instructions] from the ''Linux Mint Forums''
* [http://community.linuxmint.com/software/view/gramps Old versions available from Linuxmint]
|-
|[[File:Fedora_32x32.png]] '''[https://getfedora.org/ Fedora]'''
|Add/Remove Software (Gnome) or Software Management (KDE)
|
* Rawhide (Gramps 5.1.5)
* Fedora 34 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
* Fedora 36 (Gramps 5.1.5)
* Fedora 37 (Gramps 5.1.5)
|[https://koji.fedoraproject.org/koji/packageinfo?packageID=1969 available versions]
|-
|'''[https://www.mageia.org/en/ Mageia]'''
||[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|
* Mageia [https://madb.mageia.org/package/show/name/gramps/release/cauldron/ Caulron]: Gramps 5.1.5
* Mageia 8.0: Gramps 5.1.3
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|[[File:OpenSUSE-distribution-icon.png|32px]] '''[https://www.opensuse.org/ openSUSE]'''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|
* openSUSE Tumbleweed: Gramps 5.1.5
* openSUSE Leap 15.3: Gramps 4.2.8 
|[https://software.opensuse.org/package/gramps available versions] The most recent version can usually be installed from the 'openSUSE BuildService - GNOME:Apps' repository
|-
|[[File:Slackware-distribution-icon.jpg|32px]] '''[http://www.slackware.com/ Slackware]'''
|
|
* 15.0: Gramps 5.1.2 - [https://slackbuilds.org/repository/15.0/misc/gramps/?search=gramps slackbuilds.org]
* 14.2: Gramps 5.1.2 - [https://slackbuilds.org/repository/14.2/misc/gramps/?search=gramps slackbuilds.org]
* 14.2: Gramps 4.2.6
* 14.1: Gramps 4.0.3
|[https://pkgs.org/search/?q=gramps available versions]
|-
|[[File:archlinux-icon-crystal-32.svg]] '''[https://www.archlinux.org/ Arch Linux]'''
| [https://wiki.archlinux.org/index.php/pacman pacman]
|
* Gramps 5.1.5
|[https://www.archlinux.org/packages/community/any/gramps/ available versions]
|-
|[[File:Gentoo-distribution-icon.png|32px]]'''[https://gentoo.org Gentoo Linux]'''
|
|
* Gramps 5.1.4
* Gramps 5.1.5 (testing)
|[https://packages.gentoo.org/packages/app-misc/gramps available versions]
|-
|'''[https://www.netbsd.org/ NetBSD]'''
|
|
* NetBSD: [http://pkgsrc.se/databases/gramps5 Gramps 5.1.5]
|
|-
|'''[https://www.freebsd.org/ FreeBSD]'''
|
|
* FreeBSD: Gramps 4.2.8
* [https://www.freshports.org/science/gramps/ FreshPorts: Gramps 5.1.5]
|
|-
|'''[https://www.openbsd.org/ OpenBSD]'''
|
|
* OpenBSD: Gramps 5.1.5
|[http://openports.se/misc/gramps available versions]
|-
|
|
|
|
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually.

{{man warn|1=Warning before attempting this use your existing installation to [[How to make a backup|make a Gramps XML backup]]|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 5.1.3 to 5.1.5), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 4.y.z to 5.y.z), then the danger that it does not work properly is much greater.}}

=== Debian-based ===
For [[File:Debianopenlogo-32.png|link=Download#Debian-based]]'''[[Debian|Debian-based linux distributions]]''' (Which includes [[File:Ubuntu_32x32.png|link=Download#Debian-based]]''' Ubuntu ''') [{{github_url}}/releases/download/v{{Version Linux Debian}}/gramps_{{Version Linux Debian}}-1_all.deb Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved ({{man menu|change the filename to match the one you downloaded}}).

sudo dpkg -i gramps_{{version}}-1_all.deb

If you have an error about having unmet dependencies run:

sudo apt-get -f install

to install the dependencies.

If you see an error about an incomplete GTK installation and missing language translations when starting Gramps, run

sudo apt install language-pack-gnome-en

to install the proper language pack. You may need to replace 'en' with your own language code, like 'nl' for Dutch.

==== Useful command lines ====
Before upgrading you can[https://sourceforge.net/p/gramps/mailman/message/35460486/]:

* Find out what version you are running, by using this:

dpkg-query -s gramps

that queries the package and gives you info about it.

* If you are committed to an upgrade then make sure you have backed up you Family Trees to Gramps XML then run :

sudo dpkg -r gramps

this will remove the current gramps package (assuming its a python3 version older versions could be python-gramps )

* To stop Ubuntu updating gramps (to possibly an older version from Ubuntu!) you may need to run:

sudo apt-mark hold gramps

'''Upgrade is then complete.'''

=== Flathub ===

Gramps {{Version Linux Flatpak}} is available as a Flatpak at Flathub.

{{man note|Please use your existing installation to backup your database before proceeding.|Also, it is a good idea to [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Converting_a_BSDDB_Family_Tree_to_SQLite|convert your database to SQLite]] even though there is currently BSDDB3 support in the {{Version Linux Flatpak}} Flatpak.}}

First set up Flatpak and the Flathub repository on your system, there are instructions for various distributions at https://flatpak.org/setup/

Second, you can use the blue install button at https://flathub.org/apps/details/org.gramps_project.Gramps if you set your software manager up to work with Flathub, or use the command below in a terminal for a system wide installation if you have sudo privileges:

flatpak install flathub org.gramps_project.Gramps

{{-}}

=== For other distributions ===
For other distributions, [[File:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== BSD ==

[[File:Bsd daemon.png|128px|left|link=Download#BSD]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>

See also:
* [[BSD platforms]]
{{-}}

== Linux Live CD ==

{{man warn|Note this '''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} an old version released 2010-11-17 and it is not recommended for general use}}

[[File:Download_link.png|150px|left|link=https://sourceforge.net/projects/gramps/files/gramps-cdrom/lgenealogy-6.1-desktop-i386.iso/download]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn, [https://rufus.ie/en/ Rufus]..). [[Linux_Genealogy_CD#Download_the_CD|Download the CD]] (727 MB). The [[Linux Genealogy CD|Linux Genealogy CD is based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu] and Gramps from the CD anytime you like.
{{-}}

== Online Demonstration ==
{{man warn|Buyer Beware|This is a limited trial of a commercial cloud VM service that operates by subscription. This is '''''not''''' an endorsement by the Gramps-project. Beware of giving third parties access to your genealogical data.}}

You can also try an online demonstration of version 5.1.4 of Gramps on rollApp (''"Cloud platform for native applications"'') categorized under '''[https://www.rollapp.com/apps/utilities Utilities]''' - ''[https://www.rollapp.com/apps/diagrams #diagrams]'':

* https://www.rollapp.com/app/gramps

Select '''Launch Online''' then '''Test Drive(Opening/saving files will not be available)'''

{{-}}

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data. See : [[How to make a backup]]

== See also ==
* [https://github.com/gramps-project/gramps/releases GitHub folder of Gramps releases]
* [[Previous releases of Gramps]]
* [[:Category:Versions|Versions on various platforms]]

[[Category:Documentation]]

Template:Filename mac arm

2022-12-28T00:34:23Z

Jralls: Create template for Apple Silicon (Arm, aarch64) build of Gramps for macOS.

Gramps-Arm-{{Version_Mac}}-2<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2022-12-27T18:17:04Z

Jralls: New macOS Gramps.app with new Gtk3 to support macOS 13 Ventura.

Gramps-Intel-{{Version_Mac}}-2<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Download

2022-12-27T18:13:41Z

Jralls: /* macOS */ Update macOS version max to 13 (Ventura)

{{languages|Download}}
[[File:Gramp-Small-background-wiki-2020.jpg|120px|left]]
'''Research, organize and share your family tree with Gramps.'''

Gramps is a free software project and community. We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists. It is a community project, created, developed and governed by genealogists.

{{man note|{{Man menu|Gramps '''Current version: '''{{version}}''' Released: '''2022-02-05'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as [https://www.python.org/doc/sunset-python-2/ Python 2 support dropped]. Uses GTK+ 3 GUI. Default database is now SQLite. Lot of updates see: ''[[Gramps 5.1 Wiki Manual - What's new?|What's new?]]{{-}}
[[File:Linux_220x261.png|128px|link=Download#Linux]] [[File:windows_180x160.png|128px|link=Download#MS_Windows]] [[File:macos_200x200.png|128px|link=Download#macOS]] [[File:Bsd daemon.png|128px|link=Download#BSD]]}}

== Linux ==

[[File:Linux_220x261.png|128px|left|link=Download#Linux]]

Before upgrading your distribution: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Flathub|via Flathub]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==
[[File:windows_180x160.png|128px|left|link=Download#MS_Windows]]

Before downloading the All-In-One software installer bundle for Windows: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

This installer supports Microsoft Windows in all versions [http://windows.microsoft.com/en-au/windows/lifecycle Vista/7] and later. The 64-bit versions of Windows allow more efficient access to more resources.

(''Please note: Gramps prefers the Python-3.5 and Gtk-3.18 libraries and newer. Those libraries have dropped support for Windows XP. But Gramps can still be run on Windows XP with earlier library versions, i.e., Python3.4.4 and Gtk-3.16'')

<big>
*[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]
*[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]</big>


After download: '''double-click to install Gramps'''. By default: new releases will be added in a new directory and earlier installations of Gramps will ''not'' be overwritten; the language will be a [[#Missing_other_languages|mix of British and US English]].

{{man tip|Shortcuts|During installation, one shortcut is placed on the desktop and two shortcuts are added the Start menu. ''Please only use the 'console' secondary shortcut when performing diagnostics requested by a developer.'' 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu| ← for normal use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

Use the Windows AIO (All-In-One) version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO cx freeze-based|this page]] (English only). Or, you might want to look at the description of what is meant by an [[All_In_One_Gramps_Software_Bundle_for_Windows|All In One Bundle.]]

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
If needed, there are alternatives to the All-In-One installer.

==== PortableApps.com ====
[[File:PortableApps_Gramps_Splash.png|right|thumb|450px|When launching the PortableApps fork of Gramps, this splash screen appears.]]
A [https://portableapps.com/apps/education/gramps_portable '''PortableApps''' version] will run from an external device without the requirement of installing on the OS drive. PortableApps installations are not for touchscreen-based mobile devices. They just allow the application to run from external storage, USB thumbdrives.

You can download the '''{{Version_windows_portable}} Gramps Portable version''' from:
* the [https://portableapps.com/apps/education/gramps_portable Gramps Portable project] page in their [https://portableapps.com/apps/education/ Education] category.

Note that '''PortableApps.com''' also has a Legacy 3.4.9 version of Gramps available -- although it is not recommended for general use; just for recovering older format databases.
* [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_3.4.9.paf.exe] (29.0 MB)

[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' '''[https://portableapps.com/forums/support/education Please report packaging issues here]'''

==== Chocolatey NuGet Package ====
You may also install using the alternative independent Gramps Chocolatey NuGet Package

Chocolatey NuGet is a Machine Package Manager, somewhat like apt-get, but built with Windows in mind.

* [https://chocolatey.org/packages/gramps/ Gramps Chocolatey Package]

==== Gramps for Windows with MSYS2 ====

How to use [https://www.msys2.org/ MSYS2] to run latest Gramps development version from source in 64bit Windows.

* [[Gramps for Windows with MSYS2]]

{{-}}

=== Missing other languages ===
[[File:Microsoft Window Gramps AIO Installer Choose Components-Selection-51.png|right|thumb|450px|Microsoft Window Gramps AIO Installer Choose Components-Selection window.]]
The default Gramps AIO installer will embed the US dialect of English for the interface with the British spellcheck dictionary.

If you prefer a different language (or spell with the US or Australian dialects of English), please ensure that you pay special attention to the Choose Components phase of the installation.

To install a language other than English, select from both the '''Translations''' ''and'' '''Dictionaries''' during the Choose Components phase of the installation.

Even your primary language is installed by default, you might anticipate the need to spellcheck Notes in other than the British dialect of English. Be certain to select the appropriate languages from '''Dictionaries'''. Gramps will not access your Operating System's native dictionary.

There is no simple facility for adding interface or dictionary languages after installation.
{{-}}



== macOS ==

[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]

Before downloading the ready-to-run stand-alone bundle: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Tested for compatibility with Apple macOS/Mac OS X versions 10.13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_10.13:_%22High_Sierra%22 High Sierra]) through 13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_12:_%22Monterey%22 Monterey]). ''Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.]''

<big>
* [{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]
</big>

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
Alternatively, Gramps can also be built and installed on macOS using MacPorts.

{{-}}
==== MacPorts ====

MacPorts is a package manager for Apple Mac.

* [[Mac_OS_X:Build_from_source:MacPorts|MacPorts]]

Why use the version from MacPorts? Certain plugins or add-ons require additional supporting software in order to operate. With MacPorts, you can install such software easily (most of the time; there could be exceptions). With the official .dmg installer, installing such additional software is more difficult or impossible.

The [[Addon:Prerequisites_Checker_Gramplet|Prequisites Checker]] can identify if any add-ons have been installed that require such additional software.

{{-}}

==== Homebrew ====

The macOS application bundle can also be installed via the Homebrew package manager as a cask. Note that this is *not* a Homebrew build, it is a repackaging of the same Gramps.app provided in the above dmg. It does not depend on or use any of the Homebrew-built libraries.

[https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew] is an open-source package manager for macOS (and Linux).

See https://github.com/homebrew/

{{-}}

=== Adding additional Spell Checking languages on macOS ===
{{man tip|[[Mac_OS_X:Application_package#Dictionaries|Spell Checking:]]|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== Linux and BSD distributions ==
{{man note|These packages are built and supported by the [https://en.wikipedia.org/wiki/Linux_distribution distros].|If your distribution is not listed you may possibly find it listed on [https://repology.org/metapackage/gramps/versions ''Repology''] Please report any problems with them to the package maintainer.}}
Most Linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

{| {{prettytable}}
!style="width: 85pt;" | Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[File:Debianopenlogo-32.png|link=https://packages.debian.org/search?keywords=gramps]]''' [[Debian]] '''
|Add/Remove Software
|
* Debian 10 ("buster") (old stable): Gramps 5.0.1 
* Debian 10 ("buster")([https://packages.debian.org/buster-backports/gramps backports]) (stable): Gramps 5.1.2
* Debian 11 ("bullseye")(stable): Gramps 5.1.3
* Debian 11 ("bullseye")([https://packages.debian.org/bullseye-backports/gramps backports]): Gramps 5.1.5
* bookworm (testing): Gramps 5.1.5
* [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 5.1.5
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[File:Ubuntu_32x32.png]] '''[https://ubuntu.com/ Ubuntu]'''
|Software Centre
|
* Bionic Beaver (18.04 LTS): Gramps: 5.1.2
* Focal (20.04 LTS): Gramps: 5.1.3
* Hirsute (21.04): Gramps: 5.1.3
* Impish (21.10): Gramps: 5.1.4
* Jammy (Development: 22.04): Gramps: 5.1.5
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]/ (Also see: [https://launchpad.net/~rosco2/+archive/ubuntu/backports Backports])
|-
|[[File:Farm-Fresh linux mint.png]]''' [https://www.linuxmint.com/ Linux Mint]'''
|Software Manager
|
* 19.x(Gramps 4.2.8) 
* 20.x(Gramps 5.1.2) 
|
* Use the "Software Manager" to install a recent version.
* Manually install the most current version of Gramps using the following [https://forums.linuxmint.com/viewtopic.php?t=220159 instructions] from the ''Linux Mint Forums''
* [http://community.linuxmint.com/software/view/gramps Old versions available from Linuxmint]
|-
|[[File:Fedora_32x32.png]] '''[https://getfedora.org/ Fedora]'''
|Add/Remove Software (Gnome) or Software Management (KDE)
|
* Rawhide (Gramps 5.1.5)
* Fedora 34 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
* Fedora 36 (Gramps 5.1.5)
* Fedora 37 (Gramps 5.1.5)
|[https://koji.fedoraproject.org/koji/packageinfo?packageID=1969 available versions]
|-
|'''[https://www.mageia.org/en/ Mageia]'''
||[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|
* Mageia [https://madb.mageia.org/package/show/name/gramps/release/cauldron/ Caulron]: Gramps 5.1.5
* Mageia 8.0: Gramps 5.1.3
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|[[File:OpenSUSE-distribution-icon.png|32px]] '''[https://www.opensuse.org/ openSUSE]'''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|
* openSUSE Tumbleweed: Gramps 5.1.5
* openSUSE Leap 15.3: Gramps 4.2.8 
|[https://software.opensuse.org/package/gramps available versions] The most recent version can usually be installed from the 'openSUSE BuildService - GNOME:Apps' repository
|-
|[[File:Slackware-distribution-icon.jpg|32px]] '''[http://www.slackware.com/ Slackware]'''
|
|
* 15.0: Gramps 5.1.2 - [https://slackbuilds.org/repository/15.0/misc/gramps/?search=gramps slackbuilds.org]
* 14.2: Gramps 5.1.2 - [https://slackbuilds.org/repository/14.2/misc/gramps/?search=gramps slackbuilds.org]
* 14.2: Gramps 4.2.6
* 14.1: Gramps 4.0.3
|[https://pkgs.org/search/?q=gramps available versions]
|-
|[[File:archlinux-icon-crystal-32.svg]] '''[https://www.archlinux.org/ Arch Linux]'''
| [https://wiki.archlinux.org/index.php/pacman pacman]
|
* Gramps 5.1.5
|[https://www.archlinux.org/packages/community/any/gramps/ available versions]
|-
|[[File:Gentoo-distribution-icon.png|32px]]'''[https://gentoo.org Gentoo Linux]'''
|
|
* Gramps 5.1.4
* Gramps 5.1.5 (testing)
|[https://packages.gentoo.org/packages/app-misc/gramps available versions]
|-
|'''[https://www.netbsd.org/ NetBSD]'''
|
|
* NetBSD: [http://pkgsrc.se/databases/gramps5 Gramps 5.1.5]
|
|-
|'''[https://www.freebsd.org/ FreeBSD]'''
|
|
* FreeBSD: Gramps 4.2.8
* [https://www.freshports.org/science/gramps/ FreshPorts: Gramps 5.1.5]
|
|-
|'''[https://www.openbsd.org/ OpenBSD]'''
|
|
* OpenBSD: Gramps 5.1.5
|[http://openports.se/misc/gramps available versions]
|-
|
|
|
|
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually.

{{man warn|1=Warning before attempting this use your existing installation to [[How to make a backup|make a Gramps XML backup]]|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 5.1.3 to 5.1.5), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 4.y.z to 5.y.z), then the danger that it does not work properly is much greater.}}

=== Debian-based ===
For [[File:Debianopenlogo-32.png|link=Download#Debian-based]]'''[[Debian|Debian-based linux distributions]]''' (Which includes [[File:Ubuntu_32x32.png|link=Download#Debian-based]]''' Ubuntu ''') [{{github_url}}/releases/download/v{{Version Linux Debian}}/gramps_{{Version Linux Debian}}-1_all.deb Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved ({{man menu|change the filename to match the one you downloaded}}).

sudo dpkg -i gramps_{{version}}-1_all.deb

If you have an error about having unmet dependencies run:

sudo apt-get -f install

to install the dependencies.

If you see an error about an incomplete GTK installation and missing language translations when starting Gramps, run

sudo apt install language-pack-gnome-en

to install the proper language pack. You may need to replace 'en' with your own language code, like 'nl' for Dutch.

==== Useful command lines ====
Before upgrading you can[https://sourceforge.net/p/gramps/mailman/message/35460486/]:

* Find out what version you are running, by using this:

dpkg-query -s gramps

that queries the package and gives you info about it.

* If you are committed to an upgrade then make sure you have backed up you Family Trees to Gramps XML then run :

sudo dpkg -r gramps

this will remove the current gramps package (assuming its a python3 version older versions could be python-gramps )

* To stop Ubuntu updating gramps (to possibly an older version from Ubuntu!) you may need to run:

sudo apt-mark hold gramps

'''Upgrade is then complete.'''

=== Flathub ===

Gramps {{Version Linux Flatpak}} is available as a Flatpak at Flathub.

{{man note|Please use your existing installation to backup your database before proceeding.|Also, it is a good idea to [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Converting_a_BSDDB_Family_Tree_to_SQLite|convert your database to SQLite]] even though there is currently BSDDB3 support in the {{Version Linux Flatpak}} Flatpak.}}

First set up Flatpak and the Flathub repository on your system, there are instructions for various distributions at https://flatpak.org/setup/

Second, you can use the blue install button at https://flathub.org/apps/details/org.gramps_project.Gramps if you set your software manager up to work with Flathub, or use the command below in a terminal for a system wide installation if you have sudo privileges:

flatpak install flathub org.gramps_project.Gramps

{{-}}

=== For other distributions ===
For other distributions, [[File:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== BSD ==

[[File:Bsd daemon.png|128px|left|link=Download#BSD]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>

See also:
* [[BSD platforms]]
{{-}}

== Linux Live CD ==

{{man warn|Note this '''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} an old version released 2010-11-17 and it is not recommended for general use}}

[[File:Download_link.png|150px|left|link=https://sourceforge.net/projects/gramps/files/gramps-cdrom/lgenealogy-6.1-desktop-i386.iso/download]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn, [https://rufus.ie/en/ Rufus]..). [[Linux_Genealogy_CD#Download_the_CD|Download the CD]] (727 MB). The [[Linux Genealogy CD|Linux Genealogy CD is based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu] and Gramps from the CD anytime you like.
{{-}}

== Online Demonstration ==
{{man warn|Buyer Beware|This is a limited trial of a commercial cloud VM service that operates by subscription. This is '''''not''''' an endorsement by the Gramps-project. Beware of giving third parties access to your genealogical data.}}

You can also try an online demonstration of version 5.1.4 of Gramps on rollApp (''"Cloud platform for native applications"'') categorized under '''[https://www.rollapp.com/apps/utilities Utilities]''' - ''[https://www.rollapp.com/apps/diagrams #diagrams]'':

* https://www.rollapp.com/app/gramps

Select '''Launch Online''' then '''Test Drive(Opening/saving files will not be available)'''

{{-}}

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data. See : [[How to make a backup]]

== See also ==
* [https://github.com/gramps-project/gramps/releases GitHub folder of Gramps releases]
* [[Previous releases of Gramps]]
* [[:Category:Versions|Versions on various platforms]]

[[Category:Documentation]]

Download

2022-04-22T16:04:08Z

Jralls: /* macOS */ Homebrew just repackages our Gramps.app.

{{languages|Download}}
[[File:Gramp-Small-background-wiki-2020.jpg|120px|left]]
'''Research, organize and share your family tree with Gramps.'''

Gramps is a free software project and community. We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists. It is a community project, created, developed and governed by genealogists.

{{man note|{{Man menu|Gramps '''Current version: '''{{version}}''' Released: '''2022-02-05'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as [https://www.python.org/doc/sunset-python-2/ Python 2 support dropped]. Uses GTK+ 3 GUI. Default database is now SQLite. Lot of updates see: ''[[Gramps 5.1 Wiki Manual - What's new?|What's new?]]{{-}}
[[File:Linux_220x261.png|128px|link=Download#Linux]] [[File:windows_180x160.png|128px|link=Download#MS_Windows]] [[File:macos_200x200.png|128px|link=Download#macOS]] [[File:Bsd daemon.png|128px|link=Download#BSD]]}}

== Linux ==

[[File:Linux_220x261.png|128px|left|link=Download#Linux]]

Before upgrading your distribution: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Flathub|via Flathub]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==
[[File:windows_180x160.png|128px|left|link=Download#MS_Windows]]

Before downloading the All-In-One software installer bundle for Windows: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

This installer supports Microsoft Windows in all versions [http://windows.microsoft.com/en-au/windows/lifecycle Vista/7] and later. The 64-bit versions of Windows allow more efficient access to more resources.

(''Please note: Gramps prefers the Python-3.5 and Gtk-3.18 libraries and newer. Those libraries have dropped support for Windows XP. But Gramps can still be run on Windows XP with earlier library versions, i.e., Python3.4.4 and Gtk-3.16'')

<big>
*[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]
*[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]</big>


After download: '''double-click to install Gramps'''. By default: new releases will be added in a new directory and earlier installations of Gramps will ''not'' be overwritten; the language will be a [[#Missing_other_languages|mix of British and US English]].

{{man tip|Shortcuts|During installation, one shortcut is placed on the desktop and two shortcuts are added the Start menu. ''Please only use the 'console' secondary shortcut when performing diagnostics requested by a developer.'' 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu| ← for normal use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

Use the Windows AIO (All-In-One) version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO cx freeze-based|this page]] (English only). Or, you might want to look at the description of what is meant by an [[All_In_One_Gramps_Software_Bundle_for_Windows|All In One Bundle.]]

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
If needed, there are alternatives to the All-In-One installer.

==== PortableApps.com ====
A [https://portableapps.com/apps/education/gramps_portable '''PortableApps''' version] will run from an external device without the requirement of installing on the OS drive. PortableApps installations are not for touchscreen-based mobile devices. They just allow the application to run from external storage, USB thumbdrives.

You can download the '''{{Version_windows_portable}} Gramps Portable version''' from:
* the [https://portableapps.com/apps/education/gramps_portable Gramps Portable project] page in their [https://portableapps.com/apps/education/ Education] category.

Note that '''PortableApps.com''' also has a Legacy 3.4.9 version of Gramps available -- although it is not recommended for general use; just for recovering older format databases.
* [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_3.4.9.paf.exe] (29.0 MB)

[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' '''[https://portableapps.com/forums/support/education Please report packaging issues here]'''

==== Chocolatey NuGet Package ====
You may also install using the alternative independent Gramps Chocolatey NuGet Package

Chocolatey NuGet is a Machine Package Manager, somewhat like apt-get, but built with Windows in mind.

* [https://chocolatey.org/packages/gramps/ Gramps Chocolatey Package]

==== Gramps for Windows with MSYS2 ====

How to use [https://www.msys2.org/ MSYS2] to run latest Gramps development version from source in 64bit Windows.

* [[Gramps for Windows with MSYS2]]

{{-}}

=== Missing other languages ===
[[File:Microsoft Window Gramps AIO Installer Choose Components-Selection-51.png|right|thumb|450px|Microsoft Window Gramps AIO Installer Choose Components-Selection window.]]
The default Gramps AIO installer will embed the US dialect of English for the interface with the British spellcheck dictionary.

If you prefer a different language (or spell with the US or Australian dialects of English), please ensure that you pay special attention to the Choose Components phase of the installation.

To install a language other than English, select from both the '''Translations''' ''and'' '''Dictionaries''' during the Choose Components phase of the installation.

Even your primary language is installed by default, you might anticipate the need to spellcheck Notes in other than the British dialect of English. Be certain to select the appropriate languages from '''Dictionaries'''. Gramps will not access your Operating System's native dictionary.

There is no simple facility for adding interface or dictionary languages after installation.
{{-}}



== macOS ==

[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]

Before downloading the ready-to-run stand-alone bundle: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Tested for compatibility with Apple macOS/Mac OS X versions 10.13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_10.13:_%22High_Sierra%22 High Sierra]) through 12 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_12:_%22Monterey%22 Monterey]). ''Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.]''

<big>
* [{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]
</big>

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

The macOS application bundle can also be installed via the Homebrew package manager as a cask. Note that this is *not* a Homebrew build, it is a repackaging of the same Gramps.app provided in the above dmg. It does not depend on or use any of the Homebrew-built libraries.

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
Alternatively, Gramps can also be built and installed on macOS using MacPorts.

{{-}}
==== MacPorts ====

MacPorts is a package manager for Apple Mac.

* [[Mac_OS_X:Build_from_source:MacPorts]]

{{-}}

==== Homebrew ====
[https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew] is an open-source package manager for macOS (and Linux).

See https://github.com/homebrew/

{{-}}

=== Adding additional Spell Checking languages on macOS ===
{{man tip|[[Mac_OS_X:Application_package#Dictionaries|Spell Checking:]]|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== Linux and BSD distributions ==
{{man note|These packages are built and supported by the [https://en.wikipedia.org/wiki/Linux_distribution distros].|If your distribution is not listed you may possibly find it listed on [https://repology.org/metapackage/gramps/versions ''Repology''] Please report any problems with them to the package maintainer.}}
Most Linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

{| {{prettytable}}
!style="width: 85pt;" | Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[File:Debianopenlogo-32.png|link=https://packages.debian.org/search?keywords=gramps]]''' [[Debian]] '''
|Add/Remove Software
|
* Debian 8 ("jessie")(old old old stable): Gramps 4.1.1
* Debian 9 ("stretch") (old old stable): Gramps 4.2.5
* Debian 9 ("stretch")([https://packages.debian.org/stretch-backports/gramps backports]): Gramps 5.0.1
* Debian 10 ("buster") (old stable): Gramps 5.0.1
* Debian 10 ("buster")([https://packages.debian.org/buster-backports/gramps backports]) (stable): Gramps 5.1.2
* Debian 11 ("bullseye")(stable): Gramps 5.1.3
* Debian 11 ("bullseye")([https://packages.debian.org/bullseye-backports/gramps backports]): Gramps 5.1.5
* bookworm (testing): Gramps 5.1.5
* [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 5.1.5
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[File:Ubuntu_32x32.png]] '''[https://ubuntu.com/ Ubuntu]'''
|Software Centre
|
* Bionic Beaver (18.04 LTS): Gramps: 5.1.2
* Focal (20.04 LTS): Gramps: 5.1.3
* Hirsute (21.04): Gramps: 5.1.3
* Impish (21.10): Gramps: 5.1.4
* Jammy (Development: 22.04): Gramps: 5.1.5
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]/ (Also see: [https://launchpad.net/~rosco2/+archive/ubuntu/backports Backports])
|-
|[[File:Farm-Fresh linux mint.png]]''' [https://www.linuxmint.com/ Linux Mint]'''
|Software Manager
|
* 19.x(Gramps 4.2.8) 
* 20.x(Gramps 5.1.2) 
|
* Use the "Software Manager" to install a recent version.
* Manually install the most current version of Gramps using the following [https://forums.linuxmint.com/viewtopic.php?t=220159 instructions] from the ''Linux Mint Forums''
* [http://community.linuxmint.com/software/view/gramps Old versions available from Linuxmint]
|-
|[[File:Fedora_32x32.png]] '''[https://getfedora.org/ Fedora]'''
|Add/Remove Software (Gnome) or Software Management (KDE)
|
* Rawhide (Gramps 5.1.5)
* Fedora 34 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
|[https://koji.fedoraproject.org/koji/packageinfo?packageID=1969 available versions]
|-
|'''[https://www.mageia.org/en/ Mageia]'''
||[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|
* Mageia [https://madb.mageia.org/package/show/name/gramps/release/cauldron/ Caulron]: Gramps 5.1.5
* Mageia 8.0: Gramps 5.1.3
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|[[File:OpenSUSE-distribution-icon.png|32px]] '''[https://www.opensuse.org/ openSUSE]'''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|
* openSUSE Tumbleweed: Gramps 5.1.5
* openSUSE Leap 15.3: Gramps 4.2.8 
|[https://software.opensuse.org/package/gramps available versions] The most recent version can usually be installed from the 'openSUSE BuildService - GNOME:Apps' repository
|-
|[[File:Slackware-distribution-icon.jpg|32px]] '''[http://www.slackware.com/ Slackware]'''
|
|
* 15.0: Gramps ?.?.?
* 14.2: Gramps 5.1.2 - [https://slackbuilds.org/repository/14.2/misc/gramps/?search=gramps slackbuilds.org]
* 14.2: Gramps 4.2.6
* 14.1: Gramps 4.0.3
|[https://pkgs.org/search/?q=gramps available versions]
|-
|[[File:archlinux-icon-crystal-32.svg]] '''[https://www.archlinux.org/ Arch Linux]'''
| [https://wiki.archlinux.org/index.php/pacman pacman]
|
* Gramps 5.1.5
|[https://www.archlinux.org/packages/community/any/gramps/ available versions]
|-
|[[File:Gentoo-distribution-icon.png|32px]]'''[https://gentoo.org Gentoo Linux]'''
|
|
* Gramps 5.1.4
* Gramps 5.1.5 (testing)
|[https://packages.gentoo.org/packages/app-misc/gramps available versions]
|-
|'''[https://www.netbsd.org/ NetBSD]'''
|
|
* NetBSD: [http://pkgsrc.se/databases/gramps5 Gramps 5.1.5]
|
|-
|'''[https://www.freebsd.org/ FreeBSD]'''
|
|
* FreeBSD: Gramps 4.2.8
* [https://www.freshports.org/science/gramps/ FreshPorts: Gramps 5.1.5]
|
|-
|'''[https://www.openbsd.org/ OpenBSD]'''
|
|
* OpenBSD: Gramps 5.1.5
|[http://openports.se/misc/gramps available versions]
|-
|
|
|
|
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually.

{{man warn|1=Warning before attempting this use your existing installation to [[How to make a backup|make a Gramps XML backup]]|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 5.1.3 to 5.1.5), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 4.y.z to 5.y.z), then the danger that it does not work properly is much greater.}}

=== Debian-based ===
For [[File:Debianopenlogo-32.png|link=Download#Debian-based]]'''[[Debian|Debian-based linux distributions]]''' (Which includes [[File:Ubuntu_32x32.png|link=Download#Debian-based]]''' Ubuntu ''') [{{github_url}}/releases/download/v{{Version Linux Debian}}/gramps_{{Version Linux Debian}}-1_all.deb Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved ({{man menu|change the filename to match the one you downloaded}}).

sudo dpkg -i gramps_{{version}}-1_all.deb

If you have an error about having unmet dependencies run:

sudo apt-get -f install

to install the dependencies.

If you see an error about an incomplete GTK installation and missing language translations when starting Gramps, run

sudo apt install language-pack-gnome-en

to install the proper language pack. You may need to replace 'en' with your own language code, like 'nl' for Dutch.

==== Useful command lines ====
Before upgrading you can[https://sourceforge.net/p/gramps/mailman/message/35460486/]:

* Find out what version you are running, by using this:

dpkg-query -s gramps

that queries the package and gives you info about it.

* If you are committed to an upgrade then make sure you have backed up you Family Trees to Gramps XML then run :

sudo dpkg -r gramps

this will remove the current gramps package (assuming its a python3 version older versions could be python-gramps )

* To stop Ubuntu updating gramps (to possibly an older version from Ubuntu!) you may need to run:

sudo apt-mark hold gramps

'''Upgrade is then complete.'''

=== Flathub ===

Gramps {{Version Linux Flatpak}} is available as a Flatpak at Flathub.

{{man note|Please use your existing installation to backup your database before proceeding.|Also, it is a good idea to [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Converting_a_BSDDB_Family_Tree_to_SQLite|convert your database to SQLite]] even though there is currently BSDDB3 support in the {{Version Linux Flatpak}} Flatpak.}}

First set up Flatpak and the Flathub repository on your system, there are instructions for various distributions at https://flatpak.org/setup/

Second, you can use the blue install button at https://flathub.org/apps/details/org.gramps_project.Gramps if you set your software manager up to work with Flathub, or use the command below in a terminal for a system wide installation if you have sudo privileges:

flatpak install flathub org.gramps_project.Gramps

{{-}}

=== For other distributions ===
For other distributions, [[File:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== BSD ==

[[File:Bsd daemon.png|128px|left|link=Download#BSD]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>

See also:
* [[BSD platforms]]
{{-}}

== Linux Live CD ==

{{man warn|Note this '''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} an old version released 2010-11-17 and it is not recommended for general use}}

[[File:Download_link.png|150px|left|link=https://sourceforge.net/projects/gramps/files/gramps-cdrom/lgenealogy-6.1-desktop-i386.iso/download]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn, [https://rufus.ie/en/ Rufus]..). [[Linux_Genealogy_CD#Download_the_CD|Download the CD]] (727 MB). The [[Linux Genealogy CD|Linux Genealogy CD is based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu] and Gramps from the CD anytime you like.
{{-}}

== Online Demonstration ==
{{man note|Note|This is a commercial limited trial and not endorsed by the Gramps-project. Beware of third parties having your genealogical data.}}

You can also try an online demonstration of Gramps on rollApp:
* https://www.rollapp.com/app/gramps
Select '''Launch Online''' then '''Test Drive(Opening/saving files will not be available)'''

{{-}}

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data. See : [[How to make a backup]]

== See also ==
* [https://github.com/gramps-project/gramps/releases GitHub folder of Gramps releases]
* [[Previous releases of Gramps]]
* [[:Category:Versions|Versions on various platforms]]

[[Category:Documentation]]

Download

2022-04-22T15:46:57Z

Jralls: /* macOS */ Update supported macOS versions.

{{languages|Download}}
[[File:Gramp-Small-background-wiki-2020.jpg|120px|left]]
'''Research, organize and share your family tree with Gramps.'''

Gramps is a free software project and community. We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists. It is a community project, created, developed and governed by genealogists.

{{man note|{{Man menu|Gramps '''Current version: '''{{version}}''' Released: '''2022-02-05'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as [https://www.python.org/doc/sunset-python-2/ Python 2 support dropped]. Uses GTK+ 3 GUI. Default database is now SQLite. Lot of updates see: ''[[Gramps 5.1 Wiki Manual - What's new?|What's new?]]{{-}}
[[File:Linux_220x261.png|128px|link=Download#Linux]] [[File:windows_180x160.png|128px|link=Download#MS_Windows]] [[File:macos_200x200.png|128px|link=Download#macOS]] [[File:Bsd daemon.png|128px|link=Download#BSD]]}}

== Linux ==

[[File:Linux_220x261.png|128px|left|link=Download#Linux]]

Before upgrading your distribution: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Flathub|via Flathub]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==
[[File:windows_180x160.png|128px|left|link=Download#MS_Windows]]

Before downloading the All-In-One software installer bundle for Windows: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

This installer supports Microsoft Windows in all versions [http://windows.microsoft.com/en-au/windows/lifecycle Vista/7] and later. The 64-bit versions of Windows allow more efficient access to more resources.

(''Please note: Gramps prefers the Python-3.5 and Gtk-3.18 libraries and newer. Those libraries have dropped support for Windows XP. But Gramps can still be run on Windows XP with earlier library versions, i.e., Python3.4.4 and Gtk-3.16'')

<big>
*[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]
*[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]</big>


After download: '''double-click to install Gramps'''. By default: new releases will be added in a new directory and earlier installations of Gramps will ''not'' be overwritten; the language will be a [[#Missing_other_languages|mix of British and US English]].

{{man tip|Shortcuts|During installation, one shortcut is placed on the desktop and two shortcuts are added the Start menu. ''Please only use the 'console' secondary shortcut when performing diagnostics requested by a developer.'' 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu| ← for normal use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

Use the Windows AIO (All-In-One) version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO cx freeze-based|this page]] (English only). Or, you might want to look at the description of what is meant by an [[All_In_One_Gramps_Software_Bundle_for_Windows|All In One Bundle.]]

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
If needed, there are alternatives to the All-In-One installer.

==== PortableApps.com ====
A [https://portableapps.com/apps/education/gramps_portable '''PortableApps''' version] will run from an external device without the requirement of installing on the OS drive. PortableApps installations are not for touchscreen-based mobile devices. They just allow the application to run from external storage, USB thumbdrives.

You can download the '''{{Version_windows_portable}} Gramps Portable version''' from:
* the [https://portableapps.com/apps/education/gramps_portable Gramps Portable project] page in their [https://portableapps.com/apps/education/ Education] category.

Note that '''PortableApps.com''' also has a Legacy 3.4.9 version of Gramps available -- although it is not recommended for general use; just for recovering older format databases.
* [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_3.4.9.paf.exe] (29.0 MB)

[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' '''[https://portableapps.com/forums/support/education Please report packaging issues here]'''

==== Chocolatey NuGet Package ====
You may also install using the alternative independent Gramps Chocolatey NuGet Package

Chocolatey NuGet is a Machine Package Manager, somewhat like apt-get, but built with Windows in mind.

* [https://chocolatey.org/packages/gramps/ Gramps Chocolatey Package]

==== Gramps for Windows with MSYS2 ====

How to use [https://www.msys2.org/ MSYS2] to run latest Gramps development version from source in 64bit Windows.

* [[Gramps for Windows with MSYS2]]

{{-}}

=== Missing other languages ===
[[File:Microsoft Window Gramps AIO Installer Choose Components-Selection-51.png|right|thumb|450px|Microsoft Window Gramps AIO Installer Choose Components-Selection window.]]
The default Gramps AIO installer will embed the US dialect of English for the interface with the British spellcheck dictionary.

If you prefer a different language (or spell with the US or Australian dialects of English), please ensure that you pay special attention to the Choose Components phase of the installation.

To install a language other than English, select from both the '''Translations''' ''and'' '''Dictionaries''' during the Choose Components phase of the installation.

Even your primary language is installed by default, you might anticipate the need to spellcheck Notes in other than the British dialect of English. Be certain to select the appropriate languages from '''Dictionaries'''. Gramps will not access your Operating System's native dictionary.

There is no simple facility for adding interface or dictionary languages after installation.
{{-}}



== macOS ==

[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]

Before downloading the ready-to-run stand-alone bundle: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Tested for compatibility with Apple macOS/Mac OS X versions 10.13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_10.13:_%22High_Sierra%22 High Sierra]) through 12 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_12:_%22Monterey%22 Monterey]). ''Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.]''

<big>
* [{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]
</big>

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

=== Alternative independent installation ===
[[File:Gramps-release.png|left]]
Alternatively, Gramps can also be installed on macOS using either the MacPorts or Homebrew package manager systems.

{{-}}
==== MacPorts ====

MacPorts is a package manager for Apple Mac.

* [[Mac_OS_X:Build_from_source:MacPorts]]

{{-}}

==== Homebrew ====
[https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew] is an open-source package manager for macOS (and Linux).

See https://github.com/homebrew/

{{-}}

=== Adding additional Spell Checking languages on macOS ===
{{man tip|[[Mac_OS_X:Application_package#Dictionaries|Spell Checking:]]|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== Linux and BSD distributions ==
{{man note|These packages are built and supported by the [https://en.wikipedia.org/wiki/Linux_distribution distros].|If your distribution is not listed you may possibly find it listed on [https://repology.org/metapackage/gramps/versions ''Repology''] Please report any problems with them to the package maintainer.}}
Most Linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

{| {{prettytable}}
!style="width: 85pt;" | Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[File:Debianopenlogo-32.png|link=https://packages.debian.org/search?keywords=gramps]]''' [[Debian]] '''
|Add/Remove Software
|
* Debian 8 ("jessie")(old old old stable): Gramps 4.1.1
* Debian 9 ("stretch") (old old stable): Gramps 4.2.5
* Debian 9 ("stretch")([https://packages.debian.org/stretch-backports/gramps backports]): Gramps 5.0.1
* Debian 10 ("buster") (old stable): Gramps 5.0.1
* Debian 10 ("buster")([https://packages.debian.org/buster-backports/gramps backports]) (stable): Gramps 5.1.2
* Debian 11 ("bullseye")(stable): Gramps 5.1.3
* Debian 11 ("bullseye")([https://packages.debian.org/bullseye-backports/gramps backports]): Gramps 5.1.5
* bookworm (testing): Gramps 5.1.5
* [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 5.1.5
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[File:Ubuntu_32x32.png]] '''[https://ubuntu.com/ Ubuntu]'''
|Software Centre
|
* Bionic Beaver (18.04 LTS): Gramps: 5.1.2
* Focal (20.04 LTS): Gramps: 5.1.3
* Hirsute (21.04): Gramps: 5.1.3
* Impish (21.10): Gramps: 5.1.4
* Jammy (Development: 22.04): Gramps: 5.1.5
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]/ (Also see: [https://launchpad.net/~rosco2/+archive/ubuntu/backports Backports])
|-
|[[File:Farm-Fresh linux mint.png]]''' [https://www.linuxmint.com/ Linux Mint]'''
|Software Manager
|
* 19.x(Gramps 4.2.8) 
* 20.x(Gramps 5.1.2) 
|
* Use the "Software Manager" to install a recent version.
* Manually install the most current version of Gramps using the following [https://forums.linuxmint.com/viewtopic.php?t=220159 instructions] from the ''Linux Mint Forums''
* [http://community.linuxmint.com/software/view/gramps Old versions available from Linuxmint]
|-
|[[File:Fedora_32x32.png]] '''[https://getfedora.org/ Fedora]'''
|Add/Remove Software (Gnome) or Software Management (KDE)
|
* Rawhide (Gramps 5.1.5)
* Fedora 34 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
* Fedora 35 (Gramps 5.1.5)
|[https://koji.fedoraproject.org/koji/packageinfo?packageID=1969 available versions]
|-
|'''[https://www.mageia.org/en/ Mageia]'''
||[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|
* Mageia [https://madb.mageia.org/package/show/name/gramps/release/cauldron/ Caulron]: Gramps 5.1.5
* Mageia 8.0: Gramps 5.1.3
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|[[File:OpenSUSE-distribution-icon.png|32px]] '''[https://www.opensuse.org/ openSUSE]'''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|
* openSUSE Tumbleweed: Gramps 5.1.5
* openSUSE Leap 15.3: Gramps 4.2.8 
|[https://software.opensuse.org/package/gramps available versions] The most recent version can usually be installed from the 'openSUSE BuildService - GNOME:Apps' repository
|-
|[[File:Slackware-distribution-icon.jpg|32px]] '''[http://www.slackware.com/ Slackware]'''
|
|
* 15.0: Gramps ?.?.?
* 14.2: Gramps 5.1.2 - [https://slackbuilds.org/repository/14.2/misc/gramps/?search=gramps slackbuilds.org]
* 14.2: Gramps 4.2.6
* 14.1: Gramps 4.0.3
|[https://pkgs.org/search/?q=gramps available versions]
|-
|[[File:archlinux-icon-crystal-32.svg]] '''[https://www.archlinux.org/ Arch Linux]'''
| [https://wiki.archlinux.org/index.php/pacman pacman]
|
* Gramps 5.1.5
|[https://www.archlinux.org/packages/community/any/gramps/ available versions]
|-
|[[File:Gentoo-distribution-icon.png|32px]]'''[https://gentoo.org Gentoo Linux]'''
|
|
* Gramps 5.1.4
* Gramps 5.1.5 (testing)
|[https://packages.gentoo.org/packages/app-misc/gramps available versions]
|-
|'''[https://www.netbsd.org/ NetBSD]'''
|
|
* NetBSD: [http://pkgsrc.se/databases/gramps5 Gramps 5.1.5]
|
|-
|'''[https://www.freebsd.org/ FreeBSD]'''
|
|
* FreeBSD: Gramps 4.2.8
* [https://www.freshports.org/science/gramps/ FreshPorts: Gramps 5.1.5]
|
|-
|'''[https://www.openbsd.org/ OpenBSD]'''
|
|
* OpenBSD: Gramps 5.1.5
|[http://openports.se/misc/gramps available versions]
|-
|
|
|
|
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually.

{{man warn|1=Warning before attempting this use your existing installation to [[How to make a backup|make a Gramps XML backup]]|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 5.1.3 to 5.1.5), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 4.y.z to 5.y.z), then the danger that it does not work properly is much greater.}}

=== Debian-based ===
For [[File:Debianopenlogo-32.png|link=Download#Debian-based]]'''[[Debian|Debian-based linux distributions]]''' (Which includes [[File:Ubuntu_32x32.png|link=Download#Debian-based]]''' Ubuntu ''') [{{github_url}}/releases/download/v{{Version Linux Debian}}/gramps_{{Version Linux Debian}}-1_all.deb Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved ({{man menu|change the filename to match the one you downloaded}}).

sudo dpkg -i gramps_{{version}}-1_all.deb

If you have an error about having unmet dependencies run:

sudo apt-get -f install

to install the dependencies.

If you see an error about an incomplete GTK installation and missing language translations when starting Gramps, run

sudo apt install language-pack-gnome-en

to install the proper language pack. You may need to replace 'en' with your own language code, like 'nl' for Dutch.

==== Useful command lines ====
Before upgrading you can[https://sourceforge.net/p/gramps/mailman/message/35460486/]:

* Find out what version you are running, by using this:

dpkg-query -s gramps

that queries the package and gives you info about it.

* If you are committed to an upgrade then make sure you have backed up you Family Trees to Gramps XML then run :

sudo dpkg -r gramps

this will remove the current gramps package (assuming its a python3 version older versions could be python-gramps )

* To stop Ubuntu updating gramps (to possibly an older version from Ubuntu!) you may need to run:

sudo apt-mark hold gramps

'''Upgrade is then complete.'''

=== Flathub ===

Gramps {{Version Linux Flatpak}} is available as a Flatpak at Flathub.

{{man note|Please use your existing installation to backup your database before proceeding.|Also, it is a good idea to [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Converting_a_BSDDB_Family_Tree_to_SQLite|convert your database to SQLite]] even though there is currently BSDDB3 support in the {{Version Linux Flatpak}} Flatpak.}}

First set up Flatpak and the Flathub repository on your system, there are instructions for various distributions at https://flatpak.org/setup/

Second, you can use the blue install button at https://flathub.org/apps/details/org.gramps_project.Gramps if you set your software manager up to work with Flathub, or use the command below in a terminal for a system wide installation if you have sudo privileges:

flatpak install flathub org.gramps_project.Gramps

{{-}}

=== For other distributions ===
For other distributions, [[File:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== BSD ==

[[File:Bsd daemon.png|128px|left|link=Download#BSD]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>

See also:
* [[BSD platforms]]
{{-}}

== Linux Live CD ==

{{man warn|Note this '''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} an old version released 2010-11-17 and it is not recommended for general use}}

[[File:Download_link.png|150px|left|link=https://sourceforge.net/projects/gramps/files/gramps-cdrom/lgenealogy-6.1-desktop-i386.iso/download]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn, [https://rufus.ie/en/ Rufus]..). [[Linux_Genealogy_CD#Download_the_CD|Download the CD]] (727 MB). The [[Linux Genealogy CD|Linux Genealogy CD is based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu] and Gramps from the CD anytime you like.
{{-}}

== Online Demonstration ==
{{man note|Note|This is a commercial limited trial and not endorsed by the Gramps-project. Beware of third parties having your genealogical data.}}

You can also try an online demonstration of Gramps on rollApp:
* https://www.rollapp.com/app/gramps
Select '''Launch Online''' then '''Test Drive(Opening/saving files will not be available)'''

{{-}}

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data. See : [[How to make a backup]]

== See also ==
* [https://github.com/gramps-project/gramps/releases GitHub folder of Gramps releases]
* [[Previous releases of Gramps]]
* [[:Category:Versions|Versions on various platforms]]

[[Category:Documentation]]

Template:Filename mac intel

2021-10-16T19:26:09Z

Jralls: -4 had graphviz ilinkage problems.

Gramps-Intel-{{Version_Mac}}-5<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2021-10-15T19:35:48Z

Jralls: New Gramps macOS DMG.

Gramps-Intel-{{Version_Mac}}-4<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2021-10-14T22:22:15Z

Jralls: Upgraded 5.1.4 DMG for macOS 12 Monterey.

Gramps-Intel-{{Version_Mac}}-3<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Example.gramps

2021-06-24T15:42:57Z

Jralls: /* Load example.gramps */ Remove reference to Homebrew, that recipe just downloads the Gramps .dmg.

==What is in an Example Tree?==
The example family tree database ('''<code>example.gramps</code>''' file) ideally will have an example of everything, at least one, of everything Gramps does, or which it is possible to do in Gramps, even if obscure etc.

{{man tip|Before filing a bug report...|Is your Tree damaged? When you suspect that you have discovered an issue (aka 'bug') in Gramps, first try the same operation with the example family tree. • If the problem happens there as well, then [[How_to_create_a_good_bug_report|file a bug report]]. • If the problem cannot be recreated using the example family tree, then you may need to [[Recover corrupted family tree|fix a corruption in your data]].}}
==The purpose of an Example Tree==
[[File:Importfamilytree-dialogLinux-51.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - Gnome for Ubuntu dialog example]]
[[File:Importfamilytree-dialog-51.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - Windows dialog example]]
[[File:Importfamilytree-dialogMac-51.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - macOS dialog example]]

Your installation of Gramps should include some example family tree data. This data is used for working through tutorials and for safely exploring tools or features.

And, because many of the features of Gramps cannot be explored until the Tree is populated with People, Families, Events, Places, Sources, Media and other types of data; importing the example data creates a playground for exploring Gramps.

Further, most of the examples, [[:Category:How_do_I...|"How do I..." tutorials]] and screen-capture [[Special:ListFiles|illustrations (aka figures)]] in this wiki are based on this example data freshly imported into a newly created (empty) tree. Such a tree can be considered to be 'expendable.' If you accidentally mangle the tree then simply [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Deleting_a_Family_Tree|discard the Tree]], create a [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|new Tree]] and [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|import]] the example family tree data again.

The example is also used provide a known, stable and predictable environment for testing. Many conditions cannot be recreated without tree data. Using this tree (as a common frame of reference) eliminates the extra complexity of [[How_to_create_a_good_bug_report#Creating_a_test_database|describing how to recreate the data]] before [[How_to_create_a_good_bug_report#Recording_the_steps_that_reproduce_the_bug|describing the issue]].
==Load <code>example.gramps</code>==
Follow these steps to load the example family tree:
# Find <code>example.gramps.gz</code> or <code>example.gramps</code> on your system. For example:
#* on Linux <code>/usr/share/doc/gramps/example/gramps/</code>. If the file is named <code>example.gramps.gz</code>, rename it to <code>example.gramps</code> and gramps will recognize it. You can copy this file to a temporary location or import it directly from this directory.
#* on MS-Windows AIO <code>C:\Program Files\GrampsAIO64-X.X.X\share\doc\gramps\example\gramps</code> (On MS-Windows ensure you can see hidden files; see [[Gramps_{{Version manual}}_Wiki_Manual_-_User_Directory#MS_Windows|User Directory:MS Windows]])
#* on Apple MacOS
#** The example database is located inside the application bundle at <code>/Applications/Gramps.app/Contents/Resources/share/doc/gramps/example/gramps/</code>
# Start Gramps
# To create a new family tree {{man menu|Family Trees > Manage Family Trees...}} select the {{man button|New}} button. Give it some name, such as ''example''
# Open this new family tree. It will be empty.
# In Gramps, use {{man menu|Family Trees > Import...}} to [[Gramps_{{Version manual}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|import]] <code>example.gramps</code>.
#;Import Statistics of the example.gramps family tree
{| class="wikitable"
|
Number of new objects imported:
* People: 2157
* Families: 762
* [[Sources|{{man label|Sources}}]]: 4
* [[Events_in_Gramps|{{man label|Events}}]]: 3432
* Media Objects: 7
* [[Places_in_Gramps|{{man label|Places}}]]: 1294
* [[Repositories_in_Gramps|{{man label|Repositories}}]]: 3
* Notes: 19
* [[Tags_in_Gramps|{{man label|Tags}}]]: 2
* [[Citations#Why_Cite|{{man label|Citations}}]]: 2854

Media objects with relative paths have been
imported. These paths are considered relative to
the media directory you can set in the preferences,
or, if not set, relative to the user's directory.
|[[File:GEDCOM-ImportStatistics-dialog-50.png|right|200px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
|}

==Connecting to the example Media Objects==
[[File:Broken Media Path.png|right|350px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media object with a broken filepath]]
There are seven example Media Objects (JPEG and PNG images) provided but the relative media path starting point (the Base Path) hasn't been defined in the Preferences. So these images won't be displayed until the media path has been re-defined. The media path can be reset now or if starting to experiment with images.
# In {{man menu|Edit > Preferences}}, change the {{man label|Base path for relative media paths:}} in the [[Gramps_{{Version manual}}_Wiki_Manual_-_Settings#General|{{man label|General}}]] tab. This could be in a new directory, to keep it separate to your own family tree media. (eg On Linux <code>~/gramps/example/</code>)
# Copy the media files from the example directory (that you found in step 1, above) to this media path directory.
{{man note|The example.gramps family tree data file| Alternately, a replacement Gramps ''[https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps51/example/gramps/example.gramps example.gramps]'' [[XML|{{man label|XML}}]] family tree database file (without the Media Objects) can be downloaded from the GitHub file store.}}
==See also==
* [https://youtu.be/L5fXrfETAUw Gramps Tutorial #2: Creating Backups & Updating your Software] YouTube video by [https://www.youtube.com/channel/UCVIYPTJ3MGttLICyJDBZeSw TechTutorials]. ''Importing the [[Example.gramps]] Tree begins at 17 minutes 4 seconds.''
* [[Data.gramps]] - a smaller (60 person) sample file
* sample.ged - a 42 person [[Gramps_Glossary#gedcom|GEDCOM]] tree ''(hint: GEDCOM files do not specify a [[Gramps_Glossary#home_person|Home Person]]. Edwin Michael Smith is a reasonable person to [[Gramps_{{man version}}_Wiki_Manual_-_Settings#Setting_Home_person|set as Home Person]].)''
: for MS Windows, located in <tt>C:\Program Files\GrampsAIO64-{{template:Version windows AIO64}}\share\doc\gramps\example\gedcom\</tt>
* [[PseudonymTree.gramps|PseudonymTree.gramps]] - sample Pseudonym person Gramps tree for exploring filters & charts. (No Events or Media)
* [https://github.com/gramps-project/gramps/tree/maintenance/gramps51/example/ Gramps-Project example files] (GitHub folder)
* [[Plugins_Command_Line#Generate_Testcases_for_Persons_and_Families|testcase file generator]]
* Backup and data recovery
** [[How to make a backup]]
** [[Template:Backup_Omissions|Backup omissions]] - what is not included during a backup
** [[Recover corrupted family tree]]
[[Category:Documentation]]
[[Category:Gramps Examples]]
[[Category:Genealogy]]
[[Category:Developers/General]]

Mac OS X:Application package

2021-05-14T13:53:27Z

Jralls: /* Before installation */ Installation on Apple Silicon needs to use XML backups of data.

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.

== Before installation ==

'''MacOS versions''' Gramps 5.0 requires Mac OS X 10.9 (Mavericks) and later. Gramps 5.1 requires at least Mac OS X 10.10 (Yosemite).

'''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:''' If you are upgrading from the pre-built Gramps Application version 3.2.3 or earlier (or a build from source version) and you want to keep your old database and settings, you'll need to create a Library/Application Support/gramps folder with your existing data in it. Unless you've changed the location in Preferences, 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.

'''Migrating to Apple Silicon?''' Make an XML backup of your databases on your Intel Mac and copy them to your Apple Silicon Mac and restore them there after installing Gramps. There seems to be a binary object incompatibility in SQLite3 databases, even when running an Intel binary using Rosetta2.

== Installing Gramps ==

From the '''[[Download#Mac_OS_X]]''' page download the dmg. Once it's downloaded, you can open the file (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 whatever program you've set as the default to edit that kind of image) 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.neooffice.org/ NeoOffice], a more mac-friendly version) to work on your reports after saving them from Gramps.

== What goes where ==

'''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): 
* The Gramps database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb. 
* Setting files (ini-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32 
* 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.

== Advanced setup ==

If Gramps has the appropriate translation, calendar, etc. it will honor the settings in System Preferences>Language and Region provided that the combination results in a locale that exists in /usr/share/locale. It will always fall back to English if it can't figure out your Language & Region settings. Some examples: French and France, Belgium, or Canada work fine, as do German and Germany or Switzerland and Dutch and Netherlands or Belgium. German and France doesn't work, nor does Dutch and Switzerland.

If you want to run Gramps with different 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 AppleLocale "de_DE"
to set Gramps to operate in German with German calendar and formatting.

To read the setting use:
defaults read -app Gramps
this 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

The settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist

To remove the special settings
defaults delete -app Gramps AppleLanguages (or AppleLocale or AppleCollation).

Note that you will need to run Gramps at least once before the defaults system will recognize its existence; before that trying to use defaults will produce an error about there being no Gramps application.

[[Howto:Change the language of reports]] has more information on language features in Gramps. When reading it, 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 LANG variable.

=== 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://archive.services.openoffice.org/pub/mirror/OpenOffice.org/contrib/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).

== Bugs ==

=== If something seems to go wrong ===

You'll find error messages in the console log, which you can view with /Applications/Utilities/Console.app

All of the known bugs in previous version have been corrected in Gramps {{Version_Mac}} and later. There will no doubt be new ones; report them in the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis] ([[Using the bug tracker]] instructions). When reporting what you're sure is an OSX specific bug, please set the Platform field to "mac" (no quotes, caps, or spaces!) so that I can find it easily.

Previous Gramps version 3.2.4, bugs are described at [[Mac OS X:Build from source:gtk-osx:bugs]].

== Updates ==

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 the application and just use it. If you don'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 Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get Info.

[[Category:Developers/Packaging]]
[[Category:Documentation]]

Template:Version Mac

2019-09-15T00:59:40Z

Jralls: Release 5.1.1.

5.1.1<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Mac OS X:Application package

2019-08-20T03:31:12Z

Jralls: /* Advanced setup */ Must run Gramps before using defaults -app Gramps.

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.

== Before installation ==

'''MacOS versions''' Gramps 5.0 requires Mac OS X 10.9 (Mavericks) and later. Gramps 5.1 requires at least Mac OS X 10.10 (Yosemite).

'''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:''' If you are upgrading from the pre-built Gramps Application version 3.2.3 or earlier (or a build from source version) and you want to keep your old database and settings, you'll need to create a Library/Application Support/gramps folder with your existing data in it. Unless you've changed the location in Preferences, 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.

== Installing Gramps ==

From the '''[[Download#Mac_OS_X]]''' page select either the Intel version or Power PC version. 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.neooffice.org/ NeoOffice], a more mac-friendly version) to work on your reports after saving them from Gramps.

== What goes where ==

'''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): 
* The Gramps database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb. 
* Setting files (ini-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32 
* 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.

== Advanced setup ==

If Gramps has the appropriate translation, calendar, etc. it will honor the settings in System Preferences>Language and Region provided that the combination results in a locale that exists in /usr/share/locale. It will always fall back to English if it can't figure out your Language & Region settings. Some examples: French and France, Belgium, or Canada work fine, as do German and Germany or Switzerland and Dutch and Netherlands or Belgium. German and France doesn't work, nor does Dutch and Switzerland.

If you want to run Gramps with different 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 AppleLocale "de_DE"
to set Gramps to operate in German with German calendar and formatting.

To read the setting use:
defaults read -app Gramps
this 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

The settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist

To remove the special settings
defaults delete -app Gramps AppleLanguages (or AppleLocale or AppleCollation).

Note that you will need to run Gramps at least once before the defaults system will recognize its existence; before that trying to use defaults will produce an error about there being no Gramps application.

[[Howto:Change the language of reports]] has more information on language features in Gramps. When reading it, 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 LANG variable.

=== 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://archive.services.openoffice.org/pub/mirror/OpenOffice.org/contrib/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).

== Bugs ==

=== If something seems to go wrong ===

You'll find error messages in the console log, which you can view with /Applications/Utilities/Console.app

All of the known bugs in previous version have been corrected in Gramps {{Version_Mac}} and later. There will no doubt be new ones; report them in the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis] ([[Using the bug tracker]] instructions). When reporting what you're sure is an OSX specific bug, please set the Platform field to "mac" (no quotes, caps, or spaces!) so that I can find it easily.

Previous Gramps version 3.2.4, bugs are described at [[Mac OS X:Build from source:gtk-osx:bugs]].

== Updates ==

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 the application and just use it. If you don'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 Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get Info.

[[Category:Developers/Packaging]]
[[Category:Documentation]]

Mac OS X:Application package

2019-08-20T03:26:31Z

Jralls: /* Advanced setup */ Update locale settings to reflect Gramps's current behavior on recent MacOS versions.

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.

== Before installation ==

'''MacOS versions''' Gramps 5.0 requires Mac OS X 10.9 (Mavericks) and later. Gramps 5.1 requires at least Mac OS X 10.10 (Yosemite).

'''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:''' If you are upgrading from the pre-built Gramps Application version 3.2.3 or earlier (or a build from source version) and you want to keep your old database and settings, you'll need to create a Library/Application Support/gramps folder with your existing data in it. Unless you've changed the location in Preferences, 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.

== Installing Gramps ==

From the '''[[Download#Mac_OS_X]]''' page select either the Intel version or Power PC version. 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.neooffice.org/ NeoOffice], a more mac-friendly version) to work on your reports after saving them from Gramps.

== What goes where ==

'''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): 
* The Gramps database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb. 
* Setting files (ini-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32 
* 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.

== Advanced setup ==

If Gramps has the appropriate translation, calendar, etc. it will honor the settings in System Preferences>Language and Region provided that the combination results in a locale that exists in /usr/share/locale. It will always fall back to English if it can't figure out your Language & Region settings. Some examples: French and France, Belgium, or Canada work fine, as do German and Germany or Switzerland and Dutch and Netherlands or Belgium. German and France doesn't work, nor does Dutch and Switzerland.

If you want to run Gramps with different 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 AppleLocale "de_DE"
to set Gramps to operate in German with German calendar and formatting.

To read the setting use:
defaults read -app Gramps
this 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

The settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist

To remove the special settings
defaults delete -app Gramps AppleLanguages (or AppleLocale or AppleCollation).

[[Howto:Change the language of reports]] has more information on language features in Gramps. When reading it, 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 LANG variable.

=== 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://archive.services.openoffice.org/pub/mirror/OpenOffice.org/contrib/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).

== Bugs ==

=== If something seems to go wrong ===

You'll find error messages in the console log, which you can view with /Applications/Utilities/Console.app

All of the known bugs in previous version have been corrected in Gramps {{Version_Mac}} and later. There will no doubt be new ones; report them in the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis] ([[Using the bug tracker]] instructions). When reporting what you're sure is an OSX specific bug, please set the Platform field to "mac" (no quotes, caps, or spaces!) so that I can find it easily.

Previous Gramps version 3.2.4, bugs are described at [[Mac OS X:Build from source:gtk-osx:bugs]].

== Updates ==

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 the application and just use it. If you don'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 Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get Info.

[[Category:Developers/Packaging]]
[[Category:Documentation]]

Template:Filename mac intel

2019-08-18T15:27:27Z

Jralls: Fix https://gramps-project.org/bugs/view.php?id=11256

Gramps-Intel-{{Version_Mac}}-3<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Mac OS X:Build from source:Application package

2019-08-16T21:05:37Z

Jralls: Update for recent changes to gtk-osx and recent versions of Gramps.

Mac OS X:Build from source:Application package

2019-08-16T20:42:38Z

Jralls: Remove all mentions of PPC.

==Building Gramps from Scratch==

Building Gramps from scratch is useful to produce a version not currently available as a binary or to produce a complete environment for debugging and further development, including debugging of all the C libraries Gramps uses, like gtk.

This is a command-line process. It's not too difficult, but you'll be using Terminal.app, not XCode.

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.

=== Step 1: Install Xcode ===

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://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). You may need to search for an earlier version. For example, as of January 2017, running Mac OS X 10.11 El Capitan it is probably best to use Xcode 7 (e.g. Xcode 7.3.1).

If you are running OSX 10.7 Lion or later, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3]. Building Gramps with Xcode 4.3 or later--which is what is supplied for 10.7 on--produces code that won't run. See https://bugzilla.gnome.org/show_bug.cgi?id=702908 for details.

Earlier version of Xcode were delivered as an installer in a disk image (.dmg). Xcode should be installed in the usual way by double clicking on the installer and following the instructions.

Later versions of Xcode are delivered as an Application (.app) in a disk image, with instructions to copy this to your Applications folder. You probably need to run the Application to get it to install everything - if you don't, when you go on to the next step it will complain that you haven't agreed to the Xcode licence agreement.

=== Step 2: Install jhbuild ===

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing Homebrew, MacPorts, or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.

Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you. (It is assumed here that you have downloaded gtk-osx-build-install.sh into your home directory, and that you run the following command from there).

sudo sh gtk-osx-build-setup.sh

This may produce a number of warnings but they can be ignored:
Checking out jhbuild (7c8d34736c3804) from git...
Cloning into 'jhbuild'...
remote: Counting objects: 45961, done.
remote: Compressing objects: 100% (12945/12945), done.
remote: Total 45961 (delta 35419), reused 42858 (delta 32831)
Receiving objects: 100% (45961/45961), 10.11 MiB | 1.44 MiB/s, done.
Resolving deltas: 100% (35419/35419), done.
Checking connectivity... done.
Switched to a new branch 'stable'
Installing jhbuild...
-n WARNING: aclocal not available (usually part of package 'autoconf')
-n WARNING: automake not available (usually part of package 'automake')
-n WARNING: autopoint not available (usually part of package 'gettext')
-n WARNING: pkg-config not available (usually part of package 'pkgconfig')
-n WARNING: yelp-tools not available (usually part of package 'yelp-tools')
-n Configuring jhbuild without autotools
-n Now type `make' to compile jhbuild
Installing jhbuild configuration...
Installing gtk-osx moduleset files...
PATH does not contain /Users/tim/.local/bin, it is recommended that you add that.
Done.

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

Type:
python
to check which version of python you have (exit from python by typing crtl-D). For example, you may see (with Mac OS X 10.11 El Capitan):
$ python
Python 2.7.10 (default, Oct 23 2015, 19:19:21)
[GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> ^D

This shows you have Python 2.7. As described in [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], if you have a version of Python earlier than 2.5, you have to follow the special instructions to build a Python 2.7 module.

Now type:
jhbuild bootstrap

=== Step 3: Install Gramps dependencies and Gramps ===

==== Gramps 3.4.x ====

Next, you need a copy of the moduleset file. You *could* just pass the url to jhbuild, but it's easier to download it:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps34/mac/gramps.modules

That will retrieve the modules file to 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 command from the terminal:

jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python 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.
Not everything that this procedure builds will be included in the Gramps application bundle; there are some intermediate dependencies and build tools that are necessary for building everything but not required at runtime. '''That doesn't mean that some modules can be skipped.'''

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.modules build meta-gtk-osx-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

==== Gramps 4.x and Later ====

Gramps 4.x is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes. Gramps 4.2 and later are further updated to use Python3 only, which requires more changes.

Download the modules file for the branch you want to build:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps42/mac/gramps.modules

curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps50/mac/gramps.modules
or
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules

The list of targets changes to reflect using Gtk+-3:
jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-freetype meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps-git

For Gramps42 and later it's a bit simpler:
jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap gramps-git

If you want to build the latest release tarball rather than the latest check-in, use <tt>gramps</tt> instead of <tt>gramps-git</tt> for the last module--but note that since we don't release from the <tt>master</tt> branch, <tt>gramps.modules</tt> doesn't have a <tt>gramps</tt> module in <tt>master</tt>.

If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps40
python setup.by build

==== .jhbuildrc-custom ====
It's annoying and error-prone to type the long list of modules every time you want to build gramps, so you may want to modify <tt>~/.jhbuildrc-custom</tt> to declare the <tt>moduleset</tt> and <tt>modules</tt> variables. Note that <tt>.jhbuildrc-custom</tt> is a Python file that is loaded and executed by <tt>jhbuild</tt>, so you can make it quite complex. Do beware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be sure to prefix any top-level variables with '_'.

== Gramps 3.x and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies that JHBuild doesn't know how to handle. Thanks to Gtk+-3, these have been replaced in Gramps-4.0 (and <tt>master</tt>) with a module that JHBuild ''can'' build, so '''these instructions apply only to Gramps-3.4.x'''. 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 or later, 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 --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
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.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

=== Webkit ===
Gramps has an optional dependency on WebKit, which is used for the <tt>html-renderer</tt> add-on. If for some reason you want to use this add-on, add <tt>WebKit</tt> to your list of dependencies but be aware that it take a long time to build.
'''''WebKit will not build on 10.4 (Tiger) 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!'''''

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/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.7.dylib
gtk-mac-bundler ~/gtk/src/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-version", replacing "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 its 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!

[[Category:Developers/General]]

Mac OS X:Application package

2019-08-16T20:37:51Z

Jralls: /* Before installation */ Update MacOS version support

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.

== Before installation ==

'''MacOS versions''' Gramps 5.0 requires Mac OS X 10.9 (Mavericks) and later. Gramps 5.1 requires at least Mac OS X 10.10 (Yosemite).

'''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:''' If you are upgrading from the pre-built Gramps Application version 3.2.3 or earlier (or a build from source version) and you want to keep your old database and settings, you'll need to create a Library/Application Support/gramps folder with your existing data in it. Unless you've changed the location in Preferences, 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.

== Installing Gramps ==

From the '''[[Download#Mac_OS_X]]''' page select either the Intel version or Power PC version. 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.neooffice.org/ NeoOffice], a more mac-friendly version) to work on your reports after saving them from Gramps.

== What goes where ==

'''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): 
* The Gramps database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb. 
* Setting files (ini-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32 
* 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.

== Advanced setup ==

Usually, the default settings will be correct, but occasionally you may need to set things up differently.

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

To read the setting use:
defaults read -app Gramps
this 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

The settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist

To remove the special settings
defaults delete -app Gramps AppleLanguages (or AppleLocale or AppleCollation).

[[Howto:Change the language of reports]] has more information on language features in Gramps. When reading it, 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 LANG variable.

=== 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://archive.services.openoffice.org/pub/mirror/OpenOffice.org/contrib/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).

== Bugs ==

=== If something seems to go wrong ===

You'll find error messages in the console log, which you can view with /Applications/Utilities/Console.app

All of the known bugs in previous version have been corrected in Gramps {{Version_Mac}} and later. There will no doubt be new ones; report them in the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis] ([[Using the bug tracker]] instructions). When reporting what you're sure is an OSX specific bug, please set the Platform field to "mac" (no quotes, caps, or spaces!) so that I can find it easily.

Previous Gramps version 3.2.4, bugs are described at [[Mac OS X:Build from source:gtk-osx:bugs]].

== Updates ==

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 the application and just use it. If you don'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 Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get Info.

[[Category:Developers/Packaging]]
[[Category:Documentation]]

Template:Filename mac intel

2019-08-15T19:24:51Z

Jralls: Correct file name

Gramps-Intel-{{Version_Mac}}-1<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Example.gramps

2018-10-13T14:48:28Z

Jralls: /* Load example.gramps */ No example.gramps on MacOS

Your installation of Gramps should include an example family tree database. This is used to provide a known stable environment for testing.

If you think you have an issue/bug in your ''Family Tree''/database, try the same operation with the example family tree. If the problem happens there as well, then it is probably not due to a [[Recover corrupted family tree|corruption in your data]].

==Load <code>example.gramps</code>==
Follow these steps to load the example family tree:
# Find <code>example.gramps.gz</code> or <code>example.gramps</code> on your system. For example:
## on Linux <code>/usr/share/doc/gramps/example/gramps/</code>
## on MS-Windows AIO <code>C:\Program Files\GrampsAIO64-X.X.X\share\doc\gramps\example\gramps</code> (On MS-Windows ensure you can see hidden files; see [[Gramps_5.0_Wiki_Manual_-_User_Directory#MS_Windows|User Directory:MS Windows]])
## The example database is not included in the MacOS AIO.
# On Linux open <code>example.gramps.gz</code>, and extract <code>example.gramps</code> to a temporary location.
# Start Gramps
# To create a new family tree {{man menu|Family Trees > Manage Family Trees...}} select the {{man button|New}} button. Give it some name, such as ''example''
# Open this new family tree. It will be empty.
# In {{man menu|Edit > Preferences}}, change the {{man label|Base path for relative media paths:}}. This could be in a new directory, to keep it separate to your own family tree media. (eg On Linux <code>~/gramps/example/</code>)
# Copy the media files from the example directory (that you found in step 1, above) to this media path directory.
# In Gramps, use {{man menu|Family Trees > Import...}} to import <code>example.gramps</code>.

==See also==
* [[How to make a backup]]
* [[Recover corrupted family tree]]

[[Category:Documentation]]
[[Category:Gramps Examples]]
[[Category:Genealogy]]
[[Category:Developers/General]]

Mac OS X:Build from source:Application package

2018-08-09T14:15:27Z

Jralls: /* Gramps 4.x and Later */ Correct moduleset path for consistency.

==Building Gramps from Scratch==

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

This is a command-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 or vice-versa, so the whole process must be repeated on machines of each architecture. '''''N.B. This procedure has not been tested against OS X 10.4 Tiger. Some packages may not be compatible with that very old version of OS X.'''''

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.

=== Step 1: Install Xcode ===

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://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). You may need to search for an earlier version. For example, as of January 2017, running Mac OS X 10.11 El Capitan it is probably best to use Xcode 7 (e.g. Xcode 7.3.1).

If you are running OSX 10.7 Lion or later, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3]. Building Gramps with Xcode 4.3 or later--which is what is supplied for 10.7 on--produces code that won't run. See https://bugzilla.gnome.org/show_bug.cgi?id=702908 for details.

Earlier version of Xcode were delivered as an installer in a disk image (.dmg). Xcode should be installed in the usual way by double clicking on the installer and following the instructions.

Later versions of Xcode are delivered as an Application (.app) in a disk image, with instructions to copy this to your Applications folder. You probably need to run the Application to get it to install everything - if you don't, when you go on to the next step it will complain that you haven't agreed to the Xcode licence agreement.

=== Step 2: Install jhbuild ===

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing Homebrew, MacPorts, or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.

Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you. (It is assumed here that you have downloaded gtk-osx-build-install.sh into your home directory, and that you run the following command from there).

sudo sh gtk-osx-build-setup.sh

This may produce a number of warnings but they can be ignored:
Checking out jhbuild (7c8d34736c3804) from git...
Cloning into 'jhbuild'...
remote: Counting objects: 45961, done.
remote: Compressing objects: 100% (12945/12945), done.
remote: Total 45961 (delta 35419), reused 42858 (delta 32831)
Receiving objects: 100% (45961/45961), 10.11 MiB | 1.44 MiB/s, done.
Resolving deltas: 100% (35419/35419), done.
Checking connectivity... done.
Switched to a new branch 'stable'
Installing jhbuild...
-n WARNING: aclocal not available (usually part of package 'autoconf')
-n WARNING: automake not available (usually part of package 'automake')
-n WARNING: autopoint not available (usually part of package 'gettext')
-n WARNING: pkg-config not available (usually part of package 'pkgconfig')
-n WARNING: yelp-tools not available (usually part of package 'yelp-tools')
-n Configuring jhbuild without autotools
-n Now type `make' to compile jhbuild
Installing jhbuild configuration...
Installing gtk-osx moduleset files...
PATH does not contain /Users/tim/.local/bin, it is recommended that you add that.
Done.

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

Type:
python
to check which version of python you have (exit from python by typing crtl-D). For example, you may see (with Mac OS X 10.11 El Capitan):
$ python
Python 2.7.10 (default, Oct 23 2015, 19:19:21)
[GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> ^D

This shows you have Python 2.7. As described in [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], if you have a version of Python earlier than 2.5, you have to follow the special instructions to build a Python 2.7 module.

Now type:
jhbuild bootstrap

=== Step 3: Install Gramps dependencies and Gramps ===

==== Gramps 3.4.x ====

Next, you need a copy of the moduleset file. You *could* just pass the url to jhbuild, but it's easier to download it:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps34/mac/gramps.modules

That will retrieve the modules file to 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 command from the terminal:

jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python 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.
Not everything that this procedure builds will be included in the Gramps application bundle; there are some intermediate dependencies and build tools that are necessary for building everything but not required at runtime. '''That doesn't mean that some modules can be skipped.'''

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.modules build meta-gtk-osx-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

==== Gramps 4.x and Later ====

Gramps 4.x is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes. Gramps 4.2 and later are further updated to use Python3 only, which requires more changes.

Download the modules file for the branch you want to build:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps42/mac/gramps.modules

curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps50/mac/gramps.modules
or
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules

The list of targets changes to reflect using Gtk+-3:
jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-freetype meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps-git

For Gramps42 and later it's a bit simpler:
jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap gramps-git

If you want to build the latest release tarball rather than the latest check-in, use <tt>gramps</tt> instead of <tt>gramps-git</tt> for the last module--but note that since we don't release from the <tt>master</tt> branch, <tt>gramps.modules</tt> doesn't have a <tt>gramps</tt> module in <tt>master</tt>.

If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps40
python setup.by build

==== .jhbuildrc-custom ====
It's annoying and error-prone to type the long list of modules every time you want to build gramps, so you may want to modify <tt>~/.jhbuildrc-custom</tt> to declare the <tt>moduleset</tt> and <tt>modules</tt> variables. Note that <tt>.jhbuildrc-custom</tt> is a Python file that is loaded and executed by <tt>jhbuild</tt>, so you can make it quite complex. Do beware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be sure to prefix any top-level variables with '_'.

== Gramps 3.x and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies that JHBuild doesn't know how to handle. Thanks to Gtk+-3, these have been replaced in Gramps-4.0 (and <tt>master</tt>) with a module that JHBuild ''can'' build, so '''these instructions apply only to Gramps-3.4.x'''. 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 or later, 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 --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
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.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

=== Webkit ===
Gramps has an optional dependency on WebKit, which is used for the <tt>html-renderer</tt> add-on. If for some reason you want to use this add-on, add <tt>WebKit</tt> to your list of dependencies but be aware that it take a long time to build.
'''''WebKit will not build on 10.4 (Tiger) 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!'''''

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/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.7.dylib
gtk-mac-bundler ~/gtk/src/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!

[[Category:Developers/General]]

Mac OS X:Build from source:Application package

2018-08-09T14:14:12Z

Jralls: /* Gramps 3.4.x */ Correct path to moduleset for consistency.

==Building Gramps from Scratch==

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

This is a command-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 or vice-versa, so the whole process must be repeated on machines of each architecture. '''''N.B. This procedure has not been tested against OS X 10.4 Tiger. Some packages may not be compatible with that very old version of OS X.'''''

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.

=== Step 1: Install Xcode ===

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://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). You may need to search for an earlier version. For example, as of January 2017, running Mac OS X 10.11 El Capitan it is probably best to use Xcode 7 (e.g. Xcode 7.3.1).

If you are running OSX 10.7 Lion or later, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3]. Building Gramps with Xcode 4.3 or later--which is what is supplied for 10.7 on--produces code that won't run. See https://bugzilla.gnome.org/show_bug.cgi?id=702908 for details.

Earlier version of Xcode were delivered as an installer in a disk image (.dmg). Xcode should be installed in the usual way by double clicking on the installer and following the instructions.

Later versions of Xcode are delivered as an Application (.app) in a disk image, with instructions to copy this to your Applications folder. You probably need to run the Application to get it to install everything - if you don't, when you go on to the next step it will complain that you haven't agreed to the Xcode licence agreement.

=== Step 2: Install jhbuild ===

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing Homebrew, MacPorts, or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.

Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you. (It is assumed here that you have downloaded gtk-osx-build-install.sh into your home directory, and that you run the following command from there).

sudo sh gtk-osx-build-setup.sh

This may produce a number of warnings but they can be ignored:
Checking out jhbuild (7c8d34736c3804) from git...
Cloning into 'jhbuild'...
remote: Counting objects: 45961, done.
remote: Compressing objects: 100% (12945/12945), done.
remote: Total 45961 (delta 35419), reused 42858 (delta 32831)
Receiving objects: 100% (45961/45961), 10.11 MiB | 1.44 MiB/s, done.
Resolving deltas: 100% (35419/35419), done.
Checking connectivity... done.
Switched to a new branch 'stable'
Installing jhbuild...
-n WARNING: aclocal not available (usually part of package 'autoconf')
-n WARNING: automake not available (usually part of package 'automake')
-n WARNING: autopoint not available (usually part of package 'gettext')
-n WARNING: pkg-config not available (usually part of package 'pkgconfig')
-n WARNING: yelp-tools not available (usually part of package 'yelp-tools')
-n Configuring jhbuild without autotools
-n Now type `make' to compile jhbuild
Installing jhbuild configuration...
Installing gtk-osx moduleset files...
PATH does not contain /Users/tim/.local/bin, it is recommended that you add that.
Done.

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

Type:
python
to check which version of python you have (exit from python by typing crtl-D). For example, you may see (with Mac OS X 10.11 El Capitan):
$ python
Python 2.7.10 (default, Oct 23 2015, 19:19:21)
[GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> ^D

This shows you have Python 2.7. As described in [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], if you have a version of Python earlier than 2.5, you have to follow the special instructions to build a Python 2.7 module.

Now type:
jhbuild bootstrap

=== Step 3: Install Gramps dependencies and Gramps ===

==== Gramps 3.4.x ====

Next, you need a copy of the moduleset file. You *could* just pass the url to jhbuild, but it's easier to download it:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps34/mac/gramps.modules

That will retrieve the modules file to 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 command from the terminal:

jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python 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.
Not everything that this procedure builds will be included in the Gramps application bundle; there are some intermediate dependencies and build tools that are necessary for building everything but not required at runtime. '''That doesn't mean that some modules can be skipped.'''

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.modules build meta-gtk-osx-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

==== Gramps 4.x and Later ====

Gramps 4.x is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes. Gramps 4.2 and later are further updated to use Python3 only, which requires more changes.

Download the modules file for the branch you want to build:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps42/mac/gramps.modules

curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps50/mac/gramps.modules
or
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules

The list of targets changes to reflect using Gtk+-3:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-freetype meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps-git

For Gramps42 and later it's a bit simpler:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap gramps-git

If you want to build the latest release tarball rather than the latest check-in, use <tt>gramps</tt> instead of <tt>gramps-git</tt> for the last module--but note that since we don't release from the <tt>master</tt> branch, <tt>gramps.modules</tt> doesn't have a <tt>gramps</tt> module in <tt>master</tt>.

If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps40
python setup.by build

==== .jhbuildrc-custom ====
It's annoying and error-prone to type the long list of modules every time you want to build gramps, so you may want to modify <tt>~/.jhbuildrc-custom</tt> to declare the <tt>moduleset</tt> and <tt>modules</tt> variables. Note that <tt>.jhbuildrc-custom</tt> is a Python file that is loaded and executed by <tt>jhbuild</tt>, so you can make it quite complex. Do beware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be sure to prefix any top-level variables with '_'.

== Gramps 3.x and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies that JHBuild doesn't know how to handle. Thanks to Gtk+-3, these have been replaced in Gramps-4.0 (and <tt>master</tt>) with a module that JHBuild ''can'' build, so '''these instructions apply only to Gramps-3.4.x'''. 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 or later, 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 --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
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.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

=== Webkit ===
Gramps has an optional dependency on WebKit, which is used for the <tt>html-renderer</tt> add-on. If for some reason you want to use this add-on, add <tt>WebKit</tt> to your list of dependencies but be aware that it take a long time to build.
'''''WebKit will not build on 10.4 (Tiger) 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!'''''

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/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.7.dylib
gtk-mac-bundler ~/gtk/src/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!

[[Category:Developers/General]]

Mac OS X:Build from source:Application package

2018-08-09T14:13:00Z

Jralls: /* Gramps 3.4.x */ Correct markup

==Building Gramps from Scratch==

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

This is a command-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 or vice-versa, so the whole process must be repeated on machines of each architecture. '''''N.B. This procedure has not been tested against OS X 10.4 Tiger. Some packages may not be compatible with that very old version of OS X.'''''

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.

=== Step 1: Install Xcode ===

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://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). You may need to search for an earlier version. For example, as of January 2017, running Mac OS X 10.11 El Capitan it is probably best to use Xcode 7 (e.g. Xcode 7.3.1).

If you are running OSX 10.7 Lion or later, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3]. Building Gramps with Xcode 4.3 or later--which is what is supplied for 10.7 on--produces code that won't run. See https://bugzilla.gnome.org/show_bug.cgi?id=702908 for details.

Earlier version of Xcode were delivered as an installer in a disk image (.dmg). Xcode should be installed in the usual way by double clicking on the installer and following the instructions.

Later versions of Xcode are delivered as an Application (.app) in a disk image, with instructions to copy this to your Applications folder. You probably need to run the Application to get it to install everything - if you don't, when you go on to the next step it will complain that you haven't agreed to the Xcode licence agreement.

=== Step 2: Install jhbuild ===

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing Homebrew, MacPorts, or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.

Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you. (It is assumed here that you have downloaded gtk-osx-build-install.sh into your home directory, and that you run the following command from there).

sudo sh gtk-osx-build-setup.sh

This may produce a number of warnings but they can be ignored:
Checking out jhbuild (7c8d34736c3804) from git...
Cloning into 'jhbuild'...
remote: Counting objects: 45961, done.
remote: Compressing objects: 100% (12945/12945), done.
remote: Total 45961 (delta 35419), reused 42858 (delta 32831)
Receiving objects: 100% (45961/45961), 10.11 MiB | 1.44 MiB/s, done.
Resolving deltas: 100% (35419/35419), done.
Checking connectivity... done.
Switched to a new branch 'stable'
Installing jhbuild...
-n WARNING: aclocal not available (usually part of package 'autoconf')
-n WARNING: automake not available (usually part of package 'automake')
-n WARNING: autopoint not available (usually part of package 'gettext')
-n WARNING: pkg-config not available (usually part of package 'pkgconfig')
-n WARNING: yelp-tools not available (usually part of package 'yelp-tools')
-n Configuring jhbuild without autotools
-n Now type `make' to compile jhbuild
Installing jhbuild configuration...
Installing gtk-osx moduleset files...
PATH does not contain /Users/tim/.local/bin, it is recommended that you add that.
Done.

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

Type:
python
to check which version of python you have (exit from python by typing crtl-D). For example, you may see (with Mac OS X 10.11 El Capitan):
$ python
Python 2.7.10 (default, Oct 23 2015, 19:19:21)
[GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> ^D

This shows you have Python 2.7. As described in [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], if you have a version of Python earlier than 2.5, you have to follow the special instructions to build a Python 2.7 module.

Now type:
jhbuild bootstrap

=== Step 3: Install Gramps dependencies and Gramps ===

==== Gramps 3.4.x ====

Next, you need a copy of the moduleset file. You *could* just pass the url to jhbuild, but it's easier to download it:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps34/mac/gramps.modules

That will retrieve the modules file to 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 command from the terminal:

jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python 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.
Not everything that this procedure builds will be included in the Gramps application bundle; there are some intermediate dependencies and build tools that are necessary for building everything but not required at runtime. '''That doesn't mean that some modules can be skipped.'''

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-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

==== Gramps 4.x and Later ====

Gramps 4.x is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes. Gramps 4.2 and later are further updated to use Python3 only, which requires more changes.

Download the modules file for the branch you want to build:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps42/mac/gramps.modules

curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps50/mac/gramps.modules
or
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules

The list of targets changes to reflect using Gtk+-3:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-freetype meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps-git

For Gramps42 and later it's a bit simpler:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap gramps-git

If you want to build the latest release tarball rather than the latest check-in, use <tt>gramps</tt> instead of <tt>gramps-git</tt> for the last module--but note that since we don't release from the <tt>master</tt> branch, <tt>gramps.modules</tt> doesn't have a <tt>gramps</tt> module in <tt>master</tt>.

If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps40
python setup.by build

==== .jhbuildrc-custom ====
It's annoying and error-prone to type the long list of modules every time you want to build gramps, so you may want to modify <tt>~/.jhbuildrc-custom</tt> to declare the <tt>moduleset</tt> and <tt>modules</tt> variables. Note that <tt>.jhbuildrc-custom</tt> is a Python file that is loaded and executed by <tt>jhbuild</tt>, so you can make it quite complex. Do beware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be sure to prefix any top-level variables with '_'.

== Gramps 3.x and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies that JHBuild doesn't know how to handle. Thanks to Gtk+-3, these have been replaced in Gramps-4.0 (and <tt>master</tt>) with a module that JHBuild ''can'' build, so '''these instructions apply only to Gramps-3.4.x'''. 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 or later, 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 --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
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.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

=== Webkit ===
Gramps has an optional dependency on WebKit, which is used for the <tt>html-renderer</tt> add-on. If for some reason you want to use this add-on, add <tt>WebKit</tt> to your list of dependencies but be aware that it take a long time to build.
'''''WebKit will not build on 10.4 (Tiger) 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!'''''

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/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.7.dylib
gtk-mac-bundler ~/gtk/src/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!

[[Category:Developers/General]]

Template:Filename mac intel

2018-08-05T23:53:02Z

Jralls: New dmg for bug 10705.

Gramps-Intel-{{Version_Mac}}-2<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Gramps 5.0 Wiki Manual - Keybindings

2018-06-11T03:03:01Z

Jralls: /* Common bindings */ Bug 10619 Conflicting keybindings

{{man index|Gramps 5.0 Wiki Manual - FAQ|Gramps 5.0 Wiki Manual - Command Line|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Keybindings}}
{{#vardefine:chapter|B}}
{{#vardefine:figure|0}}
This appendix lists keybindings (also known as ''Keyboard shortcuts'') you can use on the Gramps dialogs, so as to avoid the use of the mouse.

Some keyboard shortcuts require the user to press a single key or a sequence of keys one after the other. Other keyboard shortcuts require pressing and holding several keys simultaneously. Keyboard shortcuts may depend on the keyboard layout (localisation) and on your computers operating systems.

== List Views ==
=== Common bindings ===

The following bindings are available in all category views.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="1" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|Manage family trees]]
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="2" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import family tree]]
| |{{Man key press|Ctrl|I}}
| |{{Man key press|Cmd|I}}
| |{{Man key press|Ctrl|I}}
|-
| id="3" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|Export family tree]]
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="4" | Changes to the next [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|N}}
| |{{Man key press|Cmd|N}}
| |{{Man key press|Ctrl|N}}
|-
| id="5" |Changes to the previous [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="45" |Change [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]] to Category number 0/1/2/../9
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}} ...
| |{{Man key press|Cmd|1}} {{Man key press|Cmd|2}} {{Man key press|Cmd|3}}..
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}}..
|-
| id="6" |Within the Category changes the [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Views|view]] to view number 0/1/2/../9
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}} ...
| |{{Man key press|Cmd|Alt|1}} {{Man key press|Cmd|Alt|2}} {{Man key press|Cmd|Alt|3}}..
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}}..
|-
| id="7" |Toggle the left gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Navigator|Navigator]] panel)
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|-
| id="8" |[[Gramps_5.0_Wiki_Manual_-_Navigation#Using_the_Clipboard|Open the Clipboard]]
| |{{Man key press|Ctrl|B}}
| |{{Man key press|Cmd|B}}
| |{{Man key press|Ctrl|B}}
|-
| id="9" |Add the selected item as a [[Gramps_5.0_Wiki_Manual_-_Navigation#Bookmarks|bookmark]]
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="10" |[[Gramps_5.0_Wiki_Manual_-_Navigation#Bookmarks|Organize the bookmarks]]
| |{{Man key press|Shift|Ctrl|D}}
| |{{Man key press|Shift|Cmd|D}}
| |{{Man key press|Shift|Ctrl|D}}
|-
| id="11" |Open the {{man label|[[Gramps_5.0_Wiki_Manual_-_Navigation#Edit|Undo History]]}} dialog
| |{{Man key press|Ctrl|H}}
| |{{Man key press|Shift|Cmd|H}}
| |{{Man key press|Ctrl|H}}
|-
| id="12" |Jump to an Gramps ID
| |{{Man key press|Ctrl|J}}
| |{{Man key press|Cmd|J}}
| |{{Man key press|Ctrl|J}}
|-
| id="13" |Move to previous item in history
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Alt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="14" |Move to next item in history
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctrl|Alt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|-
| id="15" |Go to the '''[[Gramps_5.0_Wiki_Manual_-_Settings#Setting_Home_person|Home Person]]'''
| |{{Man key press|Alt|Home}}
| |
| |{{Man key press|Alt|Home}}
|-
| id="16" |Configure active view
| |{{Man key press|Shift|Ctrl|C}}
| |{{Man key press|Shift|Cmd|C}}
| |{{Man key press|Shift|Ctrl|C}}
|-
| id="17" |Toggle the right gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Sidebar]])
| |{{Man key press|Shift|Ctrl|R}}
| |{{Man key press|Shift|Cmd|R}}
| |{{Man key press|Shift|Ctrl|R}}
|-
| id="18" |Toggle the bottom gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Bottombar]])
| |{{Man key press|Shift|Ctrl|B}}
| |{{Man key press|Shift|Cmd|B}}
| |{{Man key press|Shift|Ctrl|B}}
|-
| id="19" |Undo
| |{{Man key press|Ctrl|Z}}
| |{{Man key press|Cmd|Z}}
| |{{Man key press|Ctrl|Z}}
|-
| id="20" |Do again
| |{{Man key press|Shift|Ctrl|Z}}
| |{{Man key press|Shift|Cmd|Z}}
| |{{Man key press|Shift|Ctrl|Z}}
|-
| id="21" |Quit Gramps
| |{{Man key press|Ctrl|Q}}
| |{{Man key press|Cmd|Q}}
| |{{Man key press|Ctrl|Q}}
|-
| id="xx" | [[Gramps_5.0_Wiki_Manual_-_Navigation#Add|Add/Create]] a new object (Opens the related Editor) Person Family Event Place Source Citation Repository Media Note
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
| | {{Man key press|Shift|Ctrl|Alt|P}} {{Man key press|Shift|Ctrl|Alt|F}} {{Man key press|Shift|Ctrl|Alt|E}} {{Man key press|Shift|Ctrl|Alt|L}} {{Man key press|Shift|Ctrl|Alt|S}} {{Man key press|Shift|Ctrl|Alt|C}} {{Man key press|Shift|Ctrl|Alt|R}} {{Man key press|Shift|Ctrl|Alt|M}} {{Man key press|Shift|Ctrl|Alt|N}}
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
|}

=== All List Views bindings ===

The following bindings are available in all list views: People, Families, Events, Places, Sources, Citations, Repositories, Media and Notes View.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="22" |Edits the selected list item
| |{{Man key press|Ctrl|Enter}}
| |
| |{{Man key press|Ctrl|Enter}}
| |
|-
| id="23" |Adds a new item to the database
| |{{Man key press|Ctrl|Insert}}
| |
| |{{Man key press|Ctrl|Insert}}
| |
|-
| id="24" |Deletes the selected list item
| |{{Man key press|Ctrl|Delete}}
| |
| |{{Man key press|Ctrl|Delete}}
| |
|-
| id="46" |Activate the {{man button|Find}} field
|!-- Microsoft Windows --> |{{Man key press|Ctrl|F}}
|!-- Mac OS --> |{{Man key press|Cmd|F}}
|!-- KDE/GNOME --> |{{Man key press|Ctrl|F}}
| | List view interactive search ahead / Quick search
|}

=== People View bindings ===

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="25" |Expands and hides entries of the selected surname in Group mode
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|}

==Editors==

=== Editor Tab bindings ===
These bindings work on the tab pages of the editors (so not on the labels of the tabs!, press tab on label to move to tabpage content).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="26" |Same action as the {{icon|Stock_edit}} button when that button is present
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|-
| id="27" |Same action as the {{icon|Stock_add}} button when that button is present
|{{Man key press|Insert}}
|
|{{Man key press|Insert}}
|-
| id="28" |Same action as the {{icon|Stock_remove}} button when that button is present
|{{Man key press|Delete}}
|
|{{Man key press|Delete}}
|-
| id="29" |Same action as the {{man button|Share}} button when that button is present
|{{Man key press|Ctrl|O}}
|{{Man key press|Cmd|O}}
|{{Man key press|Ctrl|O}}
|-
| id="30" |Change tabpage to the tabpage to the left
|{{Man key press|Alt|Left}} (Left arrow)
|{{Man key press|Ctrl|Alt|Left}} (Left arrow)
|{{Man key press|Alt|Left}} (Left arrow)
|-
| id="31" |Change tabpage to the tabpage to the right
|{{Man key press|Alt|Right}} (Right arrow)
|{{Man key press|Ctlr|Alt|Right}} (Right arrow)
|{{Man key press|Alt|Right}} (Right arrow)
|}

{|{{prettytable}}
!Action/Function
!Mouse Key
|-
| id="32" |Call up [https://en.wikipedia.org/wiki/Context_menu context menu] popup
!Right-click
|-
| id="33" |Same action as the {{icon|Stock_edit}} {{man button|Edit}} button when that button is present
!Double-click
|-
| id="34" |Common action that is not the same as {{icon|Stock_edit}} {{man button|Edit}} button. Eg: on Family Editor Child tab, edit child
!Middle-click
|}

=== Editor bindings ===
These bindings work on Editors by activating focus or by changing state of toggle buttons ([[Accessibility]]).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="35" |Change the privacy status.
|{{Man key press|Ctrl|P}}
|{{Man key press|Cmd|P}}
|{{Man key press|Ctrl|P}}
|-
| id="36" |Call the Date editor (if present).
|{{Man key press|Ctrl|D}}
|{{Man key press|Cmd|D}}
|{{Man key press|Ctrl|D}}
|-
| id="37" |Activate the {{icon|Stock_add}} {{man button|Add}} button (if present).
|{{Man key press|Ctrl|A}}
|{{Man key press|Cmd|A}}
|{{Man key press|Ctrl|A}}
|-
| id="38" |Activate the {{icon|Stock_edit}} {{man button|Edit}} button (if present).
|{{Man key press|Ctrl|E}}
|{{Man key press|Cmd|E}}
|{{Man key press|Ctrl|E}}
|-
| id="39" |Activate the {{man button|Select}} button (if present).
|{{Man key press|Ctrl|S}}
|{{Man key press|Cmd|S}}
|{{Man key press|Ctrl|S}}
|-
| id="40" |Activate the {{man button|Father}} button (if present).
|{{Man key press|Ctrl|F}}
|{{Man key press|Cmd|F}}
|{{Man key press|Ctrl|F}}
|-
| id="41" |Activate the {{man button|Mother}} button (if present).
|{{Man key press|Ctrl|M}}
|{{Man key press|Cmd|M}}
|{{Man key press|Ctrl|M}}
|}

==Handy Shortcuts==

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="42" |Full screen
|{{man key press|F11}}
|
|{{man key press|F11}}
|Maximises Gramps to use the Full screen
|-
| id="43" |Show this user manual
|{{man key press|F1}}
|{{man key press|F1}}
|{{man key press|F1}}
|
|-
| id="44" |Select the {{man button|OK}} button
|{{man key press|Alt}}+{{man key press|O}}
|
|
|Handy for those of you with low resolution screens
|}

== See also ==
* [http://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts Table of keyboard shortcuts] - for major operating systems.

{{-}}
{{man index|Gramps 5.0 Wiki Manual - FAQ|Gramps 5.0 Wiki Manual - Command Line|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Keybindings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Download

2018-02-16T04:02:12Z

Jralls: /* Mac OS X */ Remove PPC, no longer supported.

{{languages}}
'''Research, organize and share your family tree with Gramps.'''

Gramps is a free software project and community. We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists. It is a community project, created, developed and governed by genealogists.

{{man note|{{Man menu|'''Current version: {{version}} Released: 2018-02-09'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as Python 2 support dropped. Uses GTK+ 3 GUI. Lot of updates see:.''[[Gramps_4.2_Wiki_Manual_-_What's_new%3F|What's new?]]}}

{{man warn|Final ''Legacy version: 3.4.9 Released: 2015-04-30|This is the final maintenance release designed for those of you still running gramps with gtk2. The database is common between version 4.0.x (not version 4.1.x and version 4.2.x) and 3.4.x branch, most differences are into interface...''[https://gramps-project.org/2015/04/gramps-3-4-9-released/]}}

== Linux ==

[[File:Linux_220x261.png|128px|left]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==

[[File:windows_180x160.png|128px|left]]

Before download: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

Supports Microsoft Windows in all versions [http://windows.microsoft.com/en-au/windows/lifecycle Vista/7] and later.(''Please note: Python-3.5 and Gtk-3.18 dropped support for Windows XP not Gramps itself. Gramps can still be run on Windows XP with older versions of those libraries eg:(Gtk-3.16 & Python3.4.4)'')

<big>[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]
    
[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]</big>

After download: double-click to install Gramps. {{man menu|Standard setup is ''English only'' so if using a different language please ensure that you select extra dictionary and language files when asked during the installation process.}}

{{man tip|Shortcuts|Once installed one shortcut is placed on the desktop and in the Start menu two shortcuts are added, please only use the first shortcut, unless requested by a developer. 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu|<--- Shortcut for everyday use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console)}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. However if this fails for any reason, '''Create''' a new Family Tree and '''Import''' the back-up into this new Tree.

Use the Windows AIO version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO-4|this page]] (English only).

Alternative independent '''Legacy''' MS Windows version [[#3|[3]]].

You may also install using the alternative independent Gramps Chocolatey Package [[#4|[4]]].

== Mac OS X ==

[[File:macos_200x200.png|128px|left]]

Before download: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Supports Mac OS X in all versions 10.5 (Leopard) and later.

<big>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]</big>
    

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next drag the Gramps application to your application folder and double-click to launch it [[#2|[2]]].

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. However if this fails for any reason, '''Create''' a new Family Tree and '''Import''' the back-up into this new Tree.

{{man tip|Spell Checking:|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [http://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== BSD ==

[[File:Bsd daemon.jpg|128px|left]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>
{{-}}

== Live CD ==

[[File:Download_link.png|150px|left|link=https://sourceforge.net/projects/gramps/files/gramps-cdrom/lgenealogy-6.1-desktop-i386.iso/download]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn..). [[Linux_Genealogy_CD#Download_the_CD|Download the CD]] (727 MB). The [[Linux Genealogy CD|Linux Genealogy CD is based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu] and Gramps from the CD anytime you like.
{{-}}
[[File:Download_link.png|150px|left|link=http://cdimage.ubuntu.com/edubuntu/releases/14.04/release/]]
'''Edubuntu 14.04.3''' includes Gramps 4.0.3-1 (For information about Edubuntu [http://www.edubuntu.org/news/14.04.2-release visit])
{{-}}

=== Online Demonstration ===
You can also try an online demonstration of Gramps on rollApp:
* https://www.rollapp.com/app/gramps
Select '''Launch Online''' then '''Test Drive(Opening/saving files will not be available)'''

{{man note|Note|This is a commercial limited trial and not endorsed by the Gramps-project. Beware of third parties having your genealogical data.}}
{{-}}

== Linux and BSD distributions ==
{{man note|These packages are built and supported by the [https://en.wikipedia.org/wiki/Linux_distribution distros].|Please report any problems with them to the package maintainer.}}
Most Linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

{| {{prettytable}}
!style="width: 85pt;" | Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[File:Debianopenlogo-32.png]]''' [[Debian]] '''
|Add/Remove Software
|Debian 7 ("wheezy") (old old stable): Gramps 3.4.0 Debian 8 ("jessie")(old stable): Gramps 4.1.1 Debian 8 ("jessie")(backports): Gramps 4.2.5 Debian 8 ("jessie")(backports-sloppy): Gramps 4.2.6 Debian 9 ("stretch") (stable): Gramps 4.2.5 Debian 9 ("stretch")(backports): Gramps 4.2.6 buster (testing): Gramps 4.2.6 [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 4.2.6
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[File:Ubuntu_32x32.png]]''' Ubuntu '''
|Software Centre
|Trusty (14.04 LTS): Gramps: 4.0.3 Trusty (14.04 LTS): Gramps: 4.2.3 ([https://launchpad.net/~rosco2/+archive/ubuntu/backports Backport]) Xenial (16.04 LTS): Gramps: 4.2.2 Xenial (16.04 LTS): Gramps: 4.2.6 ([https://launchpad.net/~rosco2/+archive/ubuntu/backports Backport]) Zesty (17.04): Gramps: 4.2.5 Zesty (17.04): Gramps: 4.2.6 ([https://launchpad.net/~rosco2/+archive/ubuntu/backports Backport]) Artful (Development: 17.10): Gramps: 4.2.6
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]
|-
|[[File:Farm-Fresh linux mint.png]]''' Linux Mint'''
|Software Manager
|17.x(Gramps 4.0.3+dfsg-2) 18.x(Gramps 4.2.2~dfsg-1)
|Install the most current version of Gramps using the following [https://forums.linuxmint.com/viewtopic.php?t=220159 instructions] from the ''Linux Mint Forums'' [http://community.linuxmint.com/software/view/gramps Old versions available from Linuxmint]
|-
|[[File:Fedora_32x32.png]]''' Fedora '''
|Add/Remove Software (Gnome) or Software Management (KDE)
|Rawhide (Gramps 4.2.7) Fedora 27 (Gramps 4.2.6) Fedora 26 (Gramps 4.2.6) Fedora 25 (Gramps 4.2.6)
|[https://apps.fedoraproject.org/packages/gramps available versions] / Note:The Fedora and Red Hat Projects were merged on September 22, 2003.
|-
|'''[https://www.mageia.org/en/ Mageia]'''
||[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|Mageia Caulron: Gramps 4.2.5 Mageia 5.0: Gramps 4.1.3
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|''' openSUSE '''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|openSUSE Tumbleweed: Gramps 4.2.6 openSUSE Leap 42.3: Gramps 4.2.4 openSUSE Leap 42.2: Gramps 4.2.4
|[http://software.opensuse.org/package/gramps available versions] See note [https://sourceforge.net/p/gramps/mailman/message/34367773/] : Gramps 4.2.x can be installed on Opensuse 13.2 ( if you add the 'openSUSE BuildService - GNOME:Apps' )
|-
|'''Slackware'''
|
|14.2: Gramps 3.4.3 14.1: Gramps 4.0.3
|[http://pkgs.org/search/?keyword=gramps available versions] [https://slackbuilds.org/repository/14.2/misc/gramps/?search=gramps slackbuilds.org]: Gramps 4.2.6
|-
|'''[https://www.netbsd.org/ NetBSD]'''
|
|NetBSD: Gramps 3.4.4
|[http://pkgsrc.se/databases/gramps3 available versions]
|-
|'''[https://www.freebsd.org/ FreeBSD]'''
|
|FreeBSD: Gramps 4.2.4
|[http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps available versions]
|-
|'''TrueOS'''
|
|PC-BSD: Gramps 3.4.8
|[http://web.pcbsd.org/pc-bsd-is-now-trueos/ 2016/09/01 - PC-BSD is now TrueOS]
|-
|'''[https://www.openbsd.org/ OpenBSD]'''
|
|OpenBSD: Gramps 4.2.6
|[http://openports.se/misc/gramps available versions]
|-
|[[File:archlinux-icon-crystal-32.svg]]'''[https://www.archlinux.org/ Arch Linux]'''
|
| Gramps 4.2.6
|[https://www.archlinux.org/packages/community/any/gramps/ available versions]
|-
|'''Gentoo Linux'''
|
| Gramps 4.2.5
|[https://packages.gentoo.org/packages/app-misc/gramps available versions]
|-
|
|
|
|
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually.

{{man warn|1=Warning before attempting this use your existing installation to [[How to make a backup|make a Gramps XML backup]]|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 3.4.3 to 3.4.4), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 2.y.z to 3.y.z), then the danger that it does not work properly is much greater.}}

=== Debian-based ===
For [[Image:Debianopenlogo-32.png]]'''[[Debian|Debian-based linux distributions]]''' (Which includes [[Image:Ubuntu_32x32.png]]''' Ubuntu ''') [{{github_url}}/releases/v{{version}} Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved (change the filename to match the one you downloaded).

sudo dpkg -i python3-gramps_{{version}}-1_all.deb

If you have an error about having unmet dependencies run:

sudo apt-get -f install

to install the dependencies.

==== Useful command lines ====
Before upgrading you can[https://sourceforge.net/p/gramps/mailman/message/35460486/]:

* Find out what version you are running, by using this:

dpkg-query -s python3-gramps

that queries the package and gives you info about it.

* If you are committed to an upgrade then make sure you have backed up you Family Trees to Gramps XML then run :

sudo dpkg -r python3-gramps

this will remove the current gramps package (assuming its a python3 version older versions could be python-gramps )

* To stop Ubuntu updating gramps (to possibly an older version from Ubuntu!) you may need to run:

sudo apt-mark hold gramps

'''Upgrade is then complete.'''

=== For other distributions ===
For other distributions, [[Image:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data. See : [[How to make a backup]]

[2]
Alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.

[3]
An alternative independent '''Legacy''' version is [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_{{version_windows_portable}}.paf.exe] (29.0 MB)
[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' By Bart.S - '''[http://portableapps.com/blog/84601 Please report packaging issues to the author.]''' (2012-09-07)

[4]
Chocolatey NuGet is a Machine Package Manager, somewhat like apt-get, but built with Windows in mind. [https://chocolatey.org/packages/gramps/ Gramps Chocolatey Package]

== See also ==
* [[Previous releases of Gramps]]

[[Category:Documentation]]

Template:Version Mac

2018-02-16T04:00:00Z

Jralls: Release 4.2.8

4.2.8<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Gramps 5.0 Wiki Manual - Keybindings

2018-02-09T03:42:29Z

Jralls: /* Editor Tab bindings */ Update Mac keybindings for bug 6943

{{man index|Gramps 5.0 Wiki Manual - FAQ|Gramps 5.0 Wiki Manual - Command Line|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Keybindings}}
{{#vardefine:chapter|B}}
{{#vardefine:figure|0}}
This appendix lists keybindings (also known as ''Keyboard shortcuts'') you can use on the Gramps dialogs, so as to avoid the use of the mouse.

Some keyboard shortcuts require the user to press a single key or a sequence of keys one after the other. Other keyboard shortcuts require pressing and holding several keys simultaneously. Keyboard shortcuts may depend on the keyboard layout (localisation) and on your computers operating systems.

== List Views ==
=== Common bindings ===

The following bindings are available in all category views.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="1" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|Manage family trees]]
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="2" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import family tree]]
| |{{Man key press|Ctrl|I}}
| |{{Man key press|Cmd|I}}
| |{{Man key press|Ctrl|I}}
|-
| id="3" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|Export family tree]]
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="4" | Changes to the next [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|N}}
| |{{Man key press|Cmd|N}}
| |{{Man key press|Ctrl|N}}
|-
| id="5" |Changes to the previous [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="45" |Change [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]] to Category number 0/1/2/../9
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}} ...
| |{{Man key press|Cmd|1}} {{Man key press|Cmd|2}} {{Man key press|Cmd|3}}..
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}}..
|-
| id="6" |Within the Category changes the [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Views|view]] to view number 0/1/2/../9
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}} ...
| |{{Man key press|Cmd|Alt|1}} {{Man key press|Cmd|Alt|2}} {{Man key press|Cmd|Alt|3}}..
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}}..
|-
| id="7" |Toggle the left gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Navigator|Navigator]] panel)
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|-
| id="8" |[[Gramps_5.0_Wiki_Manual_-_Navigation#Using_the_Clipboard|Open the Clipboard]]
| |{{Man key press|Ctrl|B}}
| |{{Man key press|Cmd|B}}
| |{{Man key press|Ctrl|B}}
|-
| id="9" |Add the selected item as a [[Gramps_5.0_Wiki_Manual_-_Navigation#Bookmarks|bookmark]]
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="10" |[[Gramps_5.0_Wiki_Manual_-_Navigation#Bookmarks|Organize the bookmarks]]
| |{{Man key press|Shift|Ctrl|D}}
| |{{Man key press|Shift|Cmd|D}}
| |{{Man key press|Shift|Ctrl|D}}
|-
| id="11" |Open the {{man label|[[Gramps_5.0_Wiki_Manual_-_Navigation#Edit|Undo History]]}} dialog
| |{{Man key press|Ctrl|H}}
| |{{Man key press|Cmd|H}}
| |{{Man key press|Ctrl|H}}
|-
| id="12" |Jump to an Gramps ID
| |{{Man key press|Ctrl|J}}
| |{{Man key press|Cmd|J}}
| |{{Man key press|Ctrl|J}}
|-
| id="13" |Move to previous item in history
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Alt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="14" |Move to next item in history
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctrl|Alt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|-
| id="15" |Go to the '''[[Gramps_5.0_Wiki_Manual_-_Settings#Setting_Home_person|Home Person]]'''
| |{{Man key press|Alt|Home}}
| |
| |{{Man key press|Alt|Home}}
|-
| id="16" |Configure active view
| |{{Man key press|Shift|Ctrl|C}}
| |{{Man key press|Shift|Cmd|C}}
| |{{Man key press|Shift|Ctrl|C}}
|-
| id="17" |Toggle the right gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Sidebar]])
| |{{Man key press|Shift|Ctrl|R}}
| |{{Man key press|Shift|Cmd|R}}
| |{{Man key press|Shift|Ctrl|R}}
|-
| id="18" |Toggle the bottom gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Bottombar]])
| |{{Man key press|Shift|Ctrl|B}}
| |{{Man key press|Shift|Cmd|B}}
| |{{Man key press|Shift|Ctrl|B}}
|-
| id="19" |Undo
| |{{Man key press|Ctrl|Z}}
| |{{Man key press|Cmd|Z}}
| |{{Man key press|Ctrl|Z}}
|-
| id="20" |Do again
| |{{Man key press|Shift|Ctrl|Z}}
| |{{Man key press|Shift|Cmd|Z}}
| |{{Man key press|Shift|Ctrl|Z}}
|-
| id="21" |Quit Gramps
| |{{Man key press|Ctrl|Q}}
| |{{Man key press|Cmd|Q}}
| |{{Man key press|Ctrl|Q}}
|-
| id="xx" | [[Gramps_5.0_Wiki_Manual_-_Navigation#Add|Add/Create]] a new object (Opens the related Editor) Person Family Event Place Source Citation Repository Media Note
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
| | {{Man key press|Shift|Ctrl|Alt|P}} {{Man key press|Shift|Ctrl|Alt|F}} {{Man key press|Shift|Ctrl|Alt|E}} {{Man key press|Shift|Ctrl|Alt|L}} {{Man key press|Shift|Ctrl|Alt|S}} {{Man key press|Shift|Ctrl|Alt|C}} {{Man key press|Shift|Ctrl|Alt|R}} {{Man key press|Shift|Ctrl|Alt|M}} {{Man key press|Shift|Ctrl|Alt|N}}
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
|}

=== All List Views bindings ===

The following bindings are available in all list views: People, Families, Events, Places, Sources, Citations, Repositories, Media and Notes View.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="22" |Edits the selected list item
| |{{Man key press|Ctrl|Enter}}
| |
| |{{Man key press|Ctrl|Enter}}
| |
|-
| id="23" |Adds a new item to the database
| |{{Man key press|Ctrl|Insert}}
| |
| |{{Man key press|Ctrl|Insert}}
| |
|-
| id="24" |Deletes the selected list item
| |{{Man key press|Ctrl|Delete}}
| |
| |{{Man key press|Ctrl|Delete}}
| |
|-
| id="46" |Activate the {{man button|Find}} field
|!-- Microsoft Windows --> |{{Man key press|Ctrl|F}}
|!-- Mac OS --> |{{Man key press|Cmd|F}}
|!-- KDE/GNOME --> |{{Man key press|Ctrl|F}}
| | List view interactive search ahead / Quick search
|}

=== People View bindings ===

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="25" |Expands and hides entries of the selected surname in Group mode
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|}

==Editors==

=== Editor Tab bindings ===
These bindings work on the tab pages of the editors (so not on the labels of the tabs!, press tab on label to move to tabpage content).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="26" |Same action as the {{icon|Stock_edit}} button when that button is present
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|-
| id="27" |Same action as the {{icon|Stock_add}} button when that button is present
|{{Man key press|Insert}}
|
|{{Man key press|Insert}}
|-
| id="28" |Same action as the {{icon|Stock_remove}} button when that button is present
|{{Man key press|Delete}}
|
|{{Man key press|Delete}}
|-
| id="29" |Same action as the {{man button|Share}} button when that button is present
|{{Man key press|Ctrl|O}}
|{{Man key press|Cmd|O}}
|{{Man key press|Ctrl|O}}
|-
| id="30" |Change tabpage to the tabpage to the left
|{{Man key press|Alt|Left}} (Left arrow)
|{{Man key press|Ctrl|Alt|Left}} (Left arrow)
|{{Man key press|Alt|Left}} (Left arrow)
|-
| id="31" |Change tabpage to the tabpage to the right
|{{Man key press|Alt|Right}} (Right arrow)
|{{Man key press|Ctlr|Alt|Right}} (Right arrow)
|{{Man key press|Alt|Right}} (Right arrow)
|}

{|{{prettytable}}
!Action/Function
!Mouse Key
|-
| id="32" |Call up [https://en.wikipedia.org/wiki/Context_menu context menu] popup
!Right-click
|-
| id="33" |Same action as the {{icon|Stock_edit}} {{man button|Edit}} button when that button is present
!Double-click
|-
| id="34" |Common action that is not the same as {{icon|Stock_edit}} {{man button|Edit}} button. Eg: on Family Editor Child tab, edit child
!Middle-click
|}

=== Editor bindings ===
These bindings work on Editors by activating focus or by changing state of toggle buttons ([[Accessibility]]).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="35" |Change the privacy status.
|{{Man key press|Ctrl|P}}
|{{Man key press|Cmd|P}}
|{{Man key press|Ctrl|P}}
|-
| id="36" |Call the Date editor (if present).
|{{Man key press|Ctrl|D}}
|{{Man key press|Cmd|D}}
|{{Man key press|Ctrl|D}}
|-
| id="37" |Activate the {{icon|Stock_add}} {{man button|Add}} button (if present).
|{{Man key press|Ctrl|A}}
|{{Man key press|Cmd|A}}
|{{Man key press|Ctrl|A}}
|-
| id="38" |Activate the {{icon|Stock_edit}} {{man button|Edit}} button (if present).
|{{Man key press|Ctrl|E}}
|{{Man key press|Cmd|E}}
|{{Man key press|Ctrl|E}}
|-
| id="39" |Activate the {{man button|Select}} button (if present).
|{{Man key press|Ctrl|S}}
|{{Man key press|Cmd|S}}
|{{Man key press|Ctrl|S}}
|-
| id="40" |Activate the {{man button|Father}} button (if present).
|{{Man key press|Ctrl|F}}
|{{Man key press|Cmd|F}}
|{{Man key press|Ctrl|F}}
|-
| id="41" |Activate the {{man button|Mother}} button (if present).
|{{Man key press|Ctrl|M}}
|{{Man key press|Cmd|M}}
|{{Man key press|Ctrl|M}}
|}

==Handy Shortcuts==

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="42" |Full screen
|{{man key press|F11}}
|
|{{man key press|F11}}
|Maximises Gramps to use the Full screen
|-
| id="43" |Show this user manual
|{{man key press|F1}}
|{{man key press|F1}}
|{{man key press|F1}}
|
|-
| id="44" |Select the {{man button|OK}} button
|{{man key press|Alt}}+{{man key press|O}}
|
|
|Handy for those of you with low resolution screens
|}

== See also ==
* [http://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts Table of keyboard shortcuts] - for major operating systems.

{{-}}
{{man index|Gramps 5.0 Wiki Manual - FAQ|Gramps 5.0 Wiki Manual - Command Line|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Keybindings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 5.0 Wiki Manual - Keybindings

2018-02-09T03:40:58Z

Jralls: /* Common bindings */ Update Mac keybindings for bug 6943

{{man index|Gramps 5.0 Wiki Manual - FAQ|Gramps 5.0 Wiki Manual - Command Line|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Keybindings}}
{{#vardefine:chapter|B}}
{{#vardefine:figure|0}}
This appendix lists keybindings (also known as ''Keyboard shortcuts'') you can use on the Gramps dialogs, so as to avoid the use of the mouse.

Some keyboard shortcuts require the user to press a single key or a sequence of keys one after the other. Other keyboard shortcuts require pressing and holding several keys simultaneously. Keyboard shortcuts may depend on the keyboard layout (localisation) and on your computers operating systems.

== List Views ==
=== Common bindings ===

The following bindings are available in all category views.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="1" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|Manage family trees]]
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="2" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import family tree]]
| |{{Man key press|Ctrl|I}}
| |{{Man key press|Cmd|I}}
| |{{Man key press|Ctrl|I}}
|-
| id="3" | [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|Export family tree]]
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="4" | Changes to the next [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|N}}
| |{{Man key press|Cmd|N}}
| |{{Man key press|Ctrl|N}}
|-
| id="5" |Changes to the previous [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="45" |Change [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Categories|Category]] to Category number 0/1/2/../9
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}} ...
| |{{Man key press|Cmd|1}} {{Man key press|Cmd|2}} {{Man key press|Cmd|3}}..
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}}..
|-
| id="6" |Within the Category changes the [[Gramps_5.0_Wiki_Manual_-_Main_Window#Switching_Views|view]] to view number 0/1/2/../9
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}} ...
| |{{Man key press|Cmd|Alt|1}} {{Man key press|Cmd|Alt|2}} {{Man key press|Cmd|Alt|3}}..
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}}..
|-
| id="7" |Toggle the left gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Navigator|Navigator]] panel)
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|-
| id="8" |[[Gramps_5.0_Wiki_Manual_-_Navigation#Using_the_Clipboard|Open the Clipboard]]
| |{{Man key press|Ctrl|B}}
| |{{Man key press|Cmd|B}}
| |{{Man key press|Ctrl|B}}
|-
| id="9" |Add the selected item as a [[Gramps_5.0_Wiki_Manual_-_Navigation#Bookmarks|bookmark]]
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="10" |[[Gramps_5.0_Wiki_Manual_-_Navigation#Bookmarks|Organize the bookmarks]]
| |{{Man key press|Shift|Ctrl|D}}
| |{{Man key press|Shift|Cmd|D}}
| |{{Man key press|Shift|Ctrl|D}}
|-
| id="11" |Open the {{man label|[[Gramps_5.0_Wiki_Manual_-_Navigation#Edit|Undo History]]}} dialog
| |{{Man key press|Ctrl|H}}
| |{{Man key press|Cmd|H}}
| |{{Man key press|Ctrl|H}}
|-
| id="12" |Jump to an Gramps ID
| |{{Man key press|Ctrl|J}}
| |{{Man key press|Cmd|J}}
| |{{Man key press|Ctrl|J}}
|-
| id="13" |Move to previous item in history
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Alt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="14" |Move to next item in history
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctrl|Alt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|-
| id="15" |Go to the '''[[Gramps_5.0_Wiki_Manual_-_Settings#Setting_Home_person|Home Person]]'''
| |{{Man key press|Alt|Home}}
| |
| |{{Man key press|Alt|Home}}
|-
| id="16" |Configure active view
| |{{Man key press|Shift|Ctrl|C}}
| |{{Man key press|Shift|Cmd|C}}
| |{{Man key press|Shift|Ctrl|C}}
|-
| id="17" |Toggle the right gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Sidebar]])
| |{{Man key press|Shift|Ctrl|R}}
| |{{Man key press|Shift|Cmd|R}}
| |{{Man key press|Shift|Ctrl|R}}
|-
| id="18" |Toggle the bottom gramplet sidebar ([[Gramps_5.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Bottombar]])
| |{{Man key press|Shift|Ctrl|B}}
| |{{Man key press|Shift|Cmd|B}}
| |{{Man key press|Shift|Ctrl|B}}
|-
| id="19" |Undo
| |{{Man key press|Ctrl|Z}}
| |{{Man key press|Cmd|Z}}
| |{{Man key press|Ctrl|Z}}
|-
| id="20" |Do again
| |{{Man key press|Shift|Ctrl|Z}}
| |{{Man key press|Shift|Cmd|Z}}
| |{{Man key press|Shift|Ctrl|Z}}
|-
| id="21" |Quit Gramps
| |{{Man key press|Ctrl|Q}}
| |{{Man key press|Cmd|Q}}
| |{{Man key press|Ctrl|Q}}
|-
| id="xx" | [[Gramps_5.0_Wiki_Manual_-_Navigation#Add|Add/Create]] a new object (Opens the related Editor) Person Family Event Place Source Citation Repository Media Note
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
| | {{Man key press|Shift|Ctrl|Alt|P}} {{Man key press|Shift|Ctrl|Alt|F}} {{Man key press|Shift|Ctrl|Alt|E}} {{Man key press|Shift|Ctrl|Alt|L}} {{Man key press|Shift|Ctrl|Alt|S}} {{Man key press|Shift|Ctrl|Alt|C}} {{Man key press|Shift|Ctrl|Alt|R}} {{Man key press|Shift|Ctrl|Alt|M}} {{Man key press|Shift|Ctrl|Alt|N}}
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
|}

=== All List Views bindings ===

The following bindings are available in all list views: People, Families, Events, Places, Sources, Citations, Repositories, Media and Notes View.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="22" |Edits the selected list item
| |{{Man key press|Ctrl|Enter}}
| |
| |{{Man key press|Ctrl|Enter}}
| |
|-
| id="23" |Adds a new item to the database
| |{{Man key press|Ctrl|Insert}}
| |
| |{{Man key press|Ctrl|Insert}}
| |
|-
| id="24" |Deletes the selected list item
| |{{Man key press|Ctrl|Delete}}
| |
| |{{Man key press|Ctrl|Delete}}
| |
|-
| id="46" |Activate the {{man button|Find}} field
|!-- Microsoft Windows --> |{{Man key press|Ctrl|F}}
|!-- Mac OS --> |{{Man key press|Cmd|F}}
|!-- KDE/GNOME --> |{{Man key press|Ctrl|F}}
| | List view interactive search ahead / Quick search
|}

=== People View bindings ===

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="25" |Expands and hides entries of the selected surname in Group mode
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|}

==Editors==

=== Editor Tab bindings ===
These bindings work on the tab pages of the editors (so not on the labels of the tabs!, press tab on label to move to tabpage content).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="26" |Same action as the {{icon|Stock_edit}} button when that button is present
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|-
| id="27" |Same action as the {{icon|Stock_add}} button when that button is present
|{{Man key press|Insert}}
|
|{{Man key press|Insert}}
|-
| id="28" |Same action as the {{icon|Stock_remove}} button when that button is present
|{{Man key press|Delete}}
|
|{{Man key press|Delete}}
|-
| id="29" |Same action as the {{man button|Share}} button when that button is present
|{{Man key press|Ctrl|O}}
|{{Man key press|Cmd|O}}
|{{Man key press|Ctrl|O}}
|-
| id="30" |Change tabpage to the tabpage to the left
|{{Man key press|Alt|Left}} (Left arrow)
|{{Man key press|Alt|Left}} (Left arrow)
|{{Man key press|Alt|Left}} (Left arrow)
|-
| id="31" |Change tabpage to the tabpage to the right
|{{Man key press|Alt|Right}} (Right arrow)
|{{Man key press|Alt|Right}} (Right arrow)
|{{Man key press|Alt|Right}} (Right arrow)
|}

{|{{prettytable}}
!Action/Function
!Mouse Key
|-
| id="32" |Call up [https://en.wikipedia.org/wiki/Context_menu context menu] popup
!Right-click
|-
| id="33" |Same action as the {{icon|Stock_edit}} {{man button|Edit}} button when that button is present
!Double-click
|-
| id="34" |Common action that is not the same as {{icon|Stock_edit}} {{man button|Edit}} button. Eg: on Family Editor Child tab, edit child
!Middle-click
|}

=== Editor bindings ===
These bindings work on Editors by activating focus or by changing state of toggle buttons ([[Accessibility]]).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="35" |Change the privacy status.
|{{Man key press|Ctrl|P}}
|{{Man key press|Cmd|P}}
|{{Man key press|Ctrl|P}}
|-
| id="36" |Call the Date editor (if present).
|{{Man key press|Ctrl|D}}
|{{Man key press|Cmd|D}}
|{{Man key press|Ctrl|D}}
|-
| id="37" |Activate the {{icon|Stock_add}} {{man button|Add}} button (if present).
|{{Man key press|Ctrl|A}}
|{{Man key press|Cmd|A}}
|{{Man key press|Ctrl|A}}
|-
| id="38" |Activate the {{icon|Stock_edit}} {{man button|Edit}} button (if present).
|{{Man key press|Ctrl|E}}
|{{Man key press|Cmd|E}}
|{{Man key press|Ctrl|E}}
|-
| id="39" |Activate the {{man button|Select}} button (if present).
|{{Man key press|Ctrl|S}}
|{{Man key press|Cmd|S}}
|{{Man key press|Ctrl|S}}
|-
| id="40" |Activate the {{man button|Father}} button (if present).
|{{Man key press|Ctrl|F}}
|{{Man key press|Cmd|F}}
|{{Man key press|Ctrl|F}}
|-
| id="41" |Activate the {{man button|Mother}} button (if present).
|{{Man key press|Ctrl|M}}
|{{Man key press|Cmd|M}}
|{{Man key press|Ctrl|M}}
|}

==Handy Shortcuts==

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="42" |Full screen
|{{man key press|F11}}
|
|{{man key press|F11}}
|Maximises Gramps to use the Full screen
|-
| id="43" |Show this user manual
|{{man key press|F1}}
|{{man key press|F1}}
|{{man key press|F1}}
|
|-
| id="44" |Select the {{man button|OK}} button
|{{man key press|Alt}}+{{man key press|O}}
|
|
|Handy for those of you with low resolution screens
|}

== See also ==
* [http://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts Table of keyboard shortcuts] - for major operating systems.

{{-}}
{{man index|Gramps 5.0 Wiki Manual - FAQ|Gramps 5.0 Wiki Manual - Command Line|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Keybindings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Mac OS X:Build from source:Application package

2018-01-15T15:46:26Z

Jralls: /* Gramps 4.x and Git Master */ Updates reflecting Py3 only building for 4.2 and later.

==Building Gramps from Scratch==

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

This is a command-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 or vice-versa, so the whole process must be repeated on machines of each architecture. '''''N.B. This procedure has not been tested against OS X 10.4 Tiger. Some packages may not be compatible with that very old version of OS X.'''''

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.

=== Step 1: Install Xcode ===

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://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). You may need to search for an earlier version. For example, as of January 2017, running Mac OS X 10.11 El Capitan it is probably best to use Xcode 7 (e.g. Xcode 7.3.1).

If you are running OSX 10.7 Lion or later, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3]. Building Gramps with Xcode 4.3 or later--which is what is supplied for 10.7 on--produces code that won't run. See https://bugzilla.gnome.org/show_bug.cgi?id=702908 for details.

Earlier version of Xcode were delivered as an installer in a disk image (.dmg). Xcode should be installed in the usual way by double clicking on the installer and following the instructions.

Later versions of Xcode are delivered as an Application (.app) in a disk image, with instructions to copy this to your Applications folder. You probably need to run the Application to get it to install everything - if you don't, when you go on to the next step it will complain that you haven't agreed to the Xcode licence agreement.

=== Step 2: Install jhbuild ===

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing Homebrew, MacPorts, or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.

Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you. (It is assumed here that you have downloaded gtk-osx-build-install.sh into your home directory, and that you run the following command from there).

sudo sh gtk-osx-build-setup.sh

This may produce a number of warnings but they can be ignored:
Checking out jhbuild (7c8d34736c3804) from git...
Cloning into 'jhbuild'...
remote: Counting objects: 45961, done.
remote: Compressing objects: 100% (12945/12945), done.
remote: Total 45961 (delta 35419), reused 42858 (delta 32831)
Receiving objects: 100% (45961/45961), 10.11 MiB | 1.44 MiB/s, done.
Resolving deltas: 100% (35419/35419), done.
Checking connectivity... done.
Switched to a new branch 'stable'
Installing jhbuild...
-n WARNING: aclocal not available (usually part of package 'autoconf')
-n WARNING: automake not available (usually part of package 'automake')
-n WARNING: autopoint not available (usually part of package 'gettext')
-n WARNING: pkg-config not available (usually part of package 'pkgconfig')
-n WARNING: yelp-tools not available (usually part of package 'yelp-tools')
-n Configuring jhbuild without autotools
-n Now type `make' to compile jhbuild
Installing jhbuild configuration...
Installing gtk-osx moduleset files...
PATH does not contain /Users/tim/.local/bin, it is recommended that you add that.
Done.

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

Type:
python
to check which version of python you have (exit from python by typing crtl-D). For example, you may see (with Mac OS X 10.11 El Capitan):
$ python
Python 2.7.10 (default, Oct 23 2015, 19:19:21)
[GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> ^D

This shows you have Python 2.7. As described in [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], if you have a version of Python earlier than 2.5, you have to follow the special instructions to build a Python 2.7 module.

Now type:
jhbuild bootstrap

=== Step 3: Install Gramps dependencies and Gramps ===

==== Gramps 3.4.x ====

Next, you need a copy of the moduleset file. You *could* just pass the url to jhbuild, but it's easier to download it:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps34/mac/gramps.modules

That will retrieve the modules file to 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 command from the terminal:

jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python 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.
Not everything that this procedure builds will be included in the Gramps application bundle; there are some intermediate dependencies and build tools that are necessary for building everything but not required at runtime. ```That doesn't mean that some modules can be skipped.```

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-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

==== Gramps 4.x and Later ====

Gramps 4.x is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes. Gramps 4.2 and later are further updated to use Python3 only, which requires more changes.

Download the modules file for the branch you want to build:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps42/mac/gramps.modules

curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps50/mac/gramps.modules
or
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules

The list of targets changes to reflect using Gtk+-3:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-freetype meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps-git

For Gramps42 and later it's a bit simpler:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap gramps-git

If you want to build the latest release tarball rather than the latest check-in, use <tt>gramps</tt> instead of <tt>gramps-git</tt> for the last module--but note that since we don't release from the <tt>master</tt> branch, <tt>gramps.modules</tt> doesn't have a <tt>gramps</tt> module in <tt>master</tt>.

If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps40
python setup.by build

==== .jhbuildrc-custom ====
It's annoying and error-prone to type the long list of modules every time you want to build gramps, so you may want to modify <tt>~/.jhbuildrc-custom</tt> to declare the <tt>moduleset</tt> and <tt>modules</tt> variables. Note that <tt>.jhbuildrc-custom</tt> is a Python file that is loaded and executed by <tt>jhbuild</tt>, so you can make it quite complex. Do beware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be sure to prefix any top-level variables with '_'.

== Gramps 3.x and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies that JHBuild doesn't know how to handle. Thanks to Gtk+-3, these have been replaced in Gramps-4.0 (and <tt>master</tt>) with a module that JHBuild ''can'' build, so '''these instructions apply only to Gramps-3.4.x'''. 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 or later, 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 --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
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.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

=== Webkit ===
Gramps has an optional dependency on WebKit, which is used for the <tt>html-renderer</tt> add-on. If for some reason you want to use this add-on, add <tt>WebKit</tt> to your list of dependencies but be aware that it take a long time to build.
'''''WebKit will not build on 10.4 (Tiger) 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!'''''

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/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.7.dylib
gtk-mac-bundler ~/gtk/src/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!

[[Category:Developers/General]]

Mac OS X:Build from source:Application package

2018-01-15T15:15:28Z

Jralls: /* Step 2: Install jhbuild */ Add Homebrew to list of projects that interfere with jhbuild.

==Building Gramps from Scratch==

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

This is a command-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 or vice-versa, so the whole process must be repeated on machines of each architecture. '''''N.B. This procedure has not been tested against OS X 10.4 Tiger. Some packages may not be compatible with that very old version of OS X.'''''

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.

=== Step 1: Install Xcode ===

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://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.

If you try to download Xcode, Apple will probably offer you the latest version of Xcode, irrespective of whether it runs on the version of Mac OS X you are using (Apple probably expects you to upgrade everything to the very latest). You may need to search for an earlier version. For example, as of January 2017, running Mac OS X 10.11 El Capitan it is probably best to use Xcode 7 (e.g. Xcode 7.3.1).

If you are running OSX 10.7 Lion or later, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3]. Building Gramps with Xcode 4.3 or later--which is what is supplied for 10.7 on--produces code that won't run. See https://bugzilla.gnome.org/show_bug.cgi?id=702908 for details.

Earlier version of Xcode were delivered as an installer in a disk image (.dmg). Xcode should be installed in the usual way by double clicking on the installer and following the instructions.

Later versions of Xcode are delivered as an Application (.app) in a disk image, with instructions to copy this to your Applications folder. You probably need to run the Application to get it to install everything - if you don't, when you go on to the next step it will complain that you haven't agreed to the Xcode licence agreement.

=== Step 2: Install jhbuild ===

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''.

''It's important that jhbuild is not confused by any existing Homebrew, MacPorts, or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.

Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you. (It is assumed here that you have downloaded gtk-osx-build-install.sh into your home directory, and that you run the following command from there).

sudo sh gtk-osx-build-setup.sh

This may produce a number of warnings but they can be ignored:
Checking out jhbuild (7c8d34736c3804) from git...
Cloning into 'jhbuild'...
remote: Counting objects: 45961, done.
remote: Compressing objects: 100% (12945/12945), done.
remote: Total 45961 (delta 35419), reused 42858 (delta 32831)
Receiving objects: 100% (45961/45961), 10.11 MiB | 1.44 MiB/s, done.
Resolving deltas: 100% (35419/35419), done.
Checking connectivity... done.
Switched to a new branch 'stable'
Installing jhbuild...
-n WARNING: aclocal not available (usually part of package 'autoconf')
-n WARNING: automake not available (usually part of package 'automake')
-n WARNING: autopoint not available (usually part of package 'gettext')
-n WARNING: pkg-config not available (usually part of package 'pkgconfig')
-n WARNING: yelp-tools not available (usually part of package 'yelp-tools')
-n Configuring jhbuild without autotools
-n Now type `make' to compile jhbuild
Installing jhbuild configuration...
Installing gtk-osx moduleset files...
PATH does not contain /Users/tim/.local/bin, it is recommended that you add that.
Done.

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

Type:
python
to check which version of python you have (exit from python by typing crtl-D). For example, you may see (with Mac OS X 10.11 El Capitan):
$ python
Python 2.7.10 (default, Oct 23 2015, 19:19:21)
[GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> ^D

This shows you have Python 2.7. As described in [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], if you have a version of Python earlier than 2.5, you have to follow the special instructions to build a Python 2.7 module.

Now type:
jhbuild bootstrap

=== Step 3: Install Gramps dependencies and Gramps ===

==== Gramps 3.4.x ====

Next, you need a copy of the moduleset file. You *could* just pass the url to jhbuild, but it's easier to download it:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps34/mac/gramps.modules

That will retrieve the modules file to 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 command from the terminal:

jhbuild --moduleset=~/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python 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.
Not everything that this procedure builds will be included in the Gramps application bundle; there are some intermediate dependencies and build tools that are necessary for building everything but not required at runtime. ```That doesn't mean that some modules can be skipped.```

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-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

==== Gramps 4.x and Git Master ====

Gramps 4.x is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes.

Download the modules file for the branch you want to build:
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps42/mac/gramps.modules
or
curl -o gramps.modules https://raw.githubusercontent.com/gramps-project/gramps/master/mac/gramps.modules

The list of targets changes to reflect using Gtk+-3:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-freetype meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps-git

If you want to build the latest release tarball rather than the latest check-in, use <tt>gramps</tt> instead of <tt>gramps-git</tt> for the last module--but note that since we don't release from the <tt>master</tt> branch, <tt>gramps.modules</tt> doesn't have a <tt>gramps</tt> module.

If you're planning to work on several branches, a single checkout will work: Start with <tt>master</tt>. Gramps is pure python, so once you've got everything built you need repeat this only to update the dependencies. You can quickly switch branches in your git repo with:
git clean -fdx
git checkout maintenance/gramps40
python setup.by build

==== .jhbuildrc-custom ====
It's annoying and error-prone to type the long list of modules every time you want to build gramps, so you may want to modify <tt>~/.jhbuildrc-custom</tt> to declare the <tt>moduleset</tt> and <tt>modules</tt> variables. Note that <tt>.jhbuildrc-custom</tt> is a Python file that is loaded and executed by <tt>jhbuild</tt>, so you can make it quite complex. Do beware that defining new global variables will elicit a warning from <tt>jhbuild</tt> so be sure to prefix any top-level variables with '_'.

== Gramps 3.x and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies that JHBuild doesn't know how to handle. Thanks to Gtk+-3, these have been replaced in Gramps-4.0 (and <tt>master</tt>) with a module that JHBuild ''can'' build, so '''these instructions apply only to Gramps-3.4.x'''. 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 or later, 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 --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
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.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

=== Webkit ===
Gramps has an optional dependency on WebKit, which is used for the <tt>html-renderer</tt> add-on. If for some reason you want to use this add-on, add <tt>WebKit</tt> to your list of dependencies but be aware that it take a long time to build.
'''''WebKit will not build on 10.4 (Tiger) 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!'''''

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [https://wiki.gnome.org/Projects/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

Assuming that your local repository wound up in <tt>~/gtk/src/gramps</tt>:
You may need to edit <tt>~/gtk/src/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.7.dylib
gtk-mac-bundler ~/gtk/src/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!

[[Category:Developers/General]]

What to do for a release

2017-08-27T03:42:51Z

Jralls: Remove "Release from tag" section, it was a no-op.

{{man note|Developer notes for '''What to do for a release '''}}

Note that the main use of this page will be for making
a normal "minor" release. If you are making a "major"
release (e.g. x.y.0) then you will need to update this
page first, to change the numbers. But if you are only
making an "alpha" or "beta" release, some
steps may be skipped, or altered slightly.

Note also that
there are additional things which need to be done,
which are related to making a new release, for instance
making a new release-section here on the wiki, or
making a new release-section on the bug tracker, so
they will need to be coordinated with the appropriate
people. Probably there should be a section of this
page which lists things like that.

==Prepare your repository==
* Check out the current stable branch:
git checkout maintenance/gramps{{Stable_branch}}
:That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use <code>maintenance</code> in the name) use your local name.
* Make sure that your local copy is clean:
git status
: If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
* Clean up any untracked files and make sure that the local repo is up to date:
git clean -fdx
git pull --rebase
:If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
* Build and test to make sure that everything works, then clean the repo of all build products.

==Translation update==
* Check for new files since the last release:
cd po
intltool-update -m
:That will create a file called <code>missing</code>in the <code>po</code> directory if there are new files that need to be scanned for translatable strings. Examine each of the files listed in <code>missing</code>, adding each to <code>POTFILES.in</code> if it contains translatable string constants and to <code>POTFILES.skip</code> if it does not.
* Generate a new template file:
python3 update_po.py -p # makes a new gramps.pot template file
git diff gramps.pot
:Examine the changes. If they're all just comments about where a string is found you need not commit the change:
git checkout gramps.pot
:If there have been changes on <code>msgid</code> entries, you'll need to commit <code>gramps.pot</code> and ask translators to update their <tt>.po</tt> files before you can make a release:
git add gramps.pot
git commit -m "Update translation template for new release."

* Check current translation files (there must be no 'fatal' errors):
python3 update_po.py -k all

* if all is well, return to the root directory:
cd ..

==Release name==
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] to select an appropriate name.

==Changelog and NEWS file==

[https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html#section2 Section ''2a''] of the '''G'''eneral '''P'''ublic '''L'''icense says that if you distribute a modified version of a program: ''you must cause the modified files to carry prominent notices stating that you changed the files and the date of any change''.

Note that the <code>version</code> below means the ''previous'' version, not the one you're about to release.
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
git add ChangeLog
*Edit and update the <code>NEWS</code> file using the new ChangeLog entries as a guide.. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.
Commit the NEWS file:
git add NEWS
git commit -m "Update NEWS for {{version}} release"

==Working on VERSION==

* Check that the <code>VERSION_TUPLE</code> in <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code>reflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it.

* Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</code> to indicate an official release:
- VERSION += git_revision
+ #VERSION += git_revision

* Save the changes:
git commit -am "Release Gramps {{version}}"

* Check that the version number is correct:
python3 Gramps.py -v

* If everything looks good, push the changes:
git push origin maintenance/gramps42
* If that fails then someone pushed a commit while you were working. Return to [https://gramps-project.org/wiki/index.php?title=What_to_do_for_a_release#Prepare_your_repository Prepare your repository] and start over.

==Create a tag==
Create the release tag; note the '''v''' leading the actual tag.:
git tag -am "Tag {{version}}" v{{version}}

==Push to repository==
Push the changes to the repository:
git push origin v{{version}}

===Move to the new release number on branch ===

Bump the version number in <code>gramps/version.py</code>

Update the version for the release:
VERSION_TUPLE = (4, 2, ...)

Revert change on <code>gramps/gen/const.py</code> so that the git revision is appended to the reported version in non-release builds:
- #VERSION += get_git_revision
+ VERSION += get_git_revision

Save change:
git commit -am "bump to <new version number>"
git push

===Github===
* Github generates a tarball automatically when we push a tag.
* Go to [https://github.com/gramps-project/gramps Github] and log in if necessary.
* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).
* Find the tag you just pushed and click Edit.
* Copy the NEWS file contents into the '''Write''' tab. You can use the '''Preview''' tab to check your formatting.
* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.

===SourceForge===
* Go to [https://sourceforge.net/projects/gramps/files/ the SourceForge files page] and log in if necessary.
* Click on '''Stable''' or '''Unstable''' depending on the class of the release you're making.
* Click '''Add Folder''' and name the directory for the release version. Click "'Create'". Click your new folder to enter it.
* You can either download the Github-generated tarball or create one locallly:
python3 setup.py sdist
* Click '''Add File''' and drag the tarball to the drop area on the web page.

==Announcing the new release==
* announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
* announce on Gramps [https://gramps-project.org/introduction-WP/blog/ blog] (File under: [https://gramps-project.org/introduction-WP/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WP/category/news/ News])
* update [[News]] section on this wiki
* update the list of [[Previous releases of Gramps|previous releases]]
* update reference to the new version on the [[Template:Version|wiki template]]
* update [[HeadlineNews]]
* change the topic on the IRC channel #gramps
<code> /TOPIC #gramps Welcome to Gramps! The latest versions are {{version}} and the legacy 3.4.9 || http://www.gramps-project.org/ || Please state OS and Gramps version when asking a question. Understand that replies can take up to 2 days depending on whose watching the channel. Please consider asking on the gramps-users mailing list. </code>
* update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia]
* update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues.

==Post-release==
* merge forward the <code>NEWS</code> file

=See also=
* [[Git|Brief introduction to Git]]
* [[Running a development version of Gramps]]
* [[:Category:Developers/Packaging]]
* [[GrampsAIO-4 package updating]] - Updating the MS-Windows package
* [[:Category:AppData]] - Screenshots used by Appdata - Debian

=External links=
* https://github.com/gramps-project
* http://gramps-project.org/cpanel
* http://svn.code.sf.net/p/gramps/code/
* http://sourceforge.net/projects/gramps/

[[Category:Developers/General]]

What to do for a release

2017-08-27T03:39:00Z

Jralls: Remove "Create an official tarball", left in by mistake.

{{man note|Developer notes for '''What to do for a release '''}}

Note that the main use of this page will be for making
a normal "minor" release. If you are making a "major"
release (e.g. x.y.0) then you will need to update this
page first, to change the numbers. But if you are only
making an "alpha" or "beta" release, some
steps may be skipped, or altered slightly.

Note also that
there are additional things which need to be done,
which are related to making a new release, for instance
making a new release-section here on the wiki, or
making a new release-section on the bug tracker, so
they will need to be coordinated with the appropriate
people. Probably there should be a section of this
page which lists things like that.

==Prepare your repository==
* Check out the current stable branch:
git checkout maintenance/gramps{{Stable_branch}}
:That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use <code>maintenance</code> in the name) use your local name.
* Make sure that your local copy is clean:
git status
: If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
* Clean up any untracked files and make sure that the local repo is up to date:
git clean -fdx
git pull --rebase
:If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
* Build and test to make sure that everything works, then clean the repo of all build products.

==Translation update==
* Check for new files since the last release:
cd po
intltool-update -m
:That will create a file called <code>missing</code>in the <code>po</code> directory if there are new files that need to be scanned for translatable strings. Examine each of the files listed in <code>missing</code>, adding each to <code>POTFILES.in</code> if it contains translatable string constants and to <code>POTFILES.skip</code> if it does not.
* Generate a new template file:
python3 update_po.py -p # makes a new gramps.pot template file
git diff gramps.pot
:Examine the changes. If they're all just comments about where a string is found you need not commit the change:
git checkout gramps.pot
:If there have been changes on <code>msgid</code> entries, you'll need to commit <code>gramps.pot</code> and ask translators to update their <tt>.po</tt> files before you can make a release:
git add gramps.pot
git commit -m "Update translation template for new release."

* Check current translation files (there must be no 'fatal' errors):
python3 update_po.py -k all

* if all is well, return to the root directory:
cd ..

==Release name==
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] to select an appropriate name.

==Changelog and NEWS file==

[https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html#section2 Section ''2a''] of the '''G'''eneral '''P'''ublic '''L'''icense says that if you distribute a modified version of a program: ''you must cause the modified files to carry prominent notices stating that you changed the files and the date of any change''.

Note that the <code>version</code> below means the ''previous'' version, not the one you're about to release.
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
git add ChangeLog
*Edit and update the <code>NEWS</code> file using the new ChangeLog entries as a guide.. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.
Commit the NEWS file:
git add NEWS
git commit -m "Update NEWS for {{version}} release"

==Working on VERSION==

* Check that the <code>VERSION_TUPLE</code> in <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code>reflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it.

* Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</code> to indicate an official release:
- VERSION += git_revision
+ #VERSION += git_revision

* Save the changes:
git commit -am "Release Gramps {{version}}"

* Check that the version number is correct:
python3 Gramps.py -v

* If everything looks good, push the changes:
git push origin maintenance/gramps42
* If that fails then someone pushed a commit while you were working. Return to [https://gramps-project.org/wiki/index.php?title=What_to_do_for_a_release#Prepare_your_repository Prepare your repository] and start over.

==Create a tag==
Create the release tag; note the '''v''' leading the actual tag.:
git tag -am "Tag {{version}}" v{{version}}

==Push to repository==
Push the changes to the repository:
git push origin v{{version}}

===Move to the new release number on branch ===

Bump the version number in <code>gramps/version.py</code>

Update the version for the release:
VERSION_TUPLE = (4, 2, ...)

Revert change on <code>gramps/gen/const.py</code> so that the git revision is appended to the reported version in non-release builds:
- #VERSION += get_git_revision
+ VERSION += get_git_revision

Save change:
git commit -am "bump to <new version number>"
git push

===Release from tag===

git checkout <tag> -b <new_branch_name>

===Github===
* Github generates a tarball automatically when we push a tag.
* Go to [https://github.com/gramps-project/gramps Github] and log in if necessary.
* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).
* Find the tag you just pushed and click Edit.
* Copy the NEWS file contents into the '''Write''' tab. You can use the '''Preview''' tab to check your formatting.
* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.

===SourceForge===
* Go to [https://sourceforge.net/projects/gramps/files/ the SourceForge files page] and log in if necessary.
* Click on '''Stable''' or '''Unstable''' depending on the class of the release you're making.
* Click '''Add Folder''' and name the directory for the release version. Click "'Create'". Click your new folder to enter it.
* You can either download the Github-generated tarball or create one locallly:
python3 setup.py sdist
* Click '''Add File''' and drag the tarball to the drop area on the web page.

==Announcing the new release==
* announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
* announce on Gramps [https://gramps-project.org/introduction-WP/blog/ blog] (File under: [https://gramps-project.org/introduction-WP/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WP/category/news/ News])
* update [[News]] section on this wiki
* update the list of [[Previous releases of Gramps|previous releases]]
* update reference to the new version on the [[Template:Version|wiki template]]
* update [[HeadlineNews]]
* change the topic on the IRC channel #gramps
<code> /TOPIC #gramps Welcome to Gramps! The latest versions are {{version}} and the legacy 3.4.9 || http://www.gramps-project.org/ || Please state OS and Gramps version when asking a question. Understand that replies can take up to 2 days depending on whose watching the channel. Please consider asking on the gramps-users mailing list. </code>
* update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia]
* update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues.

==Post-release==
* merge forward the <code>NEWS</code> file

=See also=
* [[Git|Brief introduction to Git]]
* [[Running a development version of Gramps]]
* [[:Category:Developers/Packaging]]
* [[GrampsAIO-4 package updating]] - Updating the MS-Windows package
* [[:Category:AppData]] - Screenshots used by Appdata - Debian

=External links=
* https://github.com/gramps-project
* http://gramps-project.org/cpanel
* http://svn.code.sf.net/p/gramps/code/
* http://sourceforge.net/projects/gramps/

[[Category:Developers/General]]

What to do for a release

2017-08-27T03:37:25Z

Jralls: /* Working on VERSION */ Correct branch name error.

{{man note|Developer notes for '''What to do for a release '''}}

Note that the main use of this page will be for making
a normal "minor" release. If you are making a "major"
release (e.g. x.y.0) then you will need to update this
page first, to change the numbers. But if you are only
making an "alpha" or "beta" release, some
steps may be skipped, or altered slightly.

Note also that
there are additional things which need to be done,
which are related to making a new release, for instance
making a new release-section here on the wiki, or
making a new release-section on the bug tracker, so
they will need to be coordinated with the appropriate
people. Probably there should be a section of this
page which lists things like that.

==Prepare your repository==
* Check out the current stable branch:
git checkout maintenance/gramps{{Stable_branch}}
:That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use <code>maintenance</code> in the name) use your local name.
* Make sure that your local copy is clean:
git status
: If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
* Clean up any untracked files and make sure that the local repo is up to date:
git clean -fdx
git pull --rebase
:If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
* Build and test to make sure that everything works, then clean the repo of all build products.

==Translation update==
* Check for new files since the last release:
cd po
intltool-update -m
:That will create a file called <code>missing</code>in the <code>po</code> directory if there are new files that need to be scanned for translatable strings. Examine each of the files listed in <code>missing</code>, adding each to <code>POTFILES.in</code> if it contains translatable string constants and to <code>POTFILES.skip</code> if it does not.
* Generate a new template file:
python3 update_po.py -p # makes a new gramps.pot template file
git diff gramps.pot
:Examine the changes. If they're all just comments about where a string is found you need not commit the change:
git checkout gramps.pot
:If there have been changes on <code>msgid</code> entries, you'll need to commit <code>gramps.pot</code> and ask translators to update their <tt>.po</tt> files before you can make a release:
git add gramps.pot
git commit -m "Update translation template for new release."

* Check current translation files (there must be no 'fatal' errors):
python3 update_po.py -k all

* if all is well, return to the root directory:
cd ..

==Release name==
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] to select an appropriate name.

==Changelog and NEWS file==

[https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html#section2 Section ''2a''] of the '''G'''eneral '''P'''ublic '''L'''icense says that if you distribute a modified version of a program: ''you must cause the modified files to carry prominent notices stating that you changed the files and the date of any change''.

Note that the <code>version</code> below means the ''previous'' version, not the one you're about to release.
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
git add ChangeLog
*Edit and update the <code>NEWS</code> file using the new ChangeLog entries as a guide.. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.
Commit the NEWS file:
git add NEWS
git commit -m "Update NEWS for {{version}} release"

==Working on VERSION==

* Check that the <code>VERSION_TUPLE</code> in <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code>reflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it.

* Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</code> to indicate an official release:
- VERSION += git_revision
+ #VERSION += git_revision

* Save the changes:
git commit -am "Release Gramps {{version}}"

* Check that the version number is correct:
python3 Gramps.py -v

* If everything looks good, push the changes:
git push origin maintenance/gramps42
* If that fails then someone pushed a commit while you were working. Return to [https://gramps-project.org/wiki/index.php?title=What_to_do_for_a_release#Prepare_your_repository Prepare your repository] and start over.

==Create a tag==
Create the release tag; note the '''v''' leading the actual tag.:
git tag -am "Tag {{version}}" v{{version}}

==Push to repository==
Push the changes to the repository:
git push origin v{{version}}

==Create an official tarball==
python3 setup.py dist

===Move to the new release number on branch ===

Bump the version number in <code>gramps/version.py</code>

Update the version for the release:
VERSION_TUPLE = (4, 2, ...)

Revert change on <code>gramps/gen/const.py</code> so that the git revision is appended to the reported version in non-release builds:
- #VERSION += get_git_revision
+ VERSION += get_git_revision

Save change:
git commit -am "bump to <new version number>"
git push

===Release from tag===

git checkout <tag> -b <new_branch_name>

===Github===
* Github generates a tarball automatically when we push a tag.
* Go to [https://github.com/gramps-project/gramps Github] and log in if necessary.
* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).
* Find the tag you just pushed and click Edit.
* Copy the NEWS file contents into the '''Write''' tab. You can use the '''Preview''' tab to check your formatting.
* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.

===SourceForge===
* Go to [https://sourceforge.net/projects/gramps/files/ the SourceForge files page] and log in if necessary.
* Click on '''Stable''' or '''Unstable''' depending on the class of the release you're making.
* Click '''Add Folder''' and name the directory for the release version. Click "'Create'". Click your new folder to enter it.
* You can either download the Github-generated tarball or create one locallly:
python3 setup.py sdist
* Click '''Add File''' and drag the tarball to the drop area on the web page.

==Announcing the new release==
* announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
* announce on Gramps [https://gramps-project.org/introduction-WP/blog/ blog] (File under: [https://gramps-project.org/introduction-WP/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WP/category/news/ News])
* update [[News]] section on this wiki
* update the list of [[Previous releases of Gramps|previous releases]]
* update reference to the new version on the [[Template:Version|wiki template]]
* update [[HeadlineNews]]
* change the topic on the IRC channel #gramps
<code> /TOPIC #gramps Welcome to Gramps! The latest versions are {{version}} and the legacy 3.4.9 || http://www.gramps-project.org/ || Please state OS and Gramps version when asking a question. Understand that replies can take up to 2 days depending on whose watching the channel. Please consider asking on the gramps-users mailing list. </code>
* update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia]
* update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues.

==Post-release==
* merge forward the <code>NEWS</code> file

=See also=
* [[Git|Brief introduction to Git]]
* [[Running a development version of Gramps]]
* [[:Category:Developers/Packaging]]
* [[GrampsAIO-4 package updating]] - Updating the MS-Windows package
* [[:Category:AppData]] - Screenshots used by Appdata - Debian

=External links=
* https://github.com/gramps-project
* http://gramps-project.org/cpanel
* http://svn.code.sf.net/p/gramps/code/
* http://sourceforge.net/projects/gramps/

[[Category:Developers/General]]

What to do for a release

2017-08-26T23:08:00Z

Jralls: Clarify and re-order the procedure, including explicit git commands.

{{man note|Developer notes for '''What to do for a release '''}}

Note that the main use of this page will be for making
a normal "minor" release. If you are making a "major"
release (e.g. x.y.0) then you will need to update this
page first, to change the numbers. But if you are only
making an "alpha" or "beta" release, some
steps may be skipped, or altered slightly.

Note also that
there are additional things which need to be done,
which are related to making a new release, for instance
making a new release-section here on the wiki, or
making a new release-section on the bug tracker, so
they will need to be coordinated with the appropriate
people. Probably there should be a section of this
page which lists things like that.

==Prepare your repository==
* Check out the current stable branch:
git checkout maintenance/gramps{{Stable_branch}}
:That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use <code>maintenance</code> in the name) use your local name.
* Make sure that your local copy is clean:
git status
: If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
* Clean up any untracked files and make sure that the local repo is up to date:
git clean -fdx
git pull --rebase
:If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
* Build and test to make sure that everything works, then clean the repo of all build products.

==Translation update==
* Check for new files since the last release:
cd po
intltool-update -m
:That will create a file called <code>missing</code>in the <code>po</code> directory if there are new files that need to be scanned for translatable strings. Examine each of the files listed in <code>missing</code>, adding each to <code>POTFILES.in</code> if it contains translatable string constants and to <code>POTFILES.skip</code> if it does not.
* Generate a new template file:
python3 update_po.py -p # makes a new gramps.pot template file
git diff gramps.pot
:Examine the changes. If they're all just comments about where a string is found you need not commit the change:
git checkout gramps.pot
:If there have been changes on <code>msgid</code> entries, you'll need to commit <code>gramps.pot</code> and ask translators to update their <tt>.po</tt> files before you can make a release:
git add gramps.pot
git commit -m "Update translation template for new release."

* Check current translation files (there must be no 'fatal' errors):
python3 update_po.py -k all

* if all is well, return to the root directory:
cd ..

==Release name==
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] to select an appropriate name.

==Changelog and NEWS file==

[https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html#section2 Section ''2a''] of the '''G'''eneral '''P'''ublic '''L'''icense says that if you distribute a modified version of a program: ''you must cause the modified files to carry prominent notices stating that you changed the files and the date of any change''.

Note that the <code>version</code> below means the ''previous'' version, not the one you're about to release.
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
git add ChangeLog
*Edit and update the <code>NEWS</code> file using the new ChangeLog entries as a guide.. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.
Commit the NEWS file:
git add NEWS
git commit -m "Update NEWS for {{version}} release"

==Working on VERSION==

* Check that the <code>VERSION_TUPLE</code> in <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code>reflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it.

* Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</code> to indicate an official release:
- VERSION += git_revision
+ #VERSION += git_revision

* Save the changes:
git commit -am "Release Gramps {{version}}"

* Check that the version number is correct:
python3 Gramps.py -v

* If everything looks good, push the changes:
git push origin maintenance/gramps{{version}}
* If that fails then someone pushed a commit while you were working. Return to [https://gramps-project.org/wiki/index.php?title=What_to_do_for_a_release#Prepare_your_repository Prepare your repository] and start over.

==Create a tag==
Create the release tag; note the '''v''' leading the actual tag.:
git tag -am "Tag {{version}}" v{{version}}

==Push to repository==
Push the changes to the repository:
git push origin v{{version}}

==Create an official tarball==
python3 setup.py dist

===Move to the new release number on branch ===

Bump the version number in <code>gramps/version.py</code>

Update the version for the release:
VERSION_TUPLE = (4, 2, ...)

Revert change on <code>gramps/gen/const.py</code> so that the git revision is appended to the reported version in non-release builds:
- #VERSION += get_git_revision
+ VERSION += get_git_revision

Save change:
git commit -am "bump to <new version number>"
git push

===Release from tag===

git checkout <tag> -b <new_branch_name>

===Github===
* Github generates a tarball automatically when we push a tag.
* Go to [https://github.com/gramps-project/gramps Github] and log in if necessary.
* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).
* Find the tag you just pushed and click Edit.
* Copy the NEWS file contents into the '''Write''' tab. You can use the '''Preview''' tab to check your formatting.
* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.

===SourceForge===
* Go to [https://sourceforge.net/projects/gramps/files/ the SourceForge files page] and log in if necessary.
* Click on '''Stable''' or '''Unstable''' depending on the class of the release you're making.
* Click '''Add Folder''' and name the directory for the release version. Click "'Create'". Click your new folder to enter it.
* You can either download the Github-generated tarball or create one locallly:
python3 setup.py sdist
* Click '''Add File''' and drag the tarball to the drop area on the web page.

==Announcing the new release==
* announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
* announce on Gramps [https://gramps-project.org/introduction-WP/blog/ blog] (File under: [https://gramps-project.org/introduction-WP/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WP/category/news/ News])
* update [[News]] section on this wiki
* update the list of [[Previous releases of Gramps|previous releases]]
* update reference to the new version on the [[Template:Version|wiki template]]
* update [[HeadlineNews]]
* change the topic on the IRC channel #gramps
<code> /TOPIC #gramps Welcome to Gramps! The latest versions are {{version}} and the legacy 3.4.9 || http://www.gramps-project.org/ || Please state OS and Gramps version when asking a question. Understand that replies can take up to 2 days depending on whose watching the channel. Please consider asking on the gramps-users mailing list. </code>
* update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia]
* update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues.

==Post-release==
* merge forward the <code>NEWS</code> file

=See also=
* [[Git|Brief introduction to Git]]
* [[Running a development version of Gramps]]
* [[:Category:Developers/Packaging]]
* [[GrampsAIO-4 package updating]] - Updating the MS-Windows package
* [[:Category:AppData]] - Screenshots used by Appdata - Debian

=External links=
* https://github.com/gramps-project
* http://gramps-project.org/cpanel
* http://svn.code.sf.net/p/gramps/code/
* http://sourceforge.net/projects/gramps/

[[Category:Developers/General]]

Template:Version Mac

2017-08-26T21:43:40Z

Jralls: Update Mac Version

4.2.6<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2016-12-17T00:59:00Z

Jralls: Reset mac/intel sub-version.

Gramps-Intel-{{Version_Mac}}-1<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Version Mac

2016-12-17T00:56:54Z

Jralls: Update Mac version to 4.2.5

4.2.5<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac ppc

2016-09-11T18:30:56Z

Jralls: Reset for new release.

Gramps-PPC-{{Version_Mac}}-1<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Version Mac

2016-09-11T18:30:10Z

Jralls: Bump for new release

4.2.4<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2016-09-11T18:29:36Z

Jralls: Update to latest dmg.

Gramps-Intel-{{Version_Mac}}-3<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Gramps 4.2 Wiki Manual - Command Line

2016-07-18T02:55:58Z

Jralls: /* Environment variables */ Clarify use of LANG, LANGUAGE, LC_MESSAGES, and LC_TIME.

{{man index|Gramps 4.2 Wiki Manual - Keybindings|Gramps 4.2 Wiki Manual - User Directory|4.2}}
{{languages|Gramps_4.2_Wiki_Manual_-_Command_Line}}
{{#vardefine:chapter|C}}
{{#vardefine:figure|0}}
This appendix provides the reference to the command line capabilities available when launching Gramps from the terminal.

== Start Gramps through the Command Line ==

Normally Gramps is started through the graphical user interface (GUI) on [[Gramps_4.2_Wiki_Manual_-_Getting_started#Start_Gramps|your platform]].

It is also possible to start Gramps using a command line interface (CLI). CLI use can
* produce reports that are not available via the GUI,
* create reports, do conversions etc. without opening a window and
* can provide [[Gramps_4.2_Wiki_Manual_-_Main_Window#Seeing_all_the_error_messages|extra information]] in the event of problems.

This section of the user manual describes how to start Gramps through the CLI, and the features that are available.

The way you start Gramps through the CLI depends on the operating system you are using.

For simplicity of description, the examples of use below are written from the point of view of running Gramps on Linux. The examples would need to be changed for other platforms.

=== Linux ===

Only the Linux platform is officially supported as Gramps developers use and test the source code on that platform, fixing any problems that arise due to upgrades.

Assuming you have used the standard Package Manager (either through a CLI or a GUI) for your Linux distribution, you start Gramps through the CLI by typing
gramps

=== MS Windows ===

MS Windows is a [[Download|community supported]] platform. If you install the [[All_In_One_Gramps_Software_Bundle_for_Windows|Windows AIO]] GrampsAIO32 or GrampsAIO64 executable, then this will place an icon on the desktop as well as a menu iten in the 'Start' menu.

What is the best way of knowing what command to type?

Starting Gramps from the command line (cmd.exe) depends on where you have chosen to install Gramps.
* Right click on the ??terminal Gramps application, or the corresponding item in the Start menu.
* Note down the starting directory.
* Select the whole of the command and copy (ctrl-C) it.
* From the Start menu, start cmd.exe.
* Change directory to the starting directory you noted down.
* Right click and select Paste.
* Press {{man key press|Enter}}.

For example, this might be:
cd "\Program Files\GrampsAIO64\bin
"C:\Program Files\GrampsAIO64\bin\pythonw.exe" -EO ..\share\gramps\gramps.py

When the instructions below tell you to type something after the start command, you just type this after the last line, for example:
cd "\Program Files\GrampsAIO64\bin
"C:\Program Files\GrampsAIO64\bin\pythonw.exe" -EO ..\share\gramps\gramps.py -L

There are other ways to install Gramps for MS Windows, but these are much more complicated and are not covered here.

=== Mac OS X ===

Mac OS X is a [[Download|community supported]] platform. If you download the Mac OS X disk image (.dmg), then you simply drag the application to your application folder (or anywhere else you want to store it) and start Gramps by double clicking on the application in the normal way.

To run from the command line, you'll need to start Terminal, found in Applications:Utilities.
Once you have a terminal window open, at the prompt type
/path/to/Gramps.app/Contents/MacOS/Gramps
If you installed Gramps in Applications along with most of your other apps, that would be
/Applications/Gramps.app/Contents/MacOS/Gramps
You may use any of the command-line options along with this. For example, to get a detailed listing of all of the Family Tree databases in your default Family Tree folder, you would use
/Applications/Gramps.app/Content/MacOS/Gramps -L

There are other ways to install Gramps for Mac OS X, but these are much more complicated and are not covered here.

== Python options ==

In the examples of different platforms above, and also in commands in various files you may see some options after the 'python' command, for example '-EO' in
"C:\Program Files\GrampsAIO64\bin\pythonw.exe" -EO ..\share\gramps\gramps.py -L

It is important to distinguish between the '''python options''' in this case:
-EO
and the '''Gramps options''', in this case
-L

The '''python options''' that you may come across are:
* <code>-E</code> Ignore all PYTHON* environment variables, e.g. <code>PYTHONPATH</code> and <code>PYTHONHOME</code>, that might be set.
* <code>-O</code> Turn on basic optimizations. This changes the filename extension for compiled (bytecode) files from <code>.pyc</code> to <code>.pyo</code>. See also PYTHONOPTIMIZE.

The <code>-O</code> optimise flag has a number of effects in Gramps:
* If it is not turned on, an additional {{man menu|[[Gramps_4.2_Wiki_Manual_-_Tools#Debug|Debug]]}} entry appears in the {{man menu|[[Gramps_4.2_Wiki_Manual_-_Tools|Tools]]}} menu.
* If it is not turned on, [[Logging_system#So_how_logging_works_in_Gramps_after_all.3F|info logging messages are output]].
* If it is not turned on, [[Debugging_Gramps#Add_debug_statements|debug statements]] may be activated.
* If it is not turned on, additional features are available in the [[Gramps_4.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].

The '''Gramps options''' are described below.

== Available Gramps options ==

This section provides the reference list of all command line options available in Gramps. If you want to know more than just a list of options, see next sections: [[#Operation|Operation]] and [[#Examples| Examples]]. The summary below is printed by
gramps -h
or
gramps --help

Usage: gramps.py [OPTION...]
--load-modules=MODULE1,MODULE2,... Dynamic modules to load

Help options
-?, --help Show this help message
--usage Display brief usage message

Application options
-O, --open=FAMILY_TREE Open Family Tree
-C, --create=FAMILY_TREE Create on open if new Family Tree
-i, --import=FILENAME Import file
-e, --export=FILENAME Export file
-f, --format=FORMAT Specify Family Tree format
-a, --action=ACTION Specify action
-p, --options=OPTIONS_STRING Specify options
-d, --debug=LOGGER_NAME Enable debug logs
-l List Family Trees
-L List Family Trees in Detail
-t List Family Trees, tab delimited
-u, --force-unlock Force unlock of Family Tree
-s, --show Show config settings
-c, --config=[config.setting[:value]] Set config setting(s) and start Gramps
-y, --yes Don't ask to confirm dangerous actions (non-GUI mode only)
-q, --quiet Suppress progress indication output (non-GUI mode only)
-v, --version Show versions

The usage message is as follows:

Example of usage of Gramps command line interface

1. To import four databases (whose formats can be determined from their names)
and then check the resulting database for errors, one may type:
gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps -i file4.wft -a tool -p name=check.

2. To explicitly specify the formats in the above example, append filenames with appropriate -f options:
gramps -i file1.ged -f gedcom -i file2.gpkg -f gramps-pkg -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a tool -p name=check.

3. To record the database resulting from all imports, supply -e flag
(use -f if the filename does not allow Gramps to guess the format):
gramps -i file1.ged -i file2.gpkg -e ~/new-package -f gramps-pkg

4. To save any error messages of the above example into files outfile and errfile, run:
gramps -i file1.ged -i file2.dpkg -e ~/new-package -f gramps-pkg >outfile 2>errfile

5. To import three databases and start interactive Gramps session with the result:
gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps

6. To open a database and, based on that data, generate timeline report in PDF format
putting the output into the my_timeline.pdf file:
gramps -O 'Family Tree 1' -a report -p name=timeline,off=pdf,of=my_timeline.pdf

7. To generate a summary of a database:
gramps -O 'Family Tree 1' -a report -p name=summary

8. Listing report options
Use the name=timeline,show=all to find out about all available options for the timeline report.
To find out details of a particular option, use show=option_name , e.g. name=timeline,show=off string.
To learn about available report names, use name=show string.

9. To convert a Family Tree on the fly to a .gramps xml file:
gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml

10. To generate a web site into an other locale (in german):
LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Family Tree 1' -a report -p name=navwebpage,target=/../de

11. Finally, to start normal interactive session type:
gramps

Note: These examples are for bash shell.
Syntax may be different for other shells and for Windows.

=== List options ===
Print a list of known family trees:

;Sparse
-l, print a list of known family trees

[[Image:CommandLineExampleOutput-l-40.png|400px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Command Line Example Output for ''python gramps.py -l'']]
{{-}}

;Detailed
-L, print a detailed list of known family trees

[[Image:CommandLineExampleOutput_L-40.png|400px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Command Line Example Output for ''python gramps.py -L'']]

 

Note that dates are shown in the default LOCALE format. You change that at the system level. For example, on POSIX-based systems you could:

LC_TIME=en_AU.UTF-8 gramps -L

{{-}}

=== Version options ===

-v or --version prints version of Gramps and dependencies,
information about environment settings and python and system paths

[[Image:CommandLineExampleOutput-v-40.png|200px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Command Line Example Output for ''python gramps.py -v'']]
{{-}}

=== Format options ===

The format of any file destined for opening, importing, or exporting can be specified with the <pre>-f format</pre> option. The acceptable <tt>''format''</tt> values are listed below.

==== Full family tree support ====
These formats contain all your data that is present in a family tree.

* '''gramps''' - Gramps XML format: This format is available for import, and export. When not specified, it can be guessed if the filename ends with .gramps
* '''gpkg''' - Gramps package XML format: This format is available for import and export. When not specified, it can be guessed if the filename ends with .gpkg. This creates a zip package with your data as xml, and all your media files included
* '''grdb''' - pre Gramps 3.x database: This format is available for import to support the old file format of Gramps. Everything in the grdb file is imported. When not specified, it can be guessed if the filename ends with .grdb
* '''burn''' - GNOME iso burning: export, only available on GNOME where burn protocol exists

==== Reduced family tree support ====
These formats contain most, but not all data that can be created in Gramps

*'''ged''' - GEDCOM format: This format is available for import, and export. When not specified, it can be guessed if the filename ends with .ged
*'''gw''' - GeneWeb file: This format is available for import and export. When not specified, it can be guessed if the filename ends with .gw

==== Subset of your data ====
These formats contain a specific subset of your data

* '''csv''' - Comma Separated Value: This format is available for import and export. Be careful however, import must be as values created by the export function. Only a part of your data is contained in the output.
* '''vcf''' - VCard format: import and export
* '''vcs''' - VCalandar format: export
* '''def''' - old Pro-Gen format: import
* '''wft''' - Web Family Tree: This format is available for export only. When not specified, it can be guessed if the filename ends with .wft

=== Opening options ===

You can open a family tree, or you can ''open'' a file by importing it in an empty family tree.

To let Gramps handle this automatically, just supply the familytree or filename you want to open:

python gramps.py 'My Fam Tree'
python gramps.py JohnDoe.ged

The first opens a family tree, the second imports a GEDCOM into an empty family tree.

Additionally, you can pass Gramps the name of the family tree to be opened:

* use this option : <code>-O famtree</code> or <code>--open=famtree</code>

<code>-O</code>, Open of a family tree. This can be done also by just typing the name (name or database dir)

Examples:
python gramps.py 'Family Tree 1'
python gramps.py /home/cristina/.gramps/grampsdb/47320f3d
python gramps.py -O 'Family Tree 1'
python gramps.py -O /home/cristina/.gramps/grampsdb/47320f3d

{{Man tip| Tip |If no option is given, just a name, Gramps will ignore the rest of the command line arguments. Use the <code>-O</code> flag to open, <code>-i</code> to import, and do something with the data.}}

{{Man tip| Tip |Only family trees can be opened directly. For other formats, you will need to use the import option which will set up the empty database and then import data into it.}}

{{Man tip| Tip |Only a single family tree can be opened. If you need to combine data from several sources, you will need to use the import option.}}

=== Import options ===

The files destined for import can be specified with the <code>-i filename</code> or <code>--import=filename</code> option. The format can be specified with the <code>-f format</code> or <code>--format=format</code> option, immediately following the ''filename'' . If not specified, the guess will be attempted based on the ''filename''.

Example:
python gramps.py -i 'Family Tree 1' -i 'Family Tree 2'
python gramps.py -i test.grdb -i data.gramps

{{man tip | Tip |More than one file can be imported in one command. If this is the case, Gramps will incorporate the data from the next file into the database available at the moment.}}

When more than one input file is given, each has to be preceded by <code>-i</code> flag. The files are imported in the specified order, i.e. <code> -i file1 -i file2 </code> and <code> -i file2 -i file1 </code> might produce different Gramps IDs in the resulting database.

=== Export options ===

The files destined for export can be specified with the <code>-e filename</code> or <code>--export=filename</code> option. The format can be specified with the <code>-f</code> option immediately following the ''filename'' . If not specified, the guess will be attempted based on the ''filename'' . For iso format, the ''filename'' is actually the name of directory the Gramps database will be written into. For gramps-xml, gpkg, gedcom, wft, geneweb, and gramps-pkg, the ''filename'' is the name of the resulting file.

-e, export a family tree in required format. It is not possible to export to a family tree.

Example:
python gramps.py -i 'Family Tree 1' -i test.grdb -f grdb -e mergedDB.gramps
Note that above does not change 'Family Tree 1' as everything happens via a temporary database, whereas:
python gramps.py -O 'Family Tree 1' -i test.grdb -f grdb -e mergedDB.gramps
will import test.grdb into Family Tree 1, and then export to a file !

{{man tip| Exporting more files |More than one file can be exported in one command. If this is the case, Gramps will attempt to write several files using the data from the database available at the moment.}}

When more than one output file is given, each has to be preceded by <code>-e</code> flag. The files are written one by one, in the specified order.

=== Action options ===

The action to perform on the imported data can be specified with the <code>-a action</code> or <code>--action=action</code> option. This is done after all imports are successfully completed.

The following actions remain the same:

*''report'': This action allows producing reports from the command line.

*''tool'': This action allows to run a tool from the command line.

Reports and tools generally have many options of their own, so these actions should be followed by the report/tool option string. The string is given using the <code>-p option_string</code> or <code>--options=option_string</code> option.

The actions available in older versions of Gramps which were relocated in Gramps 3.3 are:

*''summary'': This action was the same as {{man menu|Reports ->View ->Summary}}. In Gramps 3.3 it was replaced by (or renamed to) '''-a report -p name=summary'''.

*''check'': This action was the same as {{man menu|Tools ->Database Processing ->Check and Repair}}. In Gramps 3.3 it was replaced by (or renamed to) '''-a tool -p name=check'''.

==== report action option ====
You can generate most reports from the command line using the report action.

An example:
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html"

You can provide the css style to use here with the css option:
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css=Web_Nebraska.css"
or without css in the html output:
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css="

{{man tip| Report option string |The report option string should satisfy the following conditions: It must not contain any spaces (due to the general nature of the command line interface). If some arguments need to include spaces, the string should be enclosed with quotation marks. Option string must list pairs of option names and values. Within a pair, option name and value must be separated by the equal sign. Different pairs must be separated by commas.}}

Most of the report options are specific for every report. However, there are some common options.

*<code>name=report_name</code>: This mandatory option determines which report will be generated.
{{man note|Report names|If the supplied report_name does not correspond to any available report, an error message will be printed followed by this list of available reports. 
<pre>
Available names are:
ancestor_chart - Ancestor Tree
ancestor_report - Ahnentafel Report
birthday_report - Birthday and Anniversary Report
calendar - Calendar
descend_chart - Descendant Tree
descend_report - Descendant Report
det_ancestor_report - Detailed Ancestral Report
det_descendant_report - Detailed Descendant Report
endofline_report - End of Line Report
family_descend_chart - Family Descendant Tree
family_group - Family Group Report
familylines_graph - Family Lines Graph
fan_chart - Fan Chart
hourglass_graph - Hourglass Graph
indiv_complete - Complete Individual Report
kinship_report - Kinship Report
navwebpage - Narrated Web Site
notelinkreport - Note Link Report
number_of_ancestors - Number of Ancestors Report
place_report - Place Report
records - Records Report
rel_graph - Relationship Graph
statistics_chart - Statistics Charts
summary - Database Summary Report
tag_report - Tag Report
timeline - Timeline Chart
WebCal - Web Calendar
</pre>}}
*<code>of</code>: output filename
*<code>off</code>: output format. These are the extension an output format makes available, eg, pdf, html, doc, ...
*<code>style</code>: for text reports, the stylesheet to use. Defaults to 'default'.
*<code>show=all</code>: This will produce the list of names for all options available for a given report.
*<code>show=option_name</code>: This will print the description of the functionality supplied by the option_name, as well as what are the acceptable types and values for this option.

So, to learn to use a report, do for example:
gramps -O "Family Tree 1" -a report -p "name=family_group,show=all"

{{man tip| Tip |If an option is not supplied, the last used value will be used. If this report has never been generated before, then the value from last generated report will be used when applicable. Otherwise, the default value will be used.}}

When more than one output action is given, each has to be preceded by <code>-a</code> flag. The actions are performed one by one, in the specified order.

{{man tip| lists |Some reports have options or arguments which are interpreted (by the report) to be on multiple lines. For instance some reports allow you to format how the information will be shown, perhaps with a name on one line and the person's birth date on the next line. Such multiple-line options or arguments are called "lists" by Gramps.}}

On the command line such lists must always start with a left square bracket <code>[</code> and must always end with a right square bracket <code>]</code> but since such square brackets are usually "special" to the "shell" (they mean something to the command interpreter
you are typing the command to), you must "escape" them so that they are ignored by your shell.

The details vary with each shell but (in linux/UNIX) usually you can precede such a square bracket with a backslash <code>\</code> or put quotation marks around the square bracket, usually either "single" or "double" ones.

The Hourglass Graph report allows you to put a "note" at the top of the report and such a "note" is an example of a "list" option. Here is an example:
gramps -O "Family Tree 1" -a report -p name=hourglass_graph,note='[line one,line two]'
which shows that inside such a list different lines are separated by commas, and that spaces are acceptable since the quotation marks are already there for the square brackets.

But if you want to have a comma inside your report you have to somehow tell Gramps that comma is not one which separates lines. You do that by enclosing the line with the comma in quotation marks (either single or double).

But if you are already using a set of quotation marks (to enclose your square brackets) you have to use the other type to enclose
the line with your comma. Here is an example:
gramps -O "Family Tree 1" -a report -p name=hourglass_graph,note="['line one, also line one','line two, also line two']"

It is possible to include any character in a list but the details are beyond the scope of this command-line introduction to Gramps.

You will need to know the precise methods available in your particular command shell interpreter to include a character which is "special" to your shell or "special" to Gramps (like the comma in the example above) but in general you will have to "escape" it twice, once to your shell and once again to Gramps, since you don't want your shell to think it is some instruction it should pay attention to and you don't want Gramps to think that either.

==== tool action option ====
You can run most tools from the command line using the 'tool' action.
To see which ones, say:
gramps -O "Family Tree 1" -a tool -p show=all
To see a tool's available options, for instance the "verify" tool:
gramps -O "Family Tree 1" -a tool -p name=verify,show=all
To run a tool, for instance the "verify" tool:
gramps -O "Family Tree 1" -a tool -p name=verify

{{man note|Tool names|If the supplied tool_name does not correspond to any available tool, an error message will be printed followed by this list of available tools. 
<pre>
Available names are:
check - Check and Repair Database
chtype - Rename Event Types
dgenstats - Dump Gender Statistics
evname - Extract Event Description
populatesources - Populate Sources and Citations
rebuild - Rebuild Secondary Indexes
rebuild_genstats - Rebuild Gender Statistics
rebuild_refmap - Rebuild Reference Maps
reorder_ids - Reorder Gramps IDs
test_for_date_parser_and_displayer - Check Localized Date Displayer and Parser
testcasegenerator - Generate Testcases for Persons and Families
verify - Verify the Data
</pre>}}

==== book action option ====
{{man note|New feature|Added in Gramps 4.2}}
You can run books from the command line using the 'book' action.
To see which ones, say:
gramps -O "Family Tree 1" -a book
To see a book's available options, for instance a book called "mybook":
gramps -O "Family Tree 1" -a book -p name=mybook,show=all
To run a book, for instance a book called "mybook":
gramps -O "Family Tree 1" -a book -p name=mybook

{{man note|Book names|If the supplied book_name does not correspond to any available Book, an error message will be printed followed by this list of available Books. eg: Example listing only as the Books will be whatever you have named them. 
<pre>
Available names are:
Granny Jones
Grampa John
Smith Family History
</pre>}}

=== Force unlock option ===

*<code>-u</code>: you can extend the <code>-O</code> flag with <code>-u</code> to force a locked family to be unlocked. This allows you to recover from a crash that leaves the family tree (database) locked, from the command line.

An example (to unlock the "Family Tree 1" database):
:<code>gramps -O "Family Tree 1" -a report -u > /dev/null</code>

{{man note|Note|It is not possible to open family trees that need repair from the command line.}}

=== Configuration (config) option ===
When all configuration variable(s) are set Gramps will start with these new values.

These options can takes three forms:
{{man note|Note|Except for examples <tt>1</tt> and <tt>3.2</tt>, All the following examples, use <code>behavior.database-path</code> as the configuration variable to change.}}

1) See all config values: <code>-s</code> or <code>--show</code>
 For example:
<pre>
$python gramps.py -show
Gramps config settings from /home/username/.gramps/gramps41/gramps.ini:
behavior.max-age-prob-alive=110
behavior.betawarn=false
behavior.check-for-updates=0
behavior.check-for-update-types=['new']
behavior.avg-generation-gap=20
behavior.database-path='/home/grampsdev/.gramps/grampsdb'
behavior.startup=0
behavior.database-backend='bsddb'
</pre>

[[Image:CommandLineExampleOutput-s-40.png|400px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Command Line Example Output for ''python gramps.py -s'']]
{{-}}

2) See a value: <code>--config=behavior.database-path</code> or <code>-c behavior.database-path</code>
 For example:
<pre>
$python gramps.py --config=behavior.database-path
Current Gramps config setting: behavior.database-path:'/home/username/.gramps/grampsdb'
</pre>

3) Set a value: <code>--config=behavior.database-path:'/media/mydb'</code> or <code>-c behavior.database-path:'/media/mydb'</code>
 For example:

3.1) Set a value to its default: <code>--config=behavior.database-path:DEFAULT</code> or <code>-c behavior.database-path:DEFAULT</code>
 For example:

3.2) Set more than one value: <code>--config=behavior.use-tips:False --config=behavior.autoload:True</code> or <code>-c behavior.use-tips:False -c behavior.autoload:True</code>
 For example:

== Operation ==

If the first argument on the command line does not start with a dash (i.e. no flag), Gramps will attempt to open the file with the name given by the first argument and start an interactive session, ignoring the rest of the command line arguments.

If the <code>-O</code> flag is given, then Gramps will try opening the supplied file name and then work with that data, as instructed by the further command line parameters.

{{man note|1=Note |2=Only one file can be opened in a single invocation of Gramps. If you need to get data from multiple sources, use the importing options by using <code>-i</code> flag.}}

With or without the <code>-O</code> flag, there could be multiple imports, exports, and actions specified further on the command line by using <code>-i</code> , <code>-e</code> , and <code>-a</code> flags.

The order of <code>-i</code> , <code>-e</code> , or <code>-a</code> options with respect to each does not matter. The actual execution order always is: all imports (if any) -> all exports (if any) -> all actions (if any).

{{man note| Note |But opening must always be first!}}

If no <code>-O</code> or <code>-i</code> option is given, Gramps will launch its main window and start the usual interactive session with the empty database, since there is no data to process, anyway. (Unless you have already expressed a "preference" that it start with the last database it used.)

If no <code>-e</code> or <code>-a</code> options are given, Gramps will launch its main window and start the usual interactive session with the database resulted from opening and all imports (if any). This database resides in a directory under the ''<code>~/.gramps/grampsdb/</code>'' directory.

Any errors encountered during import, export, or action, will be either dumped to stdout (if these are exceptions handled by Gramps) or to stderr (if these are not handled). Use usual shell redirections of stdout and stderr to save messages and errors in files.

== Examples ==

*To import four databases (whose formats can be determined from their names) and then check the resulting database for errors, one may type:

:<code>gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps -i file4.wft -a check</code>

*To explicitly specify the formats in the above example, append filenames with appropriate -f options:

:<code>gramps -i file1.ged -f gedcom -i file2.gpkg -f gramps-pkg -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check</code>

*To record the database resulting from all imports, supply -e flag (use -f if the filename does not allow Gramps to guess the format):

:<code>gramps -i file1.ged -i file2.gpkg -e ~/new-package -f gramps-pkg</code>

*To save any error messages of the above example into files outfile and errfile, run:

:<code>gramps -i file1.ged -i file2.dpkg -e ~/new-package -f gramps-pkg >outfile 2>errfile </code>

*To import three databases and start interactive Gramps session with the result:

:<code>gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps </code>

*To open a database and, based on that data, generate timeline report in PDF format putting the output into the my_timeline.pdf file:

:<code>gramps -O 'Family Tree 1' -a report -p name=timeline,off=pdf,of=my_timeline.pdf </code>

{{man tip|1=Listing report options |2=Use the <code>''name=timeline,show=all''</code> to find out about all available options for the timeline report. To find out details of a particular option, use <code>''show=option_name''</code> , e.g. <code>''name=timeline,show=off''</code> string. To learn about available report names, use <code>''name=show''</code> string.}}

*To convert the bsddb database on the fly to a .gramps xml file:

:<code>gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml</code>

* To generate a web site into an other locale (in german):

:<code>LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Family Tree 1' -a report -p name=navwebpage,target=/../de </code>

*Finally, to start normal interactive session type:

:<code>gramps</code>

== Environment variables==

{{man warn|Warning|Gramps can take advantage of the following environment variables ('''Only change them if you know what are you doing.''')}}

===GRAMPSHOME===
* '''GRAMPSHOME''' - if set, override default path to profile allowing user to use an external network drive to store data and all settings. For technically advanced users who run multiple versions of Gramps, setting a different $GRAMPSHOME is a way to avoid interference between the different versions in the Gramps user directory.
For example <pre>GRAMPSHOME=$HOME/familytrees/paternal</pre>

===LANG, LANGUAGE, LC_MESSAGE, LC_TIME ===
* '''LANG''', '''LANGUAGE''', '''LC_MESSAGES''', and '''LC_TIME''' - are used by Gramps to determine which language file(s) should be loaded. See locale(1) for a general discussion of '''LANG''', '''LC_MESSAGES''', and '''LC_TIME'''. Note that in addition to setting date formats (which are overridden in Gramps with Preferences settings) '''LC_TIME''' also sets the language used for words in dates like month and day names and ''in the context of dates'' words like ''about'', ''between'', and ''before''. '''LANGUAGE''' is a comma-separated list of language codes (''not locales'', though certain languages like pt_BR or cn_TW are regional variants) that sets a preference-ordered list of desired translations. It will override '''LANG''' but not '''LC_MESSAGES''' or '''LC_TIME'''.

{{man note|MacOSX|Because of the way launching with Finder works, the environment variables for the Gramps.app bundle are hard-coded in <code>Gramps.app/Contents/MacOS/Gramps</code>. If for some reason you need to change them, edit that file with TextEdit; be sure to save it back as plain text. See as well [[Run_GRAMPS_in_another_locale#Change_Mac_OS_X_application_defaults|setting locale]] for an alternative to using the '''LANG''' and '''LANGUAGE''' environment variables.}}

===GRAMPSI18N===
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]] - The LANG assumes the Gramps translations are installed globally. If this is not the case, you need to give Gramps the directory where the translations will be found. A translation is called <code>gramps.mo</code>, you can find it in linux with the locate command. For example, if you have Swedish in directory <code>/home/me/gramps/mo/sv/gramps.mo</code>, you can direct Gramps there using:
GRAMPSI18N=/home/me/gramps/mo LC_ALL=C.UTF-8 LANG="sv" python3 gramps

===GRAMPSDIR===
* The environment variable GRAMPSDIR is the path to your [[Translating_Gramps#gramps.sh|Gramps directory]].

{{man index|Gramps 4.2 Wiki Manual - Keybindings|Gramps 4.2 Wiki Manual - User Directory|4.2}}

{{languages|Gramps_4.2_Wiki_Manual_-_Command_Line}}

{{grampsmanualcopyright}}

[[Category:Documentation]]

Howto:Change the language of reports

2016-07-18T02:55:48Z

Jralls: /* Run Gramps in a different language */ Clarify use of localization environment variables, especially LC_TIME.

{{languages|Howto:_Change_the_language_of_reports}}

{{out of date}}
How you can produce reports in a language different from the language you installed your operating system in.

If you have an international family, chances are you want to produce reports in the language used by your distant family members.

Gramps is supported in [[Gramps_translations|many languages]]. You can produce reports in all these languages, by running Gramps in this language and making the report.

== Run Gramps in a different language==

===Running Gramps from a terminal or console===

First, let us learn how to run gramps from a terminal or console (the so called CLI-Command Line Interface, which you find typically in the System Menu of your task bar).

This can be done by typing <code>gramps</code>, as Gramps typically is installed in the directory <code>/usr/bin</code>. You can also start Gramps with <code>/usr/bin/gramps</code>, although this might be different on other distributions.

This command calls up Gramps with the default locale setting of your PC, that is, the language in which you installed your linux OS. If other locales are installed on your system, calling up Gramps in this language can be done. To check if there are other installed locales, use:
locale -a

For example, if the locale ''nl_BE'' is installed with encoding ''nl_BE.UTF-8'', you can start it with:
LANG=nl_BE.UTF-8 /usr/bin/gramps

Once you get the locale working and to make things handy going forward, you can create an alias. Open the file <code>.bashrc</code> (this file is located in your home directory) in a text editor. At the bottom of the file add the following:

alias gramps_nl=' LANG=nl_BE.UTF-8; /usr/bin/gramps'

You will need to make the alias command unique, so in this instance I have used <code>gramps_nl</code>. Now save the file. The UNIX terminal will need restarted for the new setting to take effect. Enter the alias command <code>gramps_nl</code> to run gramps in another locale. Multiple alias commands can be setup for multiple locales.

If you want to run Gramps in a locale you did not install, things will only work partially. You first need to set a fallback which is installed, or Gramps will never start. For example, if you have nl_BE.UTF-8 installed, and want to run in Swedish, you can do:

LC_ALL=nl_BE.UTF-8 LANGUAGE="sv" python3 gramps

'''N.B.:''' LC_TIME, which localizes date/time formats and translations, doesn't affect formats--those are set in Preferences--but does affect translations of month and day names (e.g. 'March' and 'Sunday') as well as qualifiers like 'before' and 'between'. Setting it will override LANG and LANGUAGE but not LC_ALL, which overrides everything else.

Gramps '''requires''' an UTF-8 locale to work correctly in most cases.

This all assumes the Gramps translations are installed globally. If this is not the case, you need to give Gramps the directory where the translations will be found. A translation is called ''gramps.mo'', you can find it in linux with the ''locate'' command. For example, if you have Swedish in directory /home/me/gramps/mo/sv/gramps.mo, you can direct Gramps there using:
GRAMPSI18N=/home/me/gramps/mo LC_ALL=C.UTF-8 LANG="sv" python3 gramps

Alternatively you can add a new item to the menu of GNOME or KDE, so this command needs not to be entered in a terminal, but can be called from the menu.

===Add KDE Menu Item===

[[Image:gramps_locale_add_kde_menu_item.png|800px|Add locale Gramps KDE menu item]]

*Right Click on <code>'K'</code> -> select <code>'Menu Editor'</code>
*Click on <code>'Office'</code>
*Click on <code>'New Item', Enter <code>'Gramps Genealogy System (nl)'</code>

In each of the fields enter:

*Description: <code>Gramps NL Locale</code>
*Comment: <code>Manage genealogical information, perform genealogical research and analysis</code>
*Command: <code>LANG=nl_BE.UTF-8; /usr/bin/gramps</code>

Change LANG to whatever you wanted as described in the previous section.
Leave all other options as default. To add the Gramps icon, click on the icon beside Name and Description fields

*Select <code>'Other icons'</code> -> Click on <code>'Browse'</code>
*Navigate to directory <code>/usr/share/gramps/images</code>
*Select image <code>gramps.png</code>

In the KDE Menu Editor select <code>'Save'</code> and close the window.

To Launch the locale version of Gramps click on K->APPLICATIONS -> OFFICE -> Gramps NL Locale

===Add GNOME Menu Item===

To add a Gnome Menu item, you need to have the menu editor installed; if not installed, (in Fedora) type
yum install alacarte
in a shell and restart.

The process is similar as for KDE above; right-click on the menu and choose "Edit Menus", go to the desired location in the menu tree and add a "New Menu Item". In the launcher properties window enter:

* Type: <code>Application</code>
* Name: [Whatever you like; e.g. <code>Gramps - SV</code>]
* Command: <code>env LANG=sv_SE.utf8 /usr/local/bin/gramps</code>
* Comment: [Whatever you like; e.g. <code>Starts Gramps in Swedish locale</code>]

{{man note|Note|Locale parameters are exported using the keyword ''env'', and my installation of Gramps resides in /usr/''local''/bin as opposed to /usr/bin}}

===Add Windows OS Menu Item===
On Windows you need to run the command line (cmd.exe) and type two lines similar to this:
SET LANG=nl_BE.UTF-8
"C:\Python25\pythonw.exe" "C:\Program Files\gramps\gramps.py"
This can be saved to a .bat file for easy execution.

===Change Mac OS X application defaults===
To change language defaults for Gramps (3.x), see [[Mac_OS_X:Application_package#Advanced_setup|Mac OS X Advanced setup]].

==What about dates and calendars==
Dates and calendars depend on your locale, so changing the LANG variable will run Gramps with the date and calendar appropriate to the locale (if implemented).

==How to install a locale==
For the above to work, you must have the needed locales installed. This will be distribution specific. Add to this wiki if you know how to do this in a distribution not listed.

Before the overview, it is advised to also install the gnome language package for the locale you want, eg for locale ''nl'' you need to install the package <code>language-pack-gnome-nl</code>. The KDE package (kde-i18n-nl) is not needed as Gramps uses gnome, even when run in KDE.

=== Ubuntu and variants===
'''6.06 and later'''
The file <code>/usr/share/i18n/SUPPORTED</code> lists all possible locales. Eg, for ''nl_BE'' we can choose from ''nl_BE.UTF-8 UTF-8, nl_BE ISO-8859-1, nl_BE@euro ISO-8859-15, nl_NL.UTF-8 UTF-8, nl_NL ISO-8859-1'' and ''nl_NL@euro ISO-8859-15''. We advise to use UTF-8 encoding, so here, ''nl_BE.UTF-8 UTF-8'' is the one we need to install.

Now, we backup the old locale file, and add the required locale. In a terminal you can backup with the commands:
mkdir ~/backup/locales
sudo cp /var/lib/locales/supported.d/local ~/backup/locales/local.old
With your favorite editor, you now need to change the <code>local</code> file as root, by adding the locale you want. So for nl_BE this would be adding the line ''nl_BE.UTF-8 UTF-8'' at the bottom. Watch out: end with a newline, so put an ENTER after this line. Next we need to regenerate the locales:
sudo dpkg-reconfigure locales
This command must not generate errors; if it did, you did something wrong.

'''5.10 and before'''
Execute
sudo dpkg-reconfigure locales
and select from the choices given the locales you need. Using UTF8 is advised, eg for ''nl_BE'': choose ''nl_BE.UTF-8''

== Run the report==
Having started Gramps in another language, all reports you make will also be in this language. Of course, things you typed in yourself are not translated.

===Tips for international use===
As what you type is not translated, some tips:
* for places: use the actual placename, for example München and not Munich. You could add an alternate location to the place with the translated name. (Or wait until the [[GEPS_006:_Better_Place_handling|better place handling]] feature is fully implemented and available).
* for notes: use the languages the people who are most interested in this section will want it in. This version enables multiple notes, so you are able to make different notes, one per language, with the possibility to use filters to determine what appears
* for descriptions: Try to use built-in description names as much as possible, as those are translated. Eg, try to avoid custom events, and use the builtin events of Gramps as much as possible.

===Automatically translate names and places===

From Gramps version 3.2, Gramps doesn't support language tagging of alternative names --- whether for a person or a location. That is, you can add multiple alternative names, each in a different language, but still only one of them will be the primary one --- and will be the one picked up for a report. Nevertheless, when exporting to a relative not speaking your language, or when preparing a report for a part of your family having different language preferences than yourself, you need to change the primary language, but only in a temporary manner --- so that you still continue maintaining your own DB in your preferred language.

Luckily, the simplicity of the Gramps XML format allows the use of a small XSL stylesheet, fed by a local translation table of the names you want translated, which you can use for this purpose. Here's how you can easily do it on Linux:
* Ensure your administrator installs the "xsltproc" package.
* Export your Gramps DB (without media) in the .gramps format (i.e., GZipped GRAMPS XML). Save it (let's call it Smith.gramps). Ensure you enable the required censorship on the database (such as restrict the data on living people, etc.)
* Store the translation XSL ([http://www.tarunz.org/~vassilii/pub/gramps-translate/gramps-translate.xsl gramps-translate-names.xsl]) near the Smith.gramps. Look at the XSL source for advanced parameters allowing you to customize the translation.
* Create the translation dictionary ([http://www.tarunz.org/~vassilii/pub/gramps-translate/t.xml t.xml]) near it as well:
<?xml version="1.0" encoding="UTF-8"?>
<nowiki><dict xmlns="http://tarunz.org/xml/dict/0.1.0/"></nowiki>
<w>
<s lang="ru">Хана</s>
<s lang="ru">Ханна</s>
<s lang="de">Hane</s>
<s lang="en">Hannah</s>
</w>
</dict>
: Populate it with the translations for all the stems you want translated. The translation breaks down names into stems using a customizable delimiter set. This allows translation of compound names, like ''Menachem-Mendl'', using the same rules, as given for the simple names comprising the compound, i.e., ''Menachem'' and ''Mendl'' in this case.
* Run the translation, using the xsltproc command. To just use the defaults (Russian to English translation), do this:
gunzip < Smith.gramps | xsltproc gramps-translate-names.xsl - |gzip > en.Smith.gramps
:See the XSL source for more advanced parameters. E.g., if you want to collect the stems missing translation into a file "missing", translate into German, and use "[LIVING]" as the censorship marker, the command line will be something like this:
gunzip < Smith.gramps | xsltproc --stringparam living '[LIVING]' --param log-missing 1 --stringparam lang-to de gramps-translate-names.xsl - 2> missing |gzip > de.Smith.gramps

* Use the "missing" file obtained above to collect stems to add to the translation dictionary.
* You can use the following [http://www.tarunz.org/~vassilii/pub/gramps-translate/Makefile Makefile] stanza to facilitate your processing:
GZIP=gzip
GUNZIP=gunzip
XSLT=xsltproc
TRANSLATEXSL=gramps-translate.xsl
en.%.gramps: %.gramps
$(GUNZIP) < $< | $(XSLT) --stringparam living '[LIVING]' $(TRANSLATEXSL) - | $(GZIP) > $@
* Create a new database in gramps, and import the resulting en.Smith.gramps into it. Review the database, and now produce, using the language translated into, all the reports, export into GEDCOM, etc.
* GRAMPS XML version is hardcoded in the XSL -- make sure it matches yours. "zcat *.gramps|head" will give you the GRAMPS XML format version used in that Gramps file. The script works has been tested either 1.3.0 (Gramps v3.2) or 1.4.0 GRAMPS XML (Gramps v3.3).

[[Category:Tutorials|Change the language of reports]]
[[Category:Documentation]]
[[Category:Translators/Categories]]

Template:Filename mac ppc

2016-04-16T22:22:43Z

Jralls: Fix bug 8563

Gramps-PPC-{{Version_Mac}}-2<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2016-04-16T22:22:15Z

Jralls: Fix bugs 9375 & 8563.

Gramps-Intel-{{Version_Mac}}-2<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Template:Filename mac intel

2016-02-15T16:14:28Z

Jralls: Update with version that fixes bug 9222.

Gramps-Intel-{{Version_Mac}}-4<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>

Download

2016-02-15T16:13:11Z

Jralls: /* Mac OS X */ Restore PPC link to templates; current release is available.

{{languages}}

{{man note|{{Man menu|'''Current version: {{version}} Released: 2016-01-06'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as Python 2 support dropped. Uses GTK+ 3 GUI. Lot of updates see:.''[[Gramps_4.2_Wiki_Manual_-_What's_new%3F|What's new?]]}}

{{man warn|''Legacy version: 3.4.9 Released: 2015-04-30|This is the final maintenance release designed for those of you still running gramps with gtk2. The database is common between version 4.0.x (not version 4.1.x and version 4.2.x) and 3.4.x branch, most differences are into interface...''[https://gramps-project.org/2015/04/gramps-3-4-9-released/]}}

== Linux ==

[[Image:Linux_220x261.png|128px|left]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==

[[File:windows_180x160.png|128px|left]]

Before download: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

Supports Microsoft Windows in all versions 7 and later.(''Please note: Python-3.5 and Gtk-3.18 dropped support for Windows XP not Gramps itself. Gramps can still be run on Windows XP with older versions of those libraries.'')

<big>[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]
    
[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]</big>

After download: double-click to install Gramps.

{{man tip|Shortcuts|Once installed one shortcut is placed on the desktop and in the Start menu three shortcuts are added, please only use the first shortcut, unless requested by a developer. 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu|<--- Shortcut for everyday use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console 3) ''GrampsAIO'''XX''' ''{{version}}''-debug}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. However if this fails for any reason, '''Create''' a new Family Tree and '''Import''' the back-up into this new Tree.

Use the Windows AIO version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO-4|this page]] (English only).

Alternative independent '''Legacy''' MS Windows version [[#3|[3]]].

== Mac OS X ==

[[Image:macos_200x200.png|128px|left]]

Before download: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Supports Mac OS X in all versions 10.5 (Leopard) and later.

<big>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]</big>
    
<big>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_ppc}}.dmg Power PC {{version_Mac}}]</big>

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next drag the Gramps application to your application folder and double-click to launch it [[#2|[2]]].

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. However if this fails for any reason, '''Create''' a new Family Tree and '''Import''' the back-up into this new Tree.

{{man tip|Spell Checking:|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [http://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== BSD ==

[[File:Bsd daemon.jpg|128px|left]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>
{{-}}

== Live CD ==

[[Image:Download_link.png|150px|left|link=http://sourceforge.net/projects/gramps/files/OldFiles/3.2.5/lgenealogy-6.1-desktop-i386.iso]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn..). [[Linux_Genealogy_CD#Obtaining_the_CD|Obtaining the CD]] (727 MB) [[Linux Genealogy CD|Linux Genealogy CD based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu 14.04.3] and Gramps from the CD anytime you like.
{{-}}
[[Image:Download_link.png|150px|left|link=http://cdimage.ubuntu.com/edubuntu/releases/14.04/release/]]
'''Edubuntu 14.04.3''' includes Gramps 4.0.3-1 (For information about Edubuntu [http://www.edubuntu.org/news/14.04.2-release visit])
{{-}}

== Linux and BSD distributions ==

Most linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

— current stable release
Debian 7 ("wheezy") — obsolete stable release
— obsolete stable release

{| {{prettytable}}
!Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[Image:Debianopenlogo-32.png]]''' [[Debian]] '''
|Add/Remove Software
|Debian 7 ("wheezy") (old stable): Gramps 3.4.0 Debian 8 ("jessie")(stable): Gramps 4.1.1 stretch (testing): Gramps 4.2.2 [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 4.2.2
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[Image:Ubuntu_32x32.png]]''' Ubuntu '''
| Software Centre
|Precise (12.04 LTS): Gramps 3.3.1 Trusty (14.04 LTS): Gramps: 4.0.3 Trusty Backports (14.04 LTS): Gramps: 4.0.4 Vivid (15.04): Gramps: 4.1.1 Wily (15.10): Gramps: 4.2.0 Xenial (Development: 16.04 LTS): Gramps: 4.2.2
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]
|-
|'''Linux Mint'''
|Software Manager
|Isadora (Gramps 3.2.0-1) Lisa (Gramps 3.3.1-1) Olivia (Gramps 3.4.0-1) Qiana (Gramps 4.0.3+dfsg-2)
|[http://community.linuxmint.com/software/view/gramps available versions]
|-
|[[Image:Fedora_32x32.png]]''' Fedora '''
|Add/Remove Software (Gnome) or Software Management (KDE)
|Rawhide (Gramps 4.2.2) Fedora 23 (Gramps 4.2.2) Fedora 22 (Gramps 4.1.3)
|[https://apps.fedoraproject.org/packages/gramps available versions]
|-
|[[Image:Redhat_32x32.png]]''' Redhat '''
|Package Management Tool([https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/5/html/Deployment_Guide/ch-graphical-rpm.html pirut])
|
|The Fedora and Red Hat Projects were merged on September 22, 2003. See Fedora.
|-
|'''[https://www.mageia.org/en/ Mageia]'''
|[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|Mageia Caulron: Gramps 4.2.1 Mageia 5.0: Gramps 4.1.3 Mageia 4.1(EOL): Gramps 4.0.1
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|''' openSUSE '''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|openSUSE Tumbleweed: Gramps 4.2.0 openSUSE 13.2: Gramps 4.0.4
|[http://software.opensuse.org/package/gramps available versions] See note [http://gramps.1791082.n4.nabble.com/ahnenforschung-familie-ihle-de-td4672224.html#a4672266] : Gramps 4.2 can be installed Opensuse 13.2 ( if you add the 'openSUSE BuildService - GNOME:Apps' )
|-
|'''Slackware'''
|
|Slackware 14.1: Gramps 4.0.3
|[http://pkgs.org/search/?keyword=gramps available versions]
|-
|'''NetBSD'''
|
|NetBSD: Gramps 3.4.4
|[http://pkgsrc.se/databases/gramps3 available versions]
|-
|'''FreeBSD'''
|
|FreeBSD: Gramps 3.4.8
|[http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps available versions]
|-
|'''PC-BSD'''
|
|PC-BSD: Gramps 3.4.8
|
|-
|'''OpenBSD'''
|
|OpenBSD: Gramps 4.1.3
|[http://openports.se/misc/gramps available versions]
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually. Instructions are given below for a number of distributions.

{{man warn|1=Warning|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 3.4.3 to 3.4.4), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 2.y.z to 3.y.z), then the danger that it does not work properly is much greater.}}

[[Image:Debianopenlogo-32.png]]'''[[Debian]]''' and [[Image:Ubuntu_32x32.png]]''' Ubuntu ''' [{{github_url}}/releases/v{{version}} Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved (change the filename to match the one you downloaded).

sudo dpkg -i python-gramps_{{version}}-1_all.deb
or
sudo dpkg -i python3-gramps_{{version}}-1_all.deb

For other distributions, [[Image:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data

[2]
Alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.

[3]
An alternative independent '''Legacy''' version is [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_{{version_windows_portable}}.paf.exe] (29.0 MB)
[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' By Bart.S - '''[http://portableapps.com/blog/84601 Please report packaging issues to the author.]''' (2012-09-07)

== See also ==
* [[Previous releases of Gramps]]

[[Category:Documentation]]

Template:Filename mac intel

2016-01-11T04:15:11Z

Jralls: Bump dmg version, wrong Gramps.app packaged.

Gramps-Intel-{{Version_Mac}}-2<noinclude>
[[Category:Developers/Packaging ]]
[[Category:Versions]]
[[Category:Templates]]
</noinclude>