MAN Solaris - scrollkeeper (1)

advertisement


NAME

scrollkeeper, scrollkeeper.conf, scrollkeeper-get-cl, scrollkeeper-get-content-list, scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath, scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id, scrollkeeper-install, scrollkeeper-rebuilddb, scrollkeeper-uninstall, scrollkeeper-update - manage document metadata

CONTENTS

SYNOPSIS

scrollkeeper-get-cl [-v] locale file

scrollkeeper-get-content-list locale

scrollkeeper-get-extended-content-list locale

scrollkeeper-get-toc-from-docpath file

scrollkeeper-get-toc-from-id series-id

scrollkeeper-install [-p path] [-q] [-v] [-n] omf-file

scrollkeeper-rebuilddb [-p path] [-q] [-v] [-o path]

scrollkeeper-uninstall [-p path] [-q] [-v] omf-file

scrollkeeper-update [-p path] [-q] [-v] [-n] [-o path]

advertisements

advertisements


DESCRIPTION

These commands have been obsoleted by its equivalences in Rarian, see rarian-sk(1) which maintains backwards compatibility by creating symbolic links between rarian’s commands and scrollkeeper’s names.

scrollkeeper manages document metadata and keeps track of various document attributes such as language, format, subject, classification, copyright, and so on. scrollkeeper supports OMF (Open Metadata Format), which is a simple 16-element XML file format. OMF is a subset of the Dublin Core metadata specification developed by the Dublin Core Metadata Initiative. Currently, scrollkeeper can extract table of contents and index information only from DocBook documents.

EXTENDED DESCRIPTION

The following commands are supported:

scrollkeeper-get-cl

Exports the scrollkeeper contents list for the specified locale and the specified contents file into a temporary file, and displays the name of the temporary file.

scrollkeeper-get-content-list

Exports the scrollkeeper contents list for the specified locale into a temporary file, and displays the name of the temporary file.

scrollkeeper-get-extended-content-list

Exports the scrollkeeper extended contents list for the specified locale into a temporary file, and displays the name of the temporary file. The extended contents list contains both the document tree and the table of contents for each document.

scrollkeeper-get-toc-from-docpath

Displays the path to the file containing the table of contents of a document registered in the OMF database. Otherwise, displays a message to indicate that the requested document is not installed.

scrollkeeper-get-toc-from-id

Displays the path to the file containing the table of contents of the document with the specified scrollkeeper series ID.

scrollkeeper-install

Registers a document in the scrollkeeper database.

scrollkeeper-rebuilddb

Removes the existing scrollkeeper database and creates a new database by registering the documents described by the OMF files found in the OMF search path. This command is useful if the scrollkeeper database becomes corrupted. For more information about the scrollkeeper-rebuilddb command, see the Examples section.

scrollkeeper-uninstall

Removes a document from the scrollkeeper database and removes any related files from the scrollkeeper database and contents lists. The document and the OMF file are not removed or modified.

scrollkeeper-update

Rescans the list of directories in the OMF search path for new and removed documents, and updates the scrollkeeper database accordingly. Unless a search path is specified with the -o option, all directories in the default OMF search path are rescanned.

OPTIONS

The following options are supported:

-n Use the network to retrieve the DTD if it is not available via the system’s XML catalog.

-o path Specifies the search path for OMF files.

-p path Specifies the location of the scrollkeeper database.

-q Suppresses warnings and error messages.

-v Displays all warnings and error messages, in addition to logging these messages in the /var/log/scrollkeeper.log file.

OPERANDS

The following operands are supported:

file Specifies the location of the contents file.

locale Specifies the locale.

omf-file Specifies the location of the OMF file.

series-id Specifies the scrollkeeper series ID.

EXAMPLES

Example 1: Removing a Document From the scrollkeeper Database

example% scrollkeeper-uninstall /usr/share/omf/example/filename.omf

Example 2: Getting the scrollkeeper Extended Contents List for the C Locale

example% scrollkeeper-get-extended-content-list C

Example 3: Setting Up the scrollkeeper Database for a Diskless Client Clone Area

example% scrollkeeper-rebuilddb -p /export/root/clone/Solaris_9/sun4u/var/lib/scrollkeeper -o /export/exec/Solaris_9_sparc.all/usr/share/omf

If the scrollkeeper database must be installed in a location other than the standard location, use the -p path option to specify the location of the scrollkeeper database, where path is an empty directory. The scrollkeeper-rebuilddb command will not proceed if you specify a populated path for this option.

If the OMF files must be read from a location other than the standard location, use the -o path option to specify the location of the OMF files. Specify the complete pathname, for example, /usr/share/omf. If you specify a partial pathname, for example, /usr/share, the scrollkeeper-rebuilddb command will take a long time, produce many warnings, and may crash.

ENVIRONMENT VARIABLES

See environ(5) for descriptions of the following environment variables that affect the execution of scrollkeeper: NLSPATH.

OMF_PATH Provides scrollkeeper with an alternative list of directories in which to search for OMF files. This variable overrides the default search path. If the list contains multiple directories, the entries should be separated by colons.

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:

/var/lib/scrollkeeper

The location of the default scrollkeeper database.

/var/log/scrollkeeper.log

A log file containing log entries for database updates and error or warning messages.

/usr/share/scrollkeeper

The directory containing the scrollkeeper templates and xslt files.

/etc/scrollkeeper.conf

The default search path for omf files.

/usr/bin/scrollkeeper-config

The command-line executable for the scrollkeeper-config application.

/usr/bin/scrollkeeper-get-cl

The command-line executable for the scrollkeeper-get-cl application.

/usr/bin/scrollkeeper-get-content-list

The command-line executable for the scrollkeeper-get-content-list application.

/usr/bin/scrollkeeper-get-extended-content-list

The command-line executable for the scrollkeeper-get-extended-content-list application.

/usr/bin/scrollkeeper-get-index-from-docpath

The command-line executable for the scrollkeeper-get-index-from-docpath application.

/usr/bin/scrollkeeper-get-toc-from-docpath

The command-line executable for the scrollkeeper-get-toc-from-docpath application.

/usr/bin/scrollkeeper-get-toc-from-id

The command-line executable for the scrollkeeper-get-toc-from-id application.

/usr/bin/scrollkeeper-install

The command-line executable for the scrollkeeper-install application.

/usr/bin/scrollkeeper-rebuilddb

The command-line executable for the scrollkeeper-rebuilddb application.

/usr/bin/scrollkeeper-uninstall

The command-line executable for the scrollkeeper-uninstall application.

/usr/bin/scrollkeeper-update

The command-line executable for the scrollkeeper-update application.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWgnome-libs
Interface stabilityObsolete

SEE ALSO

scrollkeeper-config(1), scrollkeeper-devel(1)rarian-skconfig(1)

NOTES

Written by Sander Vesik, Sun Microsystems Inc., 2003.

Updated by Matt Keenan, Sun Microsystems Inc., 2006.

Updated by Ghee Teo, Sun Microsystems Inc., 2007.

Jump to page    or go to Top of page |  Section 1 |  Main Solaris Index.


SunOS 5.11 scrollkeeper (1) 12 Sep 2006
Generated by Open Solaris Forum from /usr/share/man/man1/scrollkeeper.1 using man macros with tbl support.