Cheshire II Commands

index_clusters - Index CheshireII Cluster files

SYNOPSIS

index_clusters [-b -T tempfiledir -S "sort flags" -L logfilename] configfilename [INDEXONLY]

DESCRIPTION

Index_clusters uses the descriptions included in the configuration file configfilename to index the cluster files of a Cheshire II database.

The configuration file should describe the main SGML data file, the cluster data files, the associator file (See buildassoc), the DTDs for the main SGML data file and the cluster files, and the desired index and cluster definitions. This program will create the index files specified in the configuration file for the cluster files (that is only those with the FILEDEF tag ) It will use the base temporary information used for the cluster files (which must be created by index_cheshire based on the definition in the main file definition).

If the -b flag is used, the indexing uses some batch loading techniques that greatly increase the indexing speed. Use of this flag is recommended in most cases, and especially when doing the initial indexing of a large database. If the -T flag is used then the "tempdirname" should be the path of the directory where the temporary files created by the batch processing and sorting are to be put. The -S flag can be used to pass a quoted list of flags to the system sort used in batch loading (see the documentation for the sort command on your system for the flags available).

The optional INDEXONLY keyword is used to do only the indexing of the cluster files, and not to generate the cluster files themselves from the temporary base cluster data created by index_cheshire. This option is provided for cases where indexing must be re-run and the cluster files have already been created.

LOG and ERROR INFORMATION

If the "-L" option is not used, then running the index_cheshire program creates a file in the current directory called INDEX_LOGFILE. If the "-L" option is used then the logfile is given the name provided on the command line. If this file already exists when the program is run, new information is appended to the existing file. INDEX_LOGFILE will contain any errors or problems encountered in indexing.

BUGS

None known

SEE ALSO

Configuration file documentation, index_cheshire

AUTHOR

Ray R. Larson ()