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

NAME

kasykd - start a Kasyk server for a Kasyk index

USAGE

kasykd [options] indexdir

DESCRIPTION

The 'kasykd' executable reads the configuration of the indicated index directory and starts listening for search queries on the indicated location. The 'kasykd' is the work horse of the Kasyk search engine core. It is a high performance threaded application when compiled on systems that allow so. Most of the configuration information is read from the Kasyk configuration XML that is used when the index is created with Kasyk initializer (kasyknew), or later updated with Kasyk configuration handler (kasykconfig). Several options override settings from the configuration: some of these must be specified if there is no appropiate setting available in the configuration.

The 'kasykd' executable will continue to run until it is told to stop, either by killing the process, or by using the --shutdown option.

PARAMETERS

The only parameter is not optional. It indicates which Kasyk index should be served. This is a "local" directory that was previously created with Kasyk initializer (kasyknew) and later filled with Kasyk indexer (kasykindex).

Unlike the Kasyk searcher (kasyk) executable, no direct queries are possible to 'kasykd'. It is however possible to use the Kasyk searcher (kasyk) executable to perform queries on the Kasyk index that is served with 'kasykd'.

No messages are sent to standard output (STDOUT) or standard error output (STDERR) if the server has started without any problems. If there are any problems, they are sent to the message log file (if any directly or indirectly specified) and to standard error output. To be 100% sure ofi success, call 'kasykd" again using the --server option.

OPTIONS

--location [host:]port or -L [host:]port

Override the "location" attribute of the <searching> container in the Kasyk configuration XML. Can be either specified as just a port number (in which case "localhost" will be assumed as the IP-number) or as a combination of a hostname (or IP-number) and a port number.

--server or -s

Output the Kasyk server info XML of the Kasyk server running for the specified Kasyk index. Assumes default server ID if no --id or -i has been specified. Outputs error essage if the indicated server is not running.

--restart or -R

Cause the Kasyk server running for the specified Kasyk index to be restarted (re-read its configuration and index information). Does not output any message if correctly restarted. Assumes default server ID if no --id or -i has been specified. Outputs error essage if the indicated server is not running.

--shutdown or -S

Cause the Kasyk server running for the specified Kasyk index to be shut down. Does not output any message if correctly shut down. Assumes default server ID if no --id or -i has been specified. Outputs error essage if the indicated server is not running.

--id identifier or -i identifier

Specify the server ID to be associated with this instance of a Kasyk server running on the same Kasyk index. It should be specified in conjunction with the --server, --restart and --shutdown options if neccesary.

The server ID is only needed when multiple Kasyk servers are serving from the same index directory, e.g. when the index is NFS-mounted and different physical servers are used to share the load with a Kasyk caching query server (kasykcqd). This is only necessary in high load situations where load balancing becomes important.

--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.

--querylog filename or -Q filename

Set filename for logging queries. Overrides the name of any query logfile that is specified in the Kasyk configuration XML.

--pending connections or -p connections

Specify the number of connections that can be pending before being accepted by the server. Only needed for very heavily visited servers. Defaults to the pending attribute of the <clients> container in the Kasyk configuration XML or 128 if not specified in there.

--user user or -u user

User id with which to execute . This is only applicable when running as root on Unix(like) systems. It should match whatever user setting was used (if any) with Kasyk initializer (kasyknew) and Kasyk indexer (kasykindex).

--group group or -g group

Group id with which to execute . This is only applicable when running as root on Unix(like) systems. It should match whatever group setting was used (if any) with Kasyk initializer (kasyknew) and Kasyk indexer (kasykindex).

--pending connection or -p connection

Specify the number of connections that can be "pending" before being "accepted". Only needed for very heavily visited servers. Defaults to what is specified for the pending> attribute of the <clients> container in the Kasyk configuration XML, or to 10 if not specified in there.

--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

Queries should always conform to Kasyk query XML. The resulting hitlist will always conform to Kasyk hitlist XML. Any Kasyk index must have been created with Kasyk initializer (kasyknew) previously and must have had documents indexed into it with Kasyk indexer (kasykindex).

starting using configuration only

 $ kasykd localindex <ENTER>
 $

Start serving query requests for Kasyk index "localindex" on whatever host and port are specified in the Kasyk configuration XML.

starting on specific IP-number and port

 $ kasykd --location=myserver.domain.com:3333 localindex <ENTER>
 $

Start serving query requests for Kasyk index "localindex" on host "myserver.domain.com" and port "3333". Ignore any settings for host in the Kasyk configuration XML. Assume the default server ID (because there is no --id specified).

starting on local machine on specific port, check success

 $ kasykd -L 3333 localindex <ENTER>
 $ kasykd -s localindex <ENTER>
 <kasyk:server xmlns:kasyk="http://www.kasyk.org/1.0" location="127.0.0.1:3333" pid="29601"/>
 $

Start serving query requests for Kasyk index "localindex" on host "localhost" (127.0.0.1) and port "3333". Ignore any settings for host in the Kasyk configuration XML. Show the resulting Kasyk server info XML.

shut a running server down

 $ kasykd --shutdown localindex <ENTER>

Shut the server down that is running for Kasyk index "localindex". Assume that the server was started without specifying a server ID with --id.

KNOWN BUGS

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

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.