Updated explanation of HBCI features.

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@14075 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Christian Stimming
2006-05-15 12:47:21 +00:00
parent bd28828fea
commit 55a012181f
3 changed files with 80 additions and 69 deletions

View File

@@ -1,3 +1,10 @@
2006-05-15 Christian Stimming <stimming@tuhh.de>
* doc/README.german: Updated German README which was horribly
outdated.
* doc/README.HBCI: Updated explanation of HBCI features.
2006-05-14 Chris Lyttle <chris@wilddev.net>
* NEWS: Added some text about the release.

33
README
View File

@@ -182,12 +182,12 @@ the following;
GnuCash-1.8.10 and newer needs at least the version libofx-0.7.0
or newer. Sources can be found at
http://sourceforge.net/projects/libofx/
aqbanking/aqhbci: This library provide support for HBCI file imports.
GnuCash has mostly been tested against the 0.9.7 version, though
aqbanking: This library provide support for HBCI online actions.
GnuCash has mostly been tested against the 1.3.0 version, though
any newer version should also work. Sources can be found at
http://sourceforge.net/projects/aqbanking and
http://sourceforge.net/projects/aqhbci/. More info in
doc/README.HBCI.
http://sourceforge.net/projects/aqbanking . Requires
gwenhywfar, http://sourceforge.net/projects/gwenhywfar . More
info in doc/README.HBCI.
#######
Running
@@ -270,7 +270,7 @@ of these pieces properly installed for your particular operating
system flavor will vary, but here's at least a partial list of what
you'll need for the systems we know about:
Debian/GNU/Linux:
Debian/GNU/Linux: see README.dependencies and
current:
libgnome-dev
libgtkhtml-dev
@@ -280,25 +280,11 @@ you'll need for the systems we know about:
SuSE:
see doc/build-suse.txt
see README.dependencies and doc/build-suse.txt
GnuCash understands a few non-standard ./configure options. You
should run ./configure --help for the most up to date summary of the
supported options, but here are some more detailed descriptions of
some of them:
--enable-opt-style-install
GnuCash supports two types of install, the first is the normal
/usr or /usr/local/ style, where the files are installed into
/usr/bin /usr/lib, etc. This is the default.
The second style is the FSSTND, opt-style install. In this style,
all of the files are installed under a common subdirectory, often
in /usr/local/opt, with the binaries going to
/usr/local/opt/'packagename'/bin, the libs going to
/usr/local/opt/'packagename'/lib, etc. To request this style of
install, just use the --enable-opt-style-install option to ./configure.
supported options.
If you only want a particular language installed, you can set the
LINGUAS environment variable before you run configure. For example,
@@ -436,7 +422,8 @@ Developing GnuCash
Before you start developing GnuCash, you should do the following:
1. Read the file src/doc/coding-style.txt to learn about the coding-styles
used in the GnuCash source code.
used in the GnuCash source code. Also read
http://wiki.gnucash.org/wiki/Development
2. Several of the directories under src contain files called design.txt
which explain many aspects of GnuCash's design. Read those.

View File

@@ -16,9 +16,9 @@ Since the beta release 1.7.2, GnuCash features HBCI online banking
support. This makes it the world's first *free* HBCI-enabled personal
finance manager.
Many additional information about GnuCash and HBCI can be found on
http://linuxwiki.de/GnuCash, http://linuxwiki.de/AqBanking, and
http://linuxwiki.de/OpenHBCI.
Many additional information about GnuCash and HBCI can be found in
German language on http://linuxwiki.de/GnuCash,
http://linuxwiki.de/AqBanking, and http://linuxwiki.de/OpenHBCI.
HBCI (Home Banking Computer Interface) is a standard used by German
banks for offering online banking service. Through this standard,
@@ -39,25 +39,38 @@ HBCI for now.
2. Requirements
------------
AqBanking 0.9.7 and AqHBCI 0.9.13, or any later version: Get
aqbanking, aqbanking-devel from
http://sourceforge.net/projects/aqbanking, then aqhbci, aqhbci-devel
and wizard-kde from http://sourceforge.net/projects/aqhbci/
(Historical note: Until gnucash-1.8.9, the library "openhbci" had been
used, but with gnucash-1.8.10, gnucash switched to the successor of
openhbci which is aqbanking/aqhbci.)
See also http://linuxwiki.de/AqBanking
Required packages:
AqBanking 1.3.0, or any later version: Get aqbanking from
http://sourceforge.net/projects/aqbanking . (Historical note:
Until gnucash-1.8.9, the library "openhbci" had been used, but
with gnucash-1.8.10, gnucash switched to the successor of openhbci
which is aqbanking/aqhbci.) (Second historical note: The library
versions aqbanking-1.2.x or older were split into multiple
packages named "aqbanking" and "aqhbci", but with aqbanking-1.3.0
and newer all of this is now packaged in the single aqbanking
package.)
which in turn requires:
Gwenhywfar 1.1.0, http://sourceforge.net/projects/gwenhywfar, which in
turn requires OpenSSL any 0.9.x, http://www.openssl.org
For chipcard support, you also need plugin-ddvcard from
http://sourceforge.net/projects/aqhbci, which in turn requires
Libchipcard2 version 1.9.1 or later,
http://sourceforge.net/projects/libchipcard
Gwenhywfar 1.16.0, or any later version,
http://sourceforge.net/projects/gwenhywfar, which in turn requires
OpenSSL any 0.9.x, http://www.openssl.org .
Then you can build GnuCash 1.7.x/1.8.x with:
./configure --enable-hbci --with-openhbci-prefix=/your/openhbci/prefix
If you want chipcard support, you also need libchipcard version
2.0.0 or later, http://sourceforge.net/projects/libchipcard
(Note: Not all arbitrary version combinations between aqbanking
and gwenhywfar will work! Only those versions that have been
released on approximately the same date will work together without
problems.)
After aqbanking has been installed successfully, you can build
GnuCash with:
./configure --enable-hbci --with-aqbanking-prefix=/your/aqbanking/prefix
And you need to apply at your Bank to get HBCI access. The bank will
provide you with some paper work which is needed during HBCI setup in
@@ -69,18 +82,21 @@ GnuCash. (For problems during compile see 6. Known Problems below.)
HBCI support is accessible through a few new menu items:
* Setup: In the main window with the account hierarchy, the "Tools" menu
(German: "Werkzeuge") now contains the item "HBCI Setup" ("HBCI
Einrichtung"). This menu item opens the HBCI Setup druid which will
guide you through the setup. (Note: With the new aqbanking/aqhbci, the
Setup druid is an external program provided by the aqhbci authors.)
(German: "Werkzeuge") now contains the item "HBCI Setup" ("HBCI
Einrichtung"). This menu item opens the HBCI Setup druid which
will guide you through the setup. (Note: With the new
aqbanking/aqhbci, the Setup druid is an external program provided
by the aqhbci authors, but this will be explaning during the HBCI
Setup druid.)
- Chip card users will need to run this only once. (see 6. Known
Problems below if this doesn't work)
- Chip card users and PIN/TAN users will need to run this only
once. (see 6. Known Problems below if this doesn't work)
- Users with self-generated file-based keys need to run this for the
first time to generate their keys and have their Ini-Letter printed,
which they need to send to their bank. After some days when the bank
has processed that letter, they need to run the HBCI Setup druid
- Users with self-generated file-based keys need to run this
twice. First they will be guided to generate their keys and
have their Ini-Letter printed on paper, which they need to
send to their bank. After some days when the bank has
processed that letter, they need to run the HBCI Setup druid
a second time.
- Either way, eventually you are presented with a list of
@@ -90,20 +106,21 @@ Setup druid is an external program provided by the aqhbci authors.)
* Account functions: In the register window of your GnuCash accounts,
you now find the submenu item "Online Actions" ("Online Aktionen") in
the menu "Actions" ("Aktionen"). Each item in this submenu invokes a
particular HBCI action: "Get Balance", "Get Transactions", "New
Transfer", "New Direct Debit" ("Abfrage Saldo", "Abfrage Kontoums<6D>tze",
"Neue <EFBFBD>berweisung", "Neue Lastschrift"). Of course those menu items will
only do anything if that particular GnuCash account was matched to a
HBCI account in the setup druid; otherwise, simply nothing will happen.
How to perform each action will be explained in the respective
dialog windows.
particular HBCI action: "Get Balance", "Get Transactions", "New
Transfer", "New Direct Debit" ("Saldenabfrage", "Abfrage
Kontoums<EFBFBD>tze", "<22>berweisung", "Lastschrift"). Of course those menu
items will only do anything if that particular GnuCash account was
matched to a HBCI account in the setup druid; otherwise, simply
nothing will happen. How to perform each action will be explained
in the respective dialog windows.
* Preference: By default, the user has to enter his password/PIN each
time a HBCI action is performed. If you prefer to have your password
cached in memory during your gnucash session, you can enable this by
activating the appropriate button in the Edit->Preference dialog
("Bearbeiten->Einstellungen") in the tab "Online Banking & Importing".
Of course the password/PIN is *never ever* stored on disk anywhere.
activating the appropriate button in the Edit->Preference dialog
("Bearbeiten->Einstellungen") in the tab "Online Banking &
Importing". Of course the password/PIN is *never ever* stored on
disk anywhere due to security reasons.
* HBCI Connection window preference: The HBCI Connection window can
either disappear once the connection is closed, or it can still be
@@ -115,13 +132,14 @@ window is remembered from session to session.
expected it to work, you can enable a whole lot of HBCI debugging
output. First, on the "General" page of the preferences, activate the
checkbox for "Show Advanced Setting". Then, on the newly appearing
"Advanced" page, activate "HBCI Verbose Debug Messages" to get much
more debugging output.
"Advanced" page, or on the "Online Banking & Importing" page,
activate "HBCI Verbose Debug Messages" to get much more debugging
output.
4. Known Banks
-----------
OpenHBCI/Gnucash is successfully being used with:
Gnucash/AqBanking (or OpenHBCI) is successfully being used with:
- Deutsche Bank
- Kreissparkasse Hannover
- Hamburger Sparkasse
@@ -134,7 +152,7 @@ If you encounter an error, you can report it in German language on
gnucash-de@gnucash.org (Subscriber-only list; please subscribe on
http://www.gnucash.org/cgi-bin/mailman/listinfo/gnucash-de ) and on on
openhbci-general@lists.sf.net. Please remember to include the version
numbers of gnucash and openhbci as well as any console output and/or
numbers of gnucash and aqbanking as well as any console output and/or
HBCI connection log (can be obtained through the HBCI Verbose Debug
Messages preference mentioned above).
@@ -156,8 +174,8 @@ this new functionality.
version of GnuCash from.
* If you cannot select "Chip Card" as security medium, it means that
your installed version of the OpenHBCI library has been compiled
without chipcard support. You will need to recompile OpenHBCI while
your installed version of the AqBanking library has been compiled
without chipcard support. You will need to recompile AqBanking while
libchipcard is installed, and then you (probably) need to recompile
GnuCash.
@@ -185,5 +203,4 @@ The excellent AqBanking/AqHBCI library is written by Martin Preuss
<openhbci@aquamaniac.de>.
By Christian Stimming <stimming@tuhh.de>
October 30th, 2004
May 10th, 2006