X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzebraidx.xml;h=b733d5cc76ff6e21eea6eee5117b48534f6944f4;hp=609ad35b9ed97d47d16a9917509e31ae0c1d99b7;hb=8a0144a3925311102133d62ac6258ace8d7187eb;hpb=3f3bb5184cb06221655717e9cfeb646dc699ead5 diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index 609ad35..b733d5c 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,60 +1,61 @@ - %local; %entities; - - %common; + + %idcommon; ]> - zebra &version; + Index Data zebraidx 1 + Commands - + zebraidx - Zebra Administrative Tool + &zebra; Administrative Tool - + zebraidx - - + + + + - - - + command file - + DESCRIPTION zebraidx allows you to insert, delete or updates - records in Zebra. zebraidx accepts a set options + records in &zebra;. zebraidx accepts a set options (see below) and exactly one command (mandatory). COMMANDS - + update directory @@ -64,7 +65,7 @@ directory. If no directory is provided, a list of files is read from stdin. - See Administration in the Zebra + See Administration in the &zebra; Manual. @@ -79,6 +80,17 @@ + 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 @@ -86,15 +98,23 @@ 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). + &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 @@ -119,78 +139,73 @@ OPTIONS - + - -t type + -c config-file - 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. + Read the configuration file + config-file instead of + zebra.cfg. - -c config-file + -d database - Read the configuration file - config-file instead of - zebra.cfg. + The records located should be associated with the database name + database for access through the + &acro.z3950; server. - -g group + -f number - Update the files according to the group - settings for group - (see Zebra Configuration File in - the Zebra manual). - + 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. + - -d database + -g group - The records located should be associated with the database name - database for access through the Z39.50 server. + Update the files according to the group + settings for group + (see &zebra; Configuration File in + the &zebra; manual). - -l file - + Write log messages to file instead of stderr. - - -m mbytes + -L - Use mbytes of memory before flushing - keys to background storage. This setting affects performance when - updating large databases. + Makes zebraidx skip symbolic links. By default, zebraidx follows + them. - -L + -m mbytes - Makes zebraidx skip symbolic links. By default, zebraidx follows - them. + Use mbytes of memory before flushing + keys to background storage. This setting affects performance when + updating large databases. @@ -200,7 +215,7 @@ Disable the use of shadow registers for this operation (see Shadow Registers in - the Zebra manual). + the &zebra; manual). @@ -216,14 +231,29 @@ + -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. + + + + + -V - Show Zebra version. + Show &zebra; version. - + -v level @@ -248,7 +278,7 @@ 8 - +