<chapter id="administration">
- <!-- $Id: administration.xml,v 1.10 2002-10-17 21:54:21 mike Exp $ -->
+ <!-- $Id: administration.xml,v 1.11 2002-10-20 14:02:02 mike Exp $ -->
<title>Administrating Zebra</title>
<!-- ### It's a bit daft that this chapter (which describes half of
the configuration-file formats) is separated from
<para>
You can edit the configuration file with a normal text editor.
parameter names and values are separated by colons in the file. Lines
- starting with a hash sign (<literal>#</literal>) are
+ starting with a hash sign (<literal>#</literal>) are
treated as comments.
</para>
<varlistentry>
<term>
<emphasis>group</emphasis>
- .recordType[<emphasis>.name</emphasis>]:
+ .recordType[<emphasis>.name</emphasis>]:
<replaceable>type</replaceable>
</term>
<listitem>
<appendix id="indexdata">
- <!-- $Id: indexdata.xml,v 1.5 2002-08-02 20:31:42 adam Exp $ -->
+ <!-- $Id: indexdata.xml,v 1.6 2002-10-20 14:02:03 mike Exp $ -->
<title>About Index Data and the Zebra Server</title>
<para>
Fax <fax>+45 3341 0101</fax>
Email <email>info@indexdata.dk</email>
<otheraddr>
- <ulink url="http://www.indexdata.dk/">www.indexdata.dk</ulink></otheraddr>
+ <ulink url="http://indexdata.dk/">indexdata.dk</ulink></otheraddr>
</address>
</para>
<para>
<chapter id="introduction">
- <!-- $Id: introduction.xml,v 1.18 2002-10-17 08:10:08 mike Exp $ -->
+ <!-- $Id: introduction.xml,v 1.19 2002-10-20 14:02:03 mike Exp $ -->
<title>Introduction</title>
<sect1>
<title>Overview</title>
<para>
- <ulink url="http://www.indexdata.dk/zebra/">
+ <ulink url="http://indexdata.dk/zebra/">
Zebra</ulink>
is a high-performance, general-purpose structured text
indexing and retrieval engine. It reads structured records in a
</para>
<para>
First, there's the Zebra web site at
- <ulink url="http://www.indexdata.dk/zebra/"/>,
+ <ulink url="http://indexdata.dk/zebra/"/>,
which always has the most recent version available for download.
If you have a problem with Zebra, the first thing to do is see
whether it's fixed in the current release.
</para>
<para>
Second, there's the Zebra mailing list. Its home page at
- <ulink url="http://www.indexdata.dk/mailman/listinfo/zebralist"/>
+ <ulink url="http://indexdata.dk/mailman/listinfo/zebralist"/>
includes a complete archive of all messages that have ever been
posted on the list. The Zebra mailing list is used both for
announcements from the authors (new
Third, it's possible to buy a commercial support contract, with
well defined service levels and response times, from Index Data.
See
- <ulink url="http://www.indexdata.dk/support/?lang=en"/>
+ <ulink url="http://indexdata.dk/support/?lang=en"/>
<!-- ### compare this page with http://indexdata.dk/support2/ -->
for details.
</para>
<chapter id="record-model">
- <!-- $Id: recordmodel.xml,v 1.10 2002-10-18 08:31:37 mike Exp $ -->
+ <!-- $Id: recordmodel.xml,v 1.11 2002-10-20 14:02:03 mike Exp $ -->
<title>The Record Model</title>
<para>
</sect3>
- <sect3>
+ <sect3><!-- ### we shouldn't make such a big deal about this -->
<title>Variants</title>
<para>
</para>
<para>
- An action is surrounded by curly braces ({...}), and
+ An action is surrounded by curly braces ({...}), and
consists of a sequence of statements. Statements may be separated
by newlines or semicolons (;).
Within actions, the strings that matched the expressions
immediately preceding the action can be referred to as
- $0, $1, $2, etc.
+ $0, $1, $2, etc.
</para>
<para>
<variablelist>
<varlistentry>
- <term>begin <emphasis>type [parameter ... ]</emphasis></term>
+ <term>begin <emphasis>type [parameter ... ]</emphasis></term>
<listitem>
<para>
Begin a new
</listitem>
</varlistentry>
<varlistentry>
- <term>end <emphasis>[type]</emphasis></term>
+ <term>end <emphasis>[type]</emphasis></term>
<listitem>
<para>
Close a tagged element. If no parameter is given,
<para>
Generally, the files are simple ASCII files, which can be maintained
- using any text editor. Blank lines, and lines beginning with a (#) are
- ignored. Any characters on a line followed by a (#) are also ignored.
+ using any text editor. Blank lines, and lines beginning with a (#) are
+ ignored. Any characters on a line followed by a (#) are also ignored.
All other lines contain <emphasis>directives</emphasis>, which provide
some setting or value to the system.
Generally, settings are characterized by a single
</listitem></varlistentry>
<varlistentry>
<term>att
- <emphasis>att-value att-name [local-value]</emphasis></term>
+ <emphasis>att-value att-name [local-value]</emphasis></term>
<listitem>
<para>
(o,r) This
</listitem></varlistentry>
<varlistentry>
<term>simpleElement
- <emphasis>path ['variant' variant-request]</emphasis></term>
+ <emphasis>path ['variant' variant-request]</emphasis></term>
<listitem>
<para>
(o,r) This corresponds to a simple element request
<listitem>
<para>
- Curly braces {} may be used to enclose ranges of single
+ Curly braces {} may be used to enclose ranges of single
characters (possibly using the escape convention described in the
- preceding point), eg. {a-z} to introduce the
+ preceding point), eg. {a-z} to introduce the
standard range of ASCII characters.
Note that the interpretation of such a range depends on
the concrete representation in your local, physical character set.
<chapter id="server">
- <!-- $Id: server.xml,v 1.5 2002-10-17 08:10:08 mike Exp $ -->
+ <!-- $Id: server.xml,v 1.6 2002-10-20 14:02:03 mike Exp $ -->
<title>The Z39.50 Server</title>
<sect1 id="zebrasrv">
<emphasis remap="bf">Syntax</emphasis>
<screen>
- zebrasrv [options] [listener-address ...]
+ zebrasrv [options] [listener-address ...]
</screen>
</para>
<listitem>
<para>
The log level. Use a comma-separated list of members of the set
- {fatal,debug,warn,log,all,none}.
+ {fatal,debug,warn,log,all,none}.
</para>
</listitem>
</varlistentry>
<para>
<screen>
- hostname | IP-number [: portnumber]
+ hostname | IP-number [: portnumber]
</screen>
</para>
For the <emphasis>Truncation</emphasis> attribute,
<emphasis>No Truncation</emphasis> is the default.
<emphasis>Left Truncation</emphasis> is not supported.
- <emphasis>Process #</emphasis> is supported, as is
+ <emphasis>Process # in search term</emphasis> is supported, as is
<emphasis>Regxp-1</emphasis>.
<emphasis>Regxp-2</emphasis> enables the fault-tolerant (fuzzy)
search. As a default, a single error (deletion, insertion,
</listitem>
</varlistentry>
<varlistentry>
- <term>x|y</term>
+ <term>x|y</term>
<listitem>
<para>
Matches either <emphasis>x</emphasis> or <emphasis>y</emphasis>.
<!ENTITY chap-recordmodel SYSTEM "recordmodel.xml">
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
+
<!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+ <!ENTITY ref-local-representation '
+ <xref linkend="local-representation"/>'>
+ <!ENTITY ref-record-types '
+ <xref linkend="record-types"/>'>
+ <!ENTITY ref-configuration-file '
+ <xref linkend="configuration-file"/>'>
+ <!ENTITY ref-shadow-registers '
+ <xref linkend="shadow-registers"/>'>
]>
-<!-- $Id: zebra.xml.in,v 1.11 2002-10-08 08:09:43 mike Exp $ -->
+<!-- $Id: zebra.xml.in,v 1.12 2002-10-20 14:02:03 mike Exp $ -->
<book id="zebra">
<bookinfo>
<title>Zebra - User's Guide and Reference</title>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+ <!ENTITY % ref-head "the section entitled">
+ <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
+ and Reference</citetitle>">
+ <!ENTITY ref-local-representation "
+ %ref-head; <citetitle>Local Representation</citetitle> %ref-tail;">
+ <!ENTITY ref-record-types "
+ %ref-head; <citetitle>Record Types</citetitle> %ref-tail;">
+ <!ENTITY ref-configuration-file "
+ %ref-head; <citetitle>The Zebra Configuration File</citetitle>
+ %ref-tail;">
+ <!ENTITY ref-shadow-registers "
+ %ref-head; <citetitle>Safe Updating - Using Shadow
+ Registers</citetitle> %ref-tail;">
]>
-<!-- $Id: zebraidx-man.sgml,v 1.2 2002-10-08 09:10:49 adam Exp $ -->
+<!-- $Id: zebraidx-man.sgml,v 1.3 2002-10-20 14:02:03 mike Exp $ -->
<refentry id="zebraidx">
<refmeta>
<!--
- $Id: zebraidx-options.xml,v 1.1 2002-09-19 21:06:51 adam Exp $
+ $Id: zebraidx-options.xml,v 1.2 2002-10-20 14:02:03 mike Exp $
Options for zebraidx.
Included in both manual and man page for zebraidx
-->
<literal>grs</literal><replaceable>.subtype</replaceable>.
If no <replaceable>subtype</replaceable> is provided for the GRS
(General Record Structure) type, the canonical input format
- is assumed (see <xref linkend="local-representation"/>).
+ is assumed (see &ref-local-representation;).
Generally, it is probably advisable to specify the record types
in the <literal>zebra.cfg</literal> file (see
- <xref linkend="record-types"/>), to avoid confusion at
+ &ref-record-types;), to avoid confusion at
subsequent updates.
</para>
</listitem>
<para>
Update the files according to the group
settings for <replaceable>group</replaceable>
- (see <xref linkend="configuration-file"/>).
+ (see &ref-configuration-file;).
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Disable the use of shadow registers for this operation
- (see <xref linkend="shadow-registers"/>).
+ (see &ref-shadow-registers;).
</para>
</listitem>
</varlistentry>
<chapter id="zebraidx">
- <!-- $Id: zebraidx.xml,v 1.4 2002-10-17 08:10:08 mike Exp $ -->
+ <!-- $Id: zebraidx.xml,v 1.5 2002-10-20 14:02:03 mike Exp $ -->
<title>Running the Maintenance Interface (zebraidx)</title>
<para>
Syntax
<screen>
- $ zebraidx [options] command [directory] ...
+ $ zebraidx [options] command [directory] ...
</screen>
Options:
<para>
Commands
+
+ <!-- From .../zebra/index/main.c:
+ update *
+ update1
+ update2
+ dump
+ del, delete *
+ init
+ commit *
+ clean
+ stat, status
+ dump, dumpdict
+ compact
+ ### Only the ones marked * have been documented.
+ -->
+
<variablelist>
<varlistentry>
-# $Header: /home/cvsroot/idis/examples/dinosauricon/Attic/zebra.cfg,v 1.5 2002-10-08 08:08:52 mike Exp $
+# $Header: /home/cvsroot/idis/examples/dinosauricon/Attic/zebra.cfg,v 1.6 2002-10-20 14:02:03 mike Exp $
# Bare-bones master configuration file for Zebra
profilePath: .:../../tab:../../../yaz/tab
-recordType: grs.sgml
+recordType: grs.xml
+attset: bib1.att
projects / idzebra-moved-to-github.git / commitdiff