NAME
USAGE
DESCRIPTION
PARAMETERS
OPTIONS
EXAMPLES
SEE ALSO
KNOWN BUGS
DIAGNOSTICS
COPYRIGHT

NAME

kasykindex - add documents to a Kasyk index

USAGE

kasykindex [options] indexdir [docseq1 .. docseqN]

DESCRIPTION

The 'kasykindex' executable processes any documents that are provided to it in the Kasyk document sequence XML format into a internal format, stored in the directory with which the Kasyk index is identfied, that can be used for later queries with Kasyk searcher (kasyk), Kasyk server (kasykd) and (indirectly) by Kasyk caching query server (kasykcqd).

The 'kasykindex' executable should be called at least once with at least one document in Kasyk document sequence XML format before the Kasyk index can be used for queries.

PARAMETERS

The first parameter is not optional. It indicates the Kasyk index that should be updated.

All the other parameters are optional. They specify the names of files that contains the Kasyk document sequence XML of documents to be indexed. If no parameters are specified, the Kasyk document sequence XML is read from standard input (STDIN).

OPTIONS

--messagelog filename or -M filename: Set filename to be used for logging events. Overrides the name of the logfile that is specified in the Kasyk configuration XML or with the KASYK_MESSAGELOG environment variable.
--user user or -u user: User id with which to execute . This is only applicable when running as root on Unix(like) systems. If specified, it should match whatever user setting was used (if any) with Kasyk initializer (kasyknew).
--group group or -g group: Group id with which to execute . This is only applicable when running as root on Unix(like) systems. If specified, it should match whatever group setting was used (if any) with Kasyk initializer (kasyknew).
--version or -V: Print version information of . This includes the software version, the index version it is compatible with, and whether or not it is a threaded version.
--verbose [level] or -v [level]: Set verbosity level of . Verbosity level of 1 is assumed if no value is specified. Can be used in conjunction with --copyright and --help.
--copyright or -C: Print copyright information of . This basically gives the standard GPL copyright statement. Use --verbose or -v also to get the complete copyright information including references to all internal and external libraries used.
--help or -h or -?: Print valid usage options of . Basically this information in a more condensed format.

EXAMPLES

Document sequences should always conform to Kasyk document sequence XML.

indexing from a file

 $ kasykindex localindex documents <ENTER>
 $

Index the contents of the file "documents" into the Kasyk index "localindex".

indexing from standard input

 $ cat documents | kasykindex localindex <ENTER>
 $

Index whatever comes in on standard input (STDIN) into the Kasyk index "localindex".

KNOWN BUGS

See http://www.kasyk.nl/bugs/kasykindex.html for the most up-to-date information about known bugs for 'kasykindex'.

DIAGNOSTICS

Exit status is normally 0. Exit status 1 indicates a problem of some sort with an error message sent to STDERR and any active logfile.

COPYRIGHT

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Kasyk Program Information: Kasyk version 1.0.0, generated on Tue Nov 25 12:09:47 2003.