2021-12-04 - Sorry the Gramps wiki is currently being upgraded to a newer software version. Please check back after the 2021-12-06.


From Gramps
Revision as of 06:57, 26 October 2008 by Steve geo (talk | contribs) (Removed references to Windows being unsupported)
Jump to: navigation, search

Live CD

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 Ubuntu 8.04 and GRAMPS from the CD anytime you like.

Automatic download and install of GRAMPS

Before downloading GRAMPS from this site, see if your operating system's repository makes the current version available. To see what the current version is, visit GRAMPS stable on Sourceforge and look at the version number of the top package.

To check what is available specifically for your operating system some methods are listed below:

  • Debian based systems (Ubuntu and it's variants, Mepis, Suse...):
  apt-get install gramps
  • Gentoo (and Sabayon):
  emerge gramps 
  • Mandriva:
  urpmi gramps
  • Redhat based systems (Fedora, CentOS...):
  yum install gramps

Manual download and install of GRAMPS

If you can't access the current version from your operating system's repositories you'll need to get it from this site. Some helpful users of GRAMPS have made packages for various systems. If you're lucky you'll find your system below. If it's missing you can contact the developers email list for advice.

Note: Different GNU/Linux distributions have different preferred ways to download and install packages for GRAMPS. Please read the installation instructions specific to your distribution before downloading.

In all other cases, you must download the source package (the file ending with '.tar.gz') and install GRAMPS manually. See the section about installing from source for details.

Windows, BSD, Mac OS X, Solaris

For Windows, there is an experimental Windows installer. If this installer does not offer the most recent versions of GRAMPS in Windows, you need to wait until a new installer is made available. For Windows user: See also some additional information on page GRAMPS_and_Windows.

For Mac OS X, both the Fink project and MacPorts have Gramps as a installable package. Fink currently has very old versions available it in the package database. Detailed instructions on using both these systems to install recent versions of gramps are given under Installing from source code on Mac OS X

For BSD and Solaris there are experimental install instructions below. For FreeBSD use the /usr/ports/science/gramps port.

Gnome and KDE

You can use both, but GRAMPS fits in better with GNOME. For KDE there are some minor issues due to some (GTK) issues outside of GRAMPS. Check the KDE page to know what these problems might be. Also, you might look at XdgUtils.

Additional software GRAMPS can benefit from

GRAMPS does not rely on the following programs, however, having them will increase your productivity:

  • Gnome-print: It adds the ability to directly print, to preview, and to generate fully internationalized PS and PDF output. At this time, one needs to install gnome-python-desktop to obtain this package (it might be known under different names, eg on debian python-gnome2-desktop).
  • Spell checking: Installing python-gnome2-extras provides the gtkspell module, which adds spell checking in the notes
  • Graphviz, Inkscape: Gramps can make nice Genealogical trees (relationship graphs). These are generated by the Graphviz package, which defines a code (dot), as well as programs to produce graphs (dotty, to be called from command line). This gives you as researcher most power over how your tree will look, but has a learning curve. Also, kgraphviewer works fine with dot generated by GRAMPS. An alternative is to make a graphical report, converting the tree to an svg file, which you then can open/edit/refine in eg Inkscape.
  • ttf-freefont: Useful as a font that supports a large subset of the unicode and is a true type. This works well with both gnomeprint and graphviz output.
  • XdgUtils is a set of command line tools that assist applications with a variety of desktop integration tasks. About half of the tools focus on tasks commonly required during the installation of a desktop application and the other half focuses on integration with the desktop environment while the application is running. Even if the desktop components of your application are limited to an installer, configuration or management tool, Xdg-utils provides you with an easy way to enhance the usage experience of your customers by improving the integration of these components in the user's environment.

Other packages might also be useful:

  • desktop-file-utils: see list of programs to open a media file on right click on an image
  • Yelp: Gnome help browser. This allows to call and read the GRAMPS command line reference (tool) on your computer.

Installing from source

General Requirements

GRAMPS 2.0 requires python 2.3 and the gnome-python and pygtk2 packages. The gnome-python module should be 2.6.0 or greater. The pygtk package should be version 2.5.0 or greater.

Also librsvg2-common is needed. This is a common error at the moment in some packages. Without this library, the icons are not shown.

Linux Package Requirements

Debian /Ubuntu Fedora /Redhat Comment
python python Required (needs version 2.5 or later)
pygtk2 pygtk2 Required (needs 2.5.0 or greater)
gnome-python gnome-python Required (needs 2.6.0 or greater)
rcs rcs Suggested for running
librsvg2-common librsvg2 Required for building
librsvg2-devel Required for building
gnome-common Required for building
intltool Required for building
gnome-doc-utils Required for building
gcc, make, gettext Required for building

Obtaining the source

  • The latest stable version of GRAMPS can be downloaded from the GRAMPS SourceForge page. As of this writing, this is gramps-3.0.1.tar.gz. Extract this file into a directory:
  tar xzvf gramps-zzz.tar.gz

and then go into this directory:

  cd gramps-zzz

  • If you are interested in testing out the very latest development versions of GRAMPS, they can be obtained from SVN, see Brief introduction to SVN. The SVN versions of GRAMPS are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!

Please, now is the time to read the INSTALL and README files accompanying the code. They come with the most recent information.

Dealing with earlier versions

If you have an older version of the GRAMPS source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.

Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. Do not install over the top of the old version. As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run

 make uninstall

as root from where you installed the version from. Use your distribution's package manager to uninstall if your old version was installed as a package.

Installing from source code on Linux

GRAMPS provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:

 ./autogen.sh   as user

This script will report any missing dependencies. Install these (see also INSTALL file). Building from source code typically requires that the development versions of the required libraries be installed. You might consider setting a prefix path with autogen.sh, see the INSTALL file for instructions. Standard install is in /usr/local.

Once a successful run of autogen.sh has been completed, you can run the typical make procedure.

 make (as user)


 make install (as root) 

Installing from source code on BSD

Installing on BSD is as straightforward as on Linux, apart from some minor issues like tools having different names. See the BSD page for details.

Installing from source code on Mac OS X

Version 3.0.1 has been successfully installed via fink, see: Mac OS X fink local

Some users have successfully installed GRAMPS on Mac OS X. See the Mac OS X page for details. Please, add to the wiki if you successfully installed GRAMPS on OS X.

Installing from source code on Windows

Fortunately for users of Microsoft Windows, some users have made a Windows installer. So far there have not been any reports of serious differences between the official builds of GRAMPS and the Windows Installer, so the future looks promising, but please, use this at your own risk.

If the dependencies are in place, the development version can be tested by getting the source (see above), making a copy of the file const.py.in and rename it to const.py, then execute "python gramps.py" from within the src directory. Of course, this is a development version, so warnings apply even more to this case than when using the installer.

Installing from source code on Solaris

Version 3.0.1 has been successfully installed from source on both Solaris 10 (SPARC) and OpenSolaris X86 (2008.05). Please see the Solaris page for step-by-step details.

GRAMPS on handhelds

GRAMPS can run fine on some small-factor devices. Users have been successful in using GRAMPS on: