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