[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 |
|
---|
[a4a52f4] | 7 | <!ENTITY gnucash-download-http
|
---|
| 8 | "&sourceforge-repo;/gnucash/gnucash-&gnucash-version;.tar.bz2">
|
---|
| 9 | <!ENTITY gnucash-download-ftp
|
---|
| 10 | " ">
|
---|
| 11 | <!ENTITY gnucash-src-md5sum "eebcf231beffe39a9c1b5f09625bb38e">
|
---|
| 12 | <!ENTITY gnucash-size "8.9 MB">
|
---|
| 13 | <!ENTITY gnucash-buildsize "234 MB">
|
---|
| 14 | <!ENTITY gnucash-time "2.2 SBU">
|
---|
| 15 | <!ENTITY gnucash-docs-version "2.4.1">
|
---|
| 16 | <!ENTITY gnucash-docs-download
|
---|
| 17 | "&sourceforge-repo;/gnucash/gnucash-docs-&gnucash-docs-version;.tar.gz">
|
---|
| 18 | <!ENTITY gnucash-docs-md5sum "38daeb3b15f296726ee8124122040f08">
|
---|
| 19 | <!ENTITY gnucash-docs-size "32.5 MB">
|
---|
| 20 | <!ENTITY gnucash-docs-buildsize "27 MB">
|
---|
| 21 | <!ENTITY gnucash-docs-time "0.5 SBU">
|
---|
[613c524f] | 22 | ]>
|
---|
| 23 |
|
---|
[5afbfa23] | 24 | <sect1 id="gnucash" xreflabel="GnuCash-&gnucash-version;">
|
---|
[72b5adb] | 25 | <?dbhtml filename="gnucash.html" ?>
|
---|
| 26 |
|
---|
| 27 | <sect1info>
|
---|
| 28 | <othername>$LastChangedBy$</othername>
|
---|
| 29 | <date>$Date$</date>
|
---|
| 30 | </sect1info>
|
---|
| 31 |
|
---|
| 32 | <title>GnuCash-&gnucash-version;</title>
|
---|
| 33 |
|
---|
| 34 | <indexterm zone="gnucash">
|
---|
| 35 | <primary sortas="a-GnuCash">GnuCash</primary>
|
---|
| 36 | </indexterm>
|
---|
| 37 |
|
---|
| 38 | <sect2 role="package">
|
---|
| 39 | <title>Introduction to GnuCash</title>
|
---|
| 40 |
|
---|
| 41 | <para><application>GnuCash</application> is a personal finance
|
---|
[3b37f7e8] | 42 | manager.</para>
|
---|
[72b5adb] | 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
[a4a52f4] | 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&gnucash-download-http;"/>
|
---|
| 49 | </para>
|
---|
[72b5adb] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[a4a52f4] | 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&gnucash-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
[72b5adb] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[a4a52f4] | 57 | <para>
|
---|
| 58 | Download MD5 sum: &gnucash-src-md5sum;
|
---|
| 59 | </para>
|
---|
[72b5adb] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[a4a52f4] | 62 | <para>
|
---|
| 63 | Download size: &gnucash-size;
|
---|
| 64 | </para>
|
---|
[72b5adb] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[a4a52f4] | 67 | <para>
|
---|
| 68 | Estimated disk space required: &gnucash-buildsize;
|
---|
| 69 | </para>
|
---|
[72b5adb] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[a4a52f4] | 72 | <para>
|
---|
| 73 | Estimated build time: &gnucash-time;
|
---|
| 74 | </para>
|
---|
[72b5adb] | 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[a4a52f4] | 79 | <itemizedlist spacing="compact">
|
---|
| 80 | <listitem>
|
---|
| 81 | <para>
|
---|
| 82 | Required patch:
|
---|
| 83 | <ulink url="&patch-root;/gnucash-&gnucash-version;-guile-2_fixes-1.patch"/>
|
---|
| 84 | </para>
|
---|
| 85 | </listitem>
|
---|
[72b5adb] | 86 | <listitem>
|
---|
[a4a52f4] | 87 | <para>
|
---|
| 88 | Optional Help documentation: <ulink url="&gnucash-docs-download;"/>
|
---|
| 89 | </para>
|
---|
[72b5adb] | 90 | </listitem>
|
---|
| 91 | <listitem>
|
---|
[a4a52f4] | 92 | <para>
|
---|
| 93 | Download MD5 sum: &gnucash-docs-md5sum;
|
---|
| 94 | </para>
|
---|
[72b5adb] | 95 | </listitem>
|
---|
[3b37f7e8] | 96 | <listitem>
|
---|
[a4a52f4] | 97 | <para>
|
---|
| 98 | Download size: &gnucash-docs-size;
|
---|
| 99 | </para>
|
---|
[3b37f7e8] | 100 | </listitem>
|
---|
[f89938c] | 101 | <listitem>
|
---|
[a4a52f4] | 102 | <para>
|
---|
| 103 | Estimated disk space required: &gnucash-docs-buildsize;
|
---|
| 104 | </para>
|
---|
[f89938c] | 105 | </listitem>
|
---|
| 106 | <listitem>
|
---|
[a4a52f4] | 107 | <para>
|
---|
| 108 | Estimated build time: &gnucash-docs-time;
|
---|
| 109 | </para>
|
---|
[f89938c] | 110 | </listitem>
|
---|
[72b5adb] | 111 | </itemizedlist>
|
---|
| 112 |
|
---|
| 113 | <bridgehead renderas="sect3">GnuCash Dependencies</bridgehead>
|
---|
| 114 |
|
---|
| 115 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[a4a52f4] | 116 | <para role="required">
|
---|
| 117 | <xref linkend="guile"/>,
|
---|
| 118 | <xref linkend="libgnomeui"/>,
|
---|
| 119 | <xref linkend="gnome-vfs"/>,
|
---|
| 120 | <xref linkend="slib"/> and
|
---|
| 121 | <xref linkend="goffice"/>.
|
---|
| 122 | <xref linkend="gtkhtml"/> or
|
---|
| 123 | <xref linkend="webkitgtk"/> (configured <option>--with-gtk=2.0</option>).
|
---|
| 124 | </para>
|
---|
[72b5adb] | 125 |
|
---|
| 126 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[a4a52f4] | 127 | <para role="optional">
|
---|
| 128 | <ulink url="http://libdbi.sourceforge.net/">libdbi</ulink> and
|
---|
| 129 | <ulink url="ftp://ftp.gnu.org/pub/gnu/guile/">Guile-www</ulink>
|
---|
| 130 | </para>
|
---|
[72b5adb] | 131 |
|
---|
[3b37f7e8] | 132 | <bridgehead renderas="sect4">Optional (Required for the Help System)</bridgehead>
|
---|
[a4a52f4] | 133 | <para role="optional">
|
---|
| 134 | <xref linkend="rarian"/> and
|
---|
| 135 | <xref linkend="yelp"/> (run-time requirement to view the Help documents).
|
---|
| 136 | </para>
|
---|
[3b37f7e8] | 137 |
|
---|
[72b5adb] | 138 | <bridgehead renderas="sect4">Optional (for On-Line Banking)</bridgehead>
|
---|
[a4a52f4] | 139 | <para role="optional">
|
---|
| 140 | <ulink url="http://libofx.sourceforge.net/">LibOFX</ulink> (requires
|
---|
| 141 | <xref linkend="opensp"/> and <xref linkend="curl"/>),
|
---|
| 142 | <ulink url="http://sourceforge.net/projects/ktoblzcheck">KtoBlzCheck</ulink> and
|
---|
| 143 | <ulink url="http://www.aquamaniac.de/aqbanking/">AqBanking</ulink> (requires
|
---|
| 144 | <ulink url="http://gwenhywfar.sourceforge.net/">Gwenhywfar</ulink> and
|
---|
| 145 | <ulink url="http://www.libchipcard.de/">libchipcard3</ulink>)
|
---|
| 146 | </para>
|
---|
| 147 |
|
---|
| 148 | <para condition="html" role="usernotes">
|
---|
| 149 | User Notes: <ulink url="&blfs-wiki;/gnucash"/>
|
---|
| 150 | </para>
|
---|
[38e4f06] | 151 |
|
---|
[72b5adb] | 152 | </sect2>
|
---|
| 153 |
|
---|
| 154 | <sect2 role="installation">
|
---|
| 155 | <title>Installation of GnuCash</title>
|
---|
| 156 |
|
---|
| 157 | <para>Install <application>GnuCash</application> by running the following
|
---|
| 158 | commands:</para>
|
---|
| 159 |
|
---|
[a4a52f4] | 160 | <screen><userinput>patch -p1 < ../gnucash-&gnucash-version;-guile-2_fixes-1.patch &&
|
---|
| 161 | ./configure --prefix=${GNOME_PREFIX} --sysconfdir=${GNOME_SYSCONFDIR} &&
|
---|
[f8625d25] | 162 | make</userinput></screen>
|
---|
| 163 |
|
---|
[a4a52f4] | 164 | <para>
|
---|
| 165 | If you wish to create the API documentation in HTML format, you must
|
---|
| 166 | have <xref linkend="doxygen"/> and <xref linkend="graphviz"/> installed,
|
---|
| 167 | then issue: <command>make doc</command>. If you wish to create the API
|
---|
| 168 | Design Guide in several formats, you must have <xref linkend="texlive"/>
|
---|
| 169 | installed and issue: <command>make -C src/doc/design html pdf
|
---|
| 170 | ps</command>.
|
---|
| 171 | </para>
|
---|
| 172 |
|
---|
| 173 | <para>
|
---|
| 174 | To test the results, issue: <command>make check</command>.
|
---|
| 175 | </para>
|
---|
| 176 |
|
---|
| 177 | <para>
|
---|
| 178 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 179 | </para>
|
---|
| 180 |
|
---|
| 181 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 182 |
|
---|
| 183 | <para>
|
---|
| 184 | If you want to install the Help documentation system, you must have
|
---|
| 185 | <xref linkend="yelp"/> and <xref linkend="rarian"/> installed in order to
|
---|
| 186 | view the Help documents. Unpack the additional tarball, change into the
|
---|
| 187 | <filename class="directory">gnucash-docs-&gnucash-docs-version;</filename>
|
---|
| 188 | source directory and issue the following commands as an unprivileged
|
---|
| 189 | user:
|
---|
| 190 | </para>
|
---|
| 191 |
|
---|
| 192 | <screen><userinput>./configure --prefix=${GNOME_PREFIX} &&
|
---|
[f8625d25] | 193 | make</userinput></screen>
|
---|
| 194 |
|
---|
[a4a52f4] | 195 | <para>
|
---|
| 196 | HTML versions of the Users Guide can be created if the DocBook XML tools
|
---|
| 197 | are installed (<xref linkend="libxslt"/>, <xref linkend="DocBook"/> and
|
---|
| 198 | <xref linkend="docbook-xsl"/>). A PDF version of the Users Guide can be
|
---|
| 199 | created if you have <xref linkend="docbook-utils"/>,
|
---|
| 200 | <xref linkend="jadetex"/> and <xref linkend="fop"/> installed.
|
---|
| 201 | Issue the following commands to create the documentation:
|
---|
| 202 | </para>
|
---|
[3b37f7e8] | 203 |
|
---|
[a4a52f4] | 204 | <screen><userinput>make -C guide html &&
|
---|
[3b37f7e8] | 205 | make -C guide pdf</userinput></screen>
|
---|
| 206 |
|
---|
[a4a52f4] | 207 | <para>
|
---|
| 208 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 209 | </para>
|
---|
[3b37f7e8] | 210 |
|
---|
[a4a52f4] | 211 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[3b37f7e8] | 212 |
|
---|
[a4a52f4] | 213 | <para>
|
---|
| 214 | If you built the Users Guide, install it as the
|
---|
| 215 | <systemitem class="username">root</systemitem> user:
|
---|
| 216 | </para>
|
---|
[50ad401] | 217 |
|
---|
[a4a52f4] | 218 | <screen role="root"><userinput>mkdir -p ${GNOME_PREFIX}/share/doc/gnucash-&gnucash-docs-version; &&
|
---|
| 219 | cp -v -R guide/C/gnucash-guide/* ${GNOME_PREFIX}/share/doc/gnucash-&gnucash-docs-version; &&
|
---|
| 220 | cp -v guide/C/gnucash-guide.pdf ${GNOME_PREFIX}/share/doc/gnucash-&gnucash-docs-version;</userinput></screen>
|
---|
[72b5adb] | 221 | </sect2>
|
---|
| 222 |
|
---|
| 223 | <sect2 role="commands">
|
---|
| 224 | <title>Command Explanations</title>
|
---|
| 225 |
|
---|
[a4a52f4] | 226 | <para>
|
---|
| 227 | <parameter>--sysconfdir=${GNOME_SYSCONFDIR}</parameter>: This installs
|
---|
| 228 | configuration files in
|
---|
| 229 | <filename class="directory">${GNOME_SYSCONFDIR}/gnucash</filename> instead
|
---|
| 230 | of <filename class="directory">/usr/etc/gnucash</filename>.
|
---|
| 231 | </para>
|
---|
| 232 |
|
---|
| 233 | <para>
|
---|
| 234 | <option>--with-html-engine=webkit</option>: Add this option to use
|
---|
| 235 | <xref linkend="webkitgtk"/> (configured <option>--with-gtk=2.0</option>)
|
---|
| 236 | instead of <xref linkend="gtkhtml"/>.
|
---|
| 237 | </para>
|
---|
| 238 |
|
---|
| 239 | <para>
|
---|
| 240 | <option>--disable-dbi</option>: Add this option if you've not installed
|
---|
| 241 | <application>libdbi</application>.
|
---|
| 242 | </para>
|
---|
[72b5adb] | 243 | </sect2>
|
---|
| 244 |
|
---|
| 245 | <sect2 role="configuration">
|
---|
| 246 | <title>Configuring GnuCash</title>
|
---|
| 247 |
|
---|
| 248 | <sect3>
|
---|
| 249 | <title>Configuration Information</title>
|
---|
| 250 |
|
---|
[a4a52f4] | 251 | <para>
|
---|
| 252 | If you wish to use <application>GnuCash</application> to retrieve
|
---|
| 253 | stock price quotes, you'll need to
|
---|
| 254 | install the following <application>Perl</application> modules:
|
---|
| 255 | <xref linkend="perl-lwp"/>, <xref linkend="perl-date-manip"/>,
|
---|
| 256 | <xref linkend="perl-html-parser"/>,
|
---|
| 257 | <xref linkend="perl-html-tableextract"/>,
|
---|
| 258 | <xref linkend="perl-crypt-ssleay"/>, and
|
---|
| 259 | <xref linkend="perl-finance-quote"/>. Alternatively, you can run the
|
---|
| 260 | <command>gnc-fq-update</command> script as the
|
---|
| 261 | <systemitem class="username">root</systemitem> user.
|
---|
| 262 | </para>
|
---|
[72b5adb] | 263 | </sect3>
|
---|
| 264 | </sect2>
|
---|
| 265 |
|
---|
| 266 | <sect2 role="content">
|
---|
| 267 | <title>Contents</title>
|
---|
| 268 |
|
---|
| 269 | <segmentedlist>
|
---|
| 270 | <segtitle>Installed Programs</segtitle>
|
---|
| 271 | <segtitle>Installed Libraries</segtitle>
|
---|
| 272 | <segtitle>Installed Directories</segtitle>
|
---|
| 273 |
|
---|
| 274 | <seglistitem>
|
---|
[a4a52f4] | 275 | <seg>
|
---|
| 276 | gnc-fq-check, gnc-fq-dump, gnc-fq-helper, gnc-fq-update,
|
---|
| 277 | gnucash, gnucash-env, gnucash-make-guids, gnucash-valgrind and
|
---|
| 278 | update-gnucash-gconf
|
---|
| 279 | </seg>
|
---|
| 280 | <seg>
|
---|
| 281 | libgnc-backend-sql.so, libgnc-backend-xml-utils.so,
|
---|
| 282 | libgnc-business-ledger.so,libgnc-core-utils.so, libgnc-gnome.so,
|
---|
| 283 | libgnc-module.so, libgnc-qof.so and numerous support libraries
|
---|
| 284 | installed in <filename class="directory">/usr/lib/gnucash</filename>
|
---|
| 285 | </seg>
|
---|
| 286 | <seg>
|
---|
| 287 | ${GNOME_SYSCONFDIR}/gnucash, ${GNOME_PREFIX}/include/gnucash,
|
---|
| 288 | ${GNOME_PREFIX}/lib/gnucash, ${GNOME_PREFIX}/libexec/gnucash and
|
---|
| 289 | ${GNOME_PREFIX}/share/doc/gnucash-&gnucash-version;.
|
---|
| 290 | </seg>
|
---|
[72b5adb] | 291 | </seglistitem>
|
---|
| 292 | </segmentedlist>
|
---|
| 293 |
|
---|
| 294 | <variablelist>
|
---|
| 295 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 296 | <?dbfo list-presentation="list"?>
|
---|
| 297 | <?dbhtml list-presentation="table"?>
|
---|
| 298 |
|
---|
| 299 | <varlistentry id="gnucash-prog">
|
---|
| 300 | <term><command>gnucash</command></term>
|
---|
| 301 | <listitem>
|
---|
| 302 | <para>is a personal finance manager.</para>
|
---|
| 303 | <indexterm zone="gnucash gnucash-prog">
|
---|
| 304 | <primary sortas="b-gnucash">gnucash</primary>
|
---|
| 305 | </indexterm>
|
---|
| 306 | </listitem>
|
---|
| 307 | </varlistentry>
|
---|
| 308 | </variablelist>
|
---|
| 309 | </sect2>
|
---|
[f45b1953] | 310 | </sect1>
|
---|