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