-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
<!ENTITY % local SYSTEM "local.ent">
%local;
<refentryinfo>
<productname>zebra</productname>
<productnumber>&version;</productnumber>
+ <info><orgname>Index Data</orgname></info>
</refentryinfo>
<refmeta>
<refentrytitle>zebraidx</refentrytitle>
<manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Commands</refmiscinfo>
</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>-f <replaceable>number</replaceable></option></arg>
+ <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
+ <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+ <arg choice="opt"><option>-L</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>-t <replaceable>type</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
</refsect1>
<refsect1>
<title>COMMANDS</title>
-
+
<variablelist>
<varlistentry>
<term>update <replaceable>directory</replaceable></term>
</listitem>
</varlistentry>
<varlistentry>
+ <term>check <replaceable>options</replaceable></term>
+ <listitem><para>
+ Runs consistency check of register. May take a long time.
+ Options may be one of <literal>quick</literal>,
+ <literal>default</literal> or <literal>full</literal>.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
<term>clean</term>
<listitem><para>
Clean shadow files and "forget" changes.
- </para></listitem>
+ </para></listitem>
</varlistentry>
<varlistentry>
<term>create <replaceable>database</replaceable></term>
<refsect1>
<title>OPTIONS</title>
<variablelist>
-
+
<varlistentry>
- <term>-t <replaceable>type</replaceable></term>
+ <term>-c <replaceable>config-file</replaceable></term>
<listitem>
<para>
- Update all files as <replaceable>type</replaceable>. Currently, the
- types supported are <literal>text</literal>, <literal>alvis</literal>
- and <literal>grs</literal><replaceable>.subtype</replaceable>.
- Generally, it is probably advisable to specify the record types
- in the <literal>zebra.cfg</literal> file (see
- <link linkend="record-types">Record Types</link> in the &zebra; manual),
- to avoid confusion at subsequent updates.
+ Read the configuration file
+ <replaceable>config-file</replaceable> instead of
+ <literal>zebra.cfg</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-c <replaceable>config-file</replaceable></term>
+ <term>-d <replaceable>database</replaceable></term>
<listitem>
<para>
- Read the configuration file
- <replaceable>config-file</replaceable> instead of
- <literal>zebra.cfg</literal>.
+ The records located should be associated with the database name
+ <replaceable>database</replaceable> for access through the
+ &acro.z3950; server.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-g <replaceable>group</replaceable></term>
+ <term>-f <replaceable>number</replaceable></term>
<listitem>
<para>
- Update the files according to the group
- settings for <replaceable>group</replaceable>
- (see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
- the &zebra; manual).
- </para>
+ Specify how many per-record log lines, zebraidx, should produce during
+ indexing and during register check (check command). If this option
+ is not given, a value of 1000 is used.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-d <replaceable>database</replaceable></term>
+ <term>-g <replaceable>group</replaceable></term>
<listitem>
<para>
- The records located should be associated with the database name
- <replaceable>database</replaceable> for access through the &acro.z3950; server.
+ Update the files according to the group
+ settings for <replaceable>group</replaceable>
+ (see <link linkend="zebra-cfg">&zebra; Configuration File</link> in
+ the &zebra; manual).
</para>
</listitem>
</varlistentry>
-
<varlistentry>
<term>-l <replaceable>file</replaceable></term>
<listitem>
- <para>
+ <para>
Write log messages to <replaceable>file</replaceable> instead
of <literal>stderr</literal>.
</para>
</listitem>
</varlistentry>
-
<varlistentry>
- <term>-m <replaceable>mbytes</replaceable></term>
+ <term>-L</term>
<listitem>
<para>
- Use <replaceable>mbytes</replaceable> of memory before flushing
- keys to background storage. This setting affects performance when
- updating large databases.
+ Makes zebraidx skip symbolic links. By default, zebraidx follows
+ them.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-L</term>
+ <term>-m <replaceable>mbytes</replaceable></term>
<listitem>
<para>
- Makes zebraidx skip symbolic links. By default, zebraidx follows
- them.
+ Use <replaceable>mbytes</replaceable> of memory before flushing
+ keys to background storage. This setting affects performance when
+ updating large databases.
</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
+ <term>-t <replaceable>type</replaceable></term>
+ <listitem>
+ <para>
+ Update all files as <replaceable>type</replaceable>. Currently, the
+ types supported are <literal>text</literal>, <literal>alvis</literal>
+ and <literal>grs</literal><replaceable>.subtype</replaceable>.
+ Generally, it is probably advisable to specify the record types
+ in the <literal>zebra.cfg</literal> file (see
+ <link linkend="record-types">Record Types</link> in the &zebra; manual),
+ to avoid confusion at subsequent updates.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>-V</term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>-v <replaceable>level</replaceable></term>
<listitem>
<para>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
-</refsect1>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
-sgml-parent-document:nil
+sgml-parent-document: "idzebra.xml"
sgml-local-catalogs: nil
sgml-namecase-general:t
End:
projects / idzebra-moved-to-github.git / blobdiff