From 4fe772289b1ab968655c27b144d08fc69c113fd9 Mon Sep 17 00:00:00 2001 From: Heikki Levanto Date: Wed, 10 Apr 2002 14:47:48 +0000 Subject: [PATCH] Minor fixes, especially in the beginning Added several FIXMEs to mark places that need attention --- doc/administration.xml | 22 +++++++++++---- doc/indexdata.xml | 3 +- doc/installation.xml | 20 ++++++++++++- doc/introduction.xml | 73 +++++++++++++++++++++++++++++++----------------- doc/license.xml | 8 +++++- doc/quickstart.xml | 7 ++++- doc/recordmodel.xml | 16 ++++++++--- doc/server.xml | 35 +++++++++++++++-------- doc/zebra.xml | 6 ++-- doc/zebra.xml.in | 15 ++++++---- doc/zebraidx.xml | 4 +-- 11 files changed, 149 insertions(+), 60 deletions(-) diff --git a/doc/administration.xml b/doc/administration.xml index 2486f70..417a3da 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,5 +1,5 @@ - + Administrating Zebra @@ -147,6 +147,10 @@ + FIXME - Didn't Adam make something to have multiple databases in multiple dirs... + + + @@ -186,6 +190,7 @@ Specifies the Z39.50 database name. + FIXME - now we can have multiple databases in one server. -H @@ -432,6 +437,10 @@ + FIXME - There must be a simpler way to do this with Adams string tags -H + + + For example, to update records of group esdd located below /data1/records/ you should type: @@ -635,19 +644,22 @@ each directory in the order specified and use the next specified directories as needed. The size is an integer followed by a qualifier - code, M for megabytes, + code, + b for bytes, k for kilobytes. + M for megabytes, + G for gigabytes. For instance, if you have allocated two disks for your register, and the first disk is mounted - on /d1 and has 200 MB of free space and the - second, mounted on /d2 has 300 MB, you could + on /d1 and has 2GB of free space and the + second, mounted on /d2 has 3.6 GB, you could put this entry in your configuration file: - register: /d1:200M /d2:300M + register: /d1:2G /d2:3600M diff --git a/doc/indexdata.xml b/doc/indexdata.xml index 3fe3d0b..0d93aee 100644 --- a/doc/indexdata.xml +++ b/doc/indexdata.xml @@ -1,5 +1,5 @@ - + About Index Data and the Zebra Server @@ -26,6 +26,7 @@ Phone +45 3341 0100 Fax +45 3341 0101 Email info@indexdata.dk + www.indexdata.dk diff --git a/doc/installation.xml b/doc/installation.xml index 6ade138..e456616 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,5 +1,5 @@ - + Installation An ANSI C compiler is required to compile the Zebra @@ -34,6 +34,12 @@ CC=/opt/ccs/bin/cc CFLAGS=-O ./configure + + The configure script takes a number of arguments, you can see + them all with + + ./configure --help + @@ -70,6 +76,18 @@ + + You can now use Zebra. If you wish to install it system-wide, type + + make install + + By default this will install the Zebra executables in + /usr/local/bin, + and the standard configuration files in + /usr/local/share/zebra + You can override this with the --prefix option + to configure. + + Introduction Overview - The Zebra system is a fielded free-text indexing and retrieval engine with a - Z39.50 front-end. You can use any commercial or free-ware Z39.50 client - to access data stored in Zebra. + The + + Zebra + system is a fielded free-text indexing and retrieval engine with a + Z39.50 front-end. You can use our various toolkits or any commercial + or free-ware Z39.50 client to access data stored in Zebra. + + + + FIXME - not a "first step" but a part of a complete system! -H @@ -31,9 +38,13 @@ - If you find the software interesting, you should join the support - mailing-list by sending email to - zebra-request@indexdata.dk. + + If you find the software interesting, you should visit the + + Zebra web site, where you can join the + + mailing-list + by sending email to @@ -48,17 +59,6 @@ - - - Supports updating - records can be added and deleted without - rebuilding the index from scratch. - The update procedure is tolerant to crashes or hard interrupts - during register updating - registers can be reconstructed following - a crash. - Registers can be safely updated even while users are accessing - the server. - - @@ -77,6 +77,18 @@ + Robust updating - records can be added and deleted without + rebuilding the index from scratch. + The update procedure is tolerant to crashes or hard interrupts + during register updating - registers can be reconstructed following + a crash. + Registers can be safely updated even while users are accessing + the server. + + + + + Supports random storage formats. A system of input filters driven by regular expressions allows you to easily process most ASCII-based data formats. SGML, XML, ISO2709 (MARC), and raw text are also @@ -93,6 +105,13 @@ + + Can import the data into Zebras own storage, or just refer to + external files (html pages). + + + + Supports multiple concrete syntaxes for record exchange (depending on the configuration): GRS-1, SUTRS, @@ -108,6 +127,13 @@ + + + Zebra is written in portable C, so it runs on most Unix-like systems + as well as Windows NT - a binary distribution for Windows NT is available. + + + @@ -121,6 +147,7 @@ Protocol facilities: Init, Search, Retrieve, Delete, Browse and Sort. + FIXME - Itemupdate. (Remove delete until that time, confuses people) -H @@ -162,16 +189,10 @@ Some variant support (not fully implemented yet). + FIXME - Test if complete enough - is it worth mentioning at all -H - - - Zebra runs on most Unix-like systems as well as Windows NT - a binary - distribution for Windows NT is available. - - - @@ -187,6 +208,7 @@ Items marked with an asterisk will be implemented before the last beta release. + FIXME - What are the current plans? @@ -194,6 +216,7 @@ *Complete the support for variants. + FIXME - who cares -H diff --git a/doc/license.xml b/doc/license.xml index 3d0cd10..3eb9ffb 100644 --- a/doc/license.xml +++ b/doc/license.xml @@ -1,5 +1,5 @@ - + License @@ -7,6 +7,12 @@ + FIXME - Need to change this to GPL + Should also mention something about other licenses + being available on commercial terms. + + + All rights reserved. diff --git a/doc/quickstart.xml b/doc/quickstart.xml index e1dd699..8cac9bc 100644 --- a/doc/quickstart.xml +++ b/doc/quickstart.xml @@ -1,8 +1,13 @@ - + Quick Start + FIXME - Start with the new improved example scripts that run + without any configuration file changes! + + + In this section, we will test the system by indexing a small set of sample GILS records that are included with the software distribution. Go to the test/gils subdirectory of the distribution archive. diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index 0eb13de..660c95e 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + The Record Model @@ -18,6 +18,8 @@ structured record type grs as introduced in . + FIXME - Need to describe the simple string-tag model, or at least + refer to it here. -H @@ -691,7 +693,7 @@ - Documentation needs extension here about types of nodes - numerical, + FIXME! Documentation needs extension here about types of nodes - numerical, textual, etc., plus the various types of inclusion notes. @@ -721,6 +723,10 @@ + FIXME - Need a diagram here, or a simple explanation how it all hangs together -H + + + @@ -1520,7 +1526,7 @@ - NOTE: The schema-mapping functions are so far limited to a + NOTE: FIXME! The schema-mapping functions are so far limited to a straightforward mapping of elements. This should be extended with mechanisms for conversions of the element contents, and conditional mappings of elements based on the record contents. @@ -1575,7 +1581,7 @@ - NOTE: This will be described better. We're in the process of + NOTE: FIXME! This will be described better. We're in the process of re-evaluating and most likely changing the way that MARC records are handled by the system. @@ -1810,6 +1816,7 @@ is used to show the hierarchical structure of the record. All "GRS" type records support both the GRS-1 and SUTRS representations. + FIXME - What is SUTRS - should be expanded here @@ -1852,6 +1859,7 @@ abstract syntaxes can be mapped to the SOIF format, although nested elements are represented by concatenation of the tag names at each level. + FIXME - Is this used anywhere ? What is SOIF anyway? -H diff --git a/doc/server.xml b/doc/server.xml index 382a634..8066c45 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,11 +1,18 @@ - + The Z39.50 Server Running the Z39.50 Server (zebrasrv) + FIXME - We need to be consistent here, zebraidx had the options at the + end, and lots of explaining text before them. Same for zebrasvr! -H + FIXME - At least we need a small intro, what is zebrasvr, and how it + can be run (inetd, nt service, stand-alone program, daemon...) -H + + + Syntax @@ -51,11 +58,9 @@ -z - Use the Z39.50 protocol (default). These two options complement - each other. You can use both multiple times on the same command - line, between listener-specifications (see below). This way, you - can set up the server to listen for connections in both protocols - concurrently, on different local ports. + Use the Z39.50 protocol. Currently the only protocol supported. + The option is retained for historical reasons, and for future + extensions. @@ -129,10 +134,10 @@ - A listener-address consists of a transport - mode followed by a colon (:) followed by a listener address. + A listener-address consists of an optional + transport mode followed by a colon (:) followed by a listener address. The transport mode is either ssl or - tcp. + tcp (default). @@ -148,7 +153,8 @@ - The port number defaults to 210 (standard Z39.50 port). + The port number defaults to 210 (standard Z39.50 port) for + privileged users (root), and 9999 for normal users. @@ -176,7 +182,7 @@ - zebrasrv -u daemon tcp:@ + zebrasrv -u daemon @ @@ -213,6 +219,12 @@ Search + FIXME - Need to explain the string tag stuff before people get bogged + down with all these attribute numbers. Perhaps in its own + chapter? -H + + + The supported query type are 1 and 101. All operators are currently supported with the restriction that only proximity units of type "word" are supported for the proximity operator. @@ -377,6 +389,7 @@ Matches x once or twice. Priority: high. + FIXME Is this right? Std regexp has '?' meaning zero or one -H diff --git a/doc/zebra.xml b/doc/zebra.xml index 5d0ad29..29766c3 100644 --- a/doc/zebra.xml +++ b/doc/zebra.xml @@ -11,10 +11,10 @@ ]> - + - Zebra Server - Administrators's Guide and Reference + Zebra Server - Administrators' Guide and Reference SebastianHammer @@ -28,7 +28,7 @@ The Zebra information server combines a versatile fielded/free-text - search engine with a Z39.50-1995 frontend to provide a powerful and + search engine with a Z39.50-1995 front-end to provide a powerful and flexible information management system. This document explains the procedure for installing and configuring the system, and outlines the possibilities for diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in index 74ea169..182f568 100644 --- a/doc/zebra.xml.in +++ b/doc/zebra.xml.in @@ -11,16 +11,19 @@ ]> - + Zebra Server - Administrators' Guide and Reference SebastianHammer - + AdamDickmeiss - + + + HeikkiLevanto + 1995-2002 Index Data @@ -28,11 +31,11 @@ The Zebra information server combines a versatile fielded/free-text - search engine with a Z39.50-1995 front-end to provide a powerful and + search engine with a Z39.50 v3 front-end to provide a powerful and flexible information management system. This document explains the procedure for installing and - configuring the system, and outlines the possibilities for - managing data and providing Z39.50 services with the software. + configuring the system, managing data and providing Z39.50 + services with the software. This manual covers version @VERSION@ of Zebra. diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index a9da68a..c399dd9 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,5 +1,5 @@ - + Running the Maintenance Interface (zebraidx) @@ -78,7 +78,7 @@ -m mbytes - Use mbytes of megabytes before flushing + Use mbytes of memory before flushing keys to background storage. This setting affects performance when updating large databases. -- 1.7.10.4