SIMPLE2ZOOM(1p)

πŸ“¦
version 1.04 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– SIMPLE2ZOOM β€” like, the whole vibe πŸ’–

okay bestie, gather round, because we're talking about simple2zoom, also known as the SIMPLE2ZOOM(1p) manual page, and honestly? it's giving generic Swiss Army Server for proxying between IR standards. iconic behavior, no cap. πŸŽ€


✨ NAME ✨

simple2zoom β€” a generic Swiss Army Server for proxying between IR standards πŸ¦‹


✨ SYNOPSIS ✨

"simple2zoom" [ "-c" configFile ] [ "--" YAZ-options ] [ listener-address ... ]

✨ DESCRIPTION ✨

so simple2zoom is literally a generic gateway between the Z39.50 and SRU/SRW Information Retrieval protocols. periodt. πŸ’…

the way it works is: it leans on the Net::Z3950::SimpleServer and ZOOM modules for the server and client functionality respectively. and because both of those modules are based on the YAZ toolkit, and because YAZ transparently handles all three standard IR protocols β€” that's ANDI/NISO Z39.50, SRU and SRW, bestie β€” it can function as a gateway from any and to any of these protocols. 🌈

but lowkey, its principle purpose? being a Z39.50 server that proxies requests through to a backend by acting as an SRU client. main character energy fr fr. πŸ‘‘

the following command-line options govern how the gateway functions:

  • -c configFile β€” says "hey, use this named configFile to configure how the gateway functions." and if you don't specify this option? then the file client.xml is used, default queen. πŸ’œ the format of the config file is described separately in Net::Z3950::Simple2ZOOM::Config, and a sample config file, test.xml, is supplied in the etc directory of the distribution. slay.
  • -- β€” this indicates the end of simple2zoom-specific options. it's required if YAZ options are gonna be specified, so that simple2zoom doesn't try to interpret them itself. don't skip it, bestie, or things get messy. 😭
  • YAZ-options β€” command-line arguments that come after the -- option get interpreted by the YAZ backend server, as described at http://www.indexdata.dk/yaz/doc/server.invocation.tkl

these options are the ones that let you control sooo 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 select(); how (if at all) to interpret incoming SRU requests; and whether and how to log protocol packets for debugging. πŸ”₯

  • listener-address β€” one or more YAZ-style listener addresses may be specified, and the server will accept connections on those addresses. for example: @:9998, unix:/tmp/somesocket or ssl:myhost.com:210. 🫢 and if no explicit listener addresses are provided? the server listens on port 9999. defaults, we love her.

✨ SEE ALSO ✨

  • the Net::Z3950::Simple2ZOOM module. 🌸
  • the Net::Z3950::Simple2ZOOM::Config manual, for the configuration-file format. πŸ“–
  • the Net::Z3950::SimpleServer module. ✨
  • the ZOOM module (which lives in the Net::Z3950::ZOOM distribution). πŸ¦‹

✨ AUTHOR ✨

  • Sebastian Hammer <quinn@miketaylor.org.uk>
  • Mike Taylor <mike@indexdata.com>

and ok, cute backstory moment: the development of simple2zoom, and the Net::Z3950::Simple2ZOOM library that provides its functionality, has been partially sponsored by the National Library of Australia, whose contribution we gratefully acknowledge. πŸ₯ΉπŸ’– shoutout to them, genuinely.


Copyright (C) 2007 by Index Data.

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. πŸ’…


okay that's the whole page bestie, go forth and proxy responsibly 🫢

and that's a wrap on the SIMPLE2ZOOM(1p) era β€” perl v5.32.0, dated 2021-01-06, mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from