1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/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>
15 <info><orgname>Index Data</orgname></info>
19 <refentrytitle>zebraidx</refentrytitle>
20 <manvolnum>1</manvolnum>
21 <refmiscinfo class="manual">Commands</refmiscinfo>
25 <refname>zebraidx</refname>
26 <refpurpose>&zebra; Administrative Tool</refpurpose>
31 <command>zebraidx</command>
32 <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
33 <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
34 <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
35 <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
36 <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
37 <arg choice="opt"><option>-n</option></arg>
38 <arg choice="opt"><option>-s</option></arg>
39 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
40 <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
41 <arg choice="opt"><option>-L</option></arg>
42 <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
43 <arg choice="opt"><option>-v</option></arg>
44 <arg choice="req"><replaceable>command</replaceable></arg>
45 <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
49 <refsect1><title>DESCRIPTION</title>
51 <command>zebraidx</command> allows you to insert, delete or updates
52 records in &zebra;. <command>zebraidx</command> accepts a set options
53 (see below) and exactly one command (mandatory).
57 <title>COMMANDS</title>
61 <term>update <replaceable>directory</replaceable></term>
64 Update the register with the files contained in
65 <replaceable>directory</replaceable>.
66 If no directory is provided, a list of files is read from
67 <literal>stdin</literal>.
68 See <link linkend="administration">Administration</link> in the &zebra;
74 <term>delete <replaceable>directory</replaceable></term>
77 Remove the records corresponding to the files found under
78 <replaceable>directory</replaceable> from the register.
83 <term>adelete <replaceable>directory</replaceable></term>
86 Remove the records corresponding to the files found under
87 <replaceable>directory</replaceable> from the register.
88 Unlike command <literal>delete</literal> this command does not
89 fail if a record does not exist (but which is attempted deleted).
97 Write the changes resulting from the last <literal>update</literal>
98 commands to the register. This command is only available if the use of
99 shadow register files is enabled
100 (see <link linkend="shadow-registers">Shadow Registers</link> in the
108 Clean shadow files and "forget" changes.
112 <term>create <replaceable>database</replaceable></term>
118 <term>drop <replaceable>database</replaceable></term>
120 Drop database (delete database).
126 Deletes an entire register (all files in shadow+register areas).
132 <title>OPTIONS</title>
136 <term>-t <replaceable>type</replaceable></term>
139 Update all files as <replaceable>type</replaceable>. Currently, the
140 types supported are <literal>text</literal>, <literal>alvis</literal>
141 and <literal>grs</literal><replaceable>.subtype</replaceable>.
142 Generally, it is probably advisable to specify the record types
143 in the <literal>zebra.cfg</literal> file (see
144 <link linkend="record-types">Record Types</link> in the &zebra; manual),
145 to avoid confusion at subsequent updates.
150 <term>-c <replaceable>config-file</replaceable></term>
153 Read the configuration file
154 <replaceable>config-file</replaceable> instead of
155 <literal>zebra.cfg</literal>.
160 <term>-g <replaceable>group</replaceable></term>
163 Update the files according to the group
164 settings for <replaceable>group</replaceable>
165 (see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
171 <term>-d <replaceable>database</replaceable></term>
174 The records located should be associated with the database name
175 <replaceable>database</replaceable> for access through the &acro.z3950; server.
181 <term>-l <replaceable>file</replaceable></term>
184 Write log messages to <replaceable>file</replaceable> instead
185 of <literal>stderr</literal>.
191 <term>-m <replaceable>mbytes</replaceable></term>
194 Use <replaceable>mbytes</replaceable> of memory before flushing
195 keys to background storage. This setting affects performance when
196 updating large databases.
204 Makes zebraidx skip symbolic links. By default, zebraidx follows
213 Disable the use of shadow registers for this operation
214 (see <link linkend="shadow-registers">Shadow Registers in
215 the &zebra; manual</link>).
223 Show analysis of the indexing process. The maintenance
224 program works in a read-only mode and doesn't change the state
225 of the index. This options is very useful when you wish to test a
234 Show &zebra; version.
239 <term>-v <replaceable>level</replaceable></term>
242 Set the log level to <replaceable>level</replaceable>.
243 <replaceable>level</replaceable> should be one of
244 <literal>none</literal>, <literal>debug</literal>, and
245 <literal>all</literal>.
251 <refsect1><title>FILES</title>
253 <filename>zebra.cfg</filename>
256 <refsect1><title>SEE ALSO</title>
259 <refentrytitle>zebrasrv</refentrytitle>
260 <manvolnum>8</manvolnum>
266 <!-- Keep this comment at the end of the file
271 sgml-minimize-attributes:nil
272 sgml-always-quote-attributes:t
275 sgml-parent-document:nil
276 sgml-local-catalogs: nil
277 sgml-namecase-general:t