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