doc/kstars/install.docbook

   1 <appendix id="installation">
   2 <title>Installation</title>
   3
   4 <sect1 id="getting-kstars">
   5 <title>How to obtain &kstars;</title>
   6 <para>
   7 &kstars; is distributed with &kde; as part of the kdeedu "Edutainment"
   8 module.
   9 </para>
  10 <para>
  11 We also occasionally make an independent release.  These independent
  12 releases will be available as a gzipped tar archive from the following
  13 website:
  14 <ulink
  15  url="http://prdownloads.sourceforge.net/kstars/">http://prdownloads.sourceforge.net/kstars/</ulink>.
  16 </para>
  17 <para>
  18 Independent releases are announced through the
  19 <email>kstars-announce@lists.sourceforge.net</email> mailing list.
  20 Releases are also posted to <ulink url="http://edu.kde.org/kstars">the
  21 &kstars; home page</ulink>,
  22 <ulink url="http://www.kde-apps.org/content/show.php?content=9862">kde-apps.org</ulink>, and
  23 <ulink url="http://freshmeat.net/projects/kstars">freshmeat.net</ulink>.
  24 </para>
  25 <para>
  26 &kstars; is been packaged by many Linux/BSD distributions, including Redhat, Suse,
  27 and Mandrake.  Some distributions package &kstars; as a separate application, some
  28 just provide a kdeedu package, which includes &kstars;.
  29 </para><para>
  30 If you would like the latest CVS development version of &kstars;, please
  31 follow <ulink url="http://edu.kde.org/kstars/cvs.html">these instructions</ulink>.
  32 </para>
  33 </sect1>
  34
  35 <sect1 id="requirements">
  36 <title>Requirements</title>
  37 <para>
  38 In order to successfully run &kstars;, you need &kde; >=3.2 and
  39 &Qt;>=3.2.
  40 </para>
  41 <para>
  42 To compile &kstars;, you will also have to have the following packages
  43 installed:
  44 <itemizedlist>
  45 <listitem><para>kdelibs-devel</para></listitem>
  46 <listitem><para>qt-devel</para></listitem>
  47 <listitem><para>zlib-devel</para></listitem>
  48 <listitem><para>fam-devel</para></listitem>
  49 <listitem><para>png-devel</para></listitem>
  50 <listitem><para>jpeg-devel</para></listitem>
  51 <listitem><para>autoconf (>=2.5)</para></listitem>
  52 </itemizedlist></para>
  53
  54 <para>
  55 On my system, &kstars; uses about 60 MB of system memory with the
  56 default settings.  Most of this usage is due to the loaded object
  57 databases.  You can dramatically reduce the memory footprint by
  58 reducing the faint limit for stars in the Configuration Window, or
  59 eliminating catalogs of objects (NGC, IC, comets, asteroids, &etc;).
  60 If &kstars; is idling, it uses very little <acronym>CPU</acronym>;
  61 but it will use as much as you have got when panning or zooming.
  62 </para>
  63 </sect1>
  64
  65 <sect1 id="compilation">
  66 <title>Compilation and Installation</title>
  67
  68 <para>
  69 In order to compile and install &kstars; on your system, type the
  70 following in the base folder of the unpacked &kstars; distribution:
  71 <screen width="40">
  72 <prompt>%</prompt> <userinput>./configure --prefix=$KDEDIR</userinput>
  73 <prompt>%</prompt> <userinput>make</userinput>
  74 <prompt>%</prompt> <userinput>make install</userinput>
  75 </screen>
  76 </para><para>
  77 Please do not forget the prefix argument to configure.  If your <envar>KDEDIR</envar>
  78 variable is not set, set prefix to whatever folder &kde; is installed in: this is
  79 usually either <filename class="directory">/usr</filename>,
  80 <filename class="directory">/opt/kde</filename>, or
  81 <filename class="directory">/opt/kde3</filename>.
  82 Also, make sure you do the
  83 last step as <systemitem class="username">root</systemitem>.
  84 </para><para>
  85 &kstars; uses <command>autoconf</command> and <command>automake</command>,
  86 so you should not have trouble compiling it. Should you run into problems
  87 please report them to the &kstars; mailing list
  88 <email>kstars-devel@kde.org</email>.
  89 </para>
  90 </sect1>
  91
  92 <sect1 id="configuration">
  93 <title>Configuration</title>
  94 <para>
  95 At this point, there are no special configuration options or
  96 requirements.  If &kstars; complains that there are missing data files,
  97 become <systemitem class="username">root</systemitem> and manually copy
  98 all files in <filename class="directory">kstars/data/</filename> to
  99 <filename class="directory">$(KDEDIR)/apps/kstars/</filename> (If you
 100 do not have <systemitem class="username">root</systemitem> privileges,
 101 copy them to
 102 <filename class="directory">~/.kde/share/apps/kstars/.</filename>)
 103 </para>
 104 </sect1>
 105 </appendix>