doc/zebraidx-man.sgml

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