X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fegate.sgml;h=edee040c38e42a87d449596235727d719ea07127;hb=7b58e36bc4c5a57dec46408bbfb3707638dd967a;hp=5c3704c2fc38e97f31cdefe1620d3f44a6dd11eb;hpb=1dcb80b009d6e07089380c15b920f3e3b2937799;p=egate.git diff --git a/doc/egate.sgml b/doc/egate.sgml index 5c3704c..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.7 $ +<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. @@ -34,50 +37,57 @@ The ES can use either CNIDR's Zdist package or the YAZ package from Index Data to interface the Z39.50 protocol. So you need to obtain one of these first. -The Zdist package can be found in: +The zdist package can be found in: -<url url="ftp://ftp.cnidr.org/pub/NIDR.tools/zdist/zdist102b1-1.tar.Z" > +<htmlurl +url="ftp://ftp.cnidr.org/pub/NIDR.tools/zdist/zdist102b1-1.tar.Z" + name="ftp://ftp.cnidr.org/pub/NIDR.tools/zdist/zdist102b1-1.tar.Z"> -The Zdist package doesn't support result-set references. Also, it has a few +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/. +to build the zdist software in the directory <tt/libz3950/. -YAZ can be found in: +YAZ can be found at the FTP host: -<url url="ftp://ftp.algonet.se/pub/index/yaz/">. +<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/. -The shell variables <tt/CC/ and <tt/CFLAGS/ are used by the -<tt/Makefile/ so you may modify these before compiling. +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. -Now, type <tt/make/. +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/. -<sect>Installation +The shell variables <tt/CC/ and <tt/CFLAGS/ are used by the +<tt/Makefile/ so you may set these in your shell before you start +compiling. + +Now, type <tt/make email/. <p> -If the compilation succeeds, you should install the software. -Edit the <tt/Makefile/ and set the LIBDIR to the installation +If the compilation succeeds, you should install the software in some +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. -When satisfied, type <tt/make install/. +When satisfied, type <tt/make install.email/. -Three executables are installed in LIBDIR: +Three executables are installed in EMAILLIBDIR: <descrip> <tag/eti/ The email transport interface. This program receives incoming mail, identifies the user, and delivers the mail request @@ -96,7 +106,7 @@ The <tt/sendmail/ or a similar program delivers the mail to the you create a special user and group for the ES software. In this case you should use <tt/chmod/ to and set the 'set user ID on execution' bits on the executable files and give that user read/write/execute -permissions in LIBDIR. +permissions in EMAILLIBDIR. The mail system needs to know about the ES. Pick some name that serves as the ES user and edit <tt/aliases/ used by your mail system (usually @@ -104,7 +114,7 @@ as the ES user and edit <tt/aliases/ used by your mail system (usually <tt>es:"|/usr/local/lib/es/eti </tt><em>options</em><tt>"</tt> -In this example the mail user name is <tt/es/ and the LIBDIR is +In this example the mail user name is <tt/es/ and the EMAILLIBDIR is <tt>/usr/local/lib/es</tt>. The ES system can operate with or without the monitor. When using @@ -647,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: