X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fegate.sgml;fp=doc%2Fegate.sgml;h=edee040c38e42a87d449596235727d719ea07127;hb=3141eb0fa635c964fbe1302daaf23093e3b3ff5c;hp=72963b66d0469f53d5c821446813771364f6d2de;hpb=c836eee0ae4733a3b62b74080e5ee2e38a70533e;p=egate.git diff --git a/doc/egate.sgml b/doc/egate.sgml index 72963b6..edee040 100644 --- a/doc/egate.sgml +++ b/doc/egate.sgml @@ -1,13 +1,13 @@
Email/Z39.50 gateway guide -<author>Europagate, 1995 -<date>$Revision: 1.9 $ +<author>Europagate, 1996 +<date>$Revision: 1.10 $ <abstract> This document describes a Email server that provides access to the Z39.50 protocol. @@ -18,14 +18,17 @@ Z39.50 protocol. <sect>Introduction <p> -This document describes an email server subsystem developed +This document describes an email server (ES) system developed within the EUROPAGATE project. The first part of this document serves as an administrators guide, while the second part is a -follow-up on the Design deliverable (WP4.1) that outline the +follow-up on the Design deliverable (WP4.1) that outlines the deviations from the design. Also, the second part contains a quick overview of the source code. -<sect>Compilation +The software distribution also includes a Web to Z39.50 gateway. Refer +to the web.txt documentation about installation on this gateway. + +<sect>Installation <p> An ANSI C compiler is required in order to compile the ES software. @@ -44,10 +47,7 @@ The zdist package doesn't support result-set references. Also, it has a few bugs. Therefore we've included a patch <tt/zdist.patch/ which fixes some of these bugs. Run patch in the directory above <tt/zdist102b1-1/: -<tscreen><verb> -$ patch <zdist.patch -</verb></tscreen> - +<verb>patch <zdist.path</verb> The ES server only depends on <tt>libz3950.a</tt> so you only need to build the zdist software in the directory <tt/libz3950/. @@ -56,25 +56,31 @@ YAZ can be found at the FTP host: <htmlurl url="ftp://ftp.indexdata.dk/index/yaz" name="ftp://ftp.indexdata.dk/index/yaz"> -The ES also use GNU's regex package to parse regular expressions. +The ES also uses GNU's regex package to parse regular expressions. The ES has been tested with regex-0.12. Some systems, such as Linux, come with the regex package preinstalled. Unpack <tt>egate.tar.gz</tt> and edit the top level <tt/Makefile/. Specify -where the GNU regex package is located and specify whether you use -YAZ or zdist. One some systems, you may have to set the <tt/NETLIB/ as -well. +where the GNU regex package is located by setting the variables <tt/REGEXOBJ/ +and <tt/REGXINC/. + +A little further down the <tt/Makefile/ you find a section called +<tt/Common settings/ where you specify the location of either YAZ or zdist. +On some systems, you may have to set the <tt/ELIB/ as well to link with +BSD socket libraries. + +If you intend only to compile the Email server and not the Web server +you don't have to worry about the section entitled <tt/WWW gateway settings/. The shell variables <tt/CC/ and <tt/CFLAGS/ are used by the -<tt/Makefile/ so you may modify these before compiling. +<tt/Makefile/ so you may set these in your shell before you start +compiling. Now, type <tt/make email/. -<sect>Installation - <p> If the compilation succeeds, you should install the software in some -system location. +standard location. Edit the <tt/Makefile/ and set EMAILLIBDIR to the installation directory. Since, the ES is executed by the mail system, and not by a user, this directory shouldn't be globally executable. @@ -651,7 +657,7 @@ is a public header file. <sect>LICENSE <p> - Copyright © 1995, the EUROPAGATE consortium (see below). + Copyright © 1995-1996, the EUROPAGATE consortium (see below). The EUROPAGATE consortium members are: