.\" 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 "Net::Z3950::Simple2ZOOM 3pm" .TH Net::Z3950::Simple2ZOOM 3pm "2009-04-08" "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" Net::Z3950::Simple2ZOOM \- Gateway between Z39.50 and SRU/SRW .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use Net::Z3950::Simple2ZOOM; \& $s2z = new Net::Z3950::Simple2ZOOM("somefile.xml"); \& $s2z\->launch_server("someServer", @ARGV); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \f(CW\*(C`Net::Z3950::Simple2ZOOM\*(C'\fR module provides all the application logic of a generic \*(L"Swiss Army Gateway\*(R" between Z39.50 and \s-1SRU\s0. It is used by the \f(CW\*(C`simple2zoom\*(C'\fR program, and there is probably no good reason to make any other program to use it. For that reason, this library-level documentation is more than usually terse. .PP The library has only two public entry points: the \f(CW\*(C`new()\*(C'\fR constructor and the \f(CW\*(C`launch_server()\*(C'\fR method. The synopsis above shows how they are used: a Simple2ZOOM object is created using \f(CW\*(C`new()\*(C'\fR, then the \&\f(CW\*(C`launch_server()\*(C'\fR method is invoked on it to \*(-- get ready for a big surprise here \*(-- launch the server. (In fact, this synopsis is essentially the whole of the code of the \f(CW\*(C`simple2zoom\*(C'\fR program. All the work happens inside the library.) .SH "METHODS" .IX Header "METHODS" .SS "new($configFile)" .IX Subsection "new($configFile)" .Vb 1 \& $s2z = new Net::Z3950::Simple2ZOOM("somefile.xml"); .Ve .PP Creates and returns a new Simple2ZOOM object, configured according to the \s-1XML\s0 file \f(CW$configFile\fR that is the only argument. The format of this file is described in \f(CW\*(C`Net::Z3950::Simple2ZOOM::Config\*(C'\fR. .ie n .SS "launch_server($label, @ARGV)" .el .SS "launch_server($label, \f(CW@ARGV\fP)" .IX Subsection "launch_server($label, @ARGV)" .Vb 1 \& $s2z\->launch_server("someServer", @ARGV); .Ve .PP Launches the Simple2ZOOM server: this method never returns. The \&\f(CW$label\fR string is used in logging, and the \f(CW@ARGV\fR vector of command-line arguments is interpreted by the \s-1YAZ\s0 backend server as described at http://www.indexdata.dk/yaz/doc/server.invocation.tkl .SH "SEE ALSO" .IX Header "SEE ALSO" The \f(CW\*(C`simple2zoom\*(C'\fR program. .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 .PP Mike Taylor .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.