Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

scrollkeeper(7) [suse man page]

SCROLLKEEPER(7) 					 Miscellaneous Information Manual					   SCROLLKEEPER(7)

NAME

       ScrollKeeper - An open document cataloging and metadata management system.

DESCRIPTION

       ScrollKeeper  is a system for managing document metadata.  Its primary function is to act as a card catalog for documents, keeping track of
       what documents are available, where they can be found, and various attributes of the documents such as  their  language,  format,  subject,
       version, and position in a contents list.  It also manages other metadata such as document indices.

       ScrollKeeper  acts as a middle layer between applications and help browsers.  When applications install documentation, the documentation is
       registered with ScrollKeeper.  Any ScrollKeeper-aware help browser on the system can then access this information.  In  this  way,  Scroll-
       Keeper is a compatibility layer which allows any help browser to interface to all the documentation on a system, provided the package which
       ships the documentation registers it with ScrollKeeper.	It also removes much of the burden from application  packagers	and  help  browser
       developers by providing a standard set of tools and by doing much of the work inside of ScrollKeeper.

RESOURCES

       The  ScrollKeeper  web  pages can be found at http://scrollkeeper.sourceforge.net and the mailing list can be found at http://lists.source-
       forge.net/lists/listinfo/scrollkeeper-devel.

AVAILABILITY

       ScrollKeeper is licensed under the GNU Lesser Public License (LGPL).  A copy of this license can be read in the file COPYING  shipped  with
       ScrollKeeper.

       The latest version of ScrollKeeper can be found at http://sourceforge.net/projects/scrollkeeper.

FILES

       /etc/scrollkeeper.conf
       /var/log/scrollkeeper.log
       /var/lib/scrollkeeper/*

AUTHOR

       Laszlo Kovacs   <laszlo.kovacs@sun.com>
       Dan Mueth       <d-mueth@uchicago.edu>

SEE ALSO

       scrollkeeper-config(1),	scrollkeeper-gen-seriesid(1),  scrollkeeper.conf(5), scrollkeeper-preinstall(8), scrollkeeper-rebuilddb(8) scroll-
       keeper-update(8)

scrollkeeper							    Dec 5, 2001 						   SCROLLKEEPER(7)

Check Out this Related Man Page

SCROLLKEEPER.CONF(5)						File Formats Manual					      SCROLLKEEPER.CONF(5)

NAME

       scrollkeeper.conf - ScrollKeeper configuration file

SYNOPSIS

       System-wide configuration of ScrollKeeper

DESCRIPTION

       The  system-wide  scrollkeeper.conf  file  is  typically  installed  at	/etc/scrollkeeper.conf.  It stores the default OMF paths which are
       searched by scrollkeeper-update (8) to update the ScrollKeeper documentation catalog.  The paths are held by the OMF_DIR variable which	is
       assigned to a colon (:) delimited list of paths.

       Comment lines begin with the (#) character.

EXAMPLE

       A typical scrollkeeper.conf file will look like:

       # Comment
       OMF_DIR=/usr/share/omf:/usr/local/share/omf:/opt/gnome/share/omf:/opt/gnome-2.0/share/omf:/opt/kde/omf

NOTES

       Any user on the system is able to use the scrollkeeper-update (8) command to generate a ScrollKeeper database at any path that the user has
       write permission to.  The user can over-ride the system default OMF_DIR path variable by  setting  a  shell  variable  of  the  same  name,
       OMF_DIR.  In this way, a user can create a document catalog which contains a superset of the system documentation, or a completely indepen-
       dent set of documents which the user may be interested in.

       Note that most applications will register its documentation at install time, and unregister it at uninstall time.  Thus, a user	who  keeps
       their  own  personal ScrollKeeper database may need to periodically run scrollkeeper-update (8) manually (or with cron) to keep their data-
       base up-to-date.

AUTHOR

       Laszlo Kovacs   <laszlo.kovacs@sun.com>
       Dan Mueth       <d-mueth@uchicago.edu>

SEE ALSO

       scrollkeeper-config(1), scrollkeeper-gen-seriesid(1), scrollkeeper(7), scrollkeeper-preinstall(8), scrollkeeper-rebuilddb(8), scrollkeeper-
       update(8)

ScrollKeeper							    Dec 5, 2001 					      SCROLLKEEPER.CONF(5)
Man Page