doc/zebraidx-commands.xml

   1 <!--
   2    $Id: zebraidx-commands.xml,v 1.1 2003-09-05 10:50:33 adam Exp $
   3    Commands for zebraidx.
   4    Included in both manual and man page for zebraidx
   5 -->
   6 <variablelist>
   7  <varlistentry>
   8   <term>update <replaceable>directory</replaceable></term>
   9   <listitem>
  10    <para>
  11     Update the register with the files contained in
  12     <replaceable>directory</replaceable>.
  13     If no directory is provided, a list of files is read from
  14     <literal>stdin</literal>.
  15     See <xref linkend="administration"/>.
  16    </para>
  17   </listitem>
  18  </varlistentry>
  19  <varlistentry>
  20   <term>delete <replaceable>directory</replaceable></term>
  21   <listitem>
  22    <para>
  23     Remove the records corresponding to the files found under
  24     <replaceable>directory</replaceable> from the register.
  25    </para>
  26   </listitem>
  27  </varlistentry>
  28  <varlistentry>
  29   <term>commit</term>
  30   <listitem>
  31    <para>
  32     Write the changes resulting from the last <literal>update</literal>
  33     commands to the register. This command is only available if the use of
  34     shadow register files is enabled
  35     (see <xref linkend="shadow-registers"/>).
  36    </para>
  37   </listitem>
  38  </varlistentry>
  39  <varlistentry>
  40   <term>clean</term>
  41   <listitem><para>
  42     Clean shadow files and "forget" changes.
  43    </para></listitem>
  44  </varlistentry>
  45  <varlistentry>
  46   <term>create <replaceable>database</replaceable></term>
  47   <listitem><para>
  48     Create database.
  49    </para></listitem>
  50  </varlistentry>
  51  <varlistentry>
  52   <term>drop <replaceable>database</replaceable></term>
  53   <listitem><para>
  54     Drop database (delete database).
  55    </para></listitem>
  56  </varlistentry>
  57 </variablelist>
  58 <!-- Keep this comment at the end of the file
  59 Local variables:
  60 mode: sgml
  61 sgml-omittag:t
  62 sgml-shorttag:t
  63 sgml-minimize-attributes:nil
  64 sgml-always-quote-attributes:t
  65 sgml-indent-step:1
  66 sgml-indent-data:t
  67 sgml-parent-document: "zebra.xml"
  68 sgml-local-catalogs: nil
  69 sgml-namecase-general:t
  70 End:
  71 -->