1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
4 <!ENTITY % local SYSTEM "local.ent">
6 <!ENTITY % entities SYSTEM "entities.ent">
8 <!ENTITY % idcommon SYSTEM "common/common.ent">
11 <!-- $Id: zebraidx.xml,v 1.15 2007-12-20 11:15:41 adam Exp $ -->
12 <refentry id="zebraidx">
14 <productname>zebra</productname>
15 <productnumber>&version;</productnumber>
19 <refentrytitle>zebraidx</refentrytitle>
20 <manvolnum>1</manvolnum>
24 <refname>zebraidx</refname>
25 <refpurpose>&zebra; Administrative Tool</refpurpose>
30 <command>zebraidx</command>
31 <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
32 <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
33 <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
34 <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
35 <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
36 <arg choice="opt"><option>-n</option></arg>
37 <arg choice="opt"><option>-s</option></arg>
38 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
39 <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
40 <arg choice="opt"><option>-L</option></arg>
41 <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
42 <arg choice="opt"><option>-v</option></arg>
43 <arg choice="req"><replaceable>command</replaceable></arg>
44 <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
48 <refsect1><title>DESCRIPTION</title>
50 <command>zebraidx</command> allows you to insert, delete or updates
51 records in &zebra;. <command>zebraidx</command> accepts a set options
52 (see below) and exactly one command (mandatory).
56 <title>COMMANDS</title>
60 <term>update <replaceable>directory</replaceable></term>
63 Update the register with the files contained in
64 <replaceable>directory</replaceable>.
65 If no directory is provided, a list of files is read from
66 <literal>stdin</literal>.
67 See <link linkend="administration">Administration</link> in the &zebra;
73 <term>delete <replaceable>directory</replaceable></term>
76 Remove the records corresponding to the files found under
77 <replaceable>directory</replaceable> from the register.
82 <term>adelete <replaceable>directory</replaceable></term>
85 Remove the records corresponding to the files found under
86 <replaceable>directory</replaceable> from the register.
87 Unlike command <literal>delete</literal> this command does not
88 fail if a record does not exist (but which is attempted deleted).
96 Write the changes resulting from the last <literal>update</literal>
97 commands to the register. This command is only available if the use of
98 shadow register files is enabled
99 (see <link linkend="shadow-registers">Shadow Registers</link> in the
107 Clean shadow files and "forget" changes.
111 <term>create <replaceable>database</replaceable></term>
117 <term>drop <replaceable>database</replaceable></term>
119 Drop database (delete database).
125 Deletes an entire register (all files in shadow+register areas).
131 <title>OPTIONS</title>
135 <term>-t <replaceable>type</replaceable></term>
138 Update all files as <replaceable>type</replaceable>. Currently, the
139 types supported are <literal>text</literal>, <literal>alvis</literal>
140 and <literal>grs</literal><replaceable>.subtype</replaceable>.
141 Generally, it is probably advisable to specify the record types
142 in the <literal>zebra.cfg</literal> file (see
143 <link linkend="record-types">Record Types</link> in the &zebra; manual),
144 to avoid confusion at subsequent updates.
149 <term>-c <replaceable>config-file</replaceable></term>
152 Read the configuration file
153 <replaceable>config-file</replaceable> instead of
154 <literal>zebra.cfg</literal>.
159 <term>-g <replaceable>group</replaceable></term>
162 Update the files according to the group
163 settings for <replaceable>group</replaceable>
164 (see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
170 <term>-d <replaceable>database</replaceable></term>
173 The records located should be associated with the database name
174 <replaceable>database</replaceable> for access through the &acro.z3950; server.
180 <term>-l <replaceable>file</replaceable></term>
183 Write log messages to <replaceable>file</replaceable> instead
184 of <literal>stderr</literal>.
190 <term>-m <replaceable>mbytes</replaceable></term>
193 Use <replaceable>mbytes</replaceable> of memory before flushing
194 keys to background storage. This setting affects performance when
195 updating large databases.
203 Makes zebraidx skip symbolic links. By default, zebraidx follows
212 Disable the use of shadow registers for this operation
213 (see <link linkend="shadow-registers">Shadow Registers in
214 the &zebra; manual</link>).
222 Show analysis of the indexing process. The maintenance
223 program works in a read-only mode and doesn't change the state
224 of the index. This options is very useful when you wish to test a
233 Show &zebra; version.
238 <term>-v <replaceable>level</replaceable></term>
241 Set the log level to <replaceable>level</replaceable>.
242 <replaceable>level</replaceable> should be one of
243 <literal>none</literal>, <literal>debug</literal>, and
244 <literal>all</literal>.
250 <refsect1><title>FILES</title>
252 <filename>zebra.cfg</filename>
255 <refsect1><title>SEE ALSO</title>
258 <refentrytitle>zebrasrv</refentrytitle>
259 <manvolnum>8</manvolnum>
265 <!-- Keep this comment at the end of the file
270 sgml-minimize-attributes:nil
271 sgml-always-quote-attributes:t
274 sgml-parent-document:nil
275 sgml-local-catalogs: nil
276 sgml-namecase-general:t