X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzebraidx.xml;h=c8ad513a14b2db42a33aaac77e421260d84e0987;hp=cbd8c2fb144d51ed136521f3fa016549916eed96;hb=1b8e1d7dfece31918056f76819c18675ed6e781e;hpb=47054fae00306e75212a26ee5305f00032c99001 diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index cbd8c2f..c8ad513 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,16 +1,31 @@ - - - Running the Maintenance Interface (zebraidx) - - - The following is a complete reference to the command line interface to - the zebraidx application. - + + %local; + + %entities; + + %idcommon; +]> + + + + zebra + &version; + - - Syntax - - + + zebraidx + 1 + + + + zebraidx + &zebra; Administrative Tool + + + zebraidx @@ -28,23 +43,225 @@ command file - - + - - Commands - &zebraidx-commands; + DESCRIPTION + + zebraidx allows you to insert, delete or updates + records in &zebra;. zebraidx accepts a set options + (see below) and exactly one command (mandatory). + + + COMMANDS + + + update directory + + + Update the register with the files contained in + directory. + If no directory is provided, a list of files is read from + stdin. + See Administration in the &zebra; + Manual. + + + + + delete directory + + + Remove the records corresponding to the files found under + directory from the register. + + + + + commit + + + Write the changes resulting from the last update + commands to the register. This command is only available if the use of + shadow register files is enabled + (see Shadow Registers in the + &zebra; Manual). + + + + + clean + + Clean shadow files and "forget" changes. + + + + create database + + Create database. + + + + drop database + + Drop database (delete database). + + + + init + + Deletes an entire register (all files in shadow+register areas). + + + + + + OPTIONS + + + + -t type + + + Update all files as type. Currently, the + types supported are text, alvis + and grs.subtype. + Generally, it is probably advisable to specify the record types + in the zebra.cfg file (see + Record Types in the &zebra; manual), + to avoid confusion at subsequent updates. + + + + + -c config-file + + + Read the configuration file + config-file instead of + zebra.cfg. + + + + + -g group + + + Update the files according to the group + settings for group + (see &zebra; Configuration File in + the &zebra; manual). + + + + + -d database + + + The records located should be associated with the database name + database for access through the &z3950; server. + + + + + + -l file + + + Write log messages to file instead + of stderr. + + + + + + -m mbytes + + + Use mbytes of memory before flushing + keys to background storage. This setting affects performance when + updating large databases. + + + + + -L + + + Makes zebraidx skip symbolic links. By default, zebraidx follows + them. + + + + + -n + + + Disable the use of shadow registers for this operation + (see Shadow Registers in + the &zebra; manual). + + + + + -s + + + Show analysis of the indexing process. The maintenance + program works in a read-only mode and doesn't change the state + of the index. This options is very useful when you wish to test a + new profile. + + + + + -V + + + Show &zebra; version. + + + + + -v level + + + Set the log level to level. + level should be one of + none, debug, and + all. + + + + + + FILES + + zebra.cfg + + + SEE ALSO - Options: - &zebraidx-options; - + + zebrasrv + 8 + + + + - - -