Difference between revisions of "Installation"

From Gramps
Jump to: navigation, search
m (Ubuntu and derivatives: list version for clarity)
m (See also)
 
(163 intermediate revisions by 25 users not shown)
Line 1: Line 1:
{{languages}}
+
{{languages|Installation}}
[[Category:Documentation]][[Category:Developers/Installation]][[Category:Developers/Packaging]]
 
  
== Latest Released Version ==
+
== Users ==
  
The latest released version is '''GRAMPS 3.1.2'''. This version may not yet be available for installation on your platform. Please visit the [[Download]] page for more information.
+
Full download and installation instructions for [[File:linux_32x32.png|link=Download#Linux]], [[File:windows_32x32.png|link=Download#MS_Windows]] and [[File:macosx_32x32.png|link=Download#macOS]] are on the [[Download]] page.
  
== Upgrading GRAMPS ==
+
== Developers, packagers and advanced users ==
  
If you are '''Upgrading GRAMPS''' from a previous version you should first:
+
See  instructions for [[Build from source|building from source]].
  
# Use your '''old version of GRAMPS''' to '''export''' your Family Trees to GRAMPS XML
+
== See also ==
# '''Uninstall''' your old version of GRAMPS
 
# '''Install''' the new version of GRAMPS by following the instructions below
 
# '''Create''' a new Family Tree
 
# '''Import''' your old GRAMPS XML data
 
  
==Additional software GRAMPS can benefit from==
+
* Command Line documentation : [[Gramps {{man version}} Wiki Manual - Command Line#Environment variables|<code>$GRAMPSHOME</code> Environment variable]]
GRAMPS does not rely on the following programs, however, having them will increase your productivity:
+
* Setting [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29|<code>$GRAMPSI18N</code> for your locale]]
 +
* [[Installation_alternatives|Installation alternatives]]
 +
* Translating Gramps : [[Translating_Gramps#Installing_your_translation|Installing your translation]]
 +
* How to : Change the language of reports - [[Howto:Change_the_language_of_reports#Run_Gramps_in_a_different_language|Run Gramps in a different language]]
  
* '''Spell checking''': Installing python-gnome2-extras and python-enchant provides the gtkspell module and the enchant 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, [https://gna.org/projects/kgraphviewer 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 print and graphviz output.
 
* '''[http://portland.freedesktop.org/wiki/ 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:
+
[[Category:Documentation]]
 
 
* '''desktop-file-utils''': see list of programs to open a media file on right click on an image
 
 
 
==Linux==
 
===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 [http://sourceforge.net/project/showfiles.php?group_id=25770&package_id=109309 GRAMPS stable on Sourceforge] and look at the version number of the top package.
 
 
 
To check what is available specifically for your Linux operating system some methods are listed below:
 
{|{{prettytable}}
 
!Linux Operating System
 
!Command Line
 
|-
 
|<!--Linux Operating System-->Debian based systems<br>(Ubuntu & variants, Mepis,...)
 
|<!--Command Line--><code>apt-get install gramps</code>
 
|-
 
|<!--Linux Operating System-->Gentoo (and Sabayon)
 
|<!--Command Line--><code>emerge gramps </code>
 
|-
 
|<!--Linux Operating System-->Mandriva
 
|<!--Command Line--><code>urpmi gramps</code>
 
|-
 
|<!--Linux Operating System-->Redhat based systems<br>(Fedora, CentOS...)
 
|<!--Command Line--><code>yum install gramps</code>
 
|-
 
|<!--Linux Operating System-->OpenSUSE
 
|<!--Command Line--><code>sudo zypper install gramps</code>
 
|}
 
 
 
===Manual download and install of GRAMPS===
 
If your Linux operating systems repository does not have the current version, then you may be able to download it from this site. Some helpful users of GRAMPS have made packages for various systems. If you are lucky you'll find your system below. If it's missing you can contact the developers email list for advice.
 
 
 
====Ubuntu and derivatives====
 
Repository packages for '''Ubuntu''' and derivatives (Kubuntu, Mephis, LinuxMint, ...): are available on [http://sourceforge.net/project/showfiles.php?group_id=25770 GRAMPS download page].
 
 
 
{|{{prettytable}}
 
!Ubuntu (Version)
 
! GRAMPS<br>Release
 
!Download
 
|-
 
|<!-- Ubuntu (Version) -->Jaunty Jackalope (9.04)
 
|<!-- GRAMPS<br>Release -->3.1.2
 
|<!-- Download -->[http://sourceforge.net/project/downloading.php?group_id=25770&filename=gramps_3.1.2-1_Ubuntu904.deb gramps_3.1.2-1_Ubuntu904.deb]
 
|-
 
|<!-- Ubuntu (Version) -->Intrepid Ibex (8.10)
 
|<!-- GRAMPS<br>Release -->3.1.2
 
|<!-- Download -->[http://downloads.sourceforge.net/gramps/gramps_3.1.1-1_Ubuntu810.deb?modtime=1228530730&big_mirror=0 gramps_3.1.2-1_Ubuntu810.deb]
 
|-
 
|<!-- Ubuntu (Version) -->Hardy (8.04)
 
|<!-- GRAMPS<br>Release -->3.1.2
 
|<!-- Download -->[http://transact.dl.sourceforge.net/sourceforge/gramps/gramps-3.1.2-1_Ubuntu804.deb gramps-3.1.2-1_Ubuntu804.deb]
 
|-
 
|<!-- Ubuntu (Version) -->Gutsy (7.10)
 
|<!-- GRAMPS<br>Release -->3.0.3
 
|<!-- Download -->[http://sourceforge.net/project/showfiles.php?group_id=25770  gramps_3.0.3-1_ubuntu710.deb]
 
|-
 
|<!-- Ubuntu (Version) -->Feisty (7.04)
 
|<!-- GRAMPS<br>Release -->2.2.10
 
|<!-- Download -->GRAMPS 2.2.10 only available, download [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps_2.2.10-1_all.deb]<br>and [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps-help_2.2.10-1_all.deb], and install with your package manager.
 
|-
 
|<!-- Ubuntu (Version) -->Dapper, Edgy<br> and earlier versions of Ubuntu
 
|<!-- GRAMPS<br>Release -->2.2.8
 
|<!-- Download -->GRAMPS 2.2.8 only available , download [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps_2.2.8-1dapper1_all.deb]<br>and [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps-help_2.2.8-1dapper1_all.deb], and install with your package manager.
 
|}
 
 
 
====Debian====
 
'''Debian''': the latest version should be in the ''unstable'' repository ([http://packages.debian.org/sid/gramps Sid Gramps]) and can be upgraded from your package manager. The ''testing'' repository is updated 10 days later (except near a new stable release), see [http://packages.debian.org/testing/gramps Testing Gramps].
 
 
 
====SuSE====
 
'''SuSE''': Richard Bos has been providing the GRAMPS releases for OpenSUSE. The repository for OpenSUSE 11.1 is available from [http://download.opensuse.org/repositories/Education/openSUSE_11.1/]. Note that at the time of writing this repository is not the same as that in the repository list as "Education" and must be added as a URL. The repository for 11.0 is [http://download.opensuse.org/repositories/Education/openSUSE_11.0/] and 10.3 is [http://download.opensuse.org/repositories/Education/openSUSE_10.3/]. For earlier versions of OpenSUSE (10.2) see the forum entry about [http://www.suseforums.net/index.php?s=22f80a050a1e3cffffd590db0813dea9&showtopic=28727&pid=152093&st=0&#entry152093 satisfying GRAMPS dependencies for SuSE with the ''rbos'' and SMART]. Also, there is [[OpenSUSE_RPM|an other alternative using openSUSE BuildService]].
 
 
 
====Mandriva====
 
'''Mandriva''': Newer versions of GRAMPS are sometimes backported. To install backports you must enable the ''backports'' repository (make sure you understand the instructions on the [http://wiki.mandriva.com/en/Docs/Basic_tasks/Installing_and_removing_software#Advanced_use:_Backports_and_candidate_updates Mandriva wiki]). If the latest version is not in the ''backports'' repository you cab try the ''contrib'' repository.
 
 
 
====Fedora====
 
'''Fedora''': For Fedora Core look on the [http://sourceforge.net/project/showfiles.php?group_id=25770 GRAMPS download page] for a package containing ''fc'' with your number and ending with ''.rpm''. The alternative to installing from source is to [[fedora rpm|build a package]] from an rpm spec file, or install a binary from fedora testing.
 
 
 
====Different GNU/Linux distributions====
 
Different GNU/Linux distributions have other 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 [http://sourceforge.net/project/showfiles.php?group_id=25770 download] the source package (the file ending with '.tar.gz') and install GRAMPS manually. See the section about installing from source for details.
 
 
 
===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 [http://portland.freedesktop.org/wiki/ XdgUtils].
 
 
 
===GRAMPS on handhelds===
 
GRAMPS can run fine on some small-factor devices. Users have been successful in using GRAMPS on:
 
* [[Gramps on the Eee|Asus Eee PC]]
 
 
 
===Live Genealogy 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 [http://ubuntu.com Ubuntu 8.04] and GRAMPS from the CD anytime you like.
 
 
 
==Windows, FreeBSD, Mac OS X, Solaris==
 
===Windows===
 
See the [[download]] page for the ''Windows installer'', ensure you have downloaded and installed the [[Windows_installer#Installation |Windows dependencies first.]]
 
*Additional information for Windows users is on page [[GRAMPS and Windows]].
 
 
 
===Mac OS X===
 
At present (June 2009) there is no downloadable simple installable package for the Mac. You have to [[Installation#Mac OS X_2 |build it from source]].
 
 
 
There is currently an ongoing project to deliver a click-to-install packaged GRAMPS for Mac, but at the moment it has to be built. The new project is described at [[Mac gtk-osx port]].
 
 
 
===FreeBSD and Solaris===
 
For FreeBSD and Solaris there are experimental install instructions.
 
* For FreeBSD use the [http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps /usr/ports/science/gramps] port.
 
 
 
==Installing GRAMPS from source code==
 
===General Requirements===
 
 
 
GRAMPS 3.1.x requires python 2.5 or greater, pygtk2 2.12 or greater, glade bindings and librsvg2
 
 
 
==== Linux Package Requirements ====
 
{|{{Prettytable}}
 
|-
 
!Debian      /Ubuntu
 
!Fedora      /Redhat
 
!Comment
 
|-
 
|python
 
|python
 
|Required (needs version 2.5 or later)
 
|-
 
|pygtk2
 
|pygtk2
 
|Required (needs 2.12 or greater)
 
|-
 
|xdg-utils
 
|xdg-utils
 
|Required for Gramps-3.1.x or later
 
|-
 
|rcs
 
|rcs
 
|Suggested for running
 
|-
 
|python-gnome2-extra
 
|
 
|Suggested for running (spell check)
 
|-
 
|python-enchant
 
|
 
|Suggested for running (spell check)
 
|-
 
|librsvg2-common
 
|librsvg2
 
|Required for building
 
|-
 
|libglib2.0-dev
 
|
 
|Required for building
 
|-
 
|python-glade2
 
|
 
|Required
 
|-
 
|
 
|librsvg2-devel
 
|Required for building
 
|-
 
|
 
|gnome-common
 
|Required for building
 
|-
 
|intltool
 
|intltool
 
|Required for building
 
|-
 
|
 
|gnome-doc-utils
 
|Required for building
 
|-
 
|
 
|gcc, make, gettext
 
|Required for building
 
|-
 
|}
 
 
 
====Obtaining the source====
 
 
 
There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/INSTALL?view=markup INSTALL] and [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/README?view=markup README] files accompanying the code. They come with the most recent information. Details on each download method:
 
 
 
'''1. Download a Stable Version'''
 
 
 
* The latest stable version of GRAMPS can be downloaded from the [http://sourceforge.net/projects/gramps GRAMPS SourceForge page]. Eg: gramps-3.1.2.tar.gz. Extract this file into a directory:
 
<code>
 
  tar xzvf gramps-zzz.tar.gz
 
</code> and then go into this directory:<code>
 
  cd gramps-zzz
 
</code>
 
* 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!
 
 
 
'''2. Download from SVN'''
 
 
 
You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:
 
 
 
svn co https://gramps.svn.sourceforge.net/svnroot/gramps gramps
 
 
 
====Upgrading GRAMPS====
 
 
 
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<code>
 
  make uninstall</code>
 
 
 
as root '''from where you installed the old version'''. Use your distribution's package manager to uninstall if your old version was installed as a package.
 
 
 
'''Note that you should use your old GRAMPS version to export backup copies to GRAMPS XML before removing the old version.'''
 
 
 
===Linux===
 
 
 
GRAMPS provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:<code>
 
  ./autogen.sh  </code> 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. <code>
 
  make (as user)</code>
 
 
 
then <code>
 
  make install (as root) </code>
 
 
 
===BSD===
 
 
 
Installing on BSD is as straightforward as on Linux, apart from some minor issues like tools having different names. See the [[BSD Platforms|BSD page]] for details.
 
 
 
===Mac OS X===
 
 
 
For Mac OS X, both the [http://finkproject.org Fink project] and [http://macports.org MacPorts] have GRAMPS as an installable package. Unfortunately this means that these two projects have simplified the building from source, not that they have a simple single click installer.
 
 
 
An overview of installing GRAMPS from source on the Mac as well as detailed instructions on using both these systems to install recent versions of GRAMPS are given under [[Mac_OS_X|Installing from source code on Mac OS X]]
 
 
 
===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.
 
 
 
===Solaris===
 
 
 
GRAMPS has been successfully installed from source on both Solaris 10 (SPARC) and OpenSolaris X86 (2008.05). Please see the [[Solaris Platforms|Solaris page]] for step-by-step details.
 

Latest revision as of 21:08, 8 September 2021

Users

Full download and installation instructions for Linux 32x32.png, Windows 32x32.png and Macosx 32x32.png are on the Download page.

Developers, packagers and advanced users

See instructions for building from source.

See also