doc/zebraidx-man.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2      <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
   3      <!ENTITY % ref-head "the section entitled">
   4      <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
   5         and Reference</citetitle>">
   6      <!ENTITY ref-local-representation "
   7         %ref-head; <citetitle>Local Representation</citetitle> %ref-tail;">
   8      <!ENTITY ref-record-types "
   9         %ref-head; <citetitle>Record Types</citetitle> %ref-tail;">
  10      <!ENTITY ref-configuration-file "
  11         %ref-head; <citetitle>The Zebra Configuration File</citetitle>
  12         %ref-tail;">
  13      <!ENTITY ref-shadow-registers "
  14         %ref-head; <citetitle>Safe Updating - Using Shadow
  15         Registers</citetitle> %ref-tail;">
  16 ]>
  17 <!-- $Id: zebraidx-man.sgml,v 1.3 2002-10-20 14:02:03 mike Exp $ -->
  18 <refentry id="zebraidx">
  19
  20  <refmeta>
  21   <refentrytitle>zebraidx</refentrytitle>
  22   <manvolnum>1</manvolnum>
  23  </refmeta>
  24
  25  <refnamediv>
  26   <refname>zebraidx</refname>
  27   <refpurpose>Zebra Administrative Tool</refpurpose>
  28  </refnamediv>
  29
  30  <refsynopsisdiv>
  31   <cmdsynopsis>
  32    <command>zebraidx</command>
  33    <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
  34    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
  35    <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
  36    <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
  37    <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
  38    <arg choice="opt"><option>-n</option></arg>
  39    <arg choice="opt"><option>-s</option></arg>
  40    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
  41    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
  42    <arg choice="opt"><option>-L</option></arg>
  43    <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
  44    <arg choice="opt"><option>-v</option></arg>
  45    <arg choice="req"><replaceable>command</replaceable></arg>
  46    <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
  47   </cmdsynopsis>
  48  </refsynopsisdiv>
  49
  50   <refsect1><title>DESCRIPTION</title>
  51    <para>
  52     <command>zebraidx</command> allows you to insert, delete or updates
  53     records in Zebra. <command>zebraidx</command> accepts a set options
  54     (see below) and exactly one command (mandatory).
  55     </para>
  56   </refsect1>
  57   <refsect1>
  58    <title>COMMANDS</title>
  59    <variablelist>
  60     <varlistentry>
  61      <term>update <replaceable>file ...</replaceable></term>
  62      <listitem><para>
  63        Reads records from locations given by <replaceable>file</replaceable>
  64        and updates the register accordingly (to be in sync).
  65       </para></listitem>
  66     </varlistentry>
  67     <varlistentry>
  68      <term>delete <replaceable>file ...</replaceable></term>
  69      <listitem><para>
  70        Reads records from locations given by <replaceable>file</replaceable>
  71        and deletes the corresponding records in the register.
  72       </para></listitem>
  73     </varlistentry>
  74     <varlistentry>
  75      <term>commit</term>
  76      <listitem><para>
  77        Commit changes. Only allowed when shadow registers
  78        are enabled.
  79       </para></listitem>
  80     </varlistentry>
  81     <varlistentry>
  82      <term>clean</term>
  83      <listitem><para>
  84        Clean shadow files and "forget" changes.
  85       </para></listitem>
  86     </varlistentry>
  87    </variablelist>
  88   </refsect1>
  89   <refsect1>
  90    <title>OPTIONS</title>
  91     &zebraidx-options;
  92   </refsect1>
  93   <refsect1><title>FILES</title>
  94    <para>
  95     <filename>zebra.cfg</filename>
  96    </para>
  97   </refsect1>
  98   <refsect1><title>SEE ALSO</title>
  99    <para>
 100     <citerefentry>
 101      <refentrytitle>zebrasrv</refentrytitle>
 102      <manvolnum>8</manvolnum>
 103     </citerefentry>
 104    </para>
 105    <para>
 106     Section "Administrating Zebra" in the Zebra manual.
 107    </para>
 108   </refsect1>
 109 </refentry>
 110
 111 <!-- Keep this comment at the end of the file
 112 Local variables:
 113 mode: sgml
 114 sgml-omittag:t
 115 sgml-shorttag:t
 116 sgml-minimize-attributes:nil
 117 sgml-always-quote-attributes:t
 118 sgml-indent-step:1
 119 sgml-indent-data:t
 120 sgml-parent-document:nil
 121 sgml-local-catalogs: nil
 122 sgml-namecase-general:t
 123 End:
 124 -->