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