Describe ZOOM-module scan() method changes.

[ZOOM-Perl-moved-to-github.git] / lib / ZOOM.pod

diff --git a/lib/ZOOM.pod b/lib/ZOOM.pod
index eb9204f..998a03a 100644 (file)
--- a/lib/ZOOM.pod
+++ b/lib/ZOOM.pod
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pod,v 1.22 2005-12-13 16:46:59 mike Exp $
+# $Id: ZOOM.pod,v 1.23 2005-12-19 17:42:15 mike Exp $
 
 use strict;
 use warnings;
@@ -300,7 +300,9 @@ the query rather than an object, thereby obviating the need to create
 a C<ZOOM::Query::PQF> object.  See the documentation of that class for
 information about PQF.
 
-=head4 scan()
+=head4 scan() / scan1()
+
+ ### Code sample needed here!
 
 Many Z39.50 servers allow you to browse their indexes to find terms to
 search for.  This is done using the C<scan> method, which creates and
@@ -372,6 +374,11 @@ each one returned in the ScanSet.  By default, no terms are skipped,
 but overriding this can be useful to get a high-level overview of the
 index.
 
+The C<scan1()> method is the same as C<scan()> except that it takes a
+Query object as its argument instead of a PQF string.  This means
+that it can be used to scan using a CQL term, so long as the
+underlying ZOOM-C library supports this.
+
 =back
 
 =head4 package()