Projects/KMyMoney: Difference between revisions

    From KDE TechBase
    (Version 4.6.0 delayed by a week)
    (Add 'Show aqbanking log file path')
    (50 intermediate revisions by 8 users not shown)
    Line 4: Line 4:


    == Available versions  ==
    == Available versions  ==
    === Latest release ===
    [http://download.kde.org/stable/kmymoney/4.8.0/src/kmymoney-4.8.0.tar.xz.mirrorlist KMyMoney 4.8.0] has been released on 14th of June 2016.
    Alternatively, you can get the source from the [https://projects.kde.org/projects/extragear/office/kmymoney KDE Git]. (see link below)
    === Obsolete releases ===
    [http://download.kde.org/stable/kmymoney/4.7.2/src/kmymoney-4.7.2.tar.xz.mirrorlist KMyMoney 4.7.2] has been released on 14st of April 2015.
    [http://download.kde.org/stable/kmymoney/4.7.1/src/kmymoney-4.7.1.tar.xz.mirrorlist KMyMoney 4.7.1] has been released on 1st of November 2014.
    [http://download.kde.org/stable/kmymoney/4.7.0/src/kmymoney-4.7.0.tar.xz.mirrorlist KMyMoney 4.7.0] has been released on 1st of October 2014.
    [http://download.kde.org/stable/kmymoney/4.6.6/src/kmymoney-4.6.6.tar.xz.mirrorlist KMyMoney 4.6.6] has been released
    on 24th of June 2014.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.6.4/kmymoney-4.6.4.tar.bz2/download KMyMoney 4.6.4] has been released on 6th of October 2013.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.6.3/kmymoney-4.6.3.tar.bz2/download KMyMoney 4.6.3] has been released on September 3rd 2012.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.6.2/kmymoney-4.6.2.tar.bz2/download KMyMoney 4.6.2] has been released on February 4th 2012.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.6.1/kmymoney-4.6.1.tar.bz2/download KMyMoney 4.6.1] has been released on November 6th 2011.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.6.0/kmymoney-4.6.0.tar.bz2/download KMyMoney 4.6.0] has been released on August 8th 2011.


    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.5.3/kmymoney-4.5.3.tar.bz2/download KMyMoney 4.5.3] has been released on February 13rd 2011.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/4.5.3/kmymoney-4.5.3.tar.bz2/download KMyMoney 4.5.3] has been released on February 13rd 2011.
    Line 20: Line 43:
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/3.97.2/kmymoney-3.97.2.tar.bz2/download KMyMoney 3.97.2] has been released on Apr 6th 2010.
    [http://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/3.97.2/kmymoney-3.97.2.tar.bz2/download KMyMoney 3.97.2] has been released on Apr 6th 2010.


    [https://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/3.96.1/kmymoney-3.96.1.tar.bz2/download KMyMoney 3.96.1] has been released on Feb 17th 2010.  
    [https://sourceforge.net/projects/kmymoney2/files/KMyMoney-KDE4/3.96.1/kmymoney-3.96.1.tar.bz2/download KMyMoney 3.96.1] has been released on Feb 17th 2010.
     
    Alternatively, you can get the source from the KDE SVN. (see link below)


    == Installation  ==
    == Installation  ==
    Line 28: Line 49:
    === Requirements  ===
    === Requirements  ===


    KMyMoney depends on KDE SC 4.3+. Specifically on kdelibs and kde PIM libs. Additionally, you may want to install other libraries that will provide additional functionality:  
    KMyMoney depends on KDE SC 4.7+. Specifically on kdelibskde PIM libs, and kactivities.  
     
    *g++
    *make
    *cmake
    *libkdepimlibs-devel
    *libgpgme-dev
    *libical-dev
    *libkactivities-dev
    *libgmp-dev
    *libalkimia-dev
     
    ==== Optional ====
    Additionally, you may want to install other libraries that will provide additional functionality:  


    *libofx >= 0.9.2
    *libofx >= 0.9.2
    *Aqbanking >= 5.0.0
    *Aqbanking >= 5.0.0
    *quote::finance
    *quote::finance (also known as libfinance-quote-perl)


    === Installation steps  ===
    === Installation steps  ===


    If possible, it is always preferred to use a package specifically prepared for your distribution.  However, if one is not available, or you want a more recent version, you can use the latest tarball.  If you really need the most recent version, such as to test a new bug fix, get the source from KDE SVN at
    If possible, it is always preferred to use a package specifically prepared for your distribution.  However, if one is not available, or you want a more recent version, you can use the latest tarball.  If you really need the most recent version, such as to test a new bug fix, get the source from [https://projects.kde.org/projects/extragear/office/kmymoney KDE Git] at
       
       
    * '''svn://anonsvn.kde.org/home/kde/trunk/extragear/office/kmymoney'''.  
    * '''git://anongit.kde.org/kmymoney'''.  
     
    $ git clone git://anongit.kde.org/kmymoney


    To install, read the README.cmake file in the root folder of the source. The basic steps are the following:  
    To install, read the README.cmake file in the root folder of the source. The basic steps are the following:  
    Line 47: Line 83:
      $ cd build
      $ cd build
      $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/
      $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/
      $ make # This step may be needed twice
    # optional, to adjust build configuration
      $ make install
    $ ccmake .
      $ make && make
      $ sudo make install


    It is important that the prefix is the same one that is used by your already installed KDE software.  If it does not match, you will run into problems later.
    It is important that the prefix is the same one that is used by your already installed KDE software.  If it does not match, you will run into problems later. The separate build directory is mandatory (out of source build).
    '''(The last step should be executed with admin privileges. Either switch to root or use sudo, or the appropriate steps for your installation)'''
    The ''install'' step should be executed with admin privileges. Either switch to root or use sudo, or the appropriate steps for your installation.


    To execute, either look for KMyMoney on the Office menu, or type kmymoney in a console window.
    To execute, either look for KMyMoney on the Office menu, or type kmymoney in a console window.


    === Localization ===
    === Localization ===
    '''If you are installing from SVN source, you need to install your locale files by hand. If you are installing from the tarball provided above, please skip this section.'''
    '''If you are installing from Git source, you need to install your locale files by hand. If you are installing from the tarball provided above, please skip this section.'''


    To localize you will need to download the appropriate kmymoney.po file from http://websvn.kde.org/trunk/l10n-kde4/<country_code>/messages/extragear-office/ (replace <country_code> with the correct one for your locale e.g. es would give http://websvn.kde.org/trunk/l10n-kde4/es/messages/extragear-office/) and then, either by switching to root or using sudo, do the following:  
    To localize you will need to download the appropriate kmymoney.po file from http://websvn.kde.org/trunk/l10n-kf5/<country_code>/messages/extragear-office/ (replace <country_code> with the correct one for your locale e.g. es would give http://websvn.kde.org/trunk/l10n-kf5/es/messages/extragear-office/) and then, either by switching to root or using sudo, do the following:  


    *Copy the kmymoney.po file into /usr/share/locale/<country_code>/  
    *Copy the kmymoney.po file into /usr/share/locale/<country_code>/  
    Line 90: Line 128:
    This version is only suitable for early adopters. It will behave fairly well, but the application might crash and you may lose some data. Make backups often.  
    This version is only suitable for early adopters. It will behave fairly well, but the application might crash and you may lose some data. Make backups often.  


    For 3.95 version and later, we use the Bugzilla tracker at bugs.kde.org. Any bugs you find, please report it and assign to product kmymoney4. Also, if you need help write to [email protected].  
    For 3.95 version and later, we use the Bugzilla tracker at bugs.kde.org (BKO). Any bugs you find, please report it and assign to product kmymoney. Also, if you need help write to [email protected].  


    === Link to Debian bugs ===
    === Link to Debian bugs ===
    The bugs in Debian tracker can be linked back to BKO
    The bugs in Debian tracker can be linked back to BKO


    * Open a bug report in KDE BTS
    * Open a bug report in KDE Bug Tracking System (BTS)
    * Link it to Debian bug number using "forwarded". See http://www.debian.org/Bugs/server-control#forwarded
    * Link it to Debian bug number using "forwarded". See http://www.debian.org/Bugs/server-control#forwarded
    * When the bug is fixed in KDE BTS, the status will be synced in Debian BTS too.
    * When the bug is fixed in KDE BTS, the status will be synced in Debian BTS too.


    === Obtain a useful backtrace on Windows  ===
    If you would like to create a bug report about an application crash on Windows you need to take care of the following to create a useful report:


    * make sure that you can reproduce the crash
    * download the debug information that matches your version ([http://downloads.sourceforge.net/project/kmymoney2/KMyMoney-Windows/4.6.3/kmymoney-4.6.3-debug-info.7z 4.6.3])
    * extract the archive in a folder of your choice (in this example '''c:\temp\kmm-debug-info''') using 7z archiver
    * open '''cmd.exe'''
    * run '''set _NT_SYMBOL_PATH=c:\temp\kmm-debug-info'''
    * run '''"c:\Program Files\KMyMoney\bin\kdeinit4.exe" --terminate'''
    * run '''"c:\Program Files\KMyMoney\bin\kmymoney.exe"'''
    * try to reproduce the crash and use '''DrKonqi''' the KDE crash handler that appears when the application crashes (only on Windows 7) to report the crash on bugs.kde.org
    '''Notes''':
    * '''DrKonqi''' will inform you if the crash report is useful or not (it contains the debug information or not)
    * if '''DrKonqi''' says that the report is not useful something went wrong in the above steps
    * if you can't reproduce the crash immediately you can run KMyMoney for a while in an environment in which '''_NT_SYMBOL_PATH''' is defined as above (you can use a batch file for that)
    * when you no longer need the debug information you can safely delete the folder '''c:\temp\kmm-debug-info'''


    == Release schedule  ==
    === Windows specific configuration options ===
    4.5.3 was the last release on the stable branch. Development is active on trunk towards 4.6.0, but neither the [http://community.kde.org/KMyMoney/Features/Plan46 feature set] nor the release plan have been completed and signed off yet.
    ==== KDE provided file dialogs for example for importer ====
    add to share/config/kdeglobals
    [KFileDialog Settings]
    Native=false


    === Version 4.5.95 ===
    ==== Enable debug log level for online banking plugin ====
    * First beta of what will be 4.6.0 (suitable for early adopters only)
    Open a command shell in kmymoney 'bin' dir and run
    * Feature freeze on 28.05.2011
    set AQBANKING_LEVEL=debug
    * Release on 01.06.2011
    set GWEN_LOGLEVEL=debug
     
    Then start kmymoney with
    === Version 4.5.96 ===
    kmymoney
    * Second beta on our way to 4.6.0 (suitable for early adopters only)
    * Release on 15.06.2011
    ==== Enable verbose log level for online banking plugin ====
     
    Open a command shell in kmymoney 'bin' dir and run
    === Version 4.5.97 ===
    set AQBANKING_LEVEL=verbous
    * First release candidate
    set GWEN_LOGLEVEL=verbous
    * Release on 30.06.2011
    Then start kmymoney with
     
    kmymoney
    === Version 4.6.0 ===
    * String freeze on 15.07.2011 (application) 22.07.2011 (documentation)
    * Bug freeze on 24.07.2011
    * Release on <s>01.08.2011</s> 08.08.2011
     
    <!--
    <s>
    === Version 3.95 ===
    First beta for KDE4
    Released on Dec 28th 2009
    Suitable only for early adopters only
     
    === Version 3.96 ===
    String freeze on Feb 1st 2010
    Release on Feb 15th 2010
    Suitable only for early adopters only


    === Version 3.97 ===
    ==== Show aqbanking log file path ====
    String freeze on Mar 15th 2010
    # Start kmymoney
    Release on Mar 30th 2010
    # Open Settings->configure KMymoney
    Last beta
    # In the Main tab select "Support" -> on that page there is a link to the current aqbanking lo path


    === Version 3.98 ===
    == Schedule for future releases ==
    String freeze on Apr 30th 2010
    Development is active on trunk towards the next version. There is a [https://www.kmymoney.org/todofeatures.php wishlist] of features which might be integrated in future releases.
    Release on May 15th 2010
    First release candidate</s>


    <s>After that, move to kdereview</s> done, now in extragear.
    === Version 4.8.1 ===
    * Release in October 2017
    * Windows binaries are already available at [https://download.kde.org/stable/kmymoney/4.8.1/ KDE download mirror]
    * Source release for Linux is delayed because of incomplete [https://l10n.kde.org/stats/doc/stable-kde4/package/extragear-office/ translation] of the documentation


    <s>[[/Release/announcement draft|announcement draft]]</s>
    === Version 4.8.2 ===
    * Release date is not specified yet and depends on the number bugs fixed from the list of  [https://www.kmymoney.org/openbugs.php open bugs] (at least 10)
    * Source snapshots can be fetched from the [https://cgit.kde.org/kmymoney.git/log/?h=4.8 Git repo]
    * Snapshot binaries for Windows are available (look for versions named 4.8.xyz which refers to the related git commit)
    ** Mingw based installer snapshots for [https://software.opensuse.org/search?q=mingw32-kmymoney-installer Win32]  and [https://software.opensuse.org/search?q=mingw64-kmymoney-installer Win64] (use [http://www.7-zip.org/ 7zip] for unpacking the  rpm file)
    ** Mingw based portable snapshots for [https://software.opensuse.org/search?q=mingw32-kmymoney-portable Win32] and [https://software.opensuse.org/search?q=mingw64-kmymoney-portable Win64] (use [http://www.7-zip.org/ 7zip] for unpacking the  rpm file)


    === Version 4.5 ===
    === Version 4.99.80 (Beta) ===
    <s>String freeze on Jul 26th 2010
    * Release date not specified yet (need to be specified by the KF5 development team)
    Bug freeze on Aug 13th 2010
    Release on Aug 16th 2010</s>


    === Version 4.5.1 ===
    === Version 4.99.90 (Release Candidate) ===
    <s>Release on November 14th 2010</s>
    * Release date not specified yet (need to be specified by the KF5 development team)


    === Version 4.5.2 ===
    === Version 5.0.0 ===
    <s>Release on December 23rd 2010</s>
    * Release date not specified yet (need to be specified by the KF5 development team)


    === Version 4.5.3 ===
    === Version 5.0.1 ===
    <s>Release on February 13rd 2011</s>
    * Release date not specified yet (need to be specified by the KF5 development team)
    -->

    Revision as of 19:32, 1 October 2017

    This page is dedicated to technical aspects of KMyMoney for KDE Platform 4. If you are looking for other info, or the source tarball, go to the official page of KMyMoney.

    Available versions

    Latest release

    KMyMoney 4.8.0 has been released on 14th of June 2016. Alternatively, you can get the source from the KDE Git. (see link below)

    Obsolete releases

    KMyMoney 4.7.2 has been released on 14st of April 2015.

    KMyMoney 4.7.1 has been released on 1st of November 2014.

    KMyMoney 4.7.0 has been released on 1st of October 2014.

    KMyMoney 4.6.6 has been released on 24th of June 2014.

    KMyMoney 4.6.4 has been released on 6th of October 2013.

    KMyMoney 4.6.3 has been released on September 3rd 2012.

    KMyMoney 4.6.2 has been released on February 4th 2012.

    KMyMoney 4.6.1 has been released on November 6th 2011.

    KMyMoney 4.6.0 has been released on August 8th 2011.

    KMyMoney 4.5.3 has been released on February 13rd 2011.

    KMyMoney 4.5.2 has been released on December 23rd 2010.

    KMyMoney 4.5.1 has been released on November 14th 2010.

    KMyMoney 4.5 has been released on August 16th 2010.

    KMyMoney 3.98.1 has been released on May 21st 2010.


    KMyMoney 3.98.0 has been released on May 15th 2010.

    KMyMoney 3.97.2 has been released on Apr 6th 2010.

    KMyMoney 3.96.1 has been released on Feb 17th 2010.

    Installation

    Requirements

    KMyMoney depends on KDE SC 4.7+. Specifically on kdelibs, kde PIM libs, and kactivities.

    *g++
    *make
    *cmake
    *libkdepimlibs-devel
    *libgpgme-dev
    *libical-dev
    *libkactivities-dev
    *libgmp-dev
    *libalkimia-dev
    

    Optional

    Additionally, you may want to install other libraries that will provide additional functionality:

    • libofx >= 0.9.2
    • Aqbanking >= 5.0.0
    • quote::finance (also known as libfinance-quote-perl)

    Installation steps

    If possible, it is always preferred to use a package specifically prepared for your distribution. However, if one is not available, or you want a more recent version, you can use the latest tarball. If you really need the most recent version, such as to test a new bug fix, get the source from KDE Git at

    $ git clone git://anongit.kde.org/kmymoney

    To install, read the README.cmake file in the root folder of the source. The basic steps are the following:

    First, make sure you have uninstalled any old versions of kmymoney through your package manager and/or sudo make uninstall depending on how it was installed last time. Then:

    $ mkdir build
    $ cd build
    $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/
    
    1. optional, to adjust build configuration
    $ ccmake .
    $ make && make
    $ sudo make install
    

    It is important that the prefix is the same one that is used by your already installed KDE software. If it does not match, you will run into problems later. The separate build directory is mandatory (out of source build). The install step should be executed with admin privileges. Either switch to root or use sudo, or the appropriate steps for your installation.

    To execute, either look for KMyMoney on the Office menu, or type kmymoney in a console window.

    Localization

    If you are installing from Git source, you need to install your locale files by hand. If you are installing from the tarball provided above, please skip this section.

    To localize you will need to download the appropriate kmymoney.po file from http://websvn.kde.org/trunk/l10n-kf5/<country_code>/messages/extragear-office/ (replace <country_code> with the correct one for your locale e.g. es would give http://websvn.kde.org/trunk/l10n-kf5/es/messages/extragear-office/) and then, either by switching to root or using sudo, do the following:

    • Copy the kmymoney.po file into /usr/share/locale/<country_code>/
    • In that folder run:
      $ msgfmt kmymoney.po -o LC_MESSAGES/kmymoney.mo
    
      Note: use the msgfmt that comes with your distribution not the one needed for kmymoney2.
    

    Debian dependencies

    build-essential cmake kdelibs5-dev kdepimlibs5-dev libaqbanking29-dev libboost-graph-dev libfinance-quote-perl libgpgme11-dev libgwenhywfar47-dev libical-dev libjpeg62-dev libofx-dev libpng12-dev libsqlite3-dev libz-dev gettext

    Guidelines

    This version is only suitable for early adopters. It will behave fairly well, but the application might crash and you may lose some data. Make backups often.

    For 3.95 version and later, we use the Bugzilla tracker at bugs.kde.org (BKO). Any bugs you find, please report it and assign to product kmymoney. Also, if you need help write to [email protected].

    Link to Debian bugs

    The bugs in Debian tracker can be linked back to BKO

    Obtain a useful backtrace on Windows

    If you would like to create a bug report about an application crash on Windows you need to take care of the following to create a useful report:

    • make sure that you can reproduce the crash
    • download the debug information that matches your version (4.6.3)
    • extract the archive in a folder of your choice (in this example c:\temp\kmm-debug-info) using 7z archiver
    • open cmd.exe
    • run set _NT_SYMBOL_PATH=c:\temp\kmm-debug-info
    • run "c:\Program Files\KMyMoney\bin\kdeinit4.exe" --terminate
    • run "c:\Program Files\KMyMoney\bin\kmymoney.exe"
    • try to reproduce the crash and use DrKonqi the KDE crash handler that appears when the application crashes (only on Windows 7) to report the crash on bugs.kde.org

    Notes:

    • DrKonqi will inform you if the crash report is useful or not (it contains the debug information or not)
    • if DrKonqi says that the report is not useful something went wrong in the above steps
    • if you can't reproduce the crash immediately you can run KMyMoney for a while in an environment in which _NT_SYMBOL_PATH is defined as above (you can use a batch file for that)
    • when you no longer need the debug information you can safely delete the folder c:\temp\kmm-debug-info

    Windows specific configuration options

    KDE provided file dialogs for example for importer

    add to share/config/kdeglobals

    [KFileDialog Settings]
    Native=false
    

    Enable debug log level for online banking plugin

    Open a command shell in kmymoney 'bin' dir and run

    set AQBANKING_LEVEL=debug
    set GWEN_LOGLEVEL=debug
    

    Then start kmymoney with

    kmymoney
    
    

    Enable verbose log level for online banking plugin

    Open a command shell in kmymoney 'bin' dir and run

    set AQBANKING_LEVEL=verbous
    set GWEN_LOGLEVEL=verbous
    

    Then start kmymoney with

    kmymoney
    

    Show aqbanking log file path

    1. Start kmymoney
    2. Open Settings->configure KMymoney
    3. In the Main tab select "Support" -> on that page there is a link to the current aqbanking lo path

    Schedule for future releases

    Development is active on trunk towards the next version. There is a wishlist of features which might be integrated in future releases.

    Version 4.8.1

    • Release in October 2017
    • Windows binaries are already available at KDE download mirror
    • Source release for Linux is delayed because of incomplete translation of the documentation

    Version 4.8.2

    • Release date is not specified yet and depends on the number bugs fixed from the list of open bugs (at least 10)
    • Source snapshots can be fetched from the Git repo
    • Snapshot binaries for Windows are available (look for versions named 4.8.xyz which refers to the related git commit)
      • Mingw based installer snapshots for Win32 and Win64 (use 7zip for unpacking the rpm file)
      • Mingw based portable snapshots for Win32 and Win64 (use 7zip for unpacking the rpm file)

    Version 4.99.80 (Beta)

    • Release date not specified yet (need to be specified by the KF5 development team)

    Version 4.99.90 (Release Candidate)

    • Release date not specified yet (need to be specified by the KF5 development team)

    Version 5.0.0

    • Release date not specified yet (need to be specified by the KF5 development team)

    Version 5.0.1

    • Release date not specified yet (need to be specified by the KF5 development team)