Beyond Linux® From Scratch - Version svn-20070421

Chapter 10. General Utilities

ScrollKeeper-0.3.14

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

Required

libxslt-1.1.20, DocBook XML DTD-4.5, and XML::Parser-2.34

Optional

intltool-0.35.5

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/scrollkeeper

Installation of ScrollKeeper

Install ScrollKeeper by running the following commands: 

./configure --prefix=/usr \
            --sysconfdir=/etc \
            --localstatedir=/var \
            --disable-static \
            --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde-3.5.6/share/omf:\
/opt/gnome-2.14.3/share/omf &&

make

This package does not come with a test suite.

Now, as the root user: 

make install

Command Explanations

--sysconfdir=/etc: This switch puts the configuration files in /etc instead of /usr/etc.

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

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

--with-omfdirs=...: This switch defines the locations of OMF files for ScrollKeeper. Change the locations if you have KDE and/or GNOME-2 installed in a prefix other than the ones shown. This information is stored in /etc/scrollkeeper.conf and can be updated manually, if necessary.

Configuring ScrollKeeper

Config Files

/etc/scrollkeeper.conf

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 further action is needed until another OMF directory is created.

Contents

Installed Programs: 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
Installed Library: libscrollkeeper.so
Installed Directories: /usr/share/doc/scrollkeeper-0.3.14, /usr/share/{omf, {,xml/}scrollkeeper}, and /var/lib/scrollkeeper

Short Descriptions

ScrollKeeper utility programs

The ScrollKeeper utility programs and scripts listed above are for performing installation, building, getting and updating table of contents files.

libscrollkeeper.so

provides the API necessary for help browsers to interact with documentation written to utilize ScrollKeeper.

Last updated on 2007-04-04 21:42:53 +0200