X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README.txt;h=27fd545cb091bc35244e75381ac4f961392d0e79;hb=83433ae599bf74603082679df28e178a2f3d0ff7;hp=d66836675f6bd3873acc810795e00654e32cbd36;hpb=e3133d2f2c580f76c9da2e7621c74a064f0955c9;p=yazpp-moved-to-github.git

diff --git a/README.txt b/README.txt
index d668366..27fd545 100644
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,6 @@
 YAZ++ - A C++ library for YAZ
 
-$Id: README.txt,v 1.6 2000-10-11 11:58:16 adam Exp $
+$Id: README.txt,v 1.10 2001-11-06 17:08:05 adam Exp $
  
 o Introduction
 
@@ -14,25 +14,19 @@ 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
+  yaz-my-client      basic client
+  yaz-my-server      basic server
+  yaz-proxy          not-so-basic 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++.
-
-Directory structure of the YAZ++ package.
+Directory structure of the YAZ++ package:
 
   -- src (C++ source)
-  -- include (C++ headers) 
-  -- doc (documentation)
+  -- 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. It goes, roughly,
 like this:
@@ -50,13 +44,57 @@ Then, build YAZ++:
 
 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++ 6.0. Other compilers should
-work but makefile/project files will have to be 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.
 
   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!