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>-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>
  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>clean</term>
 107     <listitem><para>
 108       Clean shadow files and "forget" changes.
 109    </para></listitem>
 110    </varlistentry>
 111    <varlistentry>
 112     <term>create <replaceable>database</replaceable></term>
 113     <listitem><para>
 114       Create database.
 115      </para></listitem>
 116    </varlistentry>
 117    <varlistentry>
 118     <term>drop <replaceable>database</replaceable></term>
 119     <listitem><para>
 120       Drop database (delete database).
 121      </para></listitem>
 122    </varlistentry>
 123    <varlistentry>
 124     <term>init</term>
 125     <listitem><para>
 126       Deletes an entire register (all files in shadow+register areas).
 127      </para></listitem>
 128    </varlistentry>
 129   </variablelist>
 130  </refsect1>
 131  <refsect1>
 132   <title>OPTIONS</title>
 133   <variablelist>
 134
 135    <varlistentry>
 136     <term>-t <replaceable>type</replaceable></term>
 137     <listitem>
 138      <para>
 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.
 146      </para>
 147     </listitem>
 148    </varlistentry>
 149    <varlistentry>
 150     <term>-c <replaceable>config-file</replaceable></term>
 151     <listitem>
 152      <para>
 153       Read the configuration file
 154       <replaceable>config-file</replaceable> instead of
 155       <literal>zebra.cfg</literal>.
 156      </para>
 157     </listitem>
 158    </varlistentry>
 159    <varlistentry>
 160     <term>-g <replaceable>group</replaceable></term>
 161     <listitem>
 162      <para>
 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
 166       the &zebra; manual).
 167    </para>
 168     </listitem>
 169    </varlistentry>
 170    <varlistentry>
 171     <term>-d <replaceable>database</replaceable></term>
 172     <listitem>
 173      <para>
 174       The records located should be associated with the database name
 175       <replaceable>database</replaceable> for access through the &acro.z3950; server.
 176      </para>
 177     </listitem>
 178    </varlistentry>
 179
 180    <varlistentry>
 181     <term>-l <replaceable>file</replaceable></term>
 182     <listitem>
 183    <para>
 184       Write log messages to <replaceable>file</replaceable> instead
 185       of <literal>stderr</literal>.
 186      </para>
 187     </listitem>
 188    </varlistentry>
 189
 190    <varlistentry>
 191     <term>-m <replaceable>mbytes</replaceable></term>
 192     <listitem>
 193      <para>
 194       Use <replaceable>mbytes</replaceable> of memory before flushing
 195       keys to background storage. This setting affects performance when
 196       updating large databases.
 197      </para>
 198     </listitem>
 199    </varlistentry>
 200    <varlistentry>
 201     <term>-L</term>
 202     <listitem>
 203      <para>
 204       Makes zebraidx skip symbolic links. By default, zebraidx follows
 205       them.
 206      </para>
 207     </listitem>
 208    </varlistentry>
 209    <varlistentry>
 210     <term>-n</term>
 211     <listitem>
 212      <para>
 213       Disable the use of shadow registers for this operation
 214       (see <link linkend="shadow-registers">Shadow Registers in
 215        the &zebra; manual</link>).
 216      </para>
 217     </listitem>
 218    </varlistentry>
 219    <varlistentry>
 220     <term>-s</term>
 221     <listitem>
 222      <para>
 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
 226       new profile.
 227      </para>
 228     </listitem>
 229    </varlistentry>
 230    <varlistentry>
 231     <term>-V</term>
 232     <listitem>
 233      <para>
 234       Show &zebra; version.
 235      </para>
 236     </listitem>
 237    </varlistentry>
 238  <varlistentry>
 239     <term>-v <replaceable>level</replaceable></term>
 240     <listitem>
 241      <para>
 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>.
 246      </para>
 247     </listitem>
 248    </varlistentry>
 249   </variablelist>
 250  </refsect1>
 251  <refsect1><title>FILES</title>
 252   <para>
 253    <filename>zebra.cfg</filename>
 254   </para>
 255  </refsect1>
 256  <refsect1><title>SEE ALSO</title>
 257   <para>
 258    <citerefentry>
 259     <refentrytitle>zebrasrv</refentrytitle>
 260     <manvolnum>8</manvolnum>
 261    </citerefentry>
 262   </para>
 263 </refsect1>
 264 </refentry>
 265
 266 <!-- Keep this comment at the end of the file
 267 Local variables:
 268 mode: sgml
 269 sgml-omittag:t
 270 sgml-shorttag:t
 271 sgml-minimize-attributes:nil
 272 sgml-always-quote-attributes:t
 273 sgml-indent-step:1
 274 sgml-indent-data:t
 275 sgml-parent-document:nil
 276 sgml-local-catalogs: nil
 277 sgml-namecase-general:t
 278 End:
 279 -->