doc/zebraidx.xml

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