Introduction to ScrollKeeper

The ScrollKeeper 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.

Package information

ScrollKeeper dependencies

Installation of ScrollKeeper

Install ScrollKeeper by running the following commands:

./configure --prefix=/usr --sysconfdir=/etc \
    --localstatedir=/var --disable-static \
/opt/kde-3.2.2/share/omf:/opt/gnome-2.6/share/omf &&
make &&
make install

Command explanations

--sysconfdir=/etc: This switch puts the configuration files in /etc/scrollkeeper.

--localstatedir=/var: This switch puts ScrollKeeper's database directory in /var/lib/scrollkeeper.

--disable-static: This switch prevents the static library from being built.

--omfdirs=/usr/share/omf:/opt/kde-3.2.2/share/omf:/opt/gnome-2.6/share/omf: This switch sets all the locations for OMF files for scrollkeeper.

Configuring ScrollKeeper

Config files


Configuration Information

The configuration file sets the OMF_DIR variable to the location of all of the omf directories in the system. This was set in the configure command so no futher action is needed until another OMF file is created.


The ScrollKeeper package contains libscrollkeeper libraries and utility scripts.


scrollkeeper libraries

libscrollkeeper libraries provide the API necessary for help browsers to interact with documentation written to utilize ScrollKeeper.

utility scripts

Utility scripts for performing installation, building, getting and updating table of contents files.