source: gnome/core/scrollkeeper.xml@ fdca4266

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY scrollkeeper-download-http "http://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
<!ENTITY scrollkeeper-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
<!ENTITY scrollkeeper-size "534 KB">
<!ENTITY scrollkeeper-buildsize "9.2 MB">
<!ENTITY scrollkeeper-time "0.20 SBU">

]>

<sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
<?dbhtml filename="scrollkeeper.html"?>
<title>ScrollKeeper-&scrollkeeper-version;</title>

<sect2>

<title>Introduction to <application>ScrollKeeper</application></title>

<para>The <application>ScrollKeeper</application> package contains a cataloging system for
documentation. This is useful for managing documentation metadata and
providing an <acronym>API</acronym> to help browsers find, sort and search the document
catalog.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&scrollkeeper-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&scrollkeeper-download-ftp;"/></para></listitem>
<listitem><para>Download size: &scrollkeeper-size;</para></listitem>
<listitem><para>Estimated Disk space required:
&scrollkeeper-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&scrollkeeper-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>ScrollKeeper</application> dependencies</title>
<sect4><title>Required</title>
<para>
<xref linkend="intltool"/>,
<xref linkend="libxslt"/>,
<xref linkend="DocBook"/> and
<xref linkend="perl-modules"/>: XML-Parser-&XML-Parser-version;
</para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>ScrollKeeper</application></title>

<para>Install <application>ScrollKeeper</application> by running the following commands:</para>

<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
    --localstatedir=/var --disable-static \
    --with-omfdirs=/usr/share/omf:/opt/gnome/share/omf:\
/opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
configuration files in <filename class="directory">/etc/scrollkeeper</filename>.</para>

<para><parameter>--localstatedir=/var</parameter>: This switch puts
<application>ScrollKeeper</application>'s database directory in
<filename class="directory">/var/lib/scrollkeeper</filename>.</para>

<para><option>--disable-static</option>: This switch prevents
the static library from being built.</para>

<para><parameter>--omfdirs=/usr/share/omf:/opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf</parameter>:
This switch sets all the locations for <filename>OMF</filename> files for scrollkeeper.</para>
</sect2>

<sect2>
<title>Configuring <application>ScrollKeeper</application></title>

<sect3><title>Config files</title>
<para><filename>/etc/scrollkeeper.conf</filename></para>
</sect3>

<sect3><title>Configuration Information</title>

<para>The configuration file sets the <envar>OMF_DIR</envar> variable to the location
of all of the <filename class="directory">omf</filename> directories in the system. This was set in the
<command>configure</command> command so no futher action is needed until another
<filename>OMF</filename> file is created.</para>

</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>ScrollKeeper</application> package contains
<filename class="libraryfile">libscrollkeeper</filename> libraries and utility scripts.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>scrollkeeper libraries</title>
<para><filename class="libraryfile">libscrollkeeper</filename> libraries provide the
<acronym>API</acronym> necessary for help browsers to
interact with documentation written to utilize
<application>ScrollKeeper</application>.</para></sect3>

<sect3><title>utility scripts</title>
<para>Utility scripts for performing installation, building, getting
and updating table of contents files.</para></sect3>

</sect2>

</sect1>