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

NAME

kasykconfig - obtain or update configuration of a Kasyk index

USAGE

kasykconfig [options] indexdir

DESCRIPTION

The 'kasykconfig' executable sends the Kasyk configuration XML of an existing Kasyk index to standard output (STDOUT). It is also capable of updating the configuration of a Kasyk index when the --update option is specified.

PARAMETERS

The parameter is not optional. It specifies the name of a (local) directory that must have been created previously with Kasyk initializer (kasyknew). If the --update option is not specified, then the Kasyk configuration XML of the Kasyk index specified will be sent to standard output (STDOUT).

OPTIONS

--update filename or -U filename: Update the Kasyk configuration XML of the indicated Kasyk index with the contents of the specified file or with the information provided on standard input (STDIN) if "-" is specified as the filename.
--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.

obtaining configuration of an index on standard output

 $ kasykconfig localindex <ENTER>
 <kasyk:config xmlns:kasyk="http://www.kasyk.org/1.0">
  <creation>
   <property name="filename" type="string" value="unique"/>
   <property name="changed" type="number" value="keyed" hitlist="no"/>
   <texttype name="title" weight="2.5" hitlist="yes"/>
  </creation>
  <searching location="3333"/>
 </kasyk:config>
 $

Send the Kasyk configuration XML of the Kasyk index "localindex" to standard output (STDOUT).

obtaining configuration of an index in a file

 $ kasykconfig localindex >configfile <ENTER>
 $

Write the Kasyk configuration XML of the Kasyk index "localindex" to file "configfile".

updating configuration of an index from a file

 $ kasykconfig --update configfile localindex <ENTER>
 $

Update the Kasyk configuration XML of Kasyk index "localindex" with the contents of file "configfile".

update configuration of an index from standard input

 $ kasykconfig localindex | xsltproc changes.xslt - | kasykconfig --update - localindex <ENTER>

Output the current Kasyk configuration XML of the Kasyk index "localindex" to act as input to the XSLT processor "xsltproc" using the stylesheet "changes.xslt" and use that result as the new configuration of the Kasyk index "localindex".

IMPLEMENTATION DETAILS

Please note that as yet only the validity of any new configuration XML is checked by itself, without taking potential conflicts with any current settings into account. Please also note that any changes made to the contents of the <creation> container are ignored, as these are only read when the first Kasyk document sequence XML is indexed with Kasyk indexer (kasykindex).

KNOWN BUGS

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

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.