doc/zebraidx.xml

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