source: archive/gnucash.xml

trunk
Last change on this file was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 4 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 10.6 KB
Line 
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
8 "&sourceforge-repo;/gnucash/gnucash-&gnucash-version;.tar.bz2">
9 <!ENTITY gnucash-download-ftp
10 " ">
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">
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">
22]>
23
24<sect1 id="gnucash" xreflabel="GnuCash-&gnucash-version;">
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
41 manager.</para>
42
43 &lfs72_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&gnucash-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&gnucash-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &gnucash-src-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &gnucash-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &gnucash-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &gnucash-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
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>
87 <listitem>
88 <para>
89 Optional Help documentation: <ulink url="&gnucash-docs-download;"/>
90 </para>
91 </listitem>
92 <listitem>
93 <para>
94 Download MD5 sum: &gnucash-docs-md5sum;
95 </para>
96 </listitem>
97 <listitem>
98 <para>
99 Download size: &gnucash-docs-size;
100 </para>
101 </listitem>
102 <listitem>
103 <para>
104 Estimated disk space required: &gnucash-docs-buildsize;
105 </para>
106 </listitem>
107 <listitem>
108 <para>
109 Estimated build time: &gnucash-docs-time;
110 </para>
111 </listitem>
112 </itemizedlist>
113
114 <bridgehead renderas="sect3">GnuCash Dependencies</bridgehead>
115
116 <bridgehead renderas="sect4">Required</bridgehead>
117 <para role="required">
118 <xref linkend="guile"/>,
119 <xref linkend="libgnomeui"/>,
120 <xref linkend="gnome-vfs"/>,
121 <xref linkend="slib"/>,
122 <xref linkend="goffice"/> and
123 <xref linkend="webkitgtk"/>
124 </para>
125
126 <bridgehead renderas="sect4">Optional</bridgehead>
127 <para role="optional">
128 <ulink url="http://libdbi.sourceforge.net/">libdbi</ulink> (and
129 <ulink url="http://libdbi-drivers.sourceforge.net/">libdbi drivers</ulink>) and
130 <ulink url="ftp://ftp.gnu.org/pub/gnu/guile/">Guile-www</ulink>
131 </para>
132
133 <bridgehead renderas="sect4">Optional (Required for the Help System)</bridgehead>
134 <para role="optional">
135 <xref linkend="rarian"/> and
136 <xref linkend="yelp"/> (run-time requirement to view the Help documents).
137 </para>
138
139 <bridgehead renderas="sect4">Optional (for On-Line Banking)</bridgehead>
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>
152
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
161<screen><userinput>patch -Np1 -i ../gnucash-&gnucash-version;-guile-2_fixes-1.patch &amp;&amp;
162
163./configure --prefix=/usr \
164 --sysconfdir=/etc/gnome \
165 --disable-dbi \
166 --with-html-engine=webkit &amp;&amp;
167make</userinput></screen>
168
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>
172
173<screen><userinput>make doc</userinput></screen>
174
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>
177
178<screen><userinput>make -C src/doc/design html pdf ps</userinput></screen>
179
180 <para>
181 The test suite is currently broken due to problems with
182 <application>Guile 2</application>.
183 <!-- To test the results, issue: <command>make check</command>.-->
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
201<screen><userinput>./configure --prefix=/usr &amp;&amp;
202make</userinput></screen>
203
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"/>,
209 and <xref linkend="fop"/> installed.
210 Issue the following commands to create the documentation:
211 </para>
212
213<screen><userinput>make -C guide html &amp;&amp;
214make -C guide pdf</userinput></screen>
215
216 <para>
217 Now, as the <systemitem class="username">root</systemitem> user:
218 </para>
219
220<screen role="root"><userinput>make install</userinput></screen>
221
222 <para>
223 If you built the Users Guide, install it as the
224 <systemitem class="username">root</systemitem> user:
225 </para>
226
227<screen role="root"><userinput>mkdir -p /usr/share/doc/gnucash-&gnucash-docs-version; &amp;&amp;
228cp -v -R guide/C/gnucash-guide/* /usr/share/doc/gnucash-&gnucash-docs-version; &amp;&amp;
229cp -v guide/C/gnucash-guide.pdf /usr/share/doc/gnucash-&gnucash-docs-version;</userinput></screen>
230 </sect2>
231
232 <sect2 role="commands">
233 <title>Command Explanations</title>
234
235 <para><parameter>--sysconfdir=/etc/gnome</parameter>: This installs
236 configuration files in
237 <filename class="directory">/etc/gnome/gnucash</filename> instead of
238 <filename class="directory">/usr/etc/gnucash</filename>.</para>
239
240 <para>
241 <parameter>--with-html-engine=webkit</parameter>: Use
242 <xref linkend="webkitgtk"/> (configured <option>--with-gtk=2.0</option>)
243 instead of gtkhtml : the default is Gtkhtml-3 which does not build on
244 current <application>Glib2</application> without various changes.
245 </para>
246
247 <para>
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.
250 </para>
251 </sect2>
252
253 <sect2 role="configuration">
254 <title>Configuring GnuCash</title>
255
256 <sect3>
257 <title>Configuration Information</title>
258
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"/>,
266 <xref linkend="perl-crypt-ssleay"/> and
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>
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>
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>
295 /opt/gnome/gnucash,
296 /usr/include/gnucash,
297 /usr/lib/gnucash,
298 /usr/libexec/gnucash and
299 /usr/share/doc/gnucash-&gnucash-version;.
300 </seg>
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>
320</sect1>
Note: See TracBrowser for help on using the repository browser.