.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SIMPLE2ZOOM 1p"
.TH SIMPLE2ZOOM 1p "2007-09-07" "perl v5.12.4" "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"
simple2zoom \- generic Swiss Army Server for proxying between IR standards
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\f(CW\*(C`simple2zoom\*(C'\fR
[
\&\f(CW\*(C`\-c\*(C'\fR
\&\fIconfigFile\fR
]
[
\&\f(CW\*(C`\-\-\*(C'\fR
\&\fIYAZ-options\fR
]
[
\&\fIlistener-address\fR
\&...
]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`simple2zoom\*(C'\fR provides a generic gateway between the Z39.50 and
\&\s-1SRU/SRW\s0 Information Retrieval protocols.  Because it relies on the
\&\f(CW\*(C`Net::Z3950::SimpleServer\*(C'\fR and \f(CW\*(C`ZOOM\*(C'\fR modules for the server and
client funcationality respectively, because both of these modules are
based on the \s-1YAZ\s0 toolkit, and because \s-1YAZ\s0 transparently handles all
three standard \s-1IR\s0 protocols (\s-1ANDI/NISO\s0 Z39.50, \s-1SRU\s0 and \s-1SRW\s0), it can
function as a gateway from any and to any of these protocols.
However, its principle purpose is as a Z39.50 server that proxies
requests through to a backend by acting as an \s-1SRU\s0 client.
.PP
The following command-line options govern how the gateway functions:
.IP "\-c configFile" 4
.IX Item "-c configFile"
Specifies that the named \fIconfigFile\fR should be used to configure the
functionality of the gateway: if this option is not specified, then
the file \f(CW\*(C`client.xml\*(C'\fR is used.  The format of the configuration file
is described separately in \f(CW\*(C`Net::Z3950::Simple2ZOOM::Config\*(C'\fR, and a
sample configuration file, \f(CW\*(C`test.xml\*(C'\fR, is supplied in the \f(CW\*(C`etc\*(C'\fR
directory of the distribution.
.IP "\-\-" 4
Indicates the end of \f(CW\*(C`simple2zoom\*(C'\fR\-specific options.  This is
required if \s-1YAZ\s0 options are to be specified, so that \f(CW\*(C`simple2zoom\*(C'\fR
doesn't try to interpret them itself.
.IP "\fIYAZ-options\fR" 4
.IX Item "YAZ-options"
Command-line arguments subsequent to the \f(CW\*(C`\-\-\*(C'\fR option are interpreted
by the \s-1YAZ\s0 backend server as described at
http://www.indexdata.dk/yaz/doc/server.invocation.tkl
.Sp
These options provide the means to control many aspects of the
gateway's functioning: for example, whether the server forks a new
process for each client or runs a single process using \f(CW\*(C`select()\*(C'\fR;
how (if at all) to interpret incoming \s-1SRU\s0 requests; whether and how to
log protocol packets for debugging.
.IP "\fIlistener-address\fR" 4
.IX Item "listener-address"
One or more YAZ-style listener addresses may be specified, and the
server will accept connections on those addresses: for example,
\&\f(CW@:9998\fR, \f(CW\*(C`unix:/tmp/somesocket\*(C'\fR or \f(CW\*(C`ssl:myhost.com:210\*(C'\fR.  If
no explicit listener addresses are provided, the server listens on
port 9999.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The \f(CW\*(C`Net::Z3950::Simple2ZOOM\*(C'\fR module.
.PP
The \f(CW\*(C`Net::Z3950::Simple2ZOOM::Config\*(C'\fR manual for the
configuration-file format.
.PP
The \f(CW\*(C`Net::Z3950::SimpleServer\*(C'\fR module.
.PP
The \f(CW\*(C`ZOOM\*(C'\fR module (in the \f(CW\*(C`Net::Z3950::ZOOM\*(C'\fR distribution).
.SH "AUTHOR"
.IX Header "AUTHOR"
Sebastian Hammer <quinn@miketaylor.org.uk>
.PP
Mike Taylor <mike@indexdata.com>
.PP
The development of \f(CW\*(C`simple2zoom\*(C'\fR, and the \f(CW\*(C`Net::Z3950::Simple2ZOOM\*(C'\fR
library that provides its functionality, has been partially sponsored
by the National Library of Australia, whose contribution we gratefully
acknowledge.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright (C) 2007 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.8 or,
at your option, any later version of Perl 5 you may have available.