dtl2sgft(1)

NAME
     dtl2sgft - Online Documentation Administration Utility for InfoSearch

SYNOPSIS
     dtl2sgft   -b book_name -s bookshelf_path [ -o output_file ] [ -f ] [ -x ] [ -v ]


DESCRIPTION
     dtl2sgft is a utility program used to assist in maintaining a full-text
     searchable index of online books available to the infosearch(1)
     application.

     For the specified online book, dtl2sgft builds or updates a full-text
     indexable word file which is an extraction of the content of the book.
     This word file is used in conjunction with the booksAdmin(1) utility to
     aid in constructing and maintaining a full-text index.

     An administrator should never have to run this process by hand.  Normally
     it will be launched by the booksAdmin(1) utility.  If it is run manually,
     the only options required when processing online books are -b and -s, as
     described below.


DEFINITIONS
     A bookshelf is defined as a directory containing a set of books. By
     default, bookshelves are located in:

       /usr/share/Insight/library/SGI_bookshelves

     To examine a sample bookshelf, look under this default path. Most of the
     directories contained under this area are defined as bookshelves. By
     convention, below each of those bookshelf directories exists a
     subdirectory named "books". The "books" subdirectory contains all
     available online books for this bookshelf.

     For example, examining the path:

       /usr/share/Insight/library/SGI_bookshelves/SGI_EndUser/books/Desktop_UG

     SGI_EndUser is the bookshelf and Desktop_UG is the book.


OPTIONS
     Command line options are described below.

     -b   The -b book_name required option tells dtl2sgft to examine the
          specified book.  The book_name is the abbreviated "short name" for
          the book, which coincides with the directory name (see the
          explanation above).
     -s   The -s bookshelf_path required option tells dtl2sgft which specific
          bookshelf the book_name is on (full path).

          For example,

          dtl2sgft -b IRISEssentials -s
          /usr/share/Insight/library/SGI_bookshelves/SGI_EndUser

     -a   The -a authorization_string option is no longer needed and is
          ignored.

     -d   The -d data_dir option is no longer needed and is ignored.

     -f   The -f option is used to force the creation of the word files.
          Normally, the software will check to determine if the online book
          has changed and if so, it will then (re-)create the word file. This
          option will disable that particular check.

     -o   The -o output_file option instructs dtl2sgft to append the resultant
          word file output to the specified output_file.

     -p   The -p option is no longer used and is ignored.

     -q   The -q granularity_qry option is no longer needed and is ignored.

     -r   The -r root option is no longer needed and is ignored.

     -t   The -t title_tag option is no longer needed and is ignored.

     -u   The -u use_shelfname option is no longer needed and is ignored.

     -w   The -w option is no longer needed and is ignored.

     -x   The -x option instructs dtl2sgft to output timing specifications.
          By default, it runs silently.

     -v   The -v option instructs dtl2sgft to output additional information.
          By default, it runs silently.

NOTES
     If you see warnings about books in an "old/unreadable format", those
     books can be converted using the -c and (optionally) the -d option(s) of
     the insightAdmin(1) command. Additional information can be found in the
     insight Release Notes.


FILES
     /usr/sbin/dtl2sgft

SEE ALSO
     infosearch(1), sgsearch(1), insightAdmin(1)

     The insight and infosearch Release Notes.