Added charmap facility to delete leading articles
[idzebra-moved-to-github.git] / doc / zebraidx-man.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2      <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
3      <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
4      <!ENTITY % ref-head "the section entitled">
5      <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
6         and Reference</citetitle>">
7      <!ENTITY ref-local-representation "
8         %ref-head; <citetitle>Local Representation</citetitle> %ref-tail;">
9      <!ENTITY ref-record-types "
10         %ref-head; <citetitle>Record Types</citetitle> %ref-tail;">
11      <!ENTITY ref-configuration-file "
12         %ref-head; <citetitle>The Zebra Configuration File</citetitle>
13         %ref-tail;">
14      <!ENTITY ref-shadow-registers "
15         %ref-head; <citetitle>Safe Updating - Using Shadow
16         Registers</citetitle> %ref-tail;">
17 ]>
18 <!-- $Id: zebraidx-man.sgml,v 1.4 2003-09-05 10:50:33 adam Exp $ -->
19 <refentry id="zebraidx">
20  
21  <refmeta>
22   <refentrytitle>zebraidx</refentrytitle>
23   <manvolnum>1</manvolnum>
24  </refmeta>
25  
26  <refnamediv>
27   <refname>zebraidx</refname>
28   <refpurpose>Zebra Administrative Tool</refpurpose>
29  </refnamediv>
30  
31  <refsynopsisdiv>
32   <cmdsynopsis>
33    <command>zebraidx</command>
34    <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
35    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
36    <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
37    <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
38    <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
39    <arg choice="opt"><option>-n</option></arg>
40    <arg choice="opt"><option>-s</option></arg>
41    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
42    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
43    <arg choice="opt"><option>-L</option></arg>
44    <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
45    <arg choice="opt"><option>-v</option></arg>
46    <arg choice="req"><replaceable>command</replaceable></arg>
47    <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
48   </cmdsynopsis>
49  </refsynopsisdiv>
50  
51  <refsect1><title>DESCRIPTION</title>
52   <para>
53    <command>zebraidx</command> allows you to insert, delete or updates
54    records in Zebra. <command>zebraidx</command> accepts a set options
55    (see below) and exactly one command (mandatory).
56   </para>
57  </refsect1>
58  <refsect1>
59    <title>COMMANDS</title>
60   &zebraidx-commands;
61  </refsect1>
62  <refsect1>
63   <title>OPTIONS</title>
64   &zebraidx-options;
65  </refsect1>
66  <refsect1><title>FILES</title>
67   <para>
68    <filename>zebra.cfg</filename>
69   </para>
70  </refsect1>
71  <refsect1><title>SEE ALSO</title>
72   <para>
73    <citerefentry>
74     <refentrytitle>zebrasrv</refentrytitle>
75     <manvolnum>8</manvolnum>
76    </citerefentry>
77   </para>
78   <para id="shadow-registers">
79    See "shadow registers" in Zebra manual
80   </para>
81   <para id="administration">
82    See "administration" in Zebra manual
83   </para>
84  </refsect1>
85 </refentry>
86
87 <!-- Keep this comment at the end of the file
88 Local variables:
89 mode: sgml
90 sgml-omittag:t
91 sgml-shorttag:t
92 sgml-minimize-attributes:nil
93 sgml-always-quote-attributes:t
94 sgml-indent-step:1
95 sgml-indent-data:t
96 sgml-parent-document:nil
97 sgml-local-catalogs: nil
98 sgml-namecase-general:t
99 End:
100 -->