1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
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">
|
---|
9 | <!ENTITY gnucash-src-md5sum "6e8c1602b365d76ec19ef211857d3ece">
|
---|
10 | <!ENTITY gnucash-size "7.0 MB">
|
---|
11 | <!ENTITY gnucash-buildsize "300 MB (includes running test suite; additional 120 MB for API docs)">
|
---|
12 | <!ENTITY gnucash-time "4.1 SBU (additional 1.8 SBU to run the test suite)">
|
---|
13 | <!ENTITY gnucash-docs-version "2.2.0">
|
---|
14 | <!ENTITY gnucash-docs-download "http://www.gnucash.org/pub/gnucash/sources/stable/gnucash-docs-&gnucash-docs-version;.tar.gz">
|
---|
15 | <!ENTITY gnucash-docs-md5sum "97a29e499baca1807a3944ae3c0ad61e">
|
---|
16 | <!ENTITY gnucash-docs-size "10.0 MB">
|
---|
17 | ]>
|
---|
18 |
|
---|
19 | <sect1 id="gnucash" xreflabel="GnuCash-&gnucash-version;">
|
---|
20 | <?dbhtml filename="gnucash.html" ?>
|
---|
21 |
|
---|
22 | <sect1info>
|
---|
23 | <othername>$LastChangedBy$</othername>
|
---|
24 | <date>$Date$</date>
|
---|
25 | </sect1info>
|
---|
26 |
|
---|
27 | <title>GnuCash-&gnucash-version;</title>
|
---|
28 |
|
---|
29 | <indexterm zone="gnucash">
|
---|
30 | <primary sortas="a-GnuCash">GnuCash</primary>
|
---|
31 | </indexterm>
|
---|
32 |
|
---|
33 | <sect2 role="package">
|
---|
34 | <title>Introduction to GnuCash</title>
|
---|
35 |
|
---|
36 | <para><application>GnuCash</application> is a personal finance
|
---|
37 | manager.</para>
|
---|
38 |
|
---|
39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
40 | <itemizedlist spacing="compact">
|
---|
41 | <listitem>
|
---|
42 | <para>Download (HTTP): <ulink url="&gnucash-download-http;"/></para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>Download (FTP): <ulink url="&gnucash-download-ftp;"/></para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>Download MD5 sum: &gnucash-src-md5sum;</para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download size: &gnucash-size;</para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Estimated disk space required: &gnucash-buildsize;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Estimated build time: &gnucash-time;</para>
|
---|
58 | </listitem>
|
---|
59 | </itemizedlist>
|
---|
60 |
|
---|
61 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
62 | <itemizedlist spacing='compact'>
|
---|
63 | <listitem>
|
---|
64 | <para>Help documentation: <ulink url="&gnucash-docs-download;"/></para>
|
---|
65 | </listitem>
|
---|
66 | <listitem>
|
---|
67 | <para>Download MD5 sum: &gnucash-docs-md5sum;</para>
|
---|
68 | </listitem>
|
---|
69 | <listitem>
|
---|
70 | <para>Download size: &gnucash-docs-size;</para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">GnuCash Dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
77 | <para role="required"><xref linkend="guile"/>,
|
---|
78 | <xref linkend="slib"/>,
|
---|
79 | <xref linkend="libgnomeui"/>,
|
---|
80 | <xref linkend="goffice"/>, and
|
---|
81 | <xref linkend="gtkhtml"/></para>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
84 | <para role="optional"><xref linkend="postgresql"/>,
|
---|
85 | <ulink url="ftp://ftp.gnu.org/pub/gnu/guile/">Guile-www</ulink>, and
|
---|
86 | <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Optional (Required for the Help System)</bridgehead>
|
---|
89 | <para role="optional"><xref linkend="scrollkeeper"/> and
|
---|
90 | <xref linkend="yelp"/> (run-time requirement to view the Help documents)</para>
|
---|
91 |
|
---|
92 | <bridgehead renderas="sect4">Optional (for On-Line Banking)</bridgehead>
|
---|
93 | <para role="optional"><ulink
|
---|
94 | url="http://libofx.sourceforge.net/">LibOFX</ulink>
|
---|
95 | (requires <xref linkend="opensp"/> and <xref linkend="curl"/>),
|
---|
96 | <ulink url="http://sourceforge.net/projects/ktoblzcheck">KtoBlzCheck</ulink>,
|
---|
97 | and <ulink url="http://www.aquamaniac.de/aqbanking/">AqBanking</ulink>
|
---|
98 | (requires <ulink
|
---|
99 | url="http://gwenhywfar.sourceforge.net/">Gwenhywfar</ulink>
|
---|
100 | and <ulink url="http://www.libchipcard.de/">libchipcard3</ulink>)</para>
|
---|
101 |
|
---|
102 | <para condition="html" role="usernotes">User Notes:
|
---|
103 | <ulink url="&blfs-wiki;/gnucash"/></para>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="installation">
|
---|
108 | <title>Installation of GnuCash</title>
|
---|
109 |
|
---|
110 | <para>Install <application>GnuCash</application> by running the following
|
---|
111 | commands:</para>
|
---|
112 |
|
---|
113 | <screen><userinput>sed -i 's|xml::${sysconfdir}|xml::&gnome-etc-dir;|' configure &&
|
---|
114 |
|
---|
115 | ./configure \
|
---|
116 | --prefix=/usr \
|
---|
117 | --sysconfdir=/etc \
|
---|
118 | --libexecdir=/usr/lib \
|
---|
119 | --with-gconf-schema-file-dir=&gnome-etc-dir;/gconf/schemas &&
|
---|
120 | make</userinput></screen>
|
---|
121 |
|
---|
122 | <para>If you wish to create the API documentation in HTML format, you must
|
---|
123 | have <xref linkend="doxygen"/> and <xref linkend="graphviz"/> installed,
|
---|
124 | then issue: <command>make doc</command>. If you wish to create the API
|
---|
125 | Design Guide in several formats, you must have <xref linkend="tetex"/>
|
---|
126 | installed and issue:
|
---|
127 | <command>make -C src/doc/design html pdf ps</command>.</para>
|
---|
128 |
|
---|
129 | <para>To test the results, issue <command>make check</command>. All tests
|
---|
130 | should pass. An easy way to look at the results of the tests is to issue
|
---|
131 | <command>grep -A1 ============== check.log</command> (this is assuming you
|
---|
132 | redirected the output from the tests to the indicated filename).</para>
|
---|
133 |
|
---|
134 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
135 |
|
---|
136 | <screen role='root'><userinput>make install &&
|
---|
137 |
|
---|
138 | mv -v /usr/share/gnucash/doc /usr/share/doc/gnucash-&gnucash-version; &&
|
---|
139 | ln -v -s ../doc/gnucash-&gnucash-version; /usr/share/gnucash/doc &&
|
---|
140 |
|
---|
141 | for FILENAME in doc/{misc*,gnome*,generic*,build*}.txt \
|
---|
142 | doc/{gtkrc*,TRANSLATION_HOWTO,README.translator.txt} \
|
---|
143 | doc/README.{build-system,OFX,HBCI}
|
---|
144 | do
|
---|
145 | install -v -m644 ${FILENAME} /usr/share/doc/gnucash-&gnucash-version;
|
---|
146 | done &&
|
---|
147 |
|
---|
148 | install -v -m755 -d /usr/share/doc/gnucash-&gnucash-version;/api/engine &&
|
---|
149 | install -v -m644 src/doc/{TODO*,*.txt,*.html} \
|
---|
150 | /usr/share/doc/gnucash-&gnucash-version;/api &&
|
---|
151 | install -v -m644 src/engine/*.txt \
|
---|
152 | /usr/share/doc/gnucash-&gnucash-version;/api/engine</userinput></screen>
|
---|
153 |
|
---|
154 | <para>If you built the API HTML or Design Guide documentation, issue the
|
---|
155 | following commands (modified as necessary, depending on what docs are
|
---|
156 | being installed) as the <systemitem class="username">root</systemitem>
|
---|
157 | user:</para>
|
---|
158 |
|
---|
159 | <screen role='root'><userinput>install -v -m755 -d /usr/share/doc/gnucash-&gnucash-version;/{design,api}/html &&
|
---|
160 | install -v -m644 src/doc/design/gnucash-design.html/* \
|
---|
161 | /usr/share/doc/gnucash-&gnucash-version;/design/html &&
|
---|
162 | install -v -m644 src/doc/design/gnucash-design.{pdf,ps,dvi} \
|
---|
163 | /usr/share/doc/gnucash-&gnucash-version;/design &&
|
---|
164 | install -v -m644 src/doc/html/* \
|
---|
165 | /usr/share/doc/gnucash-&gnucash-version;/api/html</userinput></screen>
|
---|
166 |
|
---|
167 | <para>If you want to install the Help documentation system, you must have
|
---|
168 | <xref linkend="scrollkeeper"/> installed. Then unpack the additional
|
---|
169 | tarball, change into the
|
---|
170 | <filename class='directory'>gnucash-docs-&gnucash-docs-version;</filename>
|
---|
171 | source directory and issue the following commands as an unprivileged
|
---|
172 | user:</para>
|
---|
173 |
|
---|
174 | <screen><userinput>./configure --prefix=/usr \
|
---|
175 | --localstatedir=/var/lib &&
|
---|
176 | make</userinput></screen>
|
---|
177 |
|
---|
178 | <para>HTML versions of the Help Manual and Users Guide can be created if
|
---|
179 | the DocBook XML tools are installed (<xref linkend="libxslt"/>,
|
---|
180 | <xref linkend="DocBook"/> and <xref linkend="docbook-xsl"/>). A PDF version
|
---|
181 | of the Users Guide can be created if you have <xref linkend="docbook-utils"/>
|
---|
182 | and <xref linkend="jadetex"/> installed. Issue the following commands to
|
---|
183 | create the documentation (modify as appropriate for your desires):</para>
|
---|
184 |
|
---|
185 | <screen><userinput>make -C help html &&
|
---|
186 | make -C guide html &&
|
---|
187 | make -C guide pdf</userinput></screen>
|
---|
188 |
|
---|
189 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
190 |
|
---|
191 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
192 |
|
---|
193 | <para>If you built the Help Manual or Users Guide, install them using the
|
---|
194 | following commands as the <systemitem class="username">root</systemitem>
|
---|
195 | user (modify as necessary):</para>
|
---|
196 |
|
---|
197 | <screen role='root'><userinput>install -v -m755 -d /usr/share/doc/gnucash-&gnucash-version;/{users_guide,help} &&
|
---|
198 | cp -v -R help/C/gnucash-help/* \
|
---|
199 | /usr/share/doc/gnucash-&gnucash-version;/help &&
|
---|
200 | cp -v -R guide/C/gnucash-guide/* \
|
---|
201 | /usr/share/doc/gnucash-&gnucash-version;/users_guide &&
|
---|
202 | install -v -m644 guide/C/gnucash-guide.pdf \
|
---|
203 | /usr/share/doc/gnucash-&gnucash-version;</userinput></screen>
|
---|
204 |
|
---|
205 | <para>Note that you must have <xref linkend="yelp"/> installed in order to
|
---|
206 | view the Help documents using the default
|
---|
207 | <application>GnuCash</application> method.</para>
|
---|
208 |
|
---|
209 | </sect2>
|
---|
210 |
|
---|
211 | <sect2 role="commands">
|
---|
212 | <title>Command Explanations</title>
|
---|
213 |
|
---|
214 | <para><command>sed -i 's|xml::${sysconfdir}|xml::&gnome-etc-dir;|'
|
---|
215 | configure</command>: This command is used because the location of the
|
---|
216 | <application>GConf</application> source database is hard-coded into
|
---|
217 | the <command>configure</command> script as
|
---|
218 | <filename class='directory'><envar>$sysconfdir</envar>/gconf</filename>
|
---|
219 | (rendering the <option>--with-gconf-source</option> parameter useless).
|
---|
220 | The modification ensures that the <application>GConf</application> database
|
---|
221 | is properly updated while still allowing the package configuration files
|
---|
222 | to be installed in
|
---|
223 | <filename class='directory'>/etc/gnucash</filename>.</para>
|
---|
224 |
|
---|
225 | <para><parameter>--sysconfdir=/etc</parameter>: This installs configuration
|
---|
226 | files in <filename class='directory'>/etc/gnucash</filename> instead of
|
---|
227 | <filename class='directory'>/usr/etc/gnucash</filename>.</para>
|
---|
228 |
|
---|
229 | <para><parameter>--with-gconf-schema-file-dir=&gnome-etc-dir;/gconf/schemas</parameter>:
|
---|
230 | This parameter ensures that the <application>GConf</application> schema
|
---|
231 | files are installed in the proper location instead of
|
---|
232 | <filename class='directory'>/etc/gconf</filename>.</para>
|
---|
233 |
|
---|
234 | <para><command>mv -v /usr/share/gnucash/doc
|
---|
235 | /usr/share/doc/gnucash-&gnucash-version;</command> and
|
---|
236 | <command>ln -v -s ../doc/gnucash-&gnucash-version;
|
---|
237 | /usr/share/gnucash/doc</command>: These commands are used to relocate the
|
---|
238 | documentation files to the customary location and create a symbolic link
|
---|
239 | to the original location.</para>
|
---|
240 |
|
---|
241 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
242 | href="../../xincludes/scrollkeeper-dir.xml"/>
|
---|
243 |
|
---|
244 | <para><option>--enable-sql</option>: This parameter is required if you want
|
---|
245 | to build in SQL support using <application>PostgreSQL</application>.</para>
|
---|
246 |
|
---|
247 | <para><option>--enable-hbci</option>: This parameter is required if you
|
---|
248 | want to build in on-line banking support using
|
---|
249 | <application>AqBanking</application>. See
|
---|
250 | <filename>doc/README.HBCI</filename> in the
|
---|
251 | <application>GnuCash</application> source tree for complete
|
---|
252 | information.</para>
|
---|
253 |
|
---|
254 | </sect2>
|
---|
255 |
|
---|
256 | <sect2 role="configuration">
|
---|
257 | <title>Configuring GnuCash</title>
|
---|
258 |
|
---|
259 | <sect3>
|
---|
260 | <title>Configuration Information</title>
|
---|
261 |
|
---|
262 | <para>If you wish to use <application>GnuCash</application> to retrieve
|
---|
263 | stock price quotes, you'll need to
|
---|
264 | install the following <application>Perl</application> modules:
|
---|
265 | <xref linkend="perl-lwp"/>,
|
---|
266 | <xref linkend="perl-date-manip"/>,
|
---|
267 | <xref linkend="perl-html-parser"/>,
|
---|
268 | <xref linkend="perl-html-tableextract"/>,
|
---|
269 | <xref linkend="perl-crypt-ssleay"/>, and
|
---|
270 | <xref linkend="perl-finance-quote"/>. Alternatively, you can run the
|
---|
271 | <command>/usr/bin/gnc-fq-update</command> script as the
|
---|
272 | <systemitem class="username">root</systemitem> user.</para>
|
---|
273 |
|
---|
274 | </sect3>
|
---|
275 |
|
---|
276 | </sect2>
|
---|
277 |
|
---|
278 | <sect2 role="content">
|
---|
279 | <title>Contents</title>
|
---|
280 |
|
---|
281 | <segmentedlist>
|
---|
282 | <segtitle>Installed Programs</segtitle>
|
---|
283 | <segtitle>Installed Libraries</segtitle>
|
---|
284 | <segtitle>Installed Directories</segtitle>
|
---|
285 |
|
---|
286 | <seglistitem>
|
---|
287 | <seg>gnc-fq-check, gnc-fq-dump, gnc-fq-helper, gnc-fq-update,
|
---|
288 | gnc-test-env, gnucash, gnucash-bin, gnucash-env, gnucash-make-guids,
|
---|
289 | gnucash-valgrind, and update-gnucash-gconf</seg>
|
---|
290 | <seg>libgnc-backend-file-utils.so, libgnc-backend-postgres.so,
|
---|
291 | libgnc-business-ledger.so,libgnc-core-utils.so, libgnc-gnome.so,
|
---|
292 | libgnc-module.so, libgnc-qof.so and numerous support libraries
|
---|
293 | installed in
|
---|
294 | <filename class='directory'>/usr/lib/gnucash</filename></seg>
|
---|
295 | <seg>/etc/gnucash,
|
---|
296 | /usr/include/gnucash,
|
---|
297 | /usr/lib/gnucash,
|
---|
298 | and the following subdirectories of /usr/share/:
|
---|
299 | doc/gnucash-&gnucash-version;,
|
---|
300 | gnome/help/gnucash,
|
---|
301 | gnucash,
|
---|
302 | omf/gnucash-docs, and
|
---|
303 | /xml/gnucash</seg>
|
---|
304 | </seglistitem>
|
---|
305 | </segmentedlist>
|
---|
306 |
|
---|
307 | <variablelist>
|
---|
308 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
309 | <?dbfo list-presentation="list"?>
|
---|
310 | <?dbhtml list-presentation="table"?>
|
---|
311 |
|
---|
312 | <varlistentry id="gnucash-prog">
|
---|
313 | <term><command>gnucash</command></term>
|
---|
314 | <listitem>
|
---|
315 | <para>is a personal finance manager.</para>
|
---|
316 | <indexterm zone="gnucash gnucash-prog">
|
---|
317 | <primary sortas="b-gnucash">gnucash</primary>
|
---|
318 | </indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | </variablelist>
|
---|
323 |
|
---|
324 | </sect2>
|
---|
325 |
|
---|
326 | </sect1>
|
---|