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

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 725e24c..546d07b 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.21 2003-05-19 21:38:40 adam Exp $
+## $Id: Makefile.am,v 1.22 2003-09-05 10:50:33 adam Exp $
 docdir=$(datadir)/doc/@PACKAGE@
 
 SUPPORTFILES = \
@@ -19,7 +19,8 @@ XMLFILES = \
  recordmodel.xml \
  license.xml \
  indexdata.xml \
- zebraidx-options.xml
+ zebraidx-options.xml \
+ zebraidx-commands.xml
 
 HTMLFILES =  \
  administration.html apps.html configuration-file.html data-model.html \
@@ -44,8 +45,9 @@ EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(REFFILES) \
        $(doc_DATA) $(EPSFILES) $(man_MANS) $(REFFILES) \
        zvrank.txt marc_indexing.xml
 
-zebraidx.1: zebraidx-man.sgml zebraidx-options.xml
+zebraidx.1: zebraidx-man.sgml zebraidx-options.xml zebraidx-commands.xml
        if test ! -f zebraidx-options.xml ; then ln -s $(srcdir)/zebraidx-options.xml .; fi
+       if test ! -f zebraidx-commands.xml ; then ln -s $(srcdir)/zebraidx-commands.xml .; fi
        docbook2man $(srcdir)/zebraidx-man.sgml
 
 zebrasrv.8: zebrasrv-man.sgml

diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in
index eb2f099..9623fd0 100644 (file)
--- a/doc/zebra.xml.in
+++ b/doc/zebra.xml.in
@@ -14,6 +14,7 @@
         <!ENTITY app-indexdata SYSTEM "indexdata.xml">
 
         <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+        <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
        <!ENTITY ref-local-representation '
                <xref linkend="local-representation"/>'>
        <!ENTITY ref-record-types '
@@ -23,7 +24,7 @@
        <!ENTITY ref-shadow-registers '
                <xref linkend="shadow-registers"/>'>
 ]>
-<!-- $Id: zebra.xml.in,v 1.15 2003-05-19 21:38:40 adam Exp $ -->
+<!-- $Id: zebra.xml.in,v 1.16 2003-09-05 10:50:33 adam Exp $ -->
 <book id="zebra">
  <bookinfo>
   <title>Zebra - User's Guide and Reference</title>

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:
+-->

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

diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml
index 91906f4..0627b7a 100644 (file)
--- a/doc/zebraidx.xml
+++ b/doc/zebraidx.xml
@@ -1,77 +1,44 @@
 <chapter id="zebraidx">
- <!-- $Id: zebraidx.xml,v 1.5 2002-10-20 14:02:03 mike Exp $ -->
+ <!-- $Id: zebraidx.xml,v 1.6 2003-09-05 10:50:33 adam Exp $ -->
  <title>Running the Maintenance Interface (zebraidx)</title>
  
  <para>
   The following is a complete reference to the command line interface to
   the <literal>zebraidx</literal> application.
  </para>
- 
+
  <para>
   Syntax
+  </para>
   
-  <screen>
-   $ zebraidx [options] command [directory] ...
-  </screen>
+  <cmdsynopsis>
+   <command>zebraidx</command>
+   <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
+   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+   <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
+   <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
+   <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
+   <arg choice="opt"><option>-n</option></arg>
+   <arg choice="opt"><option>-s</option></arg>
+   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+   <arg choice="opt"><option>-L</option></arg>
+   <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
+   <arg choice="opt"><option>-v</option></arg>
+   <arg choice="req"><replaceable>command</replaceable></arg>
+   <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
+  </cmdsynopsis>
   
-  Options:
-   &zebraidx-options;
- </para>
  <!-- ### swap order of commands and options -->
  
  <para>
   Commands
-
-  <!-- From .../zebra/index/main.c:
-       update          *
-       update1
-       update2
-       dump
-       del, delete     *
-       init
-       commit          *
-       clean
-       stat, status
-       dump, dumpdict
-       compact
-       ### Only the ones marked * have been documented.
-  -->
-
-  <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>
-  </variablelist>
+   &zebraidx-commands;
+  </para>
+  
+  <para>
+   Options:
+   &zebraidx-options;
  </para>
 
 </chapter>