%general-entities; ]> $LastChangedBy$ $Date$ ScrollKeeper-&scrollkeeper-version; ScrollKeeper 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. &lfs67_checked; Package Information Download (HTTP): Download (FTP): Download MD5 sum: &scrollkeeper-md5sum; Download size: &scrollkeeper-size; Estimated disk space required: &scrollkeeper-buildsize; Estimated build time: &scrollkeeper-time; ScrollKeeper Dependencies Required , , and Optional User Notes: 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/kde-&kde-version;/share/omf:\ /opt/gnome-&gnome-version;&gnome-minor-version;/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 /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 Installed Library Installed Directories 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 libscrollkeeper.so /usr/share/doc/scrollkeeper-&scrollkeeper-version;, /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. libscrollkeeper.so