User Guide

Getting started with the Verity mkvdk utility 91
Getting started with the Verity mkvdk utility
The following is the basic mkvdk syntax:
mkvdk -collection path [option] [...] [filespec] [...]
Where:
■ Square brackets ( [ ] ) indicate optional items.
■ An ellipsis (...) indicates repetition of the previous item. Thus, [filespec] [...] indicates
an optional series of filespec items.
■ filespec represents a document filename or a list of document filenames. If filespec is a
list of files, it should consist of an at sign (@) followed by the filename containing the list
(for example,
@filelist).
■ The -collection path argument creates or opens a collection. This argument is required.
Numerous optional syntax options are listed below. All syntax options must precede the first
filespec parameter.
Creating a collection
Creating a collection with the mkvdk utility involves setting up a collection directory structure
and inserting documents into this structure. You can create a collection in two steps, using two
separate commands.
To create a collection:
1 Set up a collection using the following syntax:
mkvdk -create -collection collectionname
Where collectionname is the path to the collection directory. Running this command creates
a collection directory that includes style files with configuration information.
2 Insert documents using the following syntax:
mkvdk -collection collectionname -bulk -insert filespec
Where filespec is the name of a bulk insert file that specifies which documents to index and
insert into the collection.
Alternatively, you can set up a collection and insert documents in one command, using the
following syntax:
mkvdk -create -collection collectionname -bulk -insert filespec
Note: You can use the
-create option only once to create the collection directory structure. After a
collection directory structure has been created, do not to use the
-create option to update the
collection.
Accessing online Help for the mkvdk utility
To display a list of mkvdk command-line options, enter the following command:
mkvdk -help