Documentation for now based on Docbook XML/XSLT using xsltproc + Norman

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

diff --git a/doc/zebraidx-man.xml b/doc/zebraidx-man.xml
new file mode 100644 (file)
index 0000000..f75cbd6
--- /dev/null
+++ b/doc/zebraidx-man.xml
@@ -0,0 +1,99 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!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>">
+
+     <!ENTITY ref-architecture-representation "">
+     <!ENTITY ref-local-representation "<citetitle>Local Representation</citetitle>">
+     <!ENTITY ref-record-types "<citetitle>Record Types</citetitle>">
+     <!ENTITY ref-configuration-file "<citetitle>The Zebra Configuration File</citetitle>">
+     <!ENTITY ref-shadow-registers "<citetitle>Safe Updating - Using Shadow
+       Registers</citetitle>">
+]>
+<!-- $Id: zebraidx-man.xml,v 1.1 2006-05-24 19:12:46 adam Exp $ -->
+<refentry id="zebraidx">
+ 
+ <refmeta>
+  <refentrytitle>zebraidx</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>zebraidx</refname>
+  <refpurpose>Zebra Administrative Tool</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <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>
+ </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>
+   <title>COMMANDS</title>
+  &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
+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:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->