Separate zebraidx-commands document. Mention create&drop zebraidx commands

[idzebra-moved-to-github.git] / doc / zebraidx-commands.xml

diff --git a/doc/zebraidx-commands.xml b/doc/zebraidx-commands.xml
new file mode 100644 (file)
index 0000000..deea484
--- /dev/null
+++ b/doc/zebraidx-commands.xml
@@ -0,0 +1,71 @@
+<!-- 
+   $Id: zebraidx-commands.xml,v 1.1 2003-09-05 10:50:33 adam Exp $
+   Commands for zebraidx.
+   Included in both manual and man page for zebraidx
+-->
+<variablelist>
+ <varlistentry>
+  <term>update <replaceable>directory</replaceable></term>
+  <listitem>
+   <para>
+    Update the register with the files contained in
+    <replaceable>directory</replaceable>.
+    If no directory is provided, a list of files is read from
+    <literal>stdin</literal>.
+    See <xref linkend="administration"/>.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>delete <replaceable>directory</replaceable></term>
+  <listitem>
+   <para>
+    Remove the records corresponding to the files found under
+    <replaceable>directory</replaceable> from the register.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>commit</term>
+  <listitem>
+   <para>
+    Write the changes resulting from the last <literal>update</literal>
+    commands to the register. This command is only available if the use of
+    shadow register files is enabled
+    (see <xref linkend="shadow-registers"/>).
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>clean</term>
+  <listitem><para>
+    Clean shadow files and "forget" changes.
+   </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>create <replaceable>database</replaceable></term>
+  <listitem><para>
+    Create database.
+   </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>drop <replaceable>database</replaceable></term>
+  <listitem><para>
+    Drop database (delete database).
+   </para></listitem>
+ </varlistentry>
+</variablelist>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "zebra.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->