X-Git-Url: http://git.indexdata.com/?p=simpleserver-moved-to-github.git;a=blobdiff_plain;f=SimpleServer.pm;h=a083e184afc477de8efb77779c425fb0051e978d;hp=6ab4042e89348b5fa3726d167a8b9f4e71b92a78;hb=f024b7a1fa4b9d56730b12aba0f3a1975bcfc577;hpb=2a61e82a97b2c0347018e6bd95619253fc7c2fda

diff --git a/SimpleServer.pm b/SimpleServer.pm
index 6ab4042..a083e18 100644
--- a/SimpleServer.pm
+++ b/SimpleServer.pm
@@ -25,7 +25,7 @@
 ##
 ##
 
-## $Id: SimpleServer.pm,v 1.34 2007-08-15 13:14:29 mike Exp $
+## $Id: SimpleServer.pm,v 1.36 2007-08-17 16:45:22 mike Exp $
 
 package Net::Z3950::SimpleServer;
 
@@ -601,6 +601,8 @@ an index of a book, you always find something! The parameters exchanged are
 		DATABASES	=> ["xxx"],	## Reference to a list of data-
 						## bases to search
 		TERM		=> 'start',	## The start term
+		RPN		=>  $obj,       ## Reference to a Net::Z3950::RPN::Term
+
 		NUMBER		=> xx,		## Number of requested terms
 		POS		=> yy,		## Position of starting point
 						## within returned list
@@ -633,14 +635,23 @@ should point at a data structure of this kind,
 				...
 	];
 
-The $status flag should be assigned one of two values:
+The $status flag is only meaningful after a successful scan, and
+should be assigned one of two values:
 
-  Net::Z3950::SimpleServer::ScanSuccess  On success (default)
-  Net::Z3950::SimpleServer::ScanPartial  Less terms returned than requested
+  Net::Z3950::SimpleServer::ScanSuccess  Full success (default)
+  Net::Z3950::SimpleServer::ScanPartial  Fewer terms returned than requested
 
 The STEP member contains the requested number of entries in the term-list
 between two adjacent entries in the response.
 
+A better alternative to the TERM member is the the RPN
+member, which is a reference to a Net::Z3950::RPN::Term object
+representing the scan cloause.  The structure of that object is the
+same as for Term objects included as part of the RPN tree passed to
+search handlers.  This is more useful than the simple TERM because it
+includes attributes (e.g. access points associated with the term),
+which are discarded by the TERM element.
+
 =head2 Close handler
 
 The argument hash recieved by the close handler has two elements only: