1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
<!ENTITY % local SYSTEM "local.ent">
%local;
<!ENTITY % entities SYSTEM "entities.ent">
%entities;
<!ENTITY % idcommon SYSTEM "common/common.ent">
%idcommon;
]>
<refentry id="zebraidx">
<refentryinfo>
<productname>zebra</productname>
<productnumber>&version;</productnumber>
<orgname>Index Data</orgname>
</refentryinfo>
<refmeta>
<refentrytitle>zebraidx</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>zebraidx</refname>
<refpurpose>&zebra; Administrative Tool</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>zebraidx</command>
<arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
<arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
<arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
<arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
<arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
<arg choice="opt"><option>-L</option></arg>
<arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
<arg choice="opt"><option>-n</option></arg>
<arg choice="opt"><option>-s</option></arg>
<arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
<arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
<arg choice="opt"><option>-v</option></arg>
<arg choice="req"><replaceable>command</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para>
<command>zebraidx</command> allows you to insert, delete or updates
records in &zebra;. <command>zebraidx</command> accepts a set options
(see below) and exactly one command (mandatory).
</para>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<variablelist>
<varlistentry>
<term>update <replaceable>directory</replaceable></term>
<listitem>
<para>
Update the register with the files contained in
<replaceable>directory</replaceable>.
If no directory is provided, a list of files is read from
<literal>stdin</literal>.
See <link linkend="administration">Administration</link> in the &zebra;
Manual.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>delete <replaceable>directory</replaceable></term>
<listitem>
<para>
Remove the records corresponding to the files found under
<replaceable>directory</replaceable> from the register.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>adelete <replaceable>directory</replaceable></term>
<listitem>
<para>
Remove the records corresponding to the files found under
<replaceable>directory</replaceable> from the register.
Unlike command <literal>delete</literal> this command does not
fail if a record does not exist (but which is attempted deleted).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>commit</term>
<listitem>
<para>
Write the changes resulting from the last <literal>update</literal>
commands to the register. This command is only available if the use of
shadow register files is enabled
(see <link linkend="shadow-registers">Shadow Registers</link> in the
&zebra; Manual).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>check <replaceable>options</replaceable></term>
<listitem><para>
Runs consistency check of register. May take a long time.
Options may be one of <literal>quick</literal>,
<literal>default</literal> or <literal>full</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>clean</term>
<listitem><para>
Clean shadow files and "forget" changes.
</para></listitem>
</varlistentry>
<varlistentry>
<term>create <replaceable>database</replaceable></term>
<listitem><para>
Create database.
</para></listitem>
</varlistentry>
<varlistentry>
<term>drop <replaceable>database</replaceable></term>
<listitem><para>
Drop database (delete database).
</para></listitem>
</varlistentry>
<varlistentry>
<term>init</term>
<listitem><para>
Deletes an entire register (all files in shadow+register areas).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-c <replaceable>config-file</replaceable></term>
<listitem>
<para>
Read the configuration file
<replaceable>config-file</replaceable> instead of
<literal>zebra.cfg</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-d <replaceable>database</replaceable></term>
<listitem>
<para>
The records located should be associated with the database name
<replaceable>database</replaceable> for access through the
&acro.z3950; server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f <replaceable>number</replaceable></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-g <replaceable>group</replaceable></term>
<listitem>
<para>
Update the files according to the group
settings for <replaceable>group</replaceable>
(see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
the &zebra; manual).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-l <replaceable>file</replaceable></term>
<listitem>
<para>
Write log messages to <replaceable>file</replaceable> instead
of <literal>stderr</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-L</term>
<listitem>
<para>
Makes zebraidx skip symbolic links. By default, zebraidx follows
them.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-m <replaceable>mbytes</replaceable></term>
<listitem>
<para>
Use <replaceable>mbytes</replaceable> of memory before flushing
keys to background storage. This setting affects performance when
updating large databases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-n</term>
<listitem>
<para>
Disable the use of shadow registers for this operation
(see <link linkend="shadow-registers">Shadow Registers in
the &zebra; manual</link>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s</term>
<listitem>
<para>
Show analysis of the indexing process. The maintenance
program works in a read-only mode and doesn't change the state
of the index. This options is very useful when you wish to test a
new profile.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-t <replaceable>type</replaceable></term>
<listitem>
<para>
Update all files as <replaceable>type</replaceable>. Currently, the
types supported are <literal>text</literal>, <literal>alvis</literal>
and <literal>grs</literal><replaceable>.subtype</replaceable>.
Generally, it is probably advisable to specify the record types
in the <literal>zebra.cfg</literal> file (see
<link linkend="record-types">Record Types</link> in the &zebra; manual),
to avoid confusion at subsequent updates.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>
Show &zebra; version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v <replaceable>level</replaceable></term>
<listitem>
<para>
Set the log level to <replaceable>level</replaceable>.
<replaceable>level</replaceable> should be one of
<literal>none</literal>, <literal>debug</literal>, and
<literal>all</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>FILES</title>
<para>
<filename>zebra.cfg</filename>
</para>
</refsect1>
<refsect1><title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>zebrasrv</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document: "idzebra.xml"
sgml-local-catalogs: nil
sgml-namecase-general:t
End:
-->
|
