source: gnome/core/scrollkeeper.xml@ c64a089

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/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-md5sum "b175e582a6cec3e50a9de73a5bb7455a">
<!ENTITY scrollkeeper-size "546 KB">
<!ENTITY scrollkeeper-buildsize "12 MB">
<!ENTITY scrollkeeper-time "0.1 SBU">
]>

<sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="scrollkeeper.html"?>
<title>ScrollKeeper-&scrollkeeper-version;</title>
<indexterm zone="scrollkeeper">
<primary sortas="a-ScrollKeeper">ScrollKeeper</primary></indexterm>

<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 MD5 sum: &scrollkeeper-md5sum;</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"/> and 
<xref linkend="DocBook"/></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</command></userinput></screen>

<para>This package does not come with a test suite.</para>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>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</filename> instead of 
<filename class='directory'>/usr/etc</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>--with-omfdirs=...</parameter>: This switch defines the 
locations of <filename>OMF</filename> files for 
<application>ScrollKeeper</application>. This information is stored in 
<filename>/etc/scrollkeeper.conf</filename> and can be updated manually, 
if necessary.</para>
</sect2>

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

<sect3 id="scrollkeeper-config"><title>Config files</title>
<para><filename>/etc/scrollkeeper.conf</filename></para>
<indexterm zone="scrollkeeper scrollkeeper-config">
<primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
</indexterm>
</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> directory is 
created.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>

<seglistitem>
<seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid, 
scrollkeeper-get-cl, scrollkeeper-get-content-list, 
scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath, 
scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id, 
scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb, 
scrollkeeper-uninstall and scrollkeeper-update</seg>
<seg>libscrollkeeper.so</seg>
<seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;, 
/usr/share/omf/scrollkeeper, /usr/share/scrollkeeper, 
/usr/share/xml/scrollkeeper and /var/lib/scrollkeeper</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry>
<term><command>ScrollKeeper utility programs</command></term>
<listitem><para>The <application>ScrollKeeper</application> utility programs 
and scripts listed above are for performing installation, building, getting 
and updating table of contents files.</para>
</listitem>
</varlistentry>

<varlistentry id="libscrollkeeper">
<term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
<listitem><para>provides the <acronym>API</acronym> necessary for help 
browsers to interact with documentation written to utilize 
<application>ScrollKeeper</application>.</para>
<indexterm zone="scrollkeeper libscrollkeeper">
<primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>