config_search(1M)


config_search -- perform full-text indexing on bulk insert files

Synopsis

/usr/man/bin/config_search [ -f ] [ -L LANG ]

Description

The config_search script runs the Verity bulk insert operation to update the search index files. It is normally run automatically by config_help(1M) or config_man(1M), unless the -n option is used with those scripts to defer the indexing operation.

This script is most useful when several documentation packages are being installed at the same time. You can speed up the installation by deferring the (sometimes lengthy) index optimization process and running it once after all the documentation has been installed. In this case, add the -n option to each instance of config_help and config_man in your installation scripts. This generates the .vbi bulk insert files and places them under _SearchIndex/Insert or _SearchIndex/Delete, depending on what is being added or removed. For topics or man sections being updated, the old data is placed under Delete and the new data is placed under Insert. Your installation script should then run config_search to process all the bulk insert files.

If there are more than 15 items in the queue to be indexed, config_search defers the indexing process and displays a message to this effect to standard error. In this case, to index all the items in the queue, specify the -f option:

/usr/man/bin/config_search -f


NOTE: By default, the Verity indexing process is not performed automatically at ISL. Before users can access the full capabilities of the Search and Print functions, the documentation must be indexed. To index all of the documentation on the system, the system administrator must run config_search with the -f option.

If the -L option is specified, the processes are run on the given language (LANG); otherwise all language versions are processed. For example, the following command runs config_search on all the topicID directories under the es (Spanish language) directory:

config_search -L es

When run either automatically or manually, the config_search script performs the following actions:


NOTE: The _SearchIndex directory structure is automatically maintained; documentation package removal scripts should not perform any actions in this area.

Files

/usr/man/bin/config_search
bulk insert indexing script

Exit codes

0 on success
1 on failure

 
 0   on success 
 1   on failure 

Diagnostics

Support tools not found in /usr/man/bin 
Make sure the ODSSI tools (in the ``base'' package) are installed on your system.
Cannot find documentation directory: /usr/lib/scohelp 
Make sure that /usr/lib/scohelp exists on your system.
Cannot configure documentation: permission denied: /usr/lib/scohelp 
Make sure that /usr/lib/scohelp is writable by root.
No documentation for language: LANG 
Make sure there are documentation files under /usr/lib/scohelp/LANG.

References

config_help(1M), config_man(1M)

``Adding documents to the help system''


30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.