X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fadministration.xml;h=51d3025d7c6334ba8f5f96fa63e185dcc4ad4750;hb=518c06f68ffac6658aa792da45282a165b32ca95;hp=b8c1f0428e154579100b4eea3b0d8a0677eecffe;hpb=79dbb0556936ee101483f693d38bd5e97c49689e;p=idzebra-moved-to-github.git diff --git a/doc/administration.xml b/doc/administration.xml index b8c1f04..51d3025 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,5 +1,5 @@ - + Administrating Zebra @@ -79,7 +79,7 @@ Indexing is a per-record process, in which either insert/modify/delete will occur. Before a record is indexed search keys are extracted from whatever might be the layout the original record (sgml,html,text, etc..). - The Zebra system currently supports two fundamantal types of records: + The Zebra system currently supports two fundamental types of records: structured and simple text. To specify a particular extraction process, use either the command line option -t or specify a @@ -99,7 +99,7 @@ You can edit the configuration file with a normal text editor. - parameter names and values are seperated by colons in the file. Lines + parameter names and values are separated by colons in the file. Lines starting with a hash sign (#) are treated as comments. @@ -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 @@ -318,7 +323,7 @@ Locating Records - The default behaviour of the Zebra system is to reference the + The default behavior of the Zebra system is to reference the records from their original location, i.e. where they were found when you ran zebraidx. That is, when a client wishes to retrieve a record @@ -418,7 +423,7 @@ disk space than simpler indexing methods, but it makes it easier for you to keep the index in sync with a frequently changing set of data. If you combine this system with the safe update - facility (see below), you never have to take your server offline for + facility (see below), you never have to take your server off-line for maintenance or register updating purposes. @@ -428,9 +433,12 @@ in the configuration file. In addition, you should set storeKeys to 1, since the Zebra indexer must save additional information about the contents of each record - in order to modify the indices correctly at a later time. + in order to modify the indexes correctly at a later time. + + For example, to update records of group esdd located below @@ -472,7 +480,7 @@ Indexing with General Record IDs - When using this method you construct an (almost) arbritrary, internal + When using this method you construct an (almost) arbitrary, internal record key based on the contents of the record itself and other system information. If you have a group of records that explicitly associates an ID with each record, this method is convenient. For example, the @@ -635,19 +643,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 @@ -658,7 +669,7 @@ your responsibility to ensure that enough space is available, and that other applications do not attempt to use the free space. In a large production system, it is recommended that you allocate one or more - filesystem exclusively to the Zebra register files. + file system exclusively to the Zebra register files. @@ -764,14 +775,13 @@ In order to make changes to the system take effect for the users, you'll have to submit a "commit" command after a (sequence of) update operation(s). - You can ask the indexer to commit the changes immediately - after the update operation: - $ zebraidx update /d1/records update /d2/more-records commit + $ zebraidx update /d1/records + $ zebraidx commit @@ -783,7 +793,7 @@ - $ zebraidx -g books update /d1/records update /d2/more-records + $ zebraidx -g books update /d1/records /d2/more-records $ zebraidx -g fun update /d3/fun-records $ zebraidx commit