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

[idzebra-moved-to-github.git] / doc / zebraidx-man.sgml

diff --git a/doc/zebraidx-man.sgml b/doc/zebraidx-man.sgml
index 87fdf3e..d3e5216 100644 (file)
--- a/doc/zebraidx-man.sgml
+++ b/doc/zebraidx-man.sgml
@@ -1,5 +1,6 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+     <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
      <!ENTITY % ref-head "the section entitled">
      <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
        and Reference</citetitle>">
@@ -14,7 +15,7 @@
        %ref-head; <citetitle>Safe Updating - Using Shadow
        Registers</citetitle> %ref-tail;">
 ]>
-<!-- $Id: zebraidx-man.sgml,v 1.3 2002-10-20 14:02:03 mike Exp $ -->
+<!-- $Id: zebraidx-man.sgml,v 1.4 2003-09-05 10:50:33 adam Exp $ -->
 <refentry id="zebraidx">
  
  <refmeta>
@@ -26,7 +27,7 @@
   <refname>zebraidx</refname>
   <refpurpose>Zebra Administrative Tool</refpurpose>
  </refnamediv>
-
+ 
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>zebraidx</command>
@@ -46,66 +47,41 @@
    <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
-
-  <refsect1><title>DESCRIPTION</title>
-   <para>
-    <command>zebraidx</command> allows you to insert, delete or updates
-    records in Zebra. <command>zebraidx</command> accepts a set options
-    (see below) and exactly one command (mandatory).
-    </para>
-  </refsect1>
-  <refsect1>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>zebraidx</command> allows you to insert, delete or updates
+   records in Zebra. <command>zebraidx</command> accepts a set options
+   (see below) and exactly one command (mandatory).
+  </para>
+ </refsect1>
+ <refsect1>
    <title>COMMANDS</title>
-   <variablelist>
-    <varlistentry>
-     <term>update <replaceable>file ...</replaceable></term>
-     <listitem><para>
-       Reads records from locations given by <replaceable>file</replaceable>
-       and updates the register accordingly (to be in sync).
-      </para></listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>delete <replaceable>file ...</replaceable></term>
-     <listitem><para>
-       Reads records from locations given by <replaceable>file</replaceable>
-       and deletes the corresponding records in the register.
-      </para></listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>commit</term>
-     <listitem><para>
-       Commit changes. Only allowed when shadow registers
-       are enabled.
-      </para></listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>clean</term>
-     <listitem><para>
-       Clean shadow files and "forget" changes.
-      </para></listitem>
-    </varlistentry>
-   </variablelist>
-  </refsect1>
-  <refsect1>
-   <title>OPTIONS</title>
-    &zebraidx-options;
-  </refsect1>
-  <refsect1><title>FILES</title>
-   <para>
-    <filename>zebra.cfg</filename>
-   </para>
-  </refsect1>
-  <refsect1><title>SEE ALSO</title>
-   <para>
-    <citerefentry>
-     <refentrytitle>zebrasrv</refentrytitle>
-     <manvolnum>8</manvolnum>
-    </citerefentry>
-   </para>
-   <para>
-    Section "Administrating Zebra" in the Zebra manual.
-   </para>
-  </refsect1>
+  &zebraidx-commands;
+ </refsect1>
+ <refsect1>
+  <title>OPTIONS</title>
+  &zebraidx-options;
+ </refsect1>
+ <refsect1><title>FILES</title>
+  <para>
+   <filename>zebra.cfg</filename>
+  </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>zebrasrv</refentrytitle>
+    <manvolnum>8</manvolnum>
+   </citerefentry>
+  </para>
+  <para id="shadow-registers">
+   See "shadow registers" in Zebra manual
+  </para>
+  <para id="administration">
+   See "administration" in Zebra manual
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file