View Source: scrollkeeper.conf(5) - Waikato Linux Users Group

You are viewing an old revision of this page. View the current version.

SCROLLKEEPER.CONF
!!!SCROLLKEEPER.CONF
NAME
SYNOPSIS
DESCRIPTION
EXAMPLE
NOTES
AUTHOR
SEE ALSO
----
!!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 independent 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 database
up-to-date.
!!AUTHOR


Laszlo Kovacs
Dan Mueth
!!SEE ALSO


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

7 pages link to scrollkeeper.conf(5):

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Version 1, saved on Monday, June 3, 2002 6:56:01 pm by "perry"

Edit PageHistory Diff Info LikePages