NAME

ixBuild − builds inverted indices on file system subtrees

SYNOPSIS

ixBuild [-CFlLrRvVxX][-a#][-ccmd][-dcmd][-Dstr]
[-fstr][-iindex][-ppri][-[nN]regex][-sfile]
[-Scmd][-[tT]str][[directory|file]...]

DESCRIPTION

ixBuild creates or adds to inverted indices for the files and directories named on the command line.  For each directory named on the command line, or for the current directory by default, ixBuild visits all of the files in the file system subtree rooted at that directory, extracting keywords and a description from each file visited.  With this information, it creates or updates an inverted index located in a subdirectory named .index at the root of the subtree.  For each file named on the command line, ixBuild creates or updates a reference to that file in the index specified by the i switch, or in the index in the current directory by default. 
 
An index is a BTreeFile containing three BTrees. One stores references to the indexed files, a second associates keywords with references to the files from which they were extracted, and a third provides a file name registration service used to determine the currency of the index with respect to the modification date of each file.
 
By default, a type specific keyword extraction program is used to obtain the keywords from each file, and a type specific description generation program is used to obtain a description.

OPTIONS

a # is the time delay in seconds between save operations on the index files. 

c Uses cmd to generate keywords for each file visited, regardless of type.  cmd is invoked with one argument, the name of the file in process, and should produce a list of white space separated "word weight" pairs on its standard output, one pair per line, as in pword(1). 

C Uses the name of each file as its description. 

d Uses cmd to generate a description for each file visited, regardless of type.  cmd is invoked with one argument, the name of the file in process, and should produce a one line description of the file on its standard output. 

D Uses str as the description of every file visited, regardless of type. 

f Uses str as the type of every file visited. 

F Treats file names and their components as keywords. 

i Uses index as the target of all operations. 

l Prevents the following of symbolic links. 

L Prevents the folding of keywords to lower case. 

n Considers only files with names matching regex.  regex is a file name specification in sh(1) syntax. 

N Ignores files with names matching regex.  regex is a file name specification in sh(1) syntax. 

p Sets the process priority to pri using setpriority(2).  This is useful for reducing the proportion of system resources consumed by the indexing process, so that other applications are more responsive.  The default value is 20. 

r Reads the names of files and directories to be processed, and optionally their descriptions, separated from the names by white space, from the standard input, one name and optional description per line, after processing the files and directories named on the command line. 

R Prevents the removal of extinct references from the indices following the addition of new information. 

s Uses file as a stop word table, instead of /usr/lib/indexing/files/English/stopWordTable. 

S Pipes the names of all files found to be both eligible for indexing and in need of indexing to the standard input of cmd, one file name per line, and bypasses the remainder of the indexing process. 

t Considers only files with types matching regex.  regex is a regular expression in the style of ex(1). 

T Ignores files with types matching regex.  regex is a regular expression in the style of ex(1). 

v Prints a verbose trace of the indexing process on the standard error stream. 

V Prints the type and name of each file visited on the standard output.  This option is used by Librarian(1) to update the display during index construction. 

x Prints the information gathered for each file visited, but doesn’t add keywords or registration information to the indices. 

X Bypasses everything except for determining the eligibility and currency of each file visited. 

SEE ALSO

ixClean(1), pword(1)

NeXT Computer, Inc.  —  October 18, 1990