[613c524f] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[613c524f] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY gnucash-download-http "http://www.gnucash.org/pub/gnucash/sources/stable/gnucash-&gnucash-version;.tar.gz">
|
---|
| 8 | <!ENTITY gnucash-download-ftp "ftp://ftp.at.gnucash.org/pub/gnucash/gnucash/sources/stable/gnucash-&gnucash-version;.tar.gz">
|
---|
[3b37f7e8] | 9 | <!ENTITY gnucash-src-md5sum "6e8c1602b365d76ec19ef211857d3ece">
|
---|
| 10 | <!ENTITY gnucash-size "7.0 MB">
|
---|
| 11 | <!ENTITY gnucash-buildsize "300 MB (includes running test suite; additional 120 MB for API docs)">
|
---|
| 12 | <!ENTITY gnucash-time "4.1 SBU (additional 1.8 SBU to run the test suite)">
|
---|
| 13 | <!ENTITY gnucash-docs-version "2.2.0">
|
---|
[852298f7] | 14 | <!ENTITY gnucash-docs-download "http://www.gnucash.org/pub/gnucash/sources/stable/gnucash-docs-&gnucash-docs-version;.tar.gz">
|
---|
[3b37f7e8] | 15 | <!ENTITY gnucash-docs-md5sum "97a29e499baca1807a3944ae3c0ad61e">
|
---|
| 16 | <!ENTITY gnucash-docs-size "10.0 MB">
|
---|
[613c524f] | 17 | ]>
|
---|
| 18 |
|
---|
[5afbfa23] | 19 | <sect1 id="gnucash" xreflabel="GnuCash-&gnucash-version;">
|
---|
[72b5adb] | 20 | <?dbhtml filename="gnucash.html" ?>
|
---|
| 21 |
|
---|
| 22 | <sect1info>
|
---|
| 23 | <othername>$LastChangedBy$</othername>
|
---|
| 24 | <date>$Date$</date>
|
---|
| 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>GnuCash-&gnucash-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="gnucash">
|
---|
| 30 | <primary sortas="a-GnuCash">GnuCash</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to GnuCash</title>
|
---|
| 35 |
|
---|
| 36 | <para><application>GnuCash</application> is a personal finance
|
---|
[3b37f7e8] | 37 | manager.</para>
|
---|
[72b5adb] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (HTTP): <ulink url="&gnucash-download-http;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (FTP): <ulink url="&gnucash-download-ftp;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download MD5 sum: &gnucash-src-md5sum;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download size: &gnucash-size;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated disk space required: &gnucash-buildsize;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated build time: &gnucash-time;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | </itemizedlist>
|
---|
| 60 |
|
---|
| 61 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 62 | <itemizedlist spacing='compact'>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Help documentation: <ulink url="&gnucash-docs-download;"/></para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>Download MD5 sum: &gnucash-docs-md5sum;</para>
|
---|
| 68 | </listitem>
|
---|
[3b37f7e8] | 69 | <listitem>
|
---|
| 70 | <para>Download size: &gnucash-docs-size;</para>
|
---|
| 71 | </listitem>
|
---|
[72b5adb] | 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">GnuCash Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[dcd55b37] | 77 | <para role="required"><xref linkend="guile"/>,
|
---|
[3b37f7e8] | 78 | <xref linkend="slib"/>,
|
---|
| 79 | <xref linkend="goffice"/>, and
|
---|
| 80 | <xref linkend="gtkhtml"/></para>
|
---|
[72b5adb] | 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[d1f23e0] | 83 | <para role="optional"><xref linkend="postgresql"/>,
|
---|
[6722219] | 84 | <ulink url="ftp://ftp.gnu.org/pub/gnu/guile/">Guile-www</ulink>, and
|
---|
[72b5adb] | 85 | <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
|
---|
| 86 |
|
---|
[3b37f7e8] | 87 | <bridgehead renderas="sect4">Optional (Required for the Help System)</bridgehead>
|
---|
[50ad401] | 88 | <para role="optional"><xref linkend="scrollkeeper"/> and
|
---|
| 89 | <xref linkend="yelp"/> (run-time requirement to view the Help documents)</para>
|
---|
[3b37f7e8] | 90 |
|
---|
[72b5adb] | 91 | <bridgehead renderas="sect4">Optional (for On-Line Banking)</bridgehead>
|
---|
[7aeaa620] | 92 | <para role="optional"><ulink
|
---|
| 93 | url="http://libofx.sourceforge.net/">LibOFX</ulink>
|
---|
[d1f23e0] | 94 | (requires <xref linkend="opensp"/> and <xref linkend="curl"/>),
|
---|
[72b5adb] | 95 | <ulink url="http://sourceforge.net/projects/ktoblzcheck">KtoBlzCheck</ulink>,
|
---|
[7aeaa620] | 96 | and <ulink url="http://www.aquamaniac.de/aqbanking/">AqBanking</ulink>
|
---|
| 97 | (requires <ulink
|
---|
| 98 | url="http://gwenhywfar.sourceforge.net/">Gwenhywfar</ulink>
|
---|
[3b37f7e8] | 99 | and <ulink url="http://www.libchipcard.de/">libchipcard3</ulink>)</para>
|
---|
[72b5adb] | 100 |
|
---|
[38e4f06] | 101 | <para condition="html" role="usernotes">User Notes:
|
---|
| 102 | <ulink url="&blfs-wiki;/gnucash"/></para>
|
---|
| 103 |
|
---|
[72b5adb] | 104 | </sect2>
|
---|
| 105 |
|
---|
| 106 | <sect2 role="installation">
|
---|
| 107 | <title>Installation of GnuCash</title>
|
---|
| 108 |
|
---|
| 109 | <para>Install <application>GnuCash</application> by running the following
|
---|
| 110 | commands:</para>
|
---|
| 111 |
|
---|
[3b37f7e8] | 112 | <screen><userinput>sed -i 's|xml::${sysconfdir}|xml::&gnome-etc-dir;|' configure &&
|
---|
| 113 |
|
---|
| 114 | ./configure \
|
---|
| 115 | --prefix=/usr \
|
---|
| 116 | --sysconfdir=/etc \
|
---|
| 117 | --libexecdir=/usr/lib \
|
---|
| 118 | --with-gconf-schema-file-dir=&gnome-etc-dir;/gconf/schemas &&
|
---|
[f8625d25] | 119 | make</userinput></screen>
|
---|
| 120 |
|
---|
[3b37f7e8] | 121 | <para>If you wish to create the API documentation in HTML format, you must
|
---|
| 122 | have <xref linkend="doxygen"/> and <xref linkend="graphviz"/> installed,
|
---|
| 123 | then issue: <command>make doc</command>. If you wish to create the API
|
---|
| 124 | Design Guide in several formats, you must have <xref linkend="tetex"/>
|
---|
| 125 | installed and issue:
|
---|
| 126 | <command>make -C src/doc/design html pdf ps</command>.</para>
|
---|
| 127 |
|
---|
[7aeaa620] | 128 | <para>To test the results, issue <command>make check</command>. All tests
|
---|
| 129 | should pass. An easy way to look at the results of the tests is to issue
|
---|
| 130 | <command>grep -A1 ============== check.log</command> (this is assuming you
|
---|
[3b37f7e8] | 131 | redirected the output from the tests to the indicated filename).</para>
|
---|
[f8625d25] | 132 |
|
---|
| 133 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 134 |
|
---|
[3b37f7e8] | 135 | <screen role='root'><userinput>make install &&
|
---|
| 136 |
|
---|
| 137 | mv -v /usr/share/gnucash/doc /usr/share/doc/gnucash-&gnucash-version; &&
|
---|
| 138 | ln -v -s ../doc/gnucash-&gnucash-version; /usr/share/gnucash/doc &&
|
---|
[7aeaa620] | 139 |
|
---|
[3b37f7e8] | 140 | for FILENAME in doc/{misc*,gnome*,generic*,build*}.txt \
|
---|
| 141 | doc/{gtkrc*,TRANSLATION_HOWTO,README.translator.txt} \
|
---|
| 142 | doc/README.{build-system,OFX,HBCI}
|
---|
| 143 | do
|
---|
| 144 | install -v -m644 ${FILENAME} /usr/share/doc/gnucash-&gnucash-version;
|
---|
| 145 | done &&
|
---|
[7aeaa620] | 146 |
|
---|
[3b37f7e8] | 147 | install -v -m755 -d /usr/share/doc/gnucash-&gnucash-version;/api/engine &&
|
---|
| 148 | install -v -m644 src/doc/{TODO*,*.txt,*.html} \
|
---|
| 149 | /usr/share/doc/gnucash-&gnucash-version;/api &&
|
---|
| 150 | install -v -m644 src/engine/*.txt \
|
---|
| 151 | /usr/share/doc/gnucash-&gnucash-version;/api/engine</userinput></screen>
|
---|
[7aeaa620] | 152 |
|
---|
[3b37f7e8] | 153 | <para>If you built the API HTML or Design Guide documentation, issue the
|
---|
| 154 | following commands (modified as necessary, depending on what docs are
|
---|
| 155 | being installed) as the <systemitem class="username">root</systemitem>
|
---|
| 156 | user:</para>
|
---|
[7aeaa620] | 157 |
|
---|
[3b37f7e8] | 158 | <screen role='root'><userinput>install -v -m755 -d /usr/share/doc/gnucash-&gnucash-version;/{design,api}/html &&
|
---|
| 159 | install -v -m644 src/doc/design/gnucash-design.html/* \
|
---|
| 160 | /usr/share/doc/gnucash-&gnucash-version;/design/html &&
|
---|
| 161 | install -v -m644 src/doc/design/gnucash-design.{pdf,ps,dvi} \
|
---|
| 162 | /usr/share/doc/gnucash-&gnucash-version;/design &&
|
---|
| 163 | install -v -m644 src/doc/html/* \
|
---|
| 164 | /usr/share/doc/gnucash-&gnucash-version;/api/html</userinput></screen>
|
---|
[f8625d25] | 165 |
|
---|
[3b37f7e8] | 166 | <para>If you want to install the Help documentation system, you must have
|
---|
| 167 | <xref linkend="scrollkeeper"/> installed. Then unpack the additional
|
---|
[f8625d25] | 168 | tarball, change into the
|
---|
| 169 | <filename class='directory'>gnucash-docs-&gnucash-docs-version;</filename>
|
---|
| 170 | source directory and issue the following commands as an unprivileged
|
---|
| 171 | user:</para>
|
---|
| 172 |
|
---|
[3b37f7e8] | 173 | <screen><userinput>./configure --prefix=/usr \
|
---|
[7aeaa620] | 174 | --localstatedir=/var/lib &&
|
---|
[f8625d25] | 175 | make</userinput></screen>
|
---|
| 176 |
|
---|
[3b37f7e8] | 177 | <para>HTML versions of the Help Manual and Users Guide can be created if
|
---|
| 178 | the DocBook XML tools are installed (<xref linkend="libxslt"/>,
|
---|
| 179 | <xref linkend="DocBook"/> and <xref linkend="docbook-xsl"/>). A PDF version
|
---|
| 180 | of the Users Guide can be created if you have <xref linkend="docbook-utils"/>
|
---|
| 181 | and <xref linkend="jadetex"/> installed. Issue the following commands to
|
---|
| 182 | create the documentation (modify as appropriate for your desires):</para>
|
---|
| 183 |
|
---|
| 184 | <screen><userinput>make -C help html &&
|
---|
| 185 | make -C guide html &&
|
---|
| 186 | make -C guide pdf</userinput></screen>
|
---|
| 187 |
|
---|
[f8625d25] | 188 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 189 |
|
---|
| 190 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
[72b5adb] | 191 |
|
---|
[3b37f7e8] | 192 | <para>If you built the Help Manual or Users Guide, install them using the
|
---|
| 193 | following commands as the <systemitem class="username">root</systemitem>
|
---|
| 194 | user (modify as necessary):</para>
|
---|
| 195 |
|
---|
| 196 | <screen role='root'><userinput>install -v -m755 -d /usr/share/doc/gnucash-&gnucash-version;/{users_guide,help} &&
|
---|
| 197 | cp -v -R help/C/gnucash-help/* \
|
---|
| 198 | /usr/share/doc/gnucash-&gnucash-version;/help &&
|
---|
| 199 | cp -v -R guide/C/gnucash-guide/* \
|
---|
| 200 | /usr/share/doc/gnucash-&gnucash-version;/users_guide &&
|
---|
| 201 | install -v -m644 guide/C/gnucash-guide.pdf \
|
---|
| 202 | /usr/share/doc/gnucash-&gnucash-version;</userinput></screen>
|
---|
| 203 |
|
---|
[50ad401] | 204 | <para>Note that you must have <xref linkend="yelp"/> installed in order to
|
---|
| 205 | view the Help documents using the default
|
---|
| 206 | <application>GnuCash</application> method.</para>
|
---|
| 207 |
|
---|
[72b5adb] | 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | <sect2 role="commands">
|
---|
| 211 | <title>Command Explanations</title>
|
---|
| 212 |
|
---|
[3b37f7e8] | 213 | <para><command>sed -i 's|xml::${sysconfdir}|xml::&gnome-etc-dir;|'
|
---|
| 214 | configure</command>: This command is used because the location of the
|
---|
| 215 | <application>GConf</application> source database is hard-coded into
|
---|
| 216 | the <command>configure</command> script as
|
---|
| 217 | <filename class='directory'><envar>$sysconfdir</envar>/gconf</filename>
|
---|
| 218 | (rendering the <option>--with-gconf-source</option> parameter useless).
|
---|
| 219 | The modification ensures that the <application>GConf</application> database
|
---|
| 220 | is properly updated while still allowing the package configuration files
|
---|
| 221 | to be installed in
|
---|
| 222 | <filename class='directory'>/etc/gnucash</filename>.</para>
|
---|
[72b5adb] | 223 |
|
---|
| 224 | <para><parameter>--sysconfdir=/etc</parameter>: This installs configuration
|
---|
| 225 | files in <filename class='directory'>/etc/gnucash</filename> instead of
|
---|
[3b37f7e8] | 226 | <filename class='directory'>/usr/etc/gnucash</filename>.</para>
|
---|
[72b5adb] | 227 |
|
---|
[3b37f7e8] | 228 | <para><parameter>--with-gconf-schema-file-dir=&gnome-etc-dir;/gconf/schemas</parameter>:
|
---|
| 229 | This parameter ensures that the <application>GConf</application> schema
|
---|
| 230 | files are installed in the proper location instead of
|
---|
| 231 | <filename class='directory'>/etc/gconf</filename>.</para>
|
---|
[56ce09e] | 232 |
|
---|
[3b37f7e8] | 233 | <para><command>mv -v /usr/share/gnucash/doc
|
---|
| 234 | /usr/share/doc/gnucash-&gnucash-version;</command> and
|
---|
| 235 | <command>ln -v -s ../doc/gnucash-&gnucash-version;
|
---|
| 236 | /usr/share/gnucash/doc</command>: These commands are used to relocate the
|
---|
| 237 | documentation files to the customary location and create a symbolic link
|
---|
| 238 | to the original location.</para>
|
---|
[72b5adb] | 239 |
|
---|
[3b37f7e8] | 240 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
| 241 | href="../../xincludes/scrollkeeper-dir.xml"/>
|
---|
[f8625d25] | 242 |
|
---|
| 243 | <para><option>--enable-sql</option>: This parameter is required if you want
|
---|
| 244 | to build in SQL support using <application>PostgreSQL</application>.</para>
|
---|
[72b5adb] | 245 |
|
---|
[7aeaa620] | 246 | <para><option>--enable-hbci</option>: This parameter is required if you
|
---|
| 247 | want to build in on-line banking support using
|
---|
| 248 | <application>AqBanking</application>. See
|
---|
[72b5adb] | 249 | <filename>doc/README.HBCI</filename> in the
|
---|
[7aeaa620] | 250 | <application>GnuCash</application> source tree for complete
|
---|
| 251 | information.</para>
|
---|
[72b5adb] | 252 |
|
---|
| 253 | </sect2>
|
---|
| 254 |
|
---|
| 255 | <sect2 role="configuration">
|
---|
| 256 | <title>Configuring GnuCash</title>
|
---|
| 257 |
|
---|
| 258 | <sect3>
|
---|
| 259 | <title>Configuration Information</title>
|
---|
| 260 |
|
---|
[f8625d25] | 261 | <para>If you wish to use <application>GnuCash</application> to retrieve
|
---|
[3b37f7e8] | 262 | stock price quotes, you'll need to
|
---|
[f8625d25] | 263 | install the following <application>Perl</application> modules:
|
---|
[3b37f7e8] | 264 | <xref linkend="perl-lwp"/>,
|
---|
| 265 | <xref linkend="perl-date-manip"/>,
|
---|
| 266 | <xref linkend="perl-html-parser"/>,
|
---|
| 267 | <xref linkend="perl-html-tableextract"/>,
|
---|
| 268 | <xref linkend="perl-crypt-ssleay"/>, and
|
---|
| 269 | <xref linkend="perl-finance-quote"/>. Alternatively, you can run the
|
---|
| 270 | <command>/usr/bin/gnc-fq-update</command> script as the
|
---|
| 271 | <systemitem class="username">root</systemitem> user.</para>
|
---|
[72b5adb] | 272 |
|
---|
| 273 | </sect3>
|
---|
| 274 |
|
---|
| 275 | </sect2>
|
---|
| 276 |
|
---|
| 277 | <sect2 role="content">
|
---|
| 278 | <title>Contents</title>
|
---|
| 279 |
|
---|
| 280 | <segmentedlist>
|
---|
| 281 | <segtitle>Installed Programs</segtitle>
|
---|
| 282 | <segtitle>Installed Libraries</segtitle>
|
---|
| 283 | <segtitle>Installed Directories</segtitle>
|
---|
| 284 |
|
---|
| 285 | <seglistitem>
|
---|
[3b37f7e8] | 286 | <seg>gnc-fq-check, gnc-fq-dump, gnc-fq-helper, gnc-fq-update,
|
---|
| 287 | gnc-test-env, gnucash, gnucash-bin, gnucash-env, gnucash-make-guids,
|
---|
| 288 | gnucash-valgrind, and update-gnucash-gconf</seg>
|
---|
| 289 | <seg>libgnc-backend-file-utils.so, libgnc-backend-postgres.so,
|
---|
| 290 | libgnc-business-ledger.so,libgnc-core-utils.so, libgnc-gnome.so,
|
---|
| 291 | libgnc-module.so, libgnc-qof.so and numerous support libraries
|
---|
| 292 | installed in
|
---|
| 293 | <filename class='directory'>/usr/lib/gnucash</filename></seg>
|
---|
[f8625d25] | 294 | <seg>/etc/gnucash,
|
---|
[3b37f7e8] | 295 | /usr/include/gnucash,
|
---|
| 296 | /usr/lib/gnucash,
|
---|
| 297 | and the following subdirectories of /usr/share/:
|
---|
| 298 | doc/gnucash-&gnucash-version;,
|
---|
| 299 | gnome/help/gnucash,
|
---|
| 300 | gnucash,
|
---|
| 301 | omf/gnucash-docs, and
|
---|
| 302 | /xml/gnucash</seg>
|
---|
[72b5adb] | 303 | </seglistitem>
|
---|
| 304 | </segmentedlist>
|
---|
| 305 |
|
---|
| 306 | <variablelist>
|
---|
| 307 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 308 | <?dbfo list-presentation="list"?>
|
---|
| 309 | <?dbhtml list-presentation="table"?>
|
---|
| 310 |
|
---|
| 311 | <varlistentry id="gnucash-prog">
|
---|
| 312 | <term><command>gnucash</command></term>
|
---|
| 313 | <listitem>
|
---|
| 314 | <para>is a personal finance manager.</para>
|
---|
| 315 | <indexterm zone="gnucash gnucash-prog">
|
---|
| 316 | <primary sortas="b-gnucash">gnucash</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
| 321 | </variablelist>
|
---|
| 322 |
|
---|
| 323 | </sect2>
|
---|
[f45b1953] | 324 |
|
---|
| 325 | </sect1>
|
---|