ScrollKeeper

From CBLFS
Jump to: navigation, search
Download Source: http://ftp.gnome.org/pub/gnome/sources/scrollkeeper/0.3/scrollkeeper-0.3.14.tar.bz2

Contents

Introduction to ScrollKeeper

ScrollKeeper is a cataloging system for documentation on open systems. It manages documentation metadata (as specified by the Open Source Metadata Framework(OMF)) and provides a simple API to allow help browsers to find, sort, and search the document catalog. It will also be able to communicate with catalog servers on the Net to search for documents which are not on the local system.

Project Homepage: http://scrollkeeper.sourceforge.net/

Dependencies

Required

Optional

Non-Multilib

Compile the package:

./configure --prefix=/usr \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:${GNOME_PREFIX}/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

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.

Multilib

/usr/bin/scrollkeeper-config is not wrapped because it does not contain any arch specific information

32Bit

Compile the package:

CC="gcc ${BUILD32}" USE_ARCH=32 ./configure --prefix=/usr \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

N32

Compile the package:

CC="gcc ${BUILDN32}" USE_ARCH=n32 ./configure --prefix=/usr --libdir=/usr/lib32 \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

64Bit

Compile the package:

CC="gcc ${BUILD64}" USE_ARCH=64 ./configure --prefix=/usr --libdir=/usr/lib64 \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

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 Libraries: 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.
Personal tools