Fixes.
authorAdam Dickmeiss <adam@indexdata.dk>
Wed, 28 Aug 1996 09:35:53 +0000 (09:35 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Wed, 28 Aug 1996 09:35:53 +0000 (09:35 +0000)
doc/egate.sgml
doc/web.sgml

index fab7a50..230c1e3 100644 (file)
@@ -1,14 +1,14 @@
-<!doctype linuxdoc system>
-
-<!--
-  $Id: egate.sgml,v 1.12 1996/08/28 08:03:48 adam Exp $
+        <!doctype linuxdoc system>
+        
+<!--    
+  $Id: egate.sgml,v 1.13 1996/08/28 09:35:53 adam Exp $
 -->
 
 <article>
 -->
 
 <article>
-<title>Email/Z39.50 gateway guide 
+<title>Email - Z39.50 gateway guide 
 <author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk"
  name="http://europagate.dtv.dk">
 <author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk"
  name="http://europagate.dtv.dk">
-<date>$Revision: 1.12 $
+<date>$Revision: 1.13 $
 <abstract>
 This document describes a Email server that provides access to the
 Z39.50 protocol.
 <abstract>
 This document describes a Email server that provides access to the
 Z39.50 protocol.
@@ -27,9 +27,6 @@ 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.
 
 deviations from the design. Also, the second part contains
 a quick overview of the source code.
 
-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>
 <sect>Installation
 
 <p>
@@ -62,23 +59,21 @@ 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.
 
 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 by setting the variables <tt/REGEXOBJ/
-and <tt/REGXINC/. 
+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/. 
 
 
-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.
+Some systems need you to add libraries for socket access. In this
+case specify the <tt/ELIB/ variable.
 
 
-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 next section of the <tt/Makefile/ you specify the location of your
+Z39.50 library - zdist or YAZ.
 
 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.
 
 
 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/. 
+Now, run <tt/make/. 
 
 <p>
 If the compilation succeeds, you should install the software in some
 
 <p>
 If the compilation succeeds, you should install the software in some
@@ -87,7 +82,7 @@ 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.
 
 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.email/.
+When satisfied, type <tt/make install/.
 
 Three executables are installed in EMAILLIBDIR:
 <descrip>
 
 Three executables are installed in EMAILLIBDIR:
 <descrip>
@@ -486,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.
 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 &mdash; in retrospect somewhat motivated by the 
 
 In February some of us began the development of a new Z39.50 package 
 called YAZ &mdash; in retrospect somewhat motivated by the 
index cb50078..805afc8 100644 (file)
@@ -1,14 +1,14 @@
 <!doctype linuxdoc system>
 
 <!--
 <!doctype linuxdoc system>
 
 <!--
-  $Id: web.sgml,v 1.3 1996/08/09 15:42:13 adam Exp $
+  $Id: web.sgml,v 1.4 1996/08/28 09:35:54 adam Exp $
 -->
 
 <article>
 <title>Web/Z39.50 gateway guide
 <author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk"
  name="http://europagate.dtv.dk">
 -->
 
 <article>
 <title>Web/Z39.50 gateway guide
 <author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk"
  name="http://europagate.dtv.dk">
-<date>$Revision: 1.3 $
+<date>$Revision: 1.4 $
 <abstract>
 This document describes a Web server that provides access to the
 Z39.50 protocol.
 <abstract>
 This document describes a Web server that provides access to the
 Z39.50 protocol.
@@ -22,8 +22,7 @@ Z39.50 protocol.
 The <htmlurl url="http://europagate.dtv.dk" name="EUROPAGATE">
 project developed two Z39.50 gatways that served as
 Z39.50 clients: an email gateway and a web gateway. This document
 The <htmlurl url="http://europagate.dtv.dk" name="EUROPAGATE">
 project developed two Z39.50 gatways that served as
 Z39.50 clients: an email gateway and a web gateway. This document
-describes how to compile and install the web gateway. For information
-about the email gateway see the document egate.txt.
+describes how to compile and install the web gateway.
 
 <sect>Installation
 
 
 <sect>Installation
 
@@ -43,7 +42,7 @@ You also need the Tcl package which can be found at:
 <htmlurl url="ftp://ftp.sunlabs.com/pub/tcl"
  name="ftp://ftp.sunlabs.com/pub/tcl">
 
 <htmlurl url="ftp://ftp.sunlabs.com/pub/tcl"
  name="ftp://ftp.sunlabs.com/pub/tcl">
 
-Unpack <tt>egate.tar.gz</tt> and edit the top level
+Unpack <tt>web-z39-...tar.gz</tt> and edit the top level
 <tt/Makefile/. Specify where the YAZ package can be found by setting
 the the include path <tt/ZINC/, and the YAZ library <tt/ZLIB/.
 Some systems need extra socket libraries - in this case set the
 <tt/Makefile/. Specify where the YAZ package can be found by setting
 the the include path <tt/ZINC/, and the YAZ library <tt/ZLIB/.
 Some systems need extra socket libraries - in this case set the
@@ -58,13 +57,13 @@ compiling. The CGI program, <tt/egwcgi/, will be installed in the
 <tt/CGIDIR/ directory. HTML - and images files are installed in
 the <tt/HTDOCS/ and the <tt/GIFDIR/ directories respectively.
 
 <tt/CGIDIR/ directory. HTML - and images files are installed in
 the <tt/HTDOCS/ and the <tt/GIFDIR/ directories respectively.
 
-The shell variables <tt/CC/ and <tt/CFLAGS/ are used by the
-<tt/Makefile/ so you may modify these in your shell before compiling.
+You may wish to define the <tt/CC/ or <tt/CFLAGS/ variables in the
+<tt/Makefile/ or set them in your shell.
 
 
-Now, type <tt/make web/
+Now, type <tt/make/
 
 If the compilation succeeds, you should install the software in target
 
 If the compilation succeeds, you should install the software in target
-directories, by issuing: <tt/make install.web/.
+directories, by issuing: <tt/make install/.
 
 A HTML file called <tt/egwindex.html/ should be installed in your
 <tt/HTDOCS/ directory. The page contains miscellaneous starting links
 
 A HTML file called <tt/egwindex.html/ should be installed in your
 <tt/HTDOCS/ directory. The page contains miscellaneous starting links
@@ -132,7 +131,7 @@ The <tt/z39util.tcl/ file declares a lot of Tcl functions to
 facilitate Z39.50 communication as well as other utilities.
 
 <tag/*.egw/ HTML files with embedded Tcl - located in the <tt/EGWDIR/
 facilitate Z39.50 communication as well as other utilities.
 
 <tag/*.egw/ HTML files with embedded Tcl - located in the <tt/EGWDIR/
-directory. Normally, each file correspond to one type of Web
+directory. Normally, each file corresponds to one type of Web
 page. For example, the <tt/query.egw/ file contacts a single
 target and displays a search form; the <tt/search.egw/ file
 makes a Z39.50 search/present and displays the result.
 page. For example, the <tt/query.egw/ file contacts a single
 target and displays a search form; the <tt/search.egw/ file
 makes a Z39.50 search/present and displays the result.
@@ -168,10 +167,11 @@ The scripts with the extension <tt/egw/ are HTML files with embedded Tcl.
 Tcl code is initiated with a left curly brace <tt/{/ and is terminated
 with a right curly brace <tt/}/. The Tcl code is executed on the
 top level, i.e. variables are accessed in the global scope.
 Tcl code is initiated with a left curly brace <tt/{/ and is terminated
 with a right curly brace <tt/}/. The Tcl code is executed on the
 top level, i.e. variables are accessed in the global scope.
-Standard Tcl commands, IrTcl commands (for Z39.50 communication), and
+Standard Tcl commands, IrTcl commands to access the Z39.50
+communication layer, and
 an extra set of "gateway" commands are available in the embedded Tcl code.
 The extra set of commands are used to communicate with the Europagate
 an extra set of "gateway" commands are available in the embedded Tcl code.
 The extra set of commands are used to communicate with the Europagate
-software:
+software. These are:
 
 <descrip>
 <tag/html/ Concatenates the arguments and transfers them to the HTTP server.
 
 <descrip>
 <tag/html/ Concatenates the arguments and transfers them to the HTTP server.
@@ -192,7 +192,7 @@ Note, that except from the <tt/html/ command all commands have a
 Apart from the new commands, the following global variables are set:
 <descrip>
 <tag/sessionId/ ID of the current user session (integer).
 Apart from the new commands, the following global variables are set:
 <descrip>
 <tag/sessionId/ ID of the current user session (integer).
-<tag/env/ Array of environment variables - standard Tcl really.
+<tag/env/ Array of environment variables - this is standard Tcl, really.
 </descrip>
 
 <sect>LICENSE
 </descrip>
 
 <sect>LICENSE