From: mike <mike>
Date: Wed, 16 Nov 2005 15:36:16 +0000 (+0000)
Subject: Rolling.
X-Git-Tag: cpan_1_22~356
X-Git-Url: http://lists.indexdata.com/cgi-bin?a=commitdiff_plain;h=604153dfdcbf8fb8434d8da4fdd613ad50967040;p=ZOOM-Perl-moved-to-github.git

Rolling.
---

diff --git a/lib/ZOOM.pod b/lib/ZOOM.pod
index da85d4a..21a4a33 100644
--- a/lib/ZOOM.pod
+++ b/lib/ZOOM.pod
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pod,v 1.4 2005-11-16 14:54:43 mike Exp $
+# $Id: ZOOM.pod,v 1.5 2005-11-16 15:36:16 mike Exp $
 
 use strict;
 use warnings;
@@ -110,7 +110,7 @@ relevant section of the ZOOM Abstract API.
  print("server is '", $conn->option("serverImplementationName"), "'\n");
  $conn->option(preferredRecordSyntax => "usmarc");
  $conn->option_binary(iconBlob => "foo\0bar");
- $rs = $conn->search_pqf('@attr 1=4 mineral');
+ $rs = $conn->search_pqf('@attr 1=4 mineral');/usr/local/src/mike/records/acc-ounts/cheques-
  $ss = $conn->scan('@attr 1=1003 a');
  if ($conn->errcode() != 0) {
     die("somthing went wrong: " . $conn->errmsg())
@@ -136,25 +136,74 @@ http://zoom.z3950.org/api/zoom-current.html#3.2
 =head4 new()
 
  $conn = new ZOOM::Connection("indexdata.dk", 210);
- $conn = new ZOOM::Connection("indexdata.dk/gils:210");
- $conn = new ZOOM::Connection("tcp:indexdata.dk/gils:210");
- $conn = new ZOOM::Connection("http:indexdata.dk/gils:210");
+ $conn = new ZOOM::Connection("indexdata.dk:210/gils");
+ $conn = new ZOOM::Connection("tcp:indexdata.dk:210/gils");
+ $conn = new ZOOM::Connection("http:indexdata.dk:210/gils");
 
-I<###>
+Creates a new Connection object, and immediately connects it to the
+specified server.  If you want to make a new Connection object but
+delay forging the connection, use the C<create()> and C<connect()>
+methods instead.
+
+This constructor can be called with two arguments or a single
+argument.  In the former case, the arguments are the name and port
+number of the Z39.50 server to connect to; in the latter case, the
+single argument is a YAZ service-specifier string of the form
+
+=over 4
+
+=item
+
+[I<scheme>:]I<host>[:I<port>][/I<databaseName>]
+
+=back
+
+In which the I<host> and I<port> parts are as in the two-argument
+form, the I<databaseName> if provided specifies the name of the
+database to be used in subsequent searches on this connection, and the
+optional I<scheme> (default C<tcp>) indicates what protocol should be
+used.  At present, the following schemes are supported:
+
+=over 4
+
+=item tcp
+
+Z39.50 connection.
+
+=item ssl
+
+Z39.50 connection encrypted using SSL (Secure Sockets Layer).  Not
+many servers support this, but Index Data's Zebra is one that does.
+
+=item unix
 
-create
-connect
-error_x
-errcode
-errmsg
-addinfo
-option
-option_binary
-search
-search_pqf
-scan
-package
-destroy
+Z39.50 connection on a Unix-domain (local) socket, in which case the
+I<hostname> portion of the string is instead used as a filename in the
+local filesystem.
+
+=item http
+
+SRW connection using SOAP over HTTP.
+
+=back
+
+Support for SRU will follow in the fullness of time.
+
+=head4 create()
+
+=head4 connect()
+
+=head4 error_x() / errcode() / errmsg() / addinfo()
+
+=head4 option() / option_binary()
+
+=head4 search() / search_pqf()
+
+=head4 scan()
+
+=head4 package()
+
+=head4 destroy()
 
 =head2 ZOOM::ResultSet
 
@@ -268,6 +317,10 @@ The C<Net::Z3950::ZOOM> module, included in the same distribution as this one.
 
 The C<Net::Z3950> module, which this one supersedes.
 
+The documentation for the ZOOM-C module of the YAZ Toolkit, which this
+module is built on.  Specifically, its lists of options are useful.
+http://indexdata.com/yaz/doc/zoom.tkl
+
 The BIB-1 diagnostic set of Z39.50,
 http://www.loc.gov/z3950/agency/defns/bib1diag.html