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