Difference between revisions of "Installation"

From Gramps
Jump to: navigation, search
(Additional software GRAMPS can benefit from)
(301 intermediate revisions by 39 users not shown)
Line 1: Line 1:
 
{{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 7.04 LTS] and GRAMPS from the CD anytime you like.
 
  
==Easy download and install of GRAMPS==
+
== Developers, packagers and advanced users ==
Before downloading, check if the version of GRAMPS in your distribution is not current:
 
* Mandriva: <code>
 
  urpmi gramps</code>
 
* Debian, (K,X,Edu)Ubuntu, Mepis, Suse: <code>
 
  apt-get install gramps</code>
 
* Fedora: <code>
 
  yum install gramps</code>
 
  
==Upgrading to the latest version==
+
See instructions for [[Build from source|building from source]].
If your version of GRAMPS is not current, some users offer up to date packages for some distributions:
 
  
* '''Ubuntu''' and derivatives (Kubuntu, Mephis, ...): Ubuntu packages are available on [http://sourceforge.net/project/showfiles.php?group_id=25770 sourceforge].
+
== See also ==
** Feisty (7.04) and later: download [http://sourceforge.net/project/showfiles.php?group_id=25770  gramps_2.2.8-1ubuntu1_all.deb]  and [http://sourceforge.net/project/showfiles.php?group_id=25770  gramps-help_2.2.8-1ubuntu1_all.deb] , and install with your package manager.
 
** Dapper, Edgy and before: 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 SuSE's apt repository. They are always last release in [http://software.opensuse.org/download/home:/rbos/ his repository]. See also [http://www.suseforums.net/index.php?s=22f80a050a1e3cffffd590db0813dea9&showtopic=28727&pid=152093&st=0&#entry152093. this forum entry].
 
* '''Mandriva''': Sometimes newer versions of GRAMPS are backported. For this, you must enable the ''backports'':  see [http://wiki.mandriva.com/en/Docs/Basic_tasks/Installing_and_removing_software#Advanced_use:_Backports_and_candidate_updates Mandriva wiki]. You will then possibly be able to install more recent versions of software, hopefully also of GRAMPS. You could try ''contrib'' too. If the latest version of GRAMPS is not available, you must install from source (see below).
 
* '''Fedora''': If <tt>FC6</tt>, on sourceforge, [http://sourceforge.net/project/showfiles.php?group_id=25770 download gramps-zzz.fc6.noarch.rpm] if available, and install with your package manager, for <tt>FC7</tt> use the fc7 package. The alternative to installing from source (described below) is to [[fedora rpm|build a package]] from an rpm spec file, or install a binary from fedora testing.
 
* '''Debian''': the latest version is installed directly into unstable and can be upgraded from your package manager. Testing is updated 10 days later (except near a new stable release).
 
 
 
''Note: Some Linux distributions may have a slightly different way 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 zzz.tar.gz, and install GRAMPS manually. See below for details.
 
 
 
==Windows, BSD, MacOs, 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 untill a new installer is made available.
 
 
 
For BSD, MacOS, Solaris there are experimental install instructions below.
 
 
 
==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.
 
 
 
=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, [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 gnomeprint and graphviz output.
 
 
 
Other packages might also be usefull:
 
 
 
* '''Yelp''': Gnome help browser. This allows to call and read the GRAMPS documentation on your computer.
 
* '''desktop-file-utils''': see list of programs to open a media file on right clidk on an image
 
 
 
=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.
 
 
 
(This should be a table; I need to look up the table syntax):
 
 
 
=== Linux Package Requirements ===
 
 
 
Debian/Ubuntu          Fedora/Redhat          Comment
 
---------------------  ---------------------  --------------------------------
 
python                python                Required (needs version 2.3 or later) [does 2.3 include set()?]
 
pygtk2                pygtk2                Required (needs 2.5.0 or greater)
 
gnome-python          gnome-python          Required (needs 2.6.0 or greater)
 
librsvg2-common        librsvg2              Required for building
 
                        librsvg2-devel        Required for building
 
                        gnome-common          Required for building
 
                        intltool              Required for building
 
                        python-reportlab      Optional
 
 
 
==Obtaining the source==
 
 
 
* The lastest stable version of GRAMPS can be downloaded from the [http://sourceforge.net/projects/gramps GRAMPS SourceForge page]. As of this writing, this is gramps-2.2.8.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 latest development version of GRAMPS, it can be obtained from SVN, see [[Brief introduction to SVN]]. The SVN version of GRAMPS is potentially very dangerous as it has not been extensively tested. It may be prone to crashing and cause extensive data loss. Please use with caution.
 
 
 
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.
 
 
 
==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>
 
 
 
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
 
  make install</code>
 
 
 
==Installing from source code on BSD==
 
 
 
Installing on BSD is as straithforward 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==
 
 
 
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==
 
 
 
Due to the dependencies, it is difficult to install GRAMPS on Windows. Fortunately some users have made an installer hiding all these details. See the [[Windows installer]] page for details. Use this at your own risk! The developers of GRAMPS provide the space for this install page, but are not responsible for it!
 
 
 
If the dependencies are in place, the development version can be tested by getting the source (see above), renaming the file const.py.in to const.py, and executing "python gramps.py" from within the src directory. Of course, this is a development version on an unsupported platform, so warnings apply even more to this case than when using the installer. (I have not managed to get a localized build working this way.)
 
 
 
==Installing from source code on Solaris==
 
 
 
Previous versions of GRAMPS have run on Solaris. No recent cases are know to us however. Should you have successfully installed GRAMPS on solaris, please update the [[Solaris page]].
 
  
 +
* $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:Documentation]]

Revision as of 05:29, 3 February 2014

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