summaryrefslogtreecommitdiffstats
path: root/doc/kstars/install.docbook
blob: a45cfa769de311ba26b62c0a71e43ffb37e1177e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kstars">
<title>How to obtain &kstars;</title>
<para>
&kstars; is distributed with &kde; as part of the kdeedu "Edutainment"
module.
</para>
<para>
We also occasionally make an independent release.  These independent
releases will be available as a gzipped tar archive from the following
website:
<ulink
 url="http://prdownloads.sourceforge.net/kstars/">http://prdownloads.sourceforge.net/kstars/</ulink>.
</para>
<para>
Independent releases are announced through the
<email>kstars-announce@lists.sourceforge.net</email> mailing list.
Releases are also posted to <ulink url="http://edu.kde.org/kstars">the
&kstars; home page</ulink>,
<ulink url="http://www.kde-apps.org/content/show.php?content=9862">kde-apps.org</ulink>, and 
<ulink url="http://freshmeat.net/projects/kstars">freshmeat.net</ulink>.
</para>
<para>
&kstars; is been packaged by many Linux/BSD distributions, including Redhat, Suse,
and Mandrake.  Some distributions package &kstars; as a separate application, some
just provide a kdeedu package, which includes &kstars;.
</para><para>
If you would like the latest CVS development version of &kstars;, please
follow <ulink url="http://edu.kde.org/kstars/cvs.html">these instructions</ulink>.
</para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>
<para>
In order to successfully run &kstars;, you need &kde; >=3.2 and
&Qt;>=3.2.
</para>
<para>
To compile &kstars;, you will also have to have the following packages
installed:
<itemizedlist>
<listitem><para>kdelibs-devel</para></listitem>
<listitem><para>qt-devel</para></listitem>
<listitem><para>zlib-devel</para></listitem>
<listitem><para>fam-devel</para></listitem>
<listitem><para>png-devel</para></listitem>
<listitem><para>jpeg-devel</para></listitem>
<listitem><para>autoconf (>=2.5)</para></listitem>
</itemizedlist></para>

<para>
On my system, &kstars; uses about 60 MB of system memory with the
default settings.  Most of this usage is due to the loaded object
databases.  You can dramatically reduce the memory footprint by
reducing the faint limit for stars in the Configuration Window, or
eliminating catalogs of objects (NGC, IC, comets, asteroids, &etc;).
If &kstars; is idling, it uses very little <acronym>CPU</acronym>;
but it will use as much as you have got when panning or zooming.
</para>
</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

<para>
In order to compile and install &kstars; on your system, type the
following in the base folder of the unpacked &kstars; distribution:
<screen width="40">
<prompt>%</prompt> <userinput>./configure --prefix=$KDEDIR</userinput>
<prompt>%</prompt> <userinput>make</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>
</para><para>
Please do not forget the prefix argument to configure.  If your <envar>KDEDIR</envar>
variable is not set, set prefix to whatever folder &kde; is installed in: this is
usually either <filename class="directory">/usr</filename>,
<filename class="directory">/opt/kde</filename>, or
<filename class="directory">/opt/kde3</filename>.
Also, make sure you do the
last step as <systemitem class="username">root</systemitem>.
</para><para>
&kstars; uses <command>autoconf</command> and <command>automake</command>,
so you should not have trouble compiling it. Should you run into problems
please report them to the &kstars; mailing list
<email>kstars-devel@kde.org</email>.
</para>
</sect1>

<sect1 id="configuration">
<title>Configuration</title>
<para>
At this point, there are no special configuration options or
requirements.  If &kstars; complains that there are missing data files,
become <systemitem class="username">root</systemitem> and manually copy
all files in <filename class="directory">kstars/data/</filename> to
<filename class="directory">$(KDEDIR)/apps/kstars/</filename> (If you
do not have <systemitem class="username">root</systemitem> privileges,
copy them to
<filename class="directory">~/.kde/share/apps/kstars/.</filename>)
</para>
</sect1>
</appendix>