10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13626N/A<!--ARC : LSARC 2001/201 GNOME 2.X on Solaris-->
13626N/A<!--ARC : LSARC 2001/317 Scrollkeeper Open Documentation Cataloging System-->
13666N/A<!--ARC : LSARC 2003/033 GNOME 2.x Scrollkeeper scripts-->
13666N/A<!--ARC : LSARC 2003/191 Scrollkeeper rc update-->
13666N/A<!--ARC : LSARC 2003/214 Scrollkeeper CLI change-->
10139N/A<!ENTITY cmd "scrollkeeper">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<refentry id="scrollkeeper-1">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
10139N/A<refmeta><refentrytitle>scrollkeeper</refentrytitle><manvolnum>1</manvolnum>
10139N/A<refmiscinfo class="date">12 Sep 2006</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
10139N/A<indexterm><primary>scrollkeeper</primary></indexterm><indexterm><primary>
10139N/Amanage document metadata</primary></indexterm>
10139N/A<refnamediv id="scrollkeeper-1-name"><refdescriptor>&cmd;</refdescriptor>
10139N/A<refname>scrollkeeper.conf</refname><refname>scrollkeeper-get-cl</refname>
10139N/A<refname>scrollkeeper-get-content-list</refname><refname>scrollkeeper-get-extended-content-list
10139N/A</refname><refname>scrollkeeper-get-index-from-docpath</refname><refname>
10139N/Ascrollkeeper-get-toc-from-docpath</refname><refname>scrollkeeper-get-toc-from-id
10139N/A</refname><refname>scrollkeeper-install</refname><refname>scrollkeeper-rebuilddb
10139N/A</refname><refname>scrollkeeper-uninstall</refname><refname>scrollkeeper-update
10139N/A</refname><refpurpose>manage document metadata</refpurpose></refnamediv>
10139N/A<refsynopsisdiv id="scrollkeeper-1-synp"><title>&synp-tt;</title>
10139N/A<cmdsynopsis><command>&cmd;-get-cl</command><arg choice="opt"><option>v</option></arg>
10139N/A<arg choice="plain"><option role="nodash"><replaceable>locale</replaceable></option></arg>
10139N/A<arg choice="plain"><option role="nodash"><replaceable>file</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-get-content-list</command><arg choice="plain"><option
10139N/Arole="nodash"><replaceable>locale</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-get-extended-content-list</command><arg choice="plain"><option
10139N/Arole="nodash"><replaceable>locale</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-get-toc-from-docpath</command><arg choice="plain"><option
10139N/Arole="nodash"><replaceable>file</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-get-toc-from-id</command><arg choice="plain"><option
10139N/Arole="nodash"><replaceable>series-id</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-install</command><arg choice="opt"><option>p <replaceable>
10139N/Apath</replaceable></option></arg><arg choice="opt"><option>q</option></arg>
10139N/A<arg choice="opt"><option>v</option></arg><arg choice="opt"><option>n</option></arg>
10139N/A<arg choice="plain"><option role="nodash"><replaceable>
10139N/Aomf-file</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-rebuilddb</command><arg choice="opt"><option>
10139N/Ap <replaceable>path</replaceable></option></arg><arg choice="opt"><option>
10139N/Aq</option></arg><arg choice="opt"><option>v</option></arg><arg choice="opt"><option>
10139N/Ao <replaceable>path</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-uninstall</command><arg choice="opt"><option>
10139N/Ap <replaceable>path</replaceable></option></arg><arg choice="opt"><option>
10139N/Aq</option></arg><arg choice="opt"><option>v</option></arg><arg choice="plain"><option
10139N/Arole="nodash"><replaceable>omf-file</replaceable></option></arg>
10139N/A</cmdsynopsis>
10139N/A<cmdsynopsis><command>&cmd;-update</command><arg choice="opt"><option>p <replaceable>
10139N/Apath</replaceable></option></arg><arg choice="opt"><option>q</option></arg>
10139N/A<arg choice="opt"><option>v</option></arg><arg choice="opt"><option>n</option></arg>
10139N/A<arg choice="opt"><option>o <replaceable>
10139N/Apath</replaceable></option></arg>
10139N/A</cmdsynopsis></refsynopsisdiv>
10139N/A<refsect1 id="scrollkeeper-1-desc"><title>&desc-tt;</title>
10139N/A<para><command>&cmd;</command> manages document metadata and keeps track of
10139N/Avarious document attributes such as language, format, subject, classification,
10139N/Acopyright, and so on. <command>&cmd;</command> supports OMF (Open Metadata
10139N/AFormat), which is a simple 16-element XML file format. OMF is a subset of
10139N/Athe Dublin Core metadata specification developed by the Dublin Core Metadata
10139N/AInitiative. Currently, <command>&cmd;</command> can extract table of contents
10139N/Aand index information only from DocBook documents.</para>
10139N/A</refsect1>
10139N/A<refsect1 id="scrollkeeper-1-exde"><title>&exde-tt;</title>
10139N/A<para>The following commands are supported:</para>
10139N/A<variablelist termlength="wholeline">
10139N/A<varlistentry><term><command>&cmd;-get-cl</command></term><listitem><para>
10139N/AExports the <command>&cmd;</command> contents list for the specified locale
10139N/Aand the specified contents file into a temporary file, and displays the name
10139N/Aof the temporary file.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-get-content-list</command></term><listitem>
10139N/A<para>Exports the <command>&cmd;</command> contents list for the specified
10139N/Alocale into a temporary file, and displays the name of the temporary file.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-get-extended-content-list</command></term>
10139N/A<listitem><para>Exports the <command>&cmd;</command> extended contents list
10139N/Afor the specified locale into a temporary file, and displays the name of the
10139N/Atemporary file. The extended contents list contains both the document tree
10139N/Aand the table of contents for each document.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-get-toc-from-docpath</command></term><listitem>
10139N/A<para>Displays the path to the file containing the table of contents of a
10139N/Adocument registered in the OMF database. Otherwise, displays a message to
10139N/Aindicate that the requested document is not installed.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-get-toc-from-id</command></term><listitem>
10139N/A<para>Displays the path to the file containing the table of contents of the
10139N/Adocument with the specified <command>&cmd;</command> series ID.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-install</command></term><listitem><para>
10139N/ARegisters a document in the <command>&cmd;</command> database.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-rebuilddb</command></term><listitem><para>
10139N/ARemoves the existing <command>&cmd;</command> database and creates a new database
10139N/Aby registering the documents described by the OMF files found in the OMF search
10139N/Apath. This command is useful if the <command>&cmd;</command> database becomes
10139N/Acorrupted. For more information about the <command>&cmd;-rebuilddb</command>
10139N/Acommand, see the Examples section.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-uninstall</command></term><listitem><para>
10139N/ARemoves a document from the <command>&cmd;</command> database and removes
10139N/Aany related files from the <command>&cmd;</command> database and contents
10139N/Alists. The document and the OMF file are not removed or modified.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><command>&cmd;-update</command></term><listitem><para>
10139N/ARescans the list of directories in the OMF search path for new and removed
10139N/Adocuments, and updates the <command>&cmd;</command> database accordingly.
10139N/AUnless a search path is specified with the <option>o</option> option, all
10139N/Adirectories in the default OMF search path are rescanned.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="scrollkeeper-1-opts"><title>&opts-tt;</title>
10139N/A<para>The following options are supported:</para>
10139N/A<variablelist termlength="narrow">
10139N/A<varlistentry><term><option>n</option></term><listitem><para>Use the network to retrieve the DTD if it is not available via the system's XML catalog.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>o <replaceable>path</replaceable></option></term>
10139N/A<listitem><para>Specifies the search path for OMF files.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>p <replaceable>path</replaceable></option></term>
10139N/A<listitem><para>Specifies the location of the <command>&cmd;</command> database.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>q</option></term><listitem><para>Suppresses warnings
10139N/Aand error messages.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>v</option></term><listitem><para>Displays all
10139N/Awarnings and error messages, in addition to logging these messages in the <filename>
10139N/A/var/log/scrollkeeper.log</filename> file.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="scrollkeeper-1-oper"><title>&oper-tt;</title>
10139N/A<para>The following operands are supported:</para>
10139N/A<variablelist termlength="narrow">
10139N/A<varlistentry><term><replaceable>file</replaceable></term><listitem><para>
10139N/ASpecifies the location of the contents file.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><replaceable>locale</replaceable></term><listitem><para>
10139N/ASpecifies the locale.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><replaceable>omf-file</replaceable></term><listitem><para>
10139N/ASpecifies the location of the OMF file.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><replaceable>series-id</replaceable></term><listitem>
10139N/A<para>Specifies the <command>&cmd;</command> series ID.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="scrollkeeper-1-exam"><title>&exam-tt;</title>
10139N/A<example role="example">
10139N/A<title>Removing a Document From the &cmd; Database</title>
10139N/A<para><screen>example% <userinput>&cmd;-uninstall /usr/share/omf/example/<replaceable>
10139N/Afilename</replaceable>.omf</userinput></screen></para>
10139N/A</example>
10139N/A<example role="example">
10139N/A<title>Getting the &cmd; Extended Contents List for the C Locale</title>
10139N/A<para><screen>example% <userinput>&cmd;-get-extended-content-list C</userinput></screen></para>
10139N/A</example>
10139N/A<example role="example">
10139N/A<title>Setting Up the scrollkeeper Database for a Diskless Client Clone Area
10139N/A</title>
10139N/A<screen>example% <userinput>scrollkeeper-rebuilddb -p /export/root/clone/Solaris_9/sun4u/var/lib/scrollkeeper -o /export/exec/Solaris_9_sparc.all/usr/share/omf
10139N/A</userinput></screen>
10139N/A<para>If the <command>&cmd;</command> database must be installed in a location
10139N/Aother than the standard location, use the <option>p <replaceable>path</replaceable></option>
10139N/Aoption to specify the location of the <command>&cmd;</command> database, where <replaceable>
10139N/Apath</replaceable> is an empty directory. The <command>scrollkeeper-rebuilddb
11904N/A</command> command will not proceed if you specify a populated
10139N/Apath for this option.</para>
10139N/A<para>If the OMF files must be read from a location other than the standard
10139N/Alocation, use the <option>o <replaceable>path</replaceable></option> option
10139N/Ato specify the location of the OMF files. Specify the complete pathname, for
10139N/Aexample, <literal>/usr/share/omf</literal>. If you specify a partial pathname,
10139N/Afor example, <literal>/usr/share</literal>, the <command>scrollkeeper-rebuilddb
10139N/A</command> command will take a long time, produce many warnings, and may crash.
10139N/A</para>
10139N/A</example>
10139N/A</refsect1>
10139N/A<refsect1 id="scrollkeeper-1-envr"><title>&envr-tt;</title>
10139N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
10139N/A5</manvolnum></citerefentry> for descriptions of the following environment
10139N/Avariables that affect the execution of <command>&cmd;</command>: NLSPATH.
10139N/A</para>
10139N/A<variablelist termlength="medium">
10139N/A<varlistentry><term><filename>OMF_PATH</filename> </term><listitem><para>
10139N/AProvides <command>&cmd;</command> with an alternative list of directories
10139N/Ain which to search for OMF files. This variable overrides the default search
10139N/Apath. If the list contains multiple directories, the entries should be separated
10139N/Aby colons.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="scrollkeeper-1-exit"><title>&exit-tt;</title>
10139N/A<para>The following exit values are returned:</para>
10139N/A<variablelist termlength="xtranarrow">
10139N/A<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application
10139N/Aexited successfully</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
10139N/Aexited with failure</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="scrollkeeper-1-file"><title>&file-tt;</title>
10139N/A<para>The following files are used by this application:</para>
10139N/A<variablelist termlength="wholeline">
10139N/A<varlistentry><term><filename>/var/lib/&cmd;</filename> </term><listitem>
10139N/A<para>The location of the default <command>&cmd;</command> database.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/var/log/scrollkeeper.log</filename></term>
10139N/A<listitem><para>A log file containing log entries for database updates and
10139N/Aerror or warning messages.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/share/&cmd;</filename></term><listitem>
10139N/A<para>The directory containing the &cmd; templates and <filename>xslt</filename>
10139N/Afiles.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/etc/scrollkeeper.conf</filename></term><listitem>
10139N/A<para>The default search path for <filename>omf</filename> files.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-config</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-config
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-get-cl</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-get-cl
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-get-content-list</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-get-content-list
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-get-extended-content-list
10139N/A</filename></term><listitem><para>The command-line executable for the <filename>
10139N/Ascrollkeeper-get-extended-content-list</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-get-index-from-docpath
10139N/A</filename></term><listitem><para>The command-line executable for the <filename>
10139N/Ascrollkeeper-get-index-from-docpath</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-get-toc-from-docpath</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-get-toc-from-docpath
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-get-toc-from-id</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-get-toc-from-id
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-install</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-install
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-rebuilddb</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-rebuilddb
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-uninstall</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-uninstall
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-update</filename></term>
10139N/A<listitem><para>The command-line executable for the <filename>scrollkeeper-update
10139N/A</filename> application.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="scrollkeeper-1-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
18745N/A<row><entry><para>Availability</para></entry><entry><para>library/gnome/gnome-libs</para></entry>
10139N/A</row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
11171N/Acolname="COLSPEC1"><para>Obsolete</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="scrollkeeper-1-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
11925N/A<para>
11925N/A<citerefentry><refentrytitle>scrollkeeper-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11941N/A<citerefentry><refentrytitle>scrollkeeper-devel</refentrytitle><manvolnum>1</manvolnum></citerefentry>
11925N/A</para>
10139N/A</refsect1>
10139N/A<refsect1 id="scrollkeeper-1-note"><title>&note-tt;</title>
11933N/A<para>Written by Sander Vesik, Sun Microsystems Inc., 2003.</para>
11933N/A<para>Updated by Matt Keenan, Sun Microsystems Inc., 2006.</para>
11933N/A<para>Updated by Ghee Teo, Sun Microsystems Inc., 2007.</para>
10139N/A</refsect1>
10139N/A</refentry>