Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

scrollkeeper(1) [sunos man page]

scrollkeeper(1) 						   User Commands						   scrollkeeper(1)

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 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] omf-file scrollkeeper-rebuilddb [-p path] [-q] [-v] [-o path] scrollkeeper-uninstall [-p path] [-q] [-v] omf-file scrollkeeper-update [-p path] [-q] [-v] [-o path] DESCRIPTION
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 con- tents and index information only from DocBook documents. EXTENDED DESCRIPTION
The following commands are supported: scrollkeeper-getExports 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-getExportst-thetscrollkeeper contents list for the specified locale into a temporary file, and displays the name of the tempo- rary file. scrollkeeper-getExportsetheoscrollkeeper 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-getDisplaysm-thepapath 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-getDisplaysmthe path to the file containing the table of contents of the document with the specified scrollkeeper series ID. scrollkeeper-insRegisters a document in the scrollkeeper database. scrollkeeper-rebRemoves 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 infor- mation about the scrollkeeper-rebuilddb command, see the Examples section. scrollkeeper-uniRemoves 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-updRescans 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 res- canned. OPTIONS
The following options are supported: -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/gnome/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/gnome/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 loca- tion 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 scroll- keeper-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 over- rides 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/gnome/lib/scrollkeeThe location of the default scrollkeeper database. /var/gnome/log/scrollkeeAelogofile 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-coThegcommand-line executable for the scrollkeeper-config application. /usr/bin/scrollkeeper-geThelcommand-line executable for the scrollkeeper-get-cl application. /usr/bin/scrollkeeper-geTheocommand-line executable for the scrollkeeper-get-content-list application. /usr/bin/scrollkeeper-geThexcommand-linenexecutable for the scrollkeeper-get-extended-content-list application. /usr/bin/scrollkeeper-geThencommand-linepexecutable for the scrollkeeper-get-index-from-docpath application. /usr/bin/scrollkeeper-geTheocommand-linetexecutable for the scrollkeeper-get-toc-from-docpath application. /usr/bin/scrollkeeper-geTheocommand-line executable for the scrollkeeper-get-toc-from-id application. /usr/bin/scrollkeeper-inThelcommand-line executable for the scrollkeeper-install application. /usr/bin/scrollkeeper-reThelcommand-line executable for the scrollkeeper-rebuilddb application. /usr/bin/scrollkeeper-unThetcommand-line executable for the scrollkeeper-uninstall application. /usr/bin/scrollkeeper-upTheecommand-line executable for the scrollkeeper-update application. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWgnome-libs | +-----------------------------+-----------------------------+ |Interface stability |External | +-----------------------------+-----------------------------+ SEE ALSO
scrollkeeper-config(1), scrollkeeper-devel(1) NOTES
Written by Sander Vesik, Sun Microsystems Inc., 2003. SunOS 5.10 30 Jun 2003 scrollkeeper(1)
Man Page