<?xml version="1.0" encoding="UTF-8"?>
<appendix id="installation">
<appendixinfo>
  <authorgroup>
    <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
  </authorgroup>
  <date>2010-07-25</date>
  <releaseinfo>4.5</releaseinfo>
</appendixinfo>

<title>Installation</title>

<para>
  This appendix primarily addresses the installation of &kappname; under the
  &Linux; operating system.  The <link linkend="installation.nonlinux">final
  section</link> addresses other operating systems.
</para>

<sect1 id="installation.getting">
<title>How to obtain &kappname;</title>

<!-- This first entity contains boiler plate for applications that are part of
     KDE CVS.  You should remove it if you are releasing your application.
     &install.intro.documentation; I don't think this will be correct until we
     move from extragear to the main section of KDE in the future. -->

<para>
  Although &kappname; has existed for a number of years, we are still working on
  full integration into &kde;.  Previous stable versions (1.0.x) required
  libraries from &kde; 3, and so were not available in most recent Linux
  distributions, which had already migrated to &kde; 4. However, with the
  release of version 4.5, &kappname; can now be easily compiled and installed on
  any version of &kde; 4.3 or higher.
</para>
<para>
  The rest of this section will describe installing &kappname; using the
  standard software installation process for your Linux distribution.  The
  following section will discuss compiling from source.
</para>

<sect2 id="installation.distribution">
<title>Official Distribution Packages</title>
<para>
  The best way to install &kappname; is to use the package manager of your
  distribution, such as apt-get, yum, portage, or pacman.  This will take care
  of all the dependencies and required libraries.  Although it will take some
  time after the release of this version for all the distributions to add
  &kappname; to their official repositories, please check there first.
</para>
</sect2>

<sect2 id="installation.unsupported">
<title>Unsupported Repositories</title>
<para>
  Many Linux distributions have users who provide unsupported repositories that
  offer more up-to-date packages than the distributions' official repositories.
  A list of these may be found at the <ulink
  url="http://www.kmymoney.org">&kappname; home page</ulink>.
</para>
</sect2>

</sect1>

<sect1 id="installation.fromsource">
<title>Compiling &kappname; from Source</title>

<para>
  More up-to-date information on the latest available version and any known
  installation issues will be available on the <ulink
  url="http://www.kmymoney.org">&kappname; home page</ulink>.  That page will
  also have links to tarballs of recent versions as well as instructions for
  obtaining the source from KDE SVN, in case you want to compile the latest,
  development version.
</para>

<para>
  As the previous paragraph implied, there are two distinct reasons to compile
  &kappname; from source.  If you cannot find a version specifically packaged
  for your distribution, please download the tarball of the most recent stable
  release.  This is version 4.5.0 as of the time this is being written.  This is
  the compile option recommended for normal users.
</para>

<para>
  On the other hand, if you want to see the current state of development, to
  check out a recent bug fix or new feature, you can download a tarball which is
  a snapshot of the development repository.  You can also check the source
  directly out of the repository.  (The version 4.x source is in &kde; svn and
  the version 1.0.x source is in SourceForge cvs.  Instructions for access are
  on the project home page.)
</para>
<warning>
 <para>
   The code in the repositories and in development snapshots is under active
   development: it may have bugs, it may crash, and it may mess up or lose data.
   If you use it, be absolutely sure to make adequate backups.  Unless you have
   a good reason to use this, stick to a stable released version.
 </para>
</warning>

<para>
  &kappname; depends on libraries from KDE version 4.3 or later, specifically
  kdelibs and kde PIM libs.  You may need to explicitly load the
  <quote>-devel</quote> versions in order to compile &kappname;, rather then
  just running a pre-compiled version.  Additional functionality can be obtained
  if extra libraries are available at compile time &ndash; see the web site for
  details.
</para>

<para>
  &kappname; uses the cmake build system.  Further information can be found in
  the README.cmake file in the root folder of the source.  The basic steps are
  the following:
</para>

<simplelist>
<member><command>$ mkdir build</command></member>
<member><command>$ cd build</command></member>
<member><command>$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/</command></member>
<member><command>$ make</command></member>
<member><command>$ sudo make install/fast</command></member>
</simplelist>

<important><para>
  Note that the last step is required.  &kappname; expects to find certain
  components in standard locations, and if you run it from within the build
  directory without the install step, you will have missing icons or other
  surprises.
</para></important>

<para>
  If you have compiled the source from svn, and want to update to the latest
  revision, most of the time you can do the following:
</para>

<simplelist>
<member><command>$ cd &lt;path to root of source&gt;</command></member>
<member><command>$ svn update</command></member>
<member><command>$ cd build</command></member>
<member><command>$ make</command></member>
<member><command>$ sudo make install/fast</command></member>
</simplelist>

<para>
  However, changes made by the developers sometimes cause compile problems if
  you do not start with a clean code base.  In these cases, you need to the
  following:
</para>

<simplelist>
<member><command>$ cd &lt;path to root of source&gt;</command></member>
<member><command>$ svn update</command></member>
<member><command>$ rm -r build</command></member>
<member><command>$ mkdir build</command></member>
<member><command>$ cd build</command></member>
<member><command>$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/</command></member>
<member><command>$ make</command></member>
<member><command>$ sudo make install/fast</command></member>
</simplelist>
</sect1>

<sect1 id="installation.nonlinux">
<title>Installing &kappname; without Linux</title>

<para>
  &kappname; has been successfully compiled for &MacOS; X, and is available at
  the <ulink url="http://www.macports.com">MacPorts web site</ulink>.
</para>
<para>
  &kappname; has also been reported to be available for &Windows;, but details
  were not available in time to include here.  Please check the <ulink
  url="http://www.kmymoney.org">&kappname; home page</ulink> for updated
  information.</para>
<para>
  If you know of &kappname; being successfully compiled and made available for
  any other operating system, please let us know, so we can spread the word.
</para>

</sect1>
</appendix>
