doc/zebraidx.xml

   1 <chapter id="zebraidx">
   2  <!-- $Id: zebraidx.xml,v 1.5 2002-10-20 14:02:03 mike 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 [options] command [directory] ...
  15   </screen>
  16
  17   Options:
  18    &zebraidx-options;
  19  </para>
  20  <!-- ### swap order of commands and options -->
  21
  22  <para>
  23   Commands
  24
  25   <!-- From .../zebra/index/main.c:
  26         update          *
  27         update1
  28         update2
  29         dump
  30         del, delete     *
  31         init
  32         commit          *
  33         clean
  34         stat, status
  35         dump, dumpdict
  36         compact
  37        ### Only the ones marked * have been documented.
  38   -->
  39
  40   <variablelist>
  41
  42    <varlistentry>
  43     <term>update <replaceable>directory</replaceable></term>
  44     <listitem>
  45      <para>
  46       Update the register with the files contained in
  47       <replaceable>directory</replaceable>.
  48       If no directory is provided, a list of files is read from
  49       <literal>stdin</literal>.
  50       See <xref linkend="administration"/>.
  51      </para>
  52     </listitem>
  53    </varlistentry>
  54    <varlistentry>
  55     <term>delete <replaceable>directory</replaceable></term>
  56     <listitem>
  57      <para>
  58       Remove the records corresponding to the files found under
  59       <replaceable>directory</replaceable> from the register.
  60      </para>
  61     </listitem>
  62    </varlistentry>
  63    <varlistentry>
  64     <term>commit</term>
  65     <listitem>
  66      <para>
  67       Write the changes resulting from the last <literal>update</literal>
  68       commands to the register. This command is only available if the use of
  69       shadow register files is enabled
  70       (see <xref linkend="shadow-registers"/>).
  71      </para>
  72     </listitem>
  73    </varlistentry>
  74   </variablelist>
  75  </para>
  76
  77 </chapter>
  78  <!-- Keep this comment at the end of the file
  79  Local variables:
  80  mode: sgml
  81  sgml-omittag:t
  82  sgml-shorttag:t
  83  sgml-minimize-attributes:nil
  84  sgml-always-quote-attributes:t
  85  sgml-indent-step:1
  86  sgml-indent-data:t
  87  sgml-parent-document: "zebra.xml"
  88  sgml-local-catalogs: nil
  89  sgml-namecase-general:t
  90  End:
  91  -->