doc/zebraidx.xml

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