.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Z3950::ZOOM 3pm"
.TH Net::Z3950::ZOOM 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::Z3950::ZOOM \- Perl extension for invoking the ZOOM\-C API.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\& use Net::Z3950::ZOOM;
\& $conn = Net::Z3950::ZOOM::connection_new($host, $port);
\& $errcode = Net::Z3950::ZOOM::connection_error($conn, $errmsg, $addinfo);
\& Net::Z3950::ZOOM::connection_option_set($conn, databaseName => "foo");
\& # etc.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides a simple thin-layer through to the ZOOM-C
functions in the YAZ toolkit for Z39.50 and SRW/U communication.  You
should not be using this very nasty, low-level API.  You should be
using the \f(CW\*(C`ZOOM\*(C'\fR module instead, which implements a nice, Perlish API
on top of this module, conformant to the ZOOM Abstract API described at
http://zoom.z3950.org/api/
.PP
To enforce the don't-use-this-module prohibition, I am not even going
to document it.  If you really, really, really want to use it, then it
pretty much follows the API described in the ZOOM-C documentation at
http://www.indexdata.dk/yaz/doc/zoom.tkl
.PP
The only additional (non-ZOOM-C) function provided by this module is
\&\f(CWevent_str()\fR, which takes as its argument an event code such as
\&\f(CW\*(C`Net::Z3950::ZOOM::EVENT_SEND_APDU\*(C'\fR, and returns a corresponding
short string.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The \f(CW\*(C`ZOOM\*(C'\fR module, included in the same distribution as this one.
.SH AUTHOR
.IX Header "AUTHOR"
Mike Taylor, <mike@indexdata.com>
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright (C) 2005\-2014 by Index Data.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.4 or,
at your option, any later version of Perl 5 you may have available.