doc/zebraidx.xml

   1 <chapter id="zebraidx">
   2  <!-- $Id: zebraidx.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
   3  <title>Running the Maintenance Interface (zebraidx)</title>
   4
   5  <para>
   6   The following is a complete reference to the command line interface to
   7   the <literal>zebraidx</literal> application.
   8  </para>
   9
  10  <para>
  11   Syntax
  12
  13   <screen>
  14    $ zebraidx &lsqb;options&rsqb; command &lsqb;directory&rsqb; ...
  15   </screen>
  16
  17   Options:
  18   <variablelist>
  19
  20    <varlistentry>
  21     <term>-t <replaceable>type</replaceable></term>
  22     <listitem>
  23      <para>
  24       Update all files as <replaceable>type</replaceable>. Currently, the
  25       types supported are <literal>text</literal> and
  26       <literal>grs</literal><replaceable>.subtype</replaceable>.
  27       If no <replaceable>subtype</replaceable> is provided for the GRS
  28       (General Record Structure) type, the canonical input format
  29       is assumed (see <xref linkend="local-representation"/>).
  30        Generally, it is probably advisable to specify the record types
  31        in the <literal>zebra.cfg</literal> file (see
  32        <xref linkend="record-types"/>), to avoid confusion at
  33         subsequent updates.
  34      </para>
  35     </listitem>
  36    </varlistentry>
  37    <varlistentry>
  38     <term>-c <replaceable>config-file</replaceable></term>
  39     <listitem>
  40      <para>
  41       Read the configuration file
  42       <replaceable>config-file</replaceable> instead of
  43       <literal>zebra.cfg</literal>.
  44      </para>
  45     </listitem>
  46    </varlistentry>
  47    <varlistentry>
  48     <term>-g <replaceable>group</replaceable></term>
  49     <listitem>
  50      <para>
  51       Update the files according to the group
  52       settings for <replaceable>group</replaceable>
  53       (see <xref linkend="configuration-file"/>).
  54      </para>
  55     </listitem>
  56    </varlistentry>
  57    <varlistentry>
  58     <term>-d <replaceable>database</replaceable></term>
  59     <listitem>
  60      <para>
  61       The records located should be associated with the database name
  62       <replaceable>database</replaceable> for access through the Z39.50 server.
  63      </para>
  64     </listitem>
  65    </varlistentry>
  66
  67    <varlistentry>
  68     <term>-l <replaceable>file</replaceable></term>
  69     <listitem>
  70      <para>
  71       Write log messages to <replaceable>file</replaceable> instead
  72       of <literal>stderr</literal>.
  73      </para>
  74     </listitem>
  75    </varlistentry>
  76
  77    <varlistentry>
  78     <term>-m <replaceable>mbytes</replaceable></term>
  79     <listitem>
  80      <para>
  81       Use <replaceable>mbytes</replaceable> of megabytes before flushing
  82       keys to background storage. This setting affects performance when
  83       updating large databases.
  84      </para>
  85     </listitem>
  86    </varlistentry>
  87    <varlistentry>
  88     <term>-n</term>
  89     <listitem>
  90      <para>
  91       Disable the use of shadow registers for this operation
  92       (see <xref linkend="shadow-registers"/>).
  93      </para>
  94     </listitem>
  95    </varlistentry>
  96    <varlistentry>
  97     <term>-s</term>
  98     <listitem>
  99      <para>
 100       Show analysis of the indexing process. The maintenance
 101       program works in a read-only mode and doesn't change the state
 102       of the index. This options is very useful when you wish to test a
 103       new profile.
 104      </para>
 105     </listitem>
 106    </varlistentry>
 107    <varlistentry>
 108     <term>-V</term>
 109     <listitem>
 110      <para>
 111       Show Zebra version.
 112      </para>
 113     </listitem>
 114    </varlistentry>
 115    <varlistentry>
 116     <term>-v <replaceable>level</replaceable></term>
 117     <listitem>
 118      <para>
 119       Set the log level to <replaceable>level</replaceable>.
 120       <replaceable>level</replaceable> should be one of
 121       <literal>none</literal>, <literal>debug</literal>, and
 122       <literal>all</literal>.
 123      </para>
 124     </listitem>
 125    </varlistentry>
 126   </variablelist>
 127  </para>
 128
 129  <para>
 130   Commands
 131   <variablelist>
 132
 133    <varlistentry>
 134     <term>update <replaceable>directory</replaceable></term>
 135     <listitem>
 136      <para>
 137       Update the register with the files contained in
 138       <replaceable>directory</replaceable>.
 139       If no directory is provided, a list of files is read from
 140       <literal>stdin</literal>.
 141       See <xref linkend="administration"/>.
 142      </para>
 143     </listitem>
 144    </varlistentry>
 145    <varlistentry>
 146     <term>delete <replaceable>directory</replaceable></term>
 147     <listitem>
 148      <para>
 149       Remove the records corresponding to the files found under
 150       <replaceable>directory</replaceable> from the register.
 151      </para>
 152     </listitem>
 153    </varlistentry>
 154    <varlistentry>
 155     <term>commit</term>
 156     <listitem>
 157      <para>
 158       Write the changes resulting from the last <literal>update</literal>
 159       commands to the register. This command is only available if the use of
 160       shadow register files is enabled
 161       (see <xref linkend="shadow-registers"/>).
 162      </para>
 163     </listitem>
 164    </varlistentry>
 165   </variablelist>
 166  </para>
 167
 168 </chapter>
 169  <!-- Keep this comment at the end of the file
 170  Local variables:
 171  mode: sgml
 172  sgml-omittag:t
 173  sgml-shorttag:t
 174  sgml-minimize-attributes:nil
 175  sgml-always-quote-attributes:t
 176  sgml-indent-step:1
 177  sgml-indent-data:t
 178  sgml-parent-document: "zebra.xml"
 179  sgml-local-catalogs: nil
 180  sgml-namecase-general:t
 181  End:
 182  -->