X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzebra.sgml;h=6ca296d61c4cd92a7865371c3c3b4042ace6eeba;hb=5260b5390d8a1a36c66e52083e8ebb9d26b49f01;hp=e204727bc74a18ed18e485fa7125979f242b248c;hpb=5c693d36af8be6f6642257160b3c6441d2e2d762;p=idzebra-moved-to-github.git diff --git a/doc/zebra.sgml b/doc/zebra.sgml index e204727..6ca296d 100644 --- a/doc/zebra.sgml +++ b/doc/zebra.sgml @@ -1,14 +1,14 @@
Zebra Server - Administrators's Guide and Reference <author><htmlurl url="http://www.indexdata.dk/" name="Index Data">, <tt><htmlurl url="mailto:info@indexdata.dk" name="info@indexdata.dk"></> -<date>$Revision: 1.40 $ +<date>$Revision: 1.42 $ <abstract> The Zebra information server combines a versatile fielded/free-text search engine with a Z39.50-1995 frontend to provide a powerful and flexible @@ -192,15 +192,34 @@ An ANSI C compiler is required to compile the Zebra server system — <tt/gcc/ works fine if your own system doesn't provide an adequate compiler. -Unpack the distribution archive. In some cases, you may want to edit -the top-level <tt/Makefile/, eg. to select a different C compiler, or -to specify machine-specific libraries in the <bf/ELIBS/ variable. +Unpack the distribution archive. The <tt>configure</tt> shell script +attempts to guess correct values for various system-dependent variables +used during compilation. It uses those values to create a 'Makefile' in +each directory of Zebra. -When you are done editing the <tt>Makefile</tt> type: +To run the configure script type: <tscreen><verb> -$ make + ./configure </verb></tscreen> +The configure script attempts to use C compiler specified by +the <tt>CC</tt> environment variable. If not set, <tt>cc</tt> +will be used. The <tt>CFLAGS</tt> environment variable holds +options to be passed to the C compiler. If you're using a Bourne-shell +compatible shell you may pass something like this: +<tscreen><verb> + CC=/opt/ccs/bin/cc CFLAGS=-O ./configure +</verb></tscreen> + +When configured build the software by typing: +<tscreen><verb> + make +</verb></tscreen> + +As an option you may type <tt>make depend</tt> to create +source file dependencies for the package. This is only needed, +however, if you alter the source. + If successful, two executables have been created in the sub-directory <tt/index/. <descrip> @@ -560,7 +579,7 @@ There are three kinds of tokens: <tag>Internal record info</tag> The token refers to a key that is extracted from the record. The syntax of this token is <tt/(/ <em/set/ <tt/,/ <em/use/ <tt/)/, where <em/set/ is the -attribute set ordinal number and <em/use/ is the use value of the attribute. +attribute set name <em/use/ is the name or value of the attribute. <tag>System variable</tag> The system variables are preceded by <verb>$</verb> and immediately followed by the system variable name, which may one of @@ -574,18 +593,18 @@ may one of </descrip> For instance, the sample GILS records that come with the Zebra -distribution contain a -unique ID -in the Control-Identifier field. This field is mapped to the Bib-1 -use attribute 1007. To use this field as a record id, specify -<tt>(1,1007)</tt> as the value of the <tt>recordId</tt> in the -configuration file. If you have other record types that uses -the same field for a different purpose, you might add the record type (or group or database name) -to the record id of the gils records as well, to prevent matches -with other types of records. In this case the recordId might be -set like this: +distribution contain a unique ID in the data tagged Control-Identifier. +The data is mapped to the Bib-1 use attribute Identifier-standard +(code 1007). To use this field as a record id, specify +<tt>(bib1,Identifier-standard)</tt> as the value of the +<tt>recordId</tt> in the configuration file. +If you have other record types that uses the same field for a +different purpose, you might add the record type +(or group or database name) to the record id of the gils +records as well, to prevent matches with other types of records. +In this case the recordId might be set like this: <tscreen><verb> -gils.recordId: $type (1,1007) +gils.recordId: $type (bib1,Identifier-standard) </verb></tscreen> (see section <ref id="data-model" name="Configuring Your Data Model">