Difference between revisions of "Installation"

From Gramps
Jump to: navigation, search
(Obtaining the source)
(See also)
(222 intermediate revisions by 26 users not shown)
Line 1: Line 1:
[[Category:Documentation]][[Category:Developers/Installation]][[Category:Developers/Packaging]]
 
 
{{languages}}
 
{{languages}}
  
 +
== Users ==
  
==Live CD==
+
Full download and installation instructions for [[Image:linux_32x32.png|link=Download#Linux]], [[Image:windows_32x32.png|link=Download#MS_Windows]] and [[Image:macosx_32x32.png|link=Download#Mac_OS_X]] are on the [[Download]] page.
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.
 
  
==Automatic download and install of GRAMPS==
+
== Developers, packagers and advanced users ==
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 operating system some methods are listed below:
+
See  instructions for [[Build from source|building from source]].
* Debian based systems (Ubuntu and it's variants, Mepis, ...): <code>
 
  apt-get install gramps</code>
 
* Gentoo (and Sabayon):<code>
 
  emerge gramps </code>
 
* Mandriva: <code>
 
  urpmi gramps</code>
 
* Redhat based systems (Fedora, CentOS...): <code>
 
  yum install gramps</code>
 
  
==Manual download and install of GRAMPS==
+
== See also ==
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.
 
  
* '''Ubuntu''' and derivatives (Kubuntu, Mephis, ...): Ubuntu packages are available on [http://sourceforge.net/project/showfiles.php?group_id=25770 GRAMPS download page].
+
* $GRAMPSHOME on [[Gramps 5.0 Wiki Manual - Command Line#Environment variables]]
** Intrepid Ibex (8.10) : download [http://downloads.sourceforge.net/gramps/gramps_3.1.1-1_Ubuntu810.deb?modtime=1228530730&big_mirror=0 gramps_3.1.1-1_Ubuntu810.deb]  
+
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]
** Hardy (8.04) : download [http://downloads.sourceforge.net/gramps/gramps_3.1.1-1_Ubuntu804.deb?modtime=1228530730&big_mirror=0            gramps_3.1.1-1_Ubuntu804.deb]
+
* [[Installation_alternatives]]
** Gutsy (7.10) : download [http://sourceforge.net/project/showfiles.php?group_id=25770  gramps_3.0.3-1_ubuntu710.deb]
+
* [[Translation_environment4|Translating Gramps - Installing_your_translation]]
** Feisty (7.04) : download [http://sourceforge.net/project/showfiles.php?group_id=25770  gramps_2.2.10-1_all.deb]  and [http://sourceforge.net/project/showfiles.php?group_id=25770  gramps-help_2.2.10-1_all.deb] , and install with your package manager. Standard you could use the [http://packages.ubuntu.com/gutsy/admin/gdebi  gdebi] package.
+
* [[Howto:Change_the_language_of_reports#Run_Gramps_in_a_different_language|Howto:Change the language of reports # Run Gramps in a different language]]
** Dapper, Edgy and before: 2.2.10 is not available yet, for now download [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps_2.2.8-1dapper1_all.deb] and [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps-help_2.2.8-1dapper1_all.deb] , and install with your package manager.
 
* '''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].
 
* '''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''': 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.
 
* '''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/lenny/gramps Lenny Gramps].
 
  
''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.''
+
[[Category:Documentation]]
 
 
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.
 
 
 
==Windows, BSD, Mac OS X, Solaris==
 
===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]].
 
 
 
===Mac OS X===
 
For Mac OS X, both the [http://finkproject.org Fink project] and [http://macports.org MacPorts] have Gramps as a installable package. Fink currently has '''very''' old versions available it in the [http://pdb.finkproject.org/pdb/package.php/gramps# package database]. 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]]
 
 
 
===BSD and Solaris===
 
For BSD and Solaris there are experimental install instructions below. For FreeBSD use the [http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps /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 [http://portland.freedesktop.org/wiki/ XdgUtils].
 
 
 
==Additional software GRAMPS can benefit from==
 
GRAMPS does not rely on the following programs, however, having them will increase your productivity:
 
 
 
* '''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:
 
 
 
* '''desktop-file-utils''': see list of programs to open a media file on right click on an image
 
 
 
==Installing from source==
 
===General Requirements===
 
 
 
GRAMPS 3.1 requires python 2.5 or greater, pygtk2 2.10 or greater, glade bindings and librsvg2
 
 
 
==== Linux Package Requirements ====
 
{|border="1" align ="center"
 
|-
 
|Debian      /Ubuntu
 
|Fedora      /Redhat
 
|Comment
 
|-
 
|python
 
|python
 
|Required (needs version 2.5 or later)
 
|-
 
|pygtk2
 
|pygtk2
 
|Required (needs 2.10 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
 
|-
 
|
 
|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===
 
 
 
* The latest stable version of GRAMPS can be downloaded from the [http://sourceforge.net/projects/gramps GRAMPS SourceForge page]. Eg: gramps-3.1.1.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!
 
 
 
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.
 
 
 
===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<code>
 
  make uninstall</code>
 
 
 
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:<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>
 
 
 
===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:
 
* [[Gramps on the Eee|Asus Eee PC]]
 

Revision as of 23:43, 29 March 2018

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