<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!-- SGI man2html VERSION 2.0 -->
<HTML>
<HEAD>
<TITLE>sgindexAdmin (1) - update infosearch index and table of contents</TITLE>
</HEAD>
<BODY>
<P><!--
Copyright 1996-2002 Silicon Graphics, Inc.
ALL RIGHTS RESERVEDUNPUBLISHED: Rights reserved under the copyright laws of the UnitedStates. Use of a copyright notice is precautionary only and does not
imply publication or disclosure.U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:Use, duplication or disclosure by the Government is subject to restrictions
as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
in similar or successor clauses in the FAR, or the DOD or NASA FAR
Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARYINFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICONGRAPHICS, INC.
--></P>
<H3>SGINDEXADMIN(1)</H3>
<H4>NAME</H4>
<P>sgindexAdmin - update infosearch index and table of contents</P>
<H4>SYNOPSIS</H4>
<DL>
<DT><B>sgindexAdmin</B> [ -force ] [ -update | -toc | -clean | -instchk ] [ <I>content</I>_<I>domain</I> ]
</DL>
<H4>DESCRIPTION</H4>
<P><I>sgindexAdmin</I> manages the synchronization of infosearch
fulltext indices and other
<A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20infosearch">infosearch(1)</A> data files.</P>
<P><I>sgindexAdmin</I> executed without specifying a <I>content</I>_<I>domain</I>
will update <B>all</B> available information domains. At this time,
that set is comprised of: online books (bks), release
notes (relnotes) and man pages (man).
A list of all <I>content</I>_<I>domain</I>'s and their associated
default arguments can be found at the end of the file
<TT>/usr/lib/infosearch/bin/sgindexAdmin</TT>. </P>
<P><I>sgindexAdmin</I> should be run as root in order to modify
the <I>content</I>_<I>domain</I> indices. </P>
<H4>OPTIONS</H4>
<P>Command line options are described below.</P>
<DL><DT><B>-update</B></DT>
<DD> Completely update the provided
<I>content</I>_<I>domain</I>(s). Add missing
references and delete references to documents that no
longer exist; create all ancillary data files if needed.
Unless <I>-force</I> is used, document references will be
added to the local{<I>content</I>_<I>domain</I>}
index.</DD>
</DL>
<DL><DT><B>-toc</B></DT>
<DD> Only create a table-of-contents for the documents in the
updated <I>content</I>_<I>domain</I> index.</DD>
</DL>
<DL><DT><B>-clean</B></DT>
<DD> Remove the index and table-of-contents file(s).</DD>
</DL>
<DL><DT><B>-instchk</B></DT>
<DD> Runs -update against each <I>content</I>_<I>domain</I> if
the system modify date of the <I>content</I>_<I>domain</I>
index file(s) is less than the system modify date of the
<A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20inst">inst(1M)</A> install history file, <TT>/var/inst/hist</TT>. This option is
normally used only when run as part of the system reboot
process (as a part of <TT>/etc/init.d/configmsg</TT>).</DD>
</DL>
<P>Other command line options that can be used in conjunction with
those previously mentioned include (they should be
specified <B>before</B> those listed above) :</P>
<DL><DT><B>-force</B></DT>
<DD> Causes the <B>entire</B> set of index files to be removed and rebuilt.
This option should be used with care, as rebuilding from scratch
can take some time. If this option is used, it should be used
in conjunction with -update.</DD>
</DL>
<DL><DT><B>-r</B> <B><I>root</I></B></DT>
<DD> Begin looking for each <I>content</I>_<I>domain</I> at the given
<I>root</I> path specification. For example, if <I>root</I> is
specified as <TT>/disk2</TT>, the release notes will be looked for
under <TT>/disk2/usr/relnotes</TT>. This option should be used
with care, as modifying the location of the
<I>content</I>_<I>domain</I>'s will have an effect on the
operation of <A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20infosearch">infosearch(1)</A> as a whole.</DD></DL>
<DL><DT><B>-v</B></DT>
<DD> Report any status messages or errors to stdout and/or stderr.</DD></DL>
<DL><DT><B>-t</B></DT>
<DD> Report any timing statistics to stderr. See <A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20timex">timex(1)</A> for details.</DD></DL>
<H4>FILES</H4>
<DL>
<DT><TT>/usr/lib/infosearch/bin/sgindexAdmin</TT></DT>
<DT><TT>/usr/share/catman/SGIindex/*</TT></DT>
<DT><TT>/usr/relnotes/SGIindex/*</TT></DT>
<DT><TT>/usr/share/Insight/library/SGI_bookshelves/SGIindex/*</TT></DT>
</DL>
<H4>SEE ALSO</H4>
<P><A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20infosearch">infosearch(1)</A>, <A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20booksAdmin">booksAdmin(1)</A>, <A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20sgreader">sgreader(1)</A>, <A HREF="/cgi-bin/infosrch.cgi?cmd=getdoc&db=man&fname=1%20sgmerge">sgmerge(1)</A></P>
</BODY>
</HTML>
