X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README.txt;h=e43628c2d8755ca40f3d1ce8ef6125a39adf4010;hb=b416df50f7dec326e96cd809220ea66a66044e88;hp=95b94b8b6df384e92df5952ecd70fa5e0d7de64a;hpb=cc44793fb69db2885c570cc5de05fda796993bba;p=yazpp-moved-to-github.git

diff --git a/README.txt b/README.txt
index 95b94b8..e43628c 100644
--- a/README.txt
+++ b/README.txt
@@ -1,66 +1,100 @@
 YAZ++ - A C++ library for YAZ
 
-$Id: README.txt,v 1.3 1999-02-02 14:01:10 adam Exp $
+$Id: README.txt,v 1.9 2001-04-25 19:40:18 adam Exp $
  
 o Introduction
 
-YAZ is a development toolkit that implements the ANSI Z39.50 protocol.
-YAZ homepage is: http://www.indexdata.dk/yaz
+YAZ++ is a C++ layer for YAZ and implements the ANSI Z39.50
+protocol for information retrieval (client - and server side).
+YAZ homepage is: http://www.indexdata.dk/yaz/
 
-YAZ++ is a C++ wrapper on top of that YAZ. It provides a relatively
-simple, high level, interface to YAZ.
+YAZ++ uses the same license as YAZ - see LICENSE file for details.
 
 o Overview
 
 YAZ++ builds a programmers' library libyaz++.lib and a few
 example applications:
-  yaz-client   -  small client
-  yaz-server   -  small server
-  yaz-proxy    -  simple proxy server
-
-Description in HTML format of object model can be found in the sub
-directory doc. The top-page of the documentaion is index.html. The
-documentation was auto-generated from YAZ++ source using doc++.
+  yaz-my-client      basic client
+  yaz-my-server      basic server
+  yaz-proxy          not-so-basic proxy server
 
 Directory structure of the YAZ++ package.
 
   -- src (C++ source)
-  -- include (C++ headers) 
-  -- doc (documentation)
-  -- unix (UNIX configure script and Makefile)
+  -- include/yaz++ (C++ headers) 
   -- win (Windows build files)
 
 o Installation, Unix
 
-Make sure you have a C - and C++ compiler available. gcc and
-g++ works fine.
+Make sure you have a C - and C++ compiler available. gcc and g++ works fine.
 
-Before compilation can take place YAZ must be installed. Unpack
-yaz-<version>.tar.gz in the same directory as yaz++. First
-build YAZ:
+Before compilation can take place YAZ must be installed. It goes, roughly,
+like this:
 
   $ cd yaz-<version>
   $ ./configure
   $ make
+  $ cd ..
 
 Then, build YAZ++:
 
   $ cd yaz++-<version>
-  $ cd unix
   $ ./configure
   $ make
 
 o Installation, Windows
 
-Software is WIN32 and should run on Windows 95/98 and Windows NT 4.0.
-Yaz++ was build using Microsoft Visual C++ 5.0 and 6.0. Other compilers
-should work but makefile/project files will have created for those
-compiler environments.
+YAZ++ for WIN32 should run on Windows 95/98/2K and Windows NT 4.0.
+Yaz++ was built using Microsoft Visual C++ 6.0. Other compilers
+should work but makefile/project files will have to be created for
+those compilers.
 
-  Open workspace yazxx.dsw that includes four projects
+  Workspace yazxx.dsw includes the projects
     yazxx.dsp       -   builds yazxx.dll
-    yazclient.dsp   -   builds yazclient.exe
-    yazserver.dsp   -   builds yazserver.exe
+    yazclient.dsp   -   builds yazmyclient.exe
+    yazserver.dsp   -   builds yazmyserver.exe
     yazproxy.dsp    -   builds yazproxy.exe
 
-
+o About the proxy..
+
+For the proxy the actual target is determined in by the OtherInfo
+part of the InitRequest. We've defined an OID for this which we call
+PROXY. OID is 1.2.840.10003.10.1000.81.1. 
+
+  OtherInformation   ::= [201] IMPLICIT SEQUENCE OF SEQUENCE{
+    category            [1]   IMPLICIT InfoCategory OPTIONAL, 
+    information        CHOICE{
+      characterInfo        [2]  IMPLICIT InternationalString,
+      binaryInfo        [3]  IMPLICIT OCTET STRING,
+      externallyDefinedInfo    [4]  IMPLICIT EXTERNAL,
+      oid          [5]  IMPLICIT OBJECT IDENTIFIER}}
+--
+  InfoCategory ::= SEQUENCE{
+      categoryTypeId  [1]   IMPLICIT OBJECT IDENTIFIER OPTIONAL,
+      categoryValue  [2]   IMPLICIT INTEGER}
+
+The InfoCategory is present with categoryTypeId set to the PROXY OID
+and categoryValue set to 0. The information in OtherInformation uses
+characterInfo to represent the target using the form target[:port][/db].
+
+For the client that doesn't set the PROXY OtherInformation, a default
+target can be specified using option -t for proxy.
+
+Example:
+  We start the proxy so that it listens on port 9000. The default
+  target is Bell Labs Library unless it is specified by a client in
+  the InitRequest.
+
+     $ ./yaz-proxy -t z3950.bell-labs.com/books @:9000
+
+  The client is started and talks to the proxy without specifying
+  a target. Hence this client will talk to the Bell Labs server.
+     $ ./yaz-client localhost:9000
+
+  The client is started and it specifies the actual target itself.
+     $ ./yaz-client -p localhost:9000 bagel.indexdata.dk/gils
+
+  For ZAP the equivalent would be
+     proxy=localhost:9000
+     target=bagel.indexdata.dk/gils
+  Simple, huh!