View Source: scrollkeeper-update(8) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

SCROLLKEEPER-UPDATE
!!!SCROLLKEEPER-UPDATE
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
AUTHOR
SEE ALSO
----
!!NAME


scrollkeeper-update - identify new, modified, or removed OMF files and update the scrollkeeper databases
!!SYNOPSIS


__scrollkeeper-update__ [[ __-v__ ] [[ __-q__ ] [[
__-p__ ''database-directory'' ] [[ __-o__
''omf-directories'' ]
!!DESCRIPTION


This synchronizes the scrollkeeper database with the OMF
directory. It searches the scrollkeeper OMF directory to
identify if any files were added, removed, or modified and
updates its internal database files to reflect any
changes.


This utility is generally executed as the last step of
installation, after the OMF file is copied into place. It is
also typically the last step of uninstallation, after the
OMF file is removed. Using this, an administrator can easily
manually install and uninstall documents into the database.
It can also be run to guarantee the database is fully
up-to-date.


Note that because __scrollkeeper-update__ is normally run
during installation and its output is typically seen by
users, non-critical warnings and errors such as those caused
by invalid metadata are written to the log file instead of
to the terminal. Developers should use the log file to
identify any problems.
!!OPTIONS


__-v__


Be verbose: Say which __scrollkeeper-install__ and
__scrollkeeper-uninstall__ commands are being run to
bring the database up to date.


__-q__


Run in quiet mode, suppressing output of all but the most
serious warning and error messages to STDOUT. Note that most
output to the log file will be unchanged.


__-p__ ''database-directory''


Use ''database-directory'' as the directory for the
scrollkeeper database rather than the usual one obtained by
running __omf-config --pkglocalstatedir__.


__-o__ ''omf-directories''


Examine the directories named in ''omf-directories''
rather than the one usual one obtained by running
__scrollkeeper-config --omfdir__ (or specified in the
__OMF_DIR__ environment variable if set). The
''omf-directories'' should be a colon-separated list of
directories.
!!ENVIRONMENT


OMF_DIR


If no __-o__ option is specified, this variable overrides
the __scrollkeeper-config__-provided OMF directory. It
should be a colon-separated list of
directories.
!!FILES


__/var/lib/scrollkeeper/scrollkeeper_docs
/var/lib/scrollkeeper/TOC/
/var/lib/scrollkeeper/
/var/lib/scrollkeeper/
/var/log/scrollkeeper.log__
!!AUTHOR


Laszlo Kovacs
Dan Mueth
!!SEE ALSO


scrollkeeper-config(1), scrollkeeper-gen-seriesid(1),
scrollkeeper.conf(5), scrollkeeper(7),
scrollkeeper-preinstall(8),
scrollkeeper-rebuilddb(8)
----

7 pages link to scrollkeeper-update(8):

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

Last edited on Monday, June 3, 2002 6:56:50 pm by "perry"

Edit PageHistory Diff Info LikePages