manual
389
edits
Changes
Rough draft for Gramps 4.x
==Installing Gramps from source code==
Gramps 3.4.x is the main current version, and is available in packaged form for some distributions. Gramps 4.x is a new version that has different requirements. Installation of this version is described [[Installation#Gramps_4.x|here]] === Gramps 3.4.x === ====General requirements====
Gramps {{version}} requires python 2.6 or greater, pygtk 2.16 or greater and librsvg2
</pre>
====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:
for the most recent development version, see [[Getting started with Gramps Trunk]].
====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.
'''Note that you should use your old Gramps version to export backup copies to GRAMPS XML before removing the old version.'''
==== Build 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>
Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a <code>--prefix=</code> and a <code>--with-mime-dir=</code> argument to <code>autogen.sh</code>.
==== See also ====* $GRAMPSHOME on [[Gramps 3.4 Wiki Manual - Command Line#Environment variables]]* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]* [[Installation_alternatives]]* [[Translating_Gramps#Installing_your_translation]]* [[Howto:Change_the_language_of_reports#Run_GRAMPS_in_a_different_language]] ===Mac OS X:Build from source====
There are several different ways of building Gramps from source on Mac OS X. An overview of building from source is given at [[Mac OS X:Build from source]].
An older build approach is given at [[Mac OS X:Build from source:Native OS X]].
=== Gramps 4.x ===
THIS IS ONLY A ROUGH DRAFT AND NEEDS UPDATING FOR Gramps 4.x
==== General requirements ====
Gramps 4.x requires python 2.? or greater, pygtk 2.? or greater and librsvg2
==== Linux package requirements ====
Required
{|{{Prettytable}}
|-
!Debian /Ubuntu
!Fedora /Redhat
!Comment
|-
|python
|python
|Required (needs version 2.? or later)
|-
|python-gtk2
|pygtk2
|Required (needs 2.? or greater)
|-
|[http://docs.python.org/library/bsddb.html BSDDB]
|[http://docs.python.org/library/bsddb.html BSDDB]
|Current backend
|-
|xdg-utils
|xdg-utils
|Required for Gramps-3.1.x or later
|}
Required for building
{|{{Prettytable}}
|-
!Debian /Ubuntu
!Fedora /Redhat
!Comment
|-
|librsvg2-common
|librsvg2
|Required for building
|-
|libglib2.0-dev
|glib2-devel
|Required for building
|-
|
|librsvg2-devel
|Required for building
|-
|intltool
|intltool
|Required for building
|-
|
|gcc make gettext
|Required for building
|}
Strongly recommended
{|{{Prettytable}}
|-
!Debian /Ubuntu
!Fedora /Redhat
!Comment
|-
|
|
| osmgsmap
|-
| graphviz
| graphviz graphviz-python
| Required for some reports and views
|-
|
|
| PyICU
|}
Optional
{|{{Prettytable}}
|-
!Debian /Ubuntu
!Fedora /Redhat
!Comment
|-
|python-gtkspell
|gnome-python2-gtkspell
|Suggested for running (spell check). Included in the python-gnome2-extras package in older Debian distributions.
|-
|rcs
|rcs
|Suggested for running
|-
| python-webkit python-gtkmozembed
| WebKitgtk pywebkitgtk
| Required for the HTML view
|-
| python-pygoocanvas
| goocanvas pygoocanvas
| Required for [[Graph View]]
|-
|
| Django
| Required for http://gramps-connect.org [[Gramps-Connect: Introduction|Gramps-Connect]]
|-
| python-pyexiv2
| pyexiv2
| Required for the Metadata Viewer and Edit Exif Metadata gramplets
|-
| libosmgpsmap-dev python-osmgpsmap
| osm-gps-map
| Required for the Geography views
|-
| gtk2-engines-pixbuf
|
| Solves issue with 'Unable to locate theme engine in module_path: "pixmap"'
|}
Under Redhat/Fedora you can install all of the above with:
<pre>
sudo yum install python pygtk2 xdg-utils rcs gnome-python2-gtkspell librsvg2 \
librsvg2-devel intltool gnome-doc-utils gcc automake autoconf autogen \
gettext WebKitgtk pywebkitgtk goocanvas pygoocanvas graphviz graphviz-python \ Django pyexiv2 inkscape ImageMagick
</pre>
====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/files/ Gramps SourceForge file area]. Eg: gramps-{{version}}.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#Unstable_development:_.22trunk.22|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://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0/ gramps
for the most recent development version, see [[Getting started with Gramps Trunk]].
====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.'''
==== Build 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 regular 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 </code> # as regular user
then <code>
make install </code> # as root
Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a <code>--prefix=</code> and a <code>--with-mime-dir=</code> argument to <code>autogen.sh</code>.
=== See also ===
* $GRAMPSHOME on [[Gramps 3.4 Wiki Manual - Command Line#Environment variables]]
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]
* [[Installation_alternatives]]
* [[Translating_Gramps#Installing_your_translation]]
* [[Howto:Change_the_language_of_reports#Run_GRAMPS_in_a_different_language]]
[[Category:Documentation]]
[[Category:Developers/Installation]]
[[Category:Developers/Packaging]]
