X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzebraidx.xml;h=b733d5cc76ff6e21eea6eee5117b48534f6944f4;hp=c399dd969206a61b72389c60ac7f4701300863bd;hb=8a0144a3925311102133d62ac6258ace8d7187eb;hpb=4fe772289b1ab968655c27b144d08fc69c113fd9 diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index c399dd9..b733d5c 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,40 +1,146 @@ - - - Running the Maintenance Interface (zebraidx) - - - The following is a complete reference to the command line interface to - the zebraidx application. - - - - Syntax - - - $ zebraidx [options] command [directory] ... - - - Options: + + %local; + + %entities; + + %idcommon; +]> + + + zebra + &version; + Index Data + + + + zebraidx + 1 + Commands + + + + zebraidx + &zebra; Administrative Tool + + + + + zebraidx + + + + + + + + + + + + + command + file + + + + 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 + - - -t type + update directory - Update all files as type. Currently, the - types supported are text and - grs.subtype. - If no subtype is provided for the GRS - (General Record Structure) type, the canonical input format - is assumed (see ). - Generally, it is probably advisable to specify the record types - in the zebra.cfg file (see - ), to avoid confusion at - subsequent updates. + 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. + adelete directory + + + Remove the records corresponding to the files found under + directory from the register. + Unlike command delete this command does not + fail if a record does not exist (but which is attempted deleted). + + + + + 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). + + + + + check options + + Runs consistency check of register. May take a long time. + Options may be one of quick, + default or full. + + + + 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 + + + -c config-file @@ -45,25 +151,36 @@ - -g group + -d database - Update the files according to the group - settings for group - (see ). + The records located should be associated with the database name + database for access through the + &acro.z3950; server. - -d database + -f number - The records located should be associated with the database name - database for access through the Z39.50 server. + Specify how many per-record log lines, zebraidx, should produce during + indexing and during register check (check command). If this option + is not given, a value of 1000 is used. + + + + + -g group + + + Update the files according to the group + settings for group + (see &zebra; Configuration File in + the &zebra; manual). - -l file @@ -73,7 +190,15 @@ - + + -L + + + Makes zebraidx skip symbolic links. By default, zebraidx follows + them. + + + -m mbytes @@ -89,7 +214,8 @@ Disable the use of shadow registers for this operation - (see ). + (see Shadow Registers in + the &zebra; manual). @@ -105,78 +231,67 @@ - -V - - - Show Zebra version. - - - - - -v level - - - Set the log level to level. - level should be one of - none, debug, and - all. - - - - - - - - Commands - - - - update directory + -t type - Update the register with the files contained in - directory. - If no directory is provided, a list of files is read from - stdin. - See . + 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. + - delete directory + -V - Remove the records corresponding to the files found under - directory from the register. + Show &zebra; version. - commit + -v level - 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 ). + Set the log level to level. + level should be one of + none, debug, and + all. - + + FILES + + zebra.cfg + + + SEE ALSO + + + zebrasrv + 8 + + + + - - +