Man pages: add refmiscinfo and orgname

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

diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml
index 609ad35..45233e4 100644 (file)
--- a/doc/zebraidx.xml
+++ b/doc/zebraidx.xml
@@ -1,28 +1,29 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
      <!ENTITY % entities SYSTEM "entities.ent">
      %entities;
-     <!ENTITY % common SYSTEM "common/common.ent">
-     %common;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: zebraidx.xml,v 1.10 2007-01-15 14:55:50 adam Exp $ -->
 <refentry id="zebraidx">
  <refentryinfo>
   <productname>zebra</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
 
  <refmeta>
   <refentrytitle>zebraidx</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
  
  <refnamediv>
   <refname>zebraidx</refname>
-  <refpurpose>Zebra Administrative Tool</refpurpose>
+  <refpurpose>&zebra; Administrative Tool</refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>
@@ -48,7 +49,7 @@
  <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
+   records in &zebra;. <command>zebraidx</command> accepts a set options
    (see below) and exactly one command (mandatory).
   </para>
  </refsect1>
@@ -64,7 +65,7 @@
       <replaceable>directory</replaceable>.
       If no directory is provided, a list of files is read from
       <literal>stdin</literal>.
-      See <link linkend="administration">Administration</link> in the Zebra
+      See <link linkend="administration">Administration</link> in the &zebra;
       Manual.
      </para>
     </listitem>
@@ -79,6 +80,17 @@
     </listitem>
    </varlistentry>
    <varlistentry>
+    <term>adelete <replaceable>directory</replaceable></term>
+    <listitem>
+     <para>
+      Remove the records corresponding to the files found under
+      <replaceable>directory</replaceable> from the register.
+      Unlike command <literal>delete</literal> this command does not
+      fail if a record does not exist (but which is attempted deleted).
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
     <term>commit</term>
     <listitem>
      <para>
@@ -86,7 +98,7 @@
       commands to the register. This command is only available if the use of
       shadow register files is enabled
       (see <link linkend="shadow-registers">Shadow Registers</link> in the
-      Zebra Manual).
+      &zebra; Manual).
      </para>
     </listitem>
    </varlistentry>
@@ -129,7 +141,7 @@
       and <literal>grs</literal><replaceable>.subtype</replaceable>.
       Generally, it is probably advisable to specify the record types
       in the <literal>zebra.cfg</literal> file (see
-      <link linkend="record-types">Record Types</link> in the Zebra manual),
+      <link linkend="record-types">Record Types</link> in the &zebra; manual),
       to avoid confusion at subsequent updates.
      </para>
     </listitem>
@@ -150,8 +162,8 @@
      <para>
       Update the files according to the group
       settings for <replaceable>group</replaceable>
-      (see <link linkend="zebra-cfg">Zebra Configuration File</link> in
-      the Zebra manual).
+      (see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
+      the &zebra; manual).
    </para>
     </listitem>
    </varlistentry>
@@ -160,7 +172,7 @@
     <listitem>
      <para>
       The records located should be associated with the database name
-      <replaceable>database</replaceable> for access through the Z39.50 server.
+      <replaceable>database</replaceable> for access through the &acro.z3950; server.
      </para>
     </listitem>
    </varlistentry>
@@ -200,7 +212,7 @@
      <para>
       Disable the use of shadow registers for this operation
       (see <link linkend="shadow-registers">Shadow Registers in
-       the Zebra manual</link>).
+       the &zebra; manual</link>).
      </para>
     </listitem>
    </varlistentry>
@@ -219,7 +231,7 @@
     <term>-V</term>
     <listitem>
      <para>
-      Show Zebra version.
+      Show &zebra; version.
      </para>
     </listitem>
    </varlistentry>