X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzebraidx.xml;h=45233e4fadbd063ed7370895af050407afbb71c6;hp=c399dd969206a61b72389c60ac7f4701300863bd;hb=d5bb5b72d912f673c7d123fc54d735dee2146003;hpb=4fe772289b1ab968655c27b144d08fc69c113fd9 diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index c399dd9..45233e4 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,20 +1,135 @@ - - - Running the Maintenance Interface (zebraidx) + + %local; + + %entities; + + %idcommon; +]> + + + zebra + &version; + Index Data + + + + zebraidx + 1 + Commands + - - The following is a complete reference to the command line interface to - the zebraidx application. - + + zebraidx + &zebra; Administrative Tool + - - Syntax - - - $ zebraidx [options] command [directory] ... - + + + 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 - Options: + + + 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. + + + + + 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). + + + + + 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 @@ -22,15 +137,12 @@ 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. + 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. @@ -50,8 +162,9 @@ Update the files according to the group settings for group - (see ). - + (see &zebra; Configuration File in + the &zebra; manual). + @@ -59,21 +172,21 @@ The records located should be associated with the database name - database for access through the Z39.50 server. + database for access through the &acro.z3950; server. - + -l file - + Write log messages to file instead of stderr. - + -m mbytes @@ -85,11 +198,21 @@ + -L + + + Makes zebraidx skip symbolic links. By default, zebraidx follows + them. + + + + -n Disable the use of shadow registers for this operation - (see ). + (see Shadow Registers in + the &zebra; manual). @@ -108,11 +231,11 @@ -V - Show Zebra version. + Show &zebra; version. - + -v level @@ -124,59 +247,33 @@ - - - - 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 . - - - - - 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 ). - - - - - + + FILES + + zebra.cfg + + + SEE ALSO + + + zebrasrv + 8 + + + + - - +