scrollkeeper-update(8)

1SCROLLKEEPER-UPDATE(8)      System Manager's Manual     SCROLLKEEPER-UPDATE(8)
2
3
4

NAME

6       scrollkeeper-update  - identify new, modified, or removed OMF files and
7       update the scrollkeeper databases
8

SYNOPSIS

10       scrollkeeper-update [ -v ] [ -q ] [ -n ] [ -p database-directory ] [ -o
11       omf-directories ]
12

DESCRIPTION

14       This synchronizes the scrollkeeper database with the OMF directory.  It
15       searches the scrollkeeper OMF directory to identify if any  files  were
16       added,  removed, or modified and updates its internal database files to
17       reflect any changes.
18
19       This utility is generally executed as the last  step  of  installation,
20       after the OMF file is copied into place.  It is also typically the last
21       step of uninstallation, after the OMF file is removed.  Using this,  an
22       administrator  can easily manually install and uninstall documents into
23       the database.  It can also be run to guarantee the  database  is  fully
24       up-to-date.
25
26       Note  that because scrollkeeper-update is normally run during installa‐
27       tion and its output is typically seen by users,  non-critical  warnings
28       and  errors such as those caused by invalid metadata are written to the
29       log file instead of to the terminal. Developers should use the log file
30       to identify any problems.
31
32

OPTIONS

34       -v     Be  verbose:  Say  which  scrollkeeper-install and scrollkeeper-
35              uninstall commands are being run to bring  the  database  up  to
36              date.
37
38       -q     Run  in quiet mode, suppressing output of all but the most seri‐
39              ous warning and error messages to STDOUT.  Note that most output
40              to the log file will be unchanged.
41
42       -n     Use  the  network to retrieve the DTD if it is not available via
43              the system's XML catalog.
44
45       -p database-directory
46              Use database-directory as the  directory  for  the  scrollkeeper
47              database  rather  than the usual one obtained by running scroll‐
48              keeper-config --pkglocalstatedir.
49
50       -o omf-directories
51              Examine the directories named in omf-directories rather than the
52              one  usual  one obtained by running scrollkeeper-config --omfdir
53              (or specified in the OMF_DIR environment variable if set).   The
54              omf-directories should be a colon-separated list of directories.
55
56

ENVIRONMENT

58       OMF_DIR
59              If no -o option is specified, this variable overrides the scrol‐
60              lkeeper-config-provided OMF directory.  It should  be  a  colon-
61              separated list of directories.
62
63

FILES

65       /var/lib/scrollkeeper/scrollkeeper_docs
66       /var/lib/scrollkeeper/TOC/<docnumber>
67       /var/lib/scrollkeeper/<locale>/scrollkeeper_cl.xml
68       /var/lib/scrollkeeper/<locale>/scrollkeeper_extended_cl.xml
69       /var/log/scrollkeeper.log
70

AUTHOR

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