X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fadministration.xml;h=762ba7db9f2dea232dfc8d6f2106713b6272652c;hp=5b3ab5d5444af156adf900e432f4175f2109594f;hb=99842ec71f065fd6886daa355923b01d9ce71d26;hpb=97a7adeb9e5059463f039495cc01cfa448463a27
diff --git a/doc/administration.xml b/doc/administration.xml
index 5b3ab5d..762ba7d 100644
--- a/doc/administration.xml
+++ b/doc/administration.xml
@@ -312,6 +312,19 @@
+ sortmax: integer
+
+
+ Specifies the maximum number of records that will be sorted
+ in a result set. If the result set contains more than
+ integer records, records after the
+ limit will not be sorted. If omitted, the default value is
+ 1,000.
+
+
+
+
+
staticrank: integer
@@ -325,13 +338,13 @@
- estimatehits:: integer
+ estimatehits: integer
- Controls whether &zebra; should calculate approximite hit counts and
+ Controls whether &zebra; should calculate approximate hit counts and
at which hit count it is to be enabled.
- A value of 0 disables approximiate hit counts.
- For a positive value approximaite hit count is enabled
+ A value of 0 disables approximate hit counts.
+ For a positive value approximate hit count is enabled
if it is known to be larger than integer.
@@ -425,7 +438,7 @@
permstring
- Specifies permissions (priviledge) for a user that are allowed
+ Specifies permissions (privilege) for a user that are allowed
to access &zebra; via the passwd system. There are two kinds
of permissions currently: read (r) and write(w). By default
users not listed in a permission directive are given the read
@@ -440,13 +453,53 @@
- dbaccess accessfile
+ dbaccess: accessfile
Names a file which lists database subscriptions for individual users.
- The access file should consists of lines of the form username:
- dbnames, where dbnames is a list of database names, seprated by
- '+'. No whitespace is allowed in the database list.
+ The access file should consists of lines of the form
+ username: dbnames, where dbnames is a list of
+ database names, separated by '+'. No whitespace is allowed in the
+ database list.
+
+
+
+
+
+ encoding: charsetname
+
+
+ Tells &zebra; to interpret the terms in Z39.50 queries as
+ having been encoded using the specified character
+ encoding. The default is ISO-8859-1; one
+ useful alternative is UTF-8.
+
+
+
+
+
+ storeKeys: value
+
+
+ Specifies whether &zebra; keeps a copy of indexed keys.
+ Use a value of 1 to enable; 0 to disable. If storeKeys setting is
+ omitted, it is enabled. Enabled storeKeys
+ are required for updating and deleting records. Disable only
+ storeKeys to save space and only plan to index data once.
+
+
+
+
+
+ storeData: value
+
+
+ Specifies whether &zebra; keeps a copy of indexed records.
+ Use a value of 1 to enable; 0 to disable. If storeData setting is
+ omitted, it is enabled. A storeData setting of 0 (disabled) makes
+ Zebra fetch records from the original locaction in the file
+ system using filename, file offset and file length. For the
+ DOM and ALVIS filter, the storeData setting is ignored.
@@ -773,9 +826,7 @@
The value of the register setting is a sequence
of tokens. Each token takes the form:
-
- dir:size
-
+ dir:size
The dir specifies a directory in which index files
will be stored and the size specifies the maximum
@@ -1029,7 +1080,7 @@
Static Ranking
- &zebra; uses internally inverted indexes to look up term occurencies
+ &zebra; uses internally inverted indexes to look up term frequencies
in documents. Multiple queries from different indexes can be
combined by the binary boolean operations AND,
OR and/or NOT (which
@@ -1120,7 +1171,7 @@
The default rank-1 ranking module implements a
TF/IDF (Term Frequecy over Inverse Document Frequency) like
- algorithm. In contrast to the usual defintion of TF/IDF
+ algorithm. In contrast to the usual definition of TF/IDF
algorithms, which only considers searching in one full-text
index, this one works on multiple indexes at the same time.
More precisely,
@@ -1833,7 +1884,7 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
Extended services debugging guide
- When debugging ES over PHP we recomment the following order of tests:
+ When debugging ES over PHP we recommend the following order of tests:
@@ -1854,14 +1905,14 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
yaz-client like described in
,
and
- remeber the -a option which tells you what
+ remember the -a option which tells you what
goes over the wire! Notice also the section on permissions:
try
perm.anonymous: rw
in zebra.cfg to make sure you do not run into
- permission problems (but never expose such an unsecure setup on the
+ permission problems (but never expose such an insecure setup on the
internet!!!). Then, make sure to set the general
recordType instruction, pointing correctly
to the GRS-1 filters,