doc/zebraidx.xml

   1 <chapter id="zebraidx">
   2  <!-- $Id: zebraidx.xml,v 1.4 2002-10-17 08:10:08 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 &lsqb;options&rsqb; command &lsqb;directory&rsqb; ...
  15   </screen>
  16
  17   Options:
  18    &zebraidx-options;
  19  </para>
  20  <!-- ### swap order of commands and options -->
  21
  22  <para>
  23   Commands
  24   <variablelist>
  25
  26    <varlistentry>
  27     <term>update <replaceable>directory</replaceable></term>
  28     <listitem>
  29      <para>
  30       Update the register with the files contained in
  31       <replaceable>directory</replaceable>.
  32       If no directory is provided, a list of files is read from
  33       <literal>stdin</literal>.
  34       See <xref linkend="administration"/>.
  35      </para>
  36     </listitem>
  37    </varlistentry>
  38    <varlistentry>
  39     <term>delete <replaceable>directory</replaceable></term>
  40     <listitem>
  41      <para>
  42       Remove the records corresponding to the files found under
  43       <replaceable>directory</replaceable> from the register.
  44      </para>
  45     </listitem>
  46    </varlistentry>
  47    <varlistentry>
  48     <term>commit</term>
  49     <listitem>
  50      <para>
  51       Write the changes resulting from the last <literal>update</literal>
  52       commands to the register. This command is only available if the use of
  53       shadow register files is enabled
  54       (see <xref linkend="shadow-registers"/>).
  55      </para>
  56     </listitem>
  57    </varlistentry>
  58   </variablelist>
  59  </para>
  60
  61 </chapter>
  62  <!-- Keep this comment at the end of the file
  63  Local variables:
  64  mode: sgml
  65  sgml-omittag:t
  66  sgml-shorttag:t
  67  sgml-minimize-attributes:nil
  68  sgml-always-quote-attributes:t
  69  sgml-indent-step:1
  70  sgml-indent-data:t
  71  sgml-parent-document: "zebra.xml"
  72  sgml-local-catalogs: nil
  73  sgml-namecase-general:t
  74  End:
  75  -->