source: general/genutils/scrollkeeper.xml@ 7ea6667

<?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 "&gnome-download-http;/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
  <!ENTITY scrollkeeper-download-ftp  "&gnome-download-ftp;/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;">
  <?dbhtml filename="scrollkeeper.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">scrollkeeper-&scrollkeeper-version;.tar</keyword>
      <keyword role="ftpdir">scrollkeeper</keyword>
    </keywordset>
  </sect1info>

  <title>ScrollKeeper-&scrollkeeper-version;</title>

  <indexterm zone="scrollkeeper">
    <primary sortas="a-ScrollKeeper">ScrollKeeper</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ScrollKeeper</title>

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

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

    <bridgehead renderas="sect3">ScrollKeeper Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libxslt"/>,
    <xref linkend="DocBook"/>, and
    <xref linkend="perl-xml-parser"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="intltool"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/scrollkeeper"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of ScrollKeeper</title>

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

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

make</userinput></screen>

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

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <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><parameter>--disable-static</parameter>: 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>. Change the locations if you have
    <application>KDE</application> and/or <application>GNOME</application>-2
    installed in a prefix other than the ones shown. This information is stored
    in <filename>/etc/scrollkeeper.conf</filename> and can be updated manually,
    if necessary.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring ScrollKeeper</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 further action is needed until
      another <filename>OMF</filename> directory is created.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <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, {,xml/}scrollkeeper}, and
        /var/lib/scrollkeeper</seg>
      </seglistitem>
    </segmentedlist>

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

      <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 API 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>