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.14 2007-05-24 13:44:09 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>commit</term>
  83     <listitem>
  84      <para>
  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
  89       &zebra; Manual).
  90      </para>
  91     </listitem>
  92    </varlistentry>
  93    <varlistentry>
  94     <term>clean</term>
  95     <listitem><para>
  96       Clean shadow files and "forget" changes.
  97    </para></listitem>
  98    </varlistentry>
  99    <varlistentry>
 100     <term>create <replaceable>database</replaceable></term>
 101     <listitem><para>
 102       Create database.
 103      </para></listitem>
 104    </varlistentry>
 105    <varlistentry>
 106     <term>drop <replaceable>database</replaceable></term>
 107     <listitem><para>
 108       Drop database (delete database).
 109      </para></listitem>
 110    </varlistentry>
 111    <varlistentry>
 112     <term>init</term>
 113     <listitem><para>
 114       Deletes an entire register (all files in shadow+register areas).
 115      </para></listitem>
 116    </varlistentry>
 117   </variablelist>
 118  </refsect1>
 119  <refsect1>
 120   <title>OPTIONS</title>
 121   <variablelist>
 122
 123    <varlistentry>
 124     <term>-t <replaceable>type</replaceable></term>
 125     <listitem>
 126      <para>
 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.
 134      </para>
 135     </listitem>
 136    </varlistentry>
 137    <varlistentry>
 138     <term>-c <replaceable>config-file</replaceable></term>
 139     <listitem>
 140      <para>
 141       Read the configuration file
 142       <replaceable>config-file</replaceable> instead of
 143       <literal>zebra.cfg</literal>.
 144      </para>
 145     </listitem>
 146    </varlistentry>
 147    <varlistentry>
 148     <term>-g <replaceable>group</replaceable></term>
 149     <listitem>
 150      <para>
 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
 154       the &zebra; manual).
 155    </para>
 156     </listitem>
 157    </varlistentry>
 158    <varlistentry>
 159     <term>-d <replaceable>database</replaceable></term>
 160     <listitem>
 161      <para>
 162       The records located should be associated with the database name
 163       <replaceable>database</replaceable> for access through the &acro.z3950; server.
 164      </para>
 165     </listitem>
 166    </varlistentry>
 167
 168    <varlistentry>
 169     <term>-l <replaceable>file</replaceable></term>
 170     <listitem>
 171    <para>
 172       Write log messages to <replaceable>file</replaceable> instead
 173       of <literal>stderr</literal>.
 174      </para>
 175     </listitem>
 176    </varlistentry>
 177
 178    <varlistentry>
 179     <term>-m <replaceable>mbytes</replaceable></term>
 180     <listitem>
 181      <para>
 182       Use <replaceable>mbytes</replaceable> of memory before flushing
 183       keys to background storage. This setting affects performance when
 184       updating large databases.
 185      </para>
 186     </listitem>
 187    </varlistentry>
 188    <varlistentry>
 189     <term>-L</term>
 190     <listitem>
 191      <para>
 192       Makes zebraidx skip symbolic links. By default, zebraidx follows
 193       them.
 194      </para>
 195     </listitem>
 196    </varlistentry>
 197    <varlistentry>
 198     <term>-n</term>
 199     <listitem>
 200      <para>
 201       Disable the use of shadow registers for this operation
 202       (see <link linkend="shadow-registers">Shadow Registers in
 203        the &zebra; manual</link>).
 204      </para>
 205     </listitem>
 206    </varlistentry>
 207    <varlistentry>
 208     <term>-s</term>
 209     <listitem>
 210      <para>
 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
 214       new profile.
 215      </para>
 216     </listitem>
 217    </varlistentry>
 218    <varlistentry>
 219     <term>-V</term>
 220     <listitem>
 221      <para>
 222       Show &zebra; version.
 223      </para>
 224     </listitem>
 225    </varlistentry>
 226  <varlistentry>
 227     <term>-v <replaceable>level</replaceable></term>
 228     <listitem>
 229      <para>
 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>.
 234      </para>
 235     </listitem>
 236    </varlistentry>
 237   </variablelist>
 238  </refsect1>
 239  <refsect1><title>FILES</title>
 240   <para>
 241    <filename>zebra.cfg</filename>
 242   </para>
 243  </refsect1>
 244  <refsect1><title>SEE ALSO</title>
 245   <para>
 246    <citerefentry>
 247     <refentrytitle>zebrasrv</refentrytitle>
 248     <manvolnum>8</manvolnum>
 249    </citerefentry>
 250   </para>
 251 </refsect1>
 252 </refentry>
 253
 254 <!-- Keep this comment at the end of the file
 255 Local variables:
 256 mode: sgml
 257 sgml-omittag:t
 258 sgml-shorttag:t
 259 sgml-minimize-attributes:nil
 260 sgml-always-quote-attributes:t
 261 sgml-indent-step:1
 262 sgml-indent-data:t
 263 sgml-parent-document:nil
 264 sgml-local-catalogs: nil
 265 sgml-namecase-general:t
 266 End:
 267 -->