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 % common SYSTEM "common/common.ent">
11 <!-- $Id: zebraidx.xml,v 1.9 2006-09-05 12:01:31 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.
85 Write the changes resulting from the last <literal>update</literal>
86 commands to the register. This command is only available if the use of
87 shadow register files is enabled
88 (see <link linkend="shadow-registers">Shadow Registers</link> in the
96 Clean shadow files and "forget" changes.
100 <term>create <replaceable>database</replaceable></term>
106 <term>drop <replaceable>database</replaceable></term>
108 Drop database (delete database).
114 Deletes an entire register (all files in shadow+register areas).
120 <title>OPTIONS</title>
124 <term>-t <replaceable>type</replaceable></term>
127 Update all files as <replaceable>type</replaceable>. Currently, the
128 types supported are <literal>text</literal>, <literal>alvis</literal>
129 and <literal>grs</literal><replaceable>.subtype</replaceable>.
130 Generally, it is probably advisable to specify the record types
131 in the <literal>zebra.cfg</literal> file (see
132 <link linkend="record-types">Record Types</link> in the Zebra manual),
133 to avoid confusion at subsequent updates.
138 <term>-c <replaceable>config-file</replaceable></term>
141 Read the configuration file
142 <replaceable>config-file</replaceable> instead of
143 <literal>zebra.cfg</literal>.
148 <term>-g <replaceable>group</replaceable></term>
151 Update the files according to the group
152 settings for <replaceable>group</replaceable>
153 (see <link linkend="zebra-cfg">Zebra Configuration File</link> in
159 <term>-d <replaceable>database</replaceable></term>
162 The records located should be associated with the database name
163 <replaceable>database</replaceable> for access through the Z39.50 server.
169 <term>-l <replaceable>file</replaceable></term>
172 Write log messages to <replaceable>file</replaceable> instead
173 of <literal>stderr</literal>.
179 <term>-m <replaceable>mbytes</replaceable></term>
182 Use <replaceable>mbytes</replaceable> of memory before flushing
183 keys to background storage. This setting affects performance when
184 updating large databases.
192 Makes zebraidx skip symbolic links. By default, zebraidx follows
201 Disable the use of shadow registers for this operation
202 (see <link linkend="shadow-registers">Shadow Registers in
203 the Zebra manual</link>).
211 Show analysis of the indexing process. The maintenance
212 program works in a read-only mode and doesn't change the state
213 of the index. This options is very useful when you wish to test a
227 <term>-v <replaceable>level</replaceable></term>
230 Set the log level to <replaceable>level</replaceable>.
231 <replaceable>level</replaceable> should be one of
232 <literal>none</literal>, <literal>debug</literal>, and
233 <literal>all</literal>.
239 <refsect1><title>FILES</title>
241 <filename>zebra.cfg</filename>
244 <refsect1><title>SEE ALSO</title>
247 <refentrytitle>zebrasrv</refentrytitle>
248 <manvolnum>8</manvolnum>
254 <!-- Keep this comment at the end of the file
259 sgml-minimize-attributes:nil
260 sgml-always-quote-attributes:t
263 sgml-parent-document:nil
264 sgml-local-catalogs: nil
265 sgml-namecase-general:t