X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fegate.sgml;h=acc7860b1d52fc41e95dfbc98ed3fb5aab1e2066;hb=7f332a840baf336e34d612cdee0ef27901f0dd11;hp=7eac1a5fec9906fdd57cda8ffe8d2fa411f21153;hpb=7f62c3490a9df36b4153d584a571f53d0badfb29;p=egate.git diff --git a/doc/egate.sgml b/doc/egate.sgml index 7eac1a5..acc7860 100644 --- a/doc/egate.sgml +++ b/doc/egate.sgml @@ -1,13 +1,14 @@ - - -
-Email/Z39.50 gateway guide -<author>Europagate, 1995 -<date>$Revision: 1.8 $ +<title>Email - Z39.50 gateway guide +<author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk" + name="http://europagate.dtv.dk"> +<date>$Revision: 1.14 $ <abstract> This document describes a Email server that provides access to the Z39.50 protocol. @@ -18,14 +19,15 @@ Z39.50 protocol. <sect>Introduction <p> -This document describes an email server subsystem developed -within the EUROPAGATE project. The first part of this document +This document describes an email server (ES) system developed +within the <htmlurl url="http://europagate.dtv.dk" name="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 +<sect>Installation <p> An ANSI C compiler is required in order to compile the ES software. @@ -34,53 +36,55 @@ 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: <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"> +url="ftp://ftp.cnidr.org/pub/NIDR.tools/zdist/archive/1.02/zdist102b1-1.tar.Z" +name="ftp://ftp.cnidr.org/pub/NIDR.tools/zdist/archive/1.02/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 at the FTP host: -<htmlurl url="ftp://130.225.252.168/index/yaz" - name="ftp://130.225.252.168/index/yaz"> +<htmlurl url="ftp://ftp.indexdata.dk/pub/yaz/" + name="ftp://ftp.indexdata.dk/pub/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. +Unpack <tt>email-z39-...tar.gz</tt> and edit the top level +<tt/Makefile/. Specify 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. +Some systems need you to add libraries for socket access. In this +case specify the <tt/ELIB/ variable. -Now, type <tt/make/. +The next section of the <tt/Makefile/ you specify the location of your +Z39.50 library - zdist or YAZ. -<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, run <tt/make/. <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/. -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 @@ -99,16 +103,16 @@ 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 <tt>usr/lib/aliases</tt>). Now add the following line: -<tt>es:"|/usr/local/lib/es/eti </tt><em>options</em><tt>"</tt> +<tt>es:"|/usr/local/lib/emailgw/eti </tt><em>options</em><tt>"</tt> -In this example the mail user name is <tt/es/ and the LIBDIR is -<tt>/usr/local/lib/es</tt>. +In this example the mail user name is <tt/es/ and the EMAILLIBDIR is +<tt>/usr/local/lib/emailgw</tt>. The ES system can operate with or without the monitor. When using the monitor the number of simultanous running kernels can be @@ -125,7 +129,7 @@ start the monitor in one of your boot scripts (rc). For example this might be put in a boot script: <tscreen><verb> -(cd /usr/local/lib/es; ./monitor -d -l mon.log -- -d -l kernel.log &) +(cd /usr/local/lib/emailgw; ./monitor -d -l mon.log -- -d -l kernel.log &) </verb></tscreen> Here the monitor is started with the options <tt>-d -l mon.log</tt> @@ -134,7 +138,7 @@ kernel. In this mode, the eti should contact the monitor (and not the kernel), so the following might be put in the aliases file: <tscreen><verb> -es:"|/usr/local/lib/es/eti -c /usr/local/lib/es" +es:"|/usr/local/lib/emailgw/eti -c /usr/local/lib/emailgw" </verb></tscreen> The eti sets current directory to the path specified by option <tt>-c</tt>. @@ -147,7 +151,7 @@ The eti will contact the kernel directly. The following line could be put in your aliases file: <tscreen><verb> -es:"|/usr/local/lib/es/eti -c /usr/local/lib/es -- -d -l kernel.log" +es:"|/usr/local/lib/emailgw/eti -c /usr/local/lib/emailgw -- -d -l kernel.log" </verb></tscreen> <sect1>eti @@ -477,9 +481,6 @@ standalone Zdist package</em> During the work with the Zdist package a few bugs were discovered. Fortunately, they could be solved within a few days. We also discovered that the package lacks result-set references. -We posted the bug fixes to Kevin Gamiel who is responsible for -the package but we didn't get responses. So, eventually, we weren't -satisfied with the package after all. In February some of us began the development of a new Z39.50 package called YAZ — in retrospect somewhat motivated by the @@ -650,7 +651,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: