doc/zebraidx-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
   5      <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
   6      <!ENTITY % ref-head "the section entitled">
   7      <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
   8         and Reference</citetitle>">
   9
  10      <!ENTITY ref-architecture-representation "">
  11      <!ENTITY ref-local-representation "<citetitle>Local Representation</citetitle>">
  12      <!ENTITY ref-record-types "<citetitle>Record Types</citetitle>">
  13      <!ENTITY ref-configuration-file "<citetitle>The Zebra Configuration File</citetitle>">
  14      <!ENTITY ref-shadow-registers "<citetitle>Safe Updating - Using Shadow
  15         Registers</citetitle>">
  16 ]>
  17 <!-- $Id: zebraidx-man.xml,v 1.1 2006-05-24 19:12:46 adam 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   &zebraidx-commands;
  60  </refsect1>
  61  <refsect1>
  62   <title>OPTIONS</title>
  63   &zebraidx-options;
  64  </refsect1>
  65  <refsect1><title>FILES</title>
  66   <para>
  67    <filename>zebra.cfg</filename>
  68   </para>
  69  </refsect1>
  70  <refsect1><title>SEE ALSO</title>
  71   <para>
  72    <citerefentry>
  73     <refentrytitle>zebrasrv</refentrytitle>
  74     <manvolnum>8</manvolnum>
  75    </citerefentry>
  76   </para>
  77   <para id="shadow-registers">
  78    See "shadow registers" in Zebra manual
  79   </para>
  80   <para id="administration">
  81    See "administration" in Zebra manual
  82   </para>
  83  </refsect1>
  84 </refentry>
  85
  86 <!-- Keep this comment at the end of the file
  87 Local variables:
  88 mode: sgml
  89 sgml-omittag:t
  90 sgml-shorttag:t
  91 sgml-minimize-attributes:nil
  92 sgml-always-quote-attributes:t
  93 sgml-indent-step:1
  94 sgml-indent-data:t
  95 sgml-parent-document:nil
  96 sgml-local-catalogs: nil
  97 sgml-namecase-general:t
  98 End:
  99 -->