scrollkeeper-update(8) [suse man page]
SCROLLKEEPER-UPDATE(8) System Manager's Manual SCROLLKEEPER-UPDATE(8) NAME
scrollkeeper-update - identify new, modified, or removed OMF files and update the scrollkeeper databases SYNOPSIS
scrollkeeper-update [ -v ] [ -q ] [ -n ] [ -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 docu- ments 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. -n Use the network to retrieve the DTD if it is not available via the system's XML catalog. -p database-directory Use database-directory as the directory for the scrollkeeper database rather than the usual one obtained by running scrollkeeper- 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-sepa- rated list of directories. FILES
/var/lib/scrollkeeper/scrollkeeper_docs /var/lib/scrollkeeper/TOC/<docnumber> /var/lib/scrollkeeper/<locale>/scrollkeeper_cl.xml /var/lib/scrollkeeper/<locale>/scrollkeeper_extended_cl.xml /var/log/scrollkeeper.log 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(7), scrollkeeper-preinstall(8), scrollkeeper- rebuilddb(8) scrollkeeper Dec 5, 2001 SCROLLKEEPER-UPDATE(8)
Check Out this Related Man Page
scrollkeeper-devel(1) User Commands scrollkeeper-devel(1) NAME
scrollkeeper-devel, scrollkeeper-extract, scrollkeeper-gen-seriesid, scrollkeeper-preinstall - utilities for working with OMF documents and the scrollkeeper database SYNOPSIS
scrollkeeper-extract file stylesheet output [stylesheet output...] scrollkeeper-gen-seriesid scrollkeeper-preinstall docfile omf-file1 omf-file2 DESCRIPTION
scrollkeeper-extract is used internally by scrollkeeper to convert DocBook/SGML files to Docbook/XML files if necessary, and to apply a number of transformations to the XML file to extract information from the XML file. scrollkeeper-gen-seriesid generates a globally unique series ID for an OMF file. scrollkeeper-preinstall reads omf_file1, changes the URL attribute of the identifier tag to doc_file and writes the output to omf_file2. scrollkeeper-preinstall can be used during the document installation process to point OMF files to the correct location on the target machine before registration in the scrollkeeper database. OPTIONS
None. OPERANDS
The following operands are supported: docfile Specifies the file path to the document that omf-file1 describes. file Specifies the XML file that is to be used as input for XSLT transformations. omf-file1 Specifies the OMF file that contains metadata for docfile. omf-file2 Specifies the file created by scrollkeeper-preinstall, which contains the same data as omf-file1 except that the URL attribute of the identifier tag is changed to docfile. output Specifies the file that contains the result when the preceding stylesheet has been applied to file. stylesheet Specifies an XSLT transformation to apply. EXAMPLES
Example 1: Creating a New scrollkeeper Series ID example% scrollkeeper-gen-seriesid Example 2: Extracting a TOC From a Document example% scrollkeeper-extract /path/to/xml/file.xml /usr/share/scrollkeeper/stylesheets/toc.xsl /path/to/toc.xml EXIT STATUS
The following exit values are returned: 0 Application exited successfully >0 Application exited with failure FILES
The following files are used by this application: /usr/bin/scrollkeeper-extract The command-line executable for the scrollkeeper-extract application. /usr/bin/scrollkeeper-gen-seriesid The command-line executable for the scrollkeeper-gen-seriesid application. /usr/bin/scrollkeeper-preinstall The command-line executable for the scrollkeeper-preinstall application. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWgnome-libs-devel | +-----------------------------+-----------------------------+ |Interface stability |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
scrollkeeper(1) NOTES
Written by Sander Vesik, Sun Microsystems Inc., 2003. SunOS 5.10 01 Apr 2003 scrollkeeper-devel(1)