ONINDEX(8)

NAME
onindex - Daemon to Index Document Files

SYNOPSIS
onindex [-h] | [-d] [-D] [-f <path>] [-o <path>] [-N] [-q] [-s <secs>] [-v] [-vv] [-u]

DESCRIPTION
The primary application of onindex is to create text indexes that can be read by the OnSearch(3) document search program. The daemon can be started by itself as a shell command, from within OnSearch(3), or via an init shell script.

Onindex logs its information to the OnSearch log file. The section, FILES, below, describes the location of the log, configuration, and run-time files.

OPTIONS

-d  Also index words that contain only digits.

-f <path>
    Use configuration file path.

-h  Print a help message and exit.

-N  Do not back up indexes.

-o <path>
    Use path as the output file.

-q  Do not print status information.

-s <secs>
    Wait secs seconds between indexing runs.

-v  Log progress information while indexing.

-vv Log even more information while indexing.

-u  Delete old indexes and exit.

SIGNALS
The daemon takes the following actions for each signal described below.

SIGHUP
    Re-read the configuration file.

SIGUSR1
    Begin indexing immediately.

SIGTERM, SIGINT
    Terminate the onindex process.

PLUGIN FILTERS
The plugins subdirectory (normally onsearch/plugins) contains filters for various document types. All plugins take two arguments: the name of the input file, and the name of the translated text/plain output file. Documents of the MIME type text/plain receive no translation. The filter for text/html and text/xml files removes HTML and XML tags and translates character entities. Postscript files use GNU ghostscript for translation. Files of type PDF use pdftotext for filtering. The ongzip plugin filters files compressed with GNU gzip. The jpeg plugin extracts image/jpeg file comments without the use of a helper application. Not all MIME types have plugins, and during the indexing process onindex notes the presence of these file types, if they are not excluded, using the null plugin. For example, GIF image files do not contain indexable text, and Java .jar files and Pkzip files, use the null plugin, because the PKZip utilities do not operate as filters. To determine file types, onindex, like OnSearch, uses "magic" number file signatures, similar to the Unix file(1) command. The onsearch.cfg file contains entries for the file types that onindex recognizes. See FILES, below.

FILES

@onsearchcfg@
    Configuration file for the OnSearch program. The value is normally onsearch/onsearch.cfg below the Web site's DocumentRoot directory.

@onsearchlog@
    OnSearch log file. Normally the value of (WebLogDir)/onsearch.log in onsearch.cfg.

@rundir@
    Contains OnSearch and onindex run-time data.

/usr/local/etc/init.d/onindex
    Init shell script.

BUGS
Onindex uses too much memory.

SEE ALSO
OnSearch(3)