insightAdmin(1)

NAME
     insightAdmin - The IRIS InSight Online Documentation Administration
     Utility

SYNOPSIS
     insightAdmin [ -v ] [ -a ] [ -f ] [ -l lib_path ] bookshelf_name ...


DESCRIPTION
     The IRIS InSight Administration utility is used to assist in maintaining
     the libraries of books available to the IRIS InSight Viewer.

     This utility will rebuild the library-level index for any bookshelf
     specified on the invocation line, and will update the list of books for
     that particular bookshelf (booklist.txt).

     After the installation of any book, inst(1M) automatically runs this
     command over the necessary bookshelves.  The only time an administrator
     needs to execute this command is if they have removed books via the rm(1)
     command, or by some means other than using the standard process
     (inst(1M)).  In that case, the administrator should then run this command
     on the bookshelf from which the book was removed.  Or, if for some other
     reason, the administrator feels as though the InSight Library is out-of-
     sync.

OPTIONS
     Command line options are described below.

     -v   The -v option tells insightAdmin to be verbose and list all
          messages, including status and errors.

     -a   The -a option tells insightAdmin to add any new book titles that
          have been installed on the bookshelf to the libraries list of book
          titles.   The insight viewer only displays books if they are in the
          library's list of book titles (booklist.txt).  Each book contains a
          booklist.txt file that specifies information about that specific
          book.  The bookshelf also contains a similar file that specifies the
          books on that bookshelf.  If a book is not listed in the bookshelf's
          booklist.txt file then the insight viewer will not display the book.

     -f   The -f option tells insightAdmin to force the addition or
          replacement of each book's title to the bookshelf's list of book
          titles (booklist.txt).  If a book is already listed on the
          bookshelf's list of titles, then this option will force the new
          title to replace the old title.

     -l   The -l lib_path option tells insightAdmin to look under the
          specified path for it's set of (specified) bookshelves.  By default,
          /usr/share/Insight/library is used.
     bookshelf_name
          The bookshelf_name option specifies the bookshelf on which to run
          the administration tool. See insight(1), the IRIS InSight Viewer,
          for more details on bookshelves.


FILES
     /usr/sbin/insightAdmin


SEE ALSO
     insight(1), sgihelp(1)