[613c524f] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/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">
|
---|
[f8625d25] | 9 | <!ENTITY gnucash-src-md5sum "62f94331936e37ed1b1d28b5a1863bb3">
|
---|
[ef8654b] | 10 | <!ENTITY gnucash-docs-md5sum "9758d8e523530c2509912761e327a9d5">
|
---|
[f8625d25] | 11 | <!ENTITY gnucash-size "7.8 MB">
|
---|
[a0a2216] | 12 | <!ENTITY gnucash-buildsize "113 MB (additional 22 MB for Help documentation)">
|
---|
[f8625d25] | 13 | <!ENTITY gnucash-time "2.9 SBU">
|
---|
[852298f7] | 14 | <!ENTITY gnucash-docs-version "1.8.5">
|
---|
| 15 | <!ENTITY gnucash-docs-download "http://www.gnucash.org/pub/gnucash/sources/stable/gnucash-docs-&gnucash-docs-version;.tar.gz">
|
---|
[613c524f] | 16 | ]>
|
---|
| 17 |
|
---|
[5afbfa23] | 18 | <sect1 id="gnucash" xreflabel="GnuCash-&gnucash-version;">
|
---|
[72b5adb] | 19 | <?dbhtml filename="gnucash.html" ?>
|
---|
| 20 |
|
---|
| 21 | <sect1info>
|
---|
| 22 | <othername>$LastChangedBy$</othername>
|
---|
| 23 | <date>$Date$</date>
|
---|
| 24 | </sect1info>
|
---|
| 25 |
|
---|
| 26 | <title>GnuCash-&gnucash-version;</title>
|
---|
| 27 |
|
---|
| 28 | <indexterm zone="gnucash">
|
---|
| 29 | <primary sortas="a-GnuCash">GnuCash</primary>
|
---|
| 30 | </indexterm>
|
---|
| 31 |
|
---|
| 32 | <sect2 role="package">
|
---|
| 33 | <title>Introduction to GnuCash</title>
|
---|
| 34 |
|
---|
| 35 | <para><application>GnuCash</application> is a personal finance
|
---|
| 36 | manager.</para>
|
---|
| 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>Download (HTTP): <ulink url="&gnucash-download-http;"/></para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (FTP): <ulink url="&gnucash-download-ftp;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download MD5 sum: &gnucash-src-md5sum;</para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download size: &gnucash-size;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Estimated disk space required: &gnucash-buildsize;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated build time: &gnucash-time;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | </itemizedlist>
|
---|
| 59 |
|
---|
| 60 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 61 | <itemizedlist spacing='compact'>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>Help documentation: <ulink url="&gnucash-docs-download;"/></para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>Download MD5 sum: &gnucash-docs-md5sum;</para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect3">GnuCash Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 73 | <para><xref linkend="oaf"/>,
|
---|
| 74 | <xref linkend="gal1"/>,
|
---|
| 75 | <xref linkend="gtkhtml1"/>,
|
---|
[f8625d25] | 76 | <xref linkend="libghttp"/>,
|
---|
| 77 | <xref linkend="gwrap"/> and
|
---|
| 78 | <xref linkend="slib"/></para>
|
---|
[72b5adb] | 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 81 | <para><xref linkend="postgresql"/>,
|
---|
| 82 | <xref linkend="guppi"/>,
|
---|
| 83 | <xref linkend="scrollkeeper"/>,
|
---|
| 84 | <xref linkend="doxygen"/>,
|
---|
[f8625d25] | 85 | <ulink url="http://www.graphviz.org/">GraphViz</ulink>,
|
---|
| 86 | <ulink url="ftp://ftp.gnu.org/pub/gnu/guile/">Guile-www</ulink>,
|
---|
[72b5adb] | 87 | <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Optional (for On-Line Banking)</bridgehead>
|
---|
[f8625d25] | 90 | <para><ulink url="http://libofx.sourceforge.net/">LibOFX</ulink> (requires
|
---|
| 91 | <xref linkend="opensp"/> and <xref linkend="curl"/>),
|
---|
[72b5adb] | 92 | <ulink url="http://sourceforge.net/projects/ktoblzcheck">KtoBlzCheck</ulink>,
|
---|
| 93 | <ulink url="http://sourceforge.net/projects/aqhbci">AqHBCI</ulink>
|
---|
| 94 | (requires
|
---|
| 95 | <ulink url="http://sourceforge.net/projects/gwenhywfar">Gwenhywfar</ulink>
|
---|
| 96 | then
|
---|
| 97 | <ulink url="http://sourceforge.net/projects/aqbanking">AqBanking</ulink>),
|
---|
| 98 | and also see
|
---|
| 99 | <ulink
|
---|
| 100 | url="http://sourceforge.net/projects/libchipcard">libchipcard</ulink></para>
|
---|
| 101 |
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of GnuCash</title>
|
---|
| 106 |
|
---|
| 107 | <para>Install <application>GnuCash</application> by running the following
|
---|
| 108 | commands:</para>
|
---|
| 109 |
|
---|
[a0a2216] | 110 | <screen><userinput>./configure --prefix=/opt/gnome-1.4 --sysconfdir=/etc \
|
---|
| 111 | --disable-guppi --disable-error-on-warning &&
|
---|
[f8625d25] | 112 | make</userinput></screen>
|
---|
| 113 |
|
---|
| 114 | <para>To test the results, issue <command>make check</command> as the
|
---|
| 115 | <systemitem class="username">root</systemitem> user as the test suite will
|
---|
| 116 | attempt to update the <application>SLIB</application> catalog in
|
---|
[a0a2216] | 117 | <filename class='directory'>/usr/share/guile</filename>. All tests should
|
---|
| 118 | pass.</para>
|
---|
[f8625d25] | 119 |
|
---|
| 120 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 121 |
|
---|
| 122 | <screen role='root'><userinput>make install &&
|
---|
| 123 | chown -v -R root:root /opt/gnome-1.4/share/gnucash/doc/html/html</userinput></screen>
|
---|
| 124 |
|
---|
| 125 | <para>If you want to install the Help documentation (requires
|
---|
| 126 | <xref linkend="scrollkeeper"/> to be installed), unpack the additional
|
---|
| 127 | tarball, change into the
|
---|
| 128 | <filename class='directory'>gnucash-docs-&gnucash-docs-version;</filename>
|
---|
| 129 | source directory and issue the following commands as an unprivileged
|
---|
| 130 | user:</para>
|
---|
| 131 |
|
---|
| 132 | <screen><userinput>./configure --prefix=/opt/gnome-1.4 \
|
---|
[852298f7] | 133 | --localstatedir=/var/lib &&
|
---|
[f8625d25] | 134 | make</userinput></screen>
|
---|
| 135 |
|
---|
| 136 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 137 |
|
---|
| 138 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
[72b5adb] | 139 |
|
---|
| 140 | </sect2>
|
---|
| 141 |
|
---|
| 142 | <sect2 role="commands">
|
---|
| 143 | <title>Command Explanations</title>
|
---|
| 144 |
|
---|
[f8625d25] | 145 | <para><parameter>--prefix=/opt/gnome-1.4</parameter>:
|
---|
[72b5adb] | 146 | <application>GnuCash</application>-&gnucash-version; is a
|
---|
[f8625d25] | 147 | <application>GNOME</application>-1.4 application.</para>
|
---|
[72b5adb] | 148 |
|
---|
| 149 | <para><parameter>--sysconfdir=/etc</parameter>: This installs configuration
|
---|
| 150 | files in <filename class='directory'>/etc/gnucash</filename> instead of
|
---|
[f8625d25] | 151 | <filename class='directory'>/opt/gnome-1.4/etc/gnucash</filename>.</para>
|
---|
[72b5adb] | 152 |
|
---|
| 153 | <para><parameter>--disable-guppi</parameter>: This compiles
|
---|
| 154 | <application>GnuCash</application> without support for creating
|
---|
| 155 | GUI graphs and plots. Remove this option if you have
|
---|
| 156 | <application>Guppi</application> installed.</para>
|
---|
| 157 |
|
---|
[a0a2216] | 158 | <para><parameter>-disable-error-on-warning</parameter>: Without this
|
---|
| 159 | parameter the build will fail because a warning is generated. This option
|
---|
| 160 | forces the build to ignore the warning.</para>
|
---|
[f8625d25] | 161 |
|
---|
| 162 | <para><option>--enable-sql</option>: This parameter is required if you want
|
---|
| 163 | to build in SQL support using <application>PostgreSQL</application>.</para>
|
---|
[72b5adb] | 164 |
|
---|
| 165 | <para><option>--enable-ofx</option>: This parameter is required if you want
|
---|
| 166 | to build in on-line banking support using
|
---|
| 167 | <application>LibOFX</application>.</para>
|
---|
| 168 |
|
---|
| 169 | <para><option>--enable-hbci</option>: This parameter is required if you want
|
---|
| 170 | to build in on-line banking support using
|
---|
| 171 | <application>AqBanking</application>/<application>AqHBCI</application>. See
|
---|
| 172 | <filename>doc/README.HBCI</filename> in the
|
---|
| 173 | <application>GnuCash</application> source tree for complete information.</para>
|
---|
| 174 |
|
---|
| 175 | </sect2>
|
---|
| 176 |
|
---|
| 177 | <sect2 role="configuration">
|
---|
| 178 | <title>Configuring GnuCash</title>
|
---|
| 179 |
|
---|
| 180 | <sect3>
|
---|
| 181 | <title>Configuration Information</title>
|
---|
| 182 |
|
---|
[f8625d25] | 183 | <para>If you wish to use <application>GnuCash</application> to retrieve
|
---|
| 184 | stock price quotes and stock historical information, you'll need to
|
---|
| 185 | install the following <application>Perl</application> modules:
|
---|
| 186 | <xref linkend="perl-lwp"/>, <xref linkend="perl-date-manip"/>,
|
---|
| 187 | <xref linkend="perl-html-parser"/>, <xref linkend="perl-finance-quote"/>
|
---|
| 188 | and <xref linkend="perl-finance-quotehist"/>.</para>
|
---|
| 189 |
|
---|
[72b5adb] | 190 | <note>
|
---|
| 191 | <para><application>GnuCash</application> must be run as
|
---|
| 192 | <systemitem class="username">root</systemitem> once before use. Simply
|
---|
| 193 | executing <command>gnucash</command> from an <application>X</application>
|
---|
| 194 | terminal and clicking on the cancel button is sufficient. This must be
|
---|
| 195 | done prior to setting up accounts as an unprivileged user, due to the
|
---|
| 196 | fact that <application>GnuCash</application> must update scheme catalogs
|
---|
[a0a2216] | 197 | before it is used. If you ran the test suite as the
|
---|
| 198 | <systemitem class="username">root</systemitem> user during the build
|
---|
| 199 | instructions, this step is not necessary.</para>
|
---|
[72b5adb] | 200 | </note>
|
---|
| 201 |
|
---|
| 202 | </sect3>
|
---|
| 203 |
|
---|
| 204 | </sect2>
|
---|
| 205 |
|
---|
| 206 | <sect2 role="content">
|
---|
| 207 | <title>Contents</title>
|
---|
| 208 |
|
---|
| 209 | <segmentedlist>
|
---|
| 210 | <segtitle>Installed Programs</segtitle>
|
---|
| 211 | <segtitle>Installed Libraries</segtitle>
|
---|
| 212 | <segtitle>Installed Directories</segtitle>
|
---|
| 213 |
|
---|
| 214 | <seglistitem>
|
---|
[f8625d25] | 215 | <seg>dump-finance-quote, gnc-prices, gnc-test-env, gnucash,
|
---|
| 216 | gnucash-config, gnucash-env, gnucash-make-guids, gnucash-run-script
|
---|
| 217 | and update-finance-quote</seg>
|
---|
| 218 | <seg>libcore-utils.so, libgnc-app-file-gnome.so, libgncgnome.so,
|
---|
| 219 | libgncmodule.so, libgw-core-utils.so, libgw-gnc.so and numerous
|
---|
| 220 | support libraries installed in
|
---|
| 221 | <filename class='directory'>/opt/gnome-1.4/lib/gnucash</filename></seg>
|
---|
| 222 | <seg>/etc/gnucash,
|
---|
| 223 | /opt/gnome-1.4/include/gnucash,
|
---|
| 224 | /opt/gnome-1.4/lib/gnucash,
|
---|
| 225 | /opt/gnome-1.4/libexec/gnucash,
|
---|
| 226 | /opt/gnome-1.4/share/gnome/apps/Applications,
|
---|
| 227 | /opt/gnome-1.4/share/gnome/help/gnucash,
|
---|
| 228 | /opt/gnome-1.4/share/gnucash,
|
---|
| 229 | /opt/gnome-1.4/share/omf/gnucash-docs and
|
---|
| 230 | /opt/gnome-1.4/share/pixmaps/gnucash</seg>
|
---|
[72b5adb] | 231 | </seglistitem>
|
---|
| 232 | </segmentedlist>
|
---|
| 233 |
|
---|
| 234 | <variablelist>
|
---|
| 235 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 236 | <?dbfo list-presentation="list"?>
|
---|
| 237 | <?dbhtml list-presentation="table"?>
|
---|
| 238 |
|
---|
| 239 | <varlistentry id="gnucash-prog">
|
---|
| 240 | <term><command>gnucash</command></term>
|
---|
| 241 | <listitem>
|
---|
| 242 | <para>is a personal finance manager.</para>
|
---|
| 243 | <indexterm zone="gnucash gnucash-prog">
|
---|
| 244 | <primary sortas="b-gnucash">gnucash</primary>
|
---|
| 245 | </indexterm>
|
---|
| 246 | </listitem>
|
---|
| 247 | </varlistentry>
|
---|
| 248 |
|
---|
| 249 | </variablelist>
|
---|
| 250 |
|
---|
| 251 | </sect2>
|
---|
[f45b1953] | 252 |
|
---|
| 253 | </sect1>
|
---|