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 <refentry id="zebraidx">
13 <productname>zebra</productname>
14 <productnumber>&version;</productnumber>
18 <refentrytitle>zebraidx</refentrytitle>
19 <manvolnum>1</manvolnum>
23 <refname>zebraidx</refname>
24 <refpurpose>&zebra; Administrative Tool</refpurpose>
29 <command>zebraidx</command>
30 <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
31 <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
32 <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
33 <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
34 <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
35 <arg choice="opt"><option>-n</option></arg>
36 <arg choice="opt"><option>-s</option></arg>
37 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
38 <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
39 <arg choice="opt"><option>-L</option></arg>
40 <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
41 <arg choice="opt"><option>-v</option></arg>
42 <arg choice="req"><replaceable>command</replaceable></arg>
43 <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
47 <refsect1><title>DESCRIPTION</title>
49 <command>zebraidx</command> allows you to insert, delete or updates
50 records in &zebra;. <command>zebraidx</command> accepts a set options
51 (see below) and exactly one command (mandatory).
55 <title>COMMANDS</title>
59 <term>update <replaceable>directory</replaceable></term>
62 Update the register with the files contained in
63 <replaceable>directory</replaceable>.
64 If no directory is provided, a list of files is read from
65 <literal>stdin</literal>.
66 See <link linkend="administration">Administration</link> in the &zebra;
72 <term>delete <replaceable>directory</replaceable></term>
75 Remove the records corresponding to the files found under
76 <replaceable>directory</replaceable> from the register.
81 <term>adelete <replaceable>directory</replaceable></term>
84 Remove the records corresponding to the files found under
85 <replaceable>directory</replaceable> from the register.
86 Unlike command <literal>delete</literal> this command does not
87 fail if a record does not exist (but which is attempted deleted).
95 Write the changes resulting from the last <literal>update</literal>
96 commands to the register. This command is only available if the use of
97 shadow register files is enabled
98 (see <link linkend="shadow-registers">Shadow Registers</link> in the
106 Clean shadow files and "forget" changes.
110 <term>create <replaceable>database</replaceable></term>
116 <term>drop <replaceable>database</replaceable></term>
118 Drop database (delete database).
124 Deletes an entire register (all files in shadow+register areas).
130 <title>OPTIONS</title>
134 <term>-t <replaceable>type</replaceable></term>
137 Update all files as <replaceable>type</replaceable>. Currently, the
138 types supported are <literal>text</literal>, <literal>alvis</literal>
139 and <literal>grs</literal><replaceable>.subtype</replaceable>.
140 Generally, it is probably advisable to specify the record types
141 in the <literal>zebra.cfg</literal> file (see
142 <link linkend="record-types">Record Types</link> in the &zebra; manual),
143 to avoid confusion at subsequent updates.
148 <term>-c <replaceable>config-file</replaceable></term>
151 Read the configuration file
152 <replaceable>config-file</replaceable> instead of
153 <literal>zebra.cfg</literal>.
158 <term>-g <replaceable>group</replaceable></term>
161 Update the files according to the group
162 settings for <replaceable>group</replaceable>
163 (see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
169 <term>-d <replaceable>database</replaceable></term>
172 The records located should be associated with the database name
173 <replaceable>database</replaceable> for access through the &acro.z3950; server.
179 <term>-l <replaceable>file</replaceable></term>
182 Write log messages to <replaceable>file</replaceable> instead
183 of <literal>stderr</literal>.
189 <term>-m <replaceable>mbytes</replaceable></term>
192 Use <replaceable>mbytes</replaceable> of memory before flushing
193 keys to background storage. This setting affects performance when
194 updating large databases.
202 Makes zebraidx skip symbolic links. By default, zebraidx follows
211 Disable the use of shadow registers for this operation
212 (see <link linkend="shadow-registers">Shadow Registers in
213 the &zebra; manual</link>).
221 Show analysis of the indexing process. The maintenance
222 program works in a read-only mode and doesn't change the state
223 of the index. This options is very useful when you wish to test a
232 Show &zebra; version.
237 <term>-v <replaceable>level</replaceable></term>
240 Set the log level to <replaceable>level</replaceable>.
241 <replaceable>level</replaceable> should be one of
242 <literal>none</literal>, <literal>debug</literal>, and
243 <literal>all</literal>.
249 <refsect1><title>FILES</title>
251 <filename>zebra.cfg</filename>
254 <refsect1><title>SEE ALSO</title>
257 <refentrytitle>zebrasrv</refentrytitle>
258 <manvolnum>8</manvolnum>
264 <!-- Keep this comment at the end of the file
269 sgml-minimize-attributes:nil
270 sgml-always-quote-attributes:t
273 sgml-parent-document:nil
274 sgml-local-catalogs: nil
275 sgml-namecase-general:t