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

NAME

kasyknew - create a new Kasyk index

USAGE

kasyknew [options] newindexdir [configfile]

DESCRIPTION

The 'kasyknew' executable creates a new Kasyk index with the specified Kasyk configuration XML, either read from the specified configuration file or from standard input (STDIN). It must be performed before it is possible to fill a Kasyk index with documents using Kasyk indexer (kasykindex).

PARAMETERS

The first parameter is not optional. It specifies the name of a (local) directory that may not yet exist.

The second parameter is optional. It specifies the name of the file that contains the Kasyk configuration XML with which the Kasyk index should be created. If it is not specified, it is assumed the Kasyk configuration XML will be provided by reading from standard input (STDIN).

If no error messages are displayed, then the creation of the Kasyk index was successful. This allows the Kasyk indexer (kasykindex) executable to index documents provided to it in the Kasyk document sequence XML format. After the necessary documents have been indexed, either Kasyk searcher (kasyk), Kasyk server (kasykd) or Kasyk caching query server (kasykcqd) can be used to search in the Kasyk index.

Changes to the configuration that need to be made after the Kasyk index has been created, should be made with the Kasyk configuration handler (kasykconfig) executable.

OPTIONS

--user user or -u user: User id with which to execute . This is only applicable when running as root on Unix(like) systems. Any user setting here should be used in subsequent calls to Kasyk indexer (kasykindex), Kasyk searcher (kasyk), Kasyk server (kasykd), Kasyk configuration handler (kasykconfig), Kasyk index checker (kasykcheck) and Kasyk optimizer (kasykopt).
--group group or -g group: Group id with which to execute . This is only applicable when running as root on Unix(like) systems. Any group setting here should be used in subsequent calls to Kasyk indexer (kasykindex), Kasyk searcher (kasyk), Kasyk server (kasykd), Kasyk configuration handler (kasykconfig), Kasyk index checker (kasykcheck) and Kasyk optimizer (kasykopt).
--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

Configuration information should always conform to Kasyk configuration XML.

creating a local index from a configuration file

 $ kasyknew localindex configfile <ENTER>
 $

Create the Kasyk index "localindex" with the Kasyk configuration XML that is stored in the file "configfile".

creating a local index from standard input

 $ cat configfile | kasyknew localindex <ENTER>
 $

Create the Kasyk index "localindex" from Kasyk configuration XML that is provided on standard input (STDIN).

KNOWN BUGS

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

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.