-## $Id: Makefile.am,v 1.13 2004-03-31 18:28:05 adam Exp $
+## $Id: Makefile.am,v 1.14 2004-04-11 12:13:32 adam Exp $
docdir=$(datadir)/doc/@PACKAGE@
SUPPORTFILES = \
introduction.xml \
installation.xml \
zoom.xml \
- proxy.xml \
api.xml \
- yaz-proxy-ref.xml \
- yaz-proxy-man.sgml \
license.xml \
yaz++.xml.in
TOP=yaz++.xml
-MANFILES=yaz-proxy.8
+MANFILES=
HTMLFILES = \
api.html \
implementations.html \
installation.html \
introduction.html \
license.html \
- other-optimizations.html \
- otherinfo-encoding.html \
- proxy-config-file.html \
- proxy-keepalive.html \
- proxy-target.html \
- proxy-usage.html \
- proxy.html \
- query-cache.html \
- query-validation.html \
- record-cache.html \
- record-validation.html \
windows.html \
- yaz-proxy.html \
- yaz.license.html \
yazpp.html \
zoom-connection.html \
zoom-exception.html \
$(HTMLFILES): $(XMLFILES)
jade -E14 -D $(srcdir) -d yazhtml.dsl -t sgml $(srcdir)/xml.dcl $(TOP)
-yaz-proxy.8: yaz-proxy-man.sgml yaz-proxy-ref.xml
- docbook2man $(srcdir)/yaz-proxy-man.sgml
-
yazpp.php: $(XMLFILES)
jade -E14 -D $(srcdir) -d yazphp.dsl -t sgml $(srcdir)/xml.dcl $(TOP)
<chapter id="installation">
- <!-- $Id: installation.xml,v 1.10 2004-03-31 18:28:05 adam Exp $ -->
+ <!-- $Id: installation.xml,v 1.11 2004-04-11 12:13:32 adam Exp $ -->
<title>Installation</title>
<para>
You need a C++ compiler to compile and use YAZ++.
what you want.
</para></listitem>
</varlistentry>
- <varlistentry>
- <term><literal>--with-xslt </literal>directory</term>
- <listitem><para>
- Specifies prefix for libxslt (and libxml2).
- configure must be able to locate <command>xslt-config</command>
- in PREFIX/bin. If this option is omitted, configure looks
- for <command>xslt-config</command> in the current PATH.
- </para></listitem>
- </varlistentry>
</variablelist>
For the whole list of <literal>configure</literal> options, refer
to the help:
This is what you have after successful compilation:
<variablelist>
<varlistentry>
- <term><literal>proxy/yaz-proxy</literal></term>
- <listitem><para>
- The YAZ <link linkend="proxy">Z39.50 Proxy</link>.
- This program gets installed in your binaries directory
- (<parameter>prefix</parameter><literal>/bin</literal>).
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
<term><literal>src/libyazcpp.la</literal></term>
<listitem><para>
The YAZ++ library.
</varlistentry>
<varlistentry>
- <term><literal>proxy/libyazproxy.la</literal></term>
- <listitem><para>
- The YAZ proxy library. This library gets installed in
- your libraries directory
- (<parameter>prefix</parameter><literal>/lib</literal>).
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
<term><literal>include/yaz++/*.h</literal></term>
<listitem><para>
Various C++ header files, which you'll need for YAZ++
(code generation is multi-threaded DLL).
</para></listitem>
</varlistentry>
-
- <varlistentry>
- <term><literal>HAVE_XSLT</literal>,
- <literal>LIBXSLT_DIR</literal></term>
- <listitem>
- <para>
- If <literal>HAVE_LIBXSLT</literal> is set to 1, the proxy is compiled
- with XSLT and XML support. In this configuration, set
- <literal>LIBXSLT_DIR</literal> to the
- <ulink url="http://www.xmlsoft.org/">libxslt</ulink> source
- directory.
- </para>
-
- <note>
- <para>
- If you enable libXSLT you have to enable libxml2 and its
- sub components zlib and iconv as well.
- </para>
- </note>
-
- <para>
- Windows versions of libxslt, libxml2, zlib and iconv can be found
- <ulink url="http://www.zlatkovic.com/libxml.en.html">
- here</ulink>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>HAVE_ICONV</literal>,
- <literal>ICONV_DIR</literal></term>
- <listitem><para>
- If <literal>HAVE_ICONV</literal> is set to 1, the proxy is
- compiled with iconv support. In this configuration, set
- <literal>ICONV_DIR</literal> to the iconv source directory.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>HAVE_LIBXML2</literal>,
- <literal>LIBXML2_DIR</literal></term>
- <listitem>
- <para>
- If <literal>HAVE_LIBXML2</literal> is set to 1, the proxy is compiled
- with XML support. In this configuration, set
- <literal>LIBXML2_DIR</literal> to the
- <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
- and
- <literal>ZLIB_DIR</literal> to the zlib directory.
- </para>
-
- <note>
- <para>
- YAZ++ is not using ZLIB. But libxml2 is.
- </para>
- </note>
- </listitem>
- </varlistentry>
-
</variablelist>
</para>
<para>
YAZ++ DLL . Includes ZOOM C++ as well.
</para></listitem></varlistentry>
- <varlistentry><term><filename>lib/yaz.lib</filename></term>
+ <varlistentry><term><filename>lib/yazpp.lib</filename></term>
<listitem><para>
Import library for <filename>yazpp.dll</filename>.
</para></listitem></varlistentry>
- <varlistentry><term><filename>bin/yazproxy.dll</filename></term>
- <listitem><para>
- YAZ proxy DLL.
- </para></listitem></varlistentry>
-
- <varlistentry><term><filename>lib/yazproxy.lib</filename></term>
- <listitem><para>
- Import library for <filename>yazproxy.dll</filename>.
- </para></listitem></varlistentry>
-
- <varlistentry><term><filename>bin/yaz-proxy.exe</filename></term>
- <listitem><para>
- YAZ proxy. It's a WIN32 console application.
- See <xref linkend="proxy"/> for more information.
- </para></listitem></varlistentry>
-
<varlistentry><term><filename>bin/zclient.exe</filename></term>
<listitem><para>
ZOOM C++ demo client. A simple WIN32 console application.
-<!-- $Id: introduction.xml,v 1.2 2004-04-11 11:16:39 adam Exp $ -->
+<!-- $Id: introduction.xml,v 1.3 2004-04-11 12:13:32 adam Exp $ -->
<chapter id="introduction"><title>Introduction</title>
<para>
<ulink url="http://www.indexdata.dk/yazplusplus/">YAZ++</ulink>
<para>
Later versions (0.7+) of YAZ++ also supports SRW/SRU.
</para>
- <para>
- This package also contains a proxy application and proxy developer
- library.
- The proxy application can be used to debug existing Z39.50
- implementations, optimize Z39.50 operation (by caching and other
- mechanisms), and offer a SRW/SRU service.
- </para>
-
<section>
<title>Licensing</title>
<para>
- The proxy application and the proxy library is covered by the
- <link linkend="gpl">GPL</link>.
- The remaning parts: the ZOOM-C++ library and the YAZ++ library is covered
- by the <link linkend="yaz.license">YAZ license</link>.
+ YAZ++ and ZOOM-C++ is is covered
+ by the <link linkend="yaz.license">YAZ license</link>.
</para>
</section>
</chapter>
-<!-- $Id: license.xml,v 1.4 2004-03-31 18:28:06 adam Exp $ -->
+<!-- $Id: license.xml,v 1.5 2004-04-11 12:13:32 adam Exp $ -->
<appendix id="license"><title>License</title>
- <section id="gpl"><title>GPL</title>
-
- <para>
- YAZ Proxy,
- Copyright © 1999-2004 Index Data ApS.
- </para>
-
- <para>
- YAZ Proxy is free software; you can redistribute it and/or modify it under
- the terms of the GNU General Public License as published by the Free
- Software Foundation; either version 2, or (at your option) any later
- version.
- </para>
-
- <para>
- YAZ Proxy is distributed in the hope that it will be useful, but WITHOUT ANY
- WARRANTY; without even the implied warranty of MERCHANTABILITY or
- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- for more details.
- </para>
-
- <para>
- You should have received a copy of the GNU General Public License
- along with YAZ Proxy; see the file LICENSE.proxy. If not, write to the
- Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
- 02111-1307, USA.
- </para>
-
- <section><title>GNU General Public License</title>
- <screen>
- GNU GENERAL PUBLIC LICENSE
- Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.) You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
-
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- GNU GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term "modification".) Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
- 1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
- 2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
-
- c) If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such
- interactive use in the most ordinary way, to print or display an
- announcement including an appropriate copyright notice and a
- notice that there is no warranty (or else, saying that you provide
- a warranty) and that users may redistribute the program under
- these conditions, and telling the user how to view a copy of this
- License. (Exception: if the Program itself is interactive but
- does not normally print such an announcement, your work based on
- the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
- b) Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your
- cost of physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
-
- c) Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is
- allowed only for noncommercial distribution and only if you
- received the program in object code or executable form with such
- an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
- 5. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
- 6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
- 7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
- 9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
- 10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
- NO WARRANTY
-
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
- END OF TERMS AND CONDITIONS
- </screen>
- </section>
- </section>
-
<section id="yaz.license"><title>YAZ License</title>
<para>
+++ /dev/null
- <chapter id="proxy">
- <title>The YAZ Proxy</title>
- <para>
- The YAZ proxy is a transparent SRW/SRU/Z39.50-to-Z39.50 gateway.
- That is, it is a SRW/SRU/Z39.50 server which has as its back-end a
- Z39.50 client that forwards requests on to another server (known as
- the <firstterm>backend target</firstterm>.)
- </para>
- <para>
- -- All config directives --
- -- SRW/SRU ..
- -- Example config
- -- Mention XSLT conversion
- </para>
- <para>
- The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging
- APDUs, redirecting Z39.50 packages through firewalls, etc.
- Furthermore, it offers facilities that often
- boost performance for connectionless Z39.50 clients such
- as web gateways.
- </para>
- <para>
- Unlike most other server software, the proxy runs single-threaded,
- single-process. Every I/O operation
- is non-blocking so it is very lightweight and extremely fast.
- It does not store any state information on the hard drive,
- except any log files you ask for.
- </para>
-
- <section id="proxy-example">
- <title>Example: Using the Proxy to Log APDUs</title>
- <para>
- Suppose you use a commercial Z39.50 client for which you do not
- have source code, and it's not behaving how you think it should
- when running against some specific server that you have no control
- over. One way to diagnose the problem is to find out what packets
- (APDUs) are being sent and received, but not all client
- applications have facilities to do APDU logging.
- </para>
- <para>
- No problem. Run the proxy on a friendly machine, get it to log
- APDUs, and point the errant client at the proxy instead of
- directly at the server that's causing it problems.
- </para>
- <para>
- Suppose the server is running on <literal>foo.bar.com</literal>,
- port 18398. Run the proxy on the machine of your choice, say
- <literal>your.company.com</literal> like this:
- </para>
- <screen>
- yaz-proxy -a - -t tcp:foo.bar.com:18398 tcp:@:9000
- </screen>
- <para>
- (The <literal>-a -</literal> option requests APDU logging on
- standard output, <literal>-t tcp:foo.bar.com:18398</literal>
- specifies where the backend target is, and
- <literal>tcp:@:9000</literal> tells the proxy to listen on port
- 9000 and accept connections from any machine.)
- </para>
- <para>
- Now change your client application's configuration so that instead
- of connecting to <literal>foo.bar.com</literal> port 18398, it
- connects to <literal>your.company.com</literal> port 9000, and
- start it up. It will work exactly as usual, but all the packets
- will be sent via the proxy, which will generate a log like this:
- </para>
- <screen><![CDATA[
- decode choice
- initRequest {
- referenceId OCTETSTRING(len=4) 69 6E 69 74
- protocolVersion BITSTRING(len=1)
- options BITSTRING(len=2)
- preferredMessageSize 1048576
- maximumRecordSize 1048576
- implementationId 'Mike Taylor (id=169)'
- implementationName 'Net::Z3950.pm (Perl)'
- implementationVersion '0.31'
- }
- encode choice
- initResponse {
- referenceId OCTETSTRING(len=4) 69 6E 69 74
- protocolVersion BITSTRING(len=1)
- options BITSTRING(len=2)
- preferredMessageSize 1048576
- maximumRecordSize 1048576
- result TRUE
- implementationId '81'
- implementationName 'GFS/YAZ / Zebra Information Server'
- implementationVersion 'YAZ 1.9.1 / Zebra 1.3.3'
- }
- decode choice
- searchRequest {
- referenceId OCTETSTRING(len=1) 30
- smallSetUpperBound 0
- largeSetLowerBound 1
- mediumSetPresentNumber 0
- replaceIndicator TRUE
- resultSetName 'default'
- databaseNames {
- 'gils'
- }
- {
- smallSetElementSetNames choice
- generic 'F'
- }
- {
- mediumSetElementSetNames choice
- generic 'B'
- }
- preferredRecordSyntax OID: 1 2 840 10003 5 10
- {
- query choice
- type_1 {
- attributeSetId OID: 1 2 840 10003 3 1
- RPNStructure choice
- {
- simple choice
- attributesPlusTerm {
- attributes {
- }
- term choice
- general OCTETSTRING(len=7) 6D 69 6E 65 72 61 6C
- }
- }
- }
- }
- }
-]]>
- </screen>
- </section>
-
- <section id="proxy-target">
- <title>Specifying the Backend Target</title>
- <para>
- When the proxy receives a Z39.50 Initialize Request from a Z39.50
- client, it determines the backend target by the following rules:
- <orderedlist>
- <listitem>
- <para>If the <literal>InitializeRequest</literal> PDU from the
- client includes an
- <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
- element with OID
- <literal>1.2.840.10003.10.1000.81.1</literal>, then the
- contents of that element specify the target to be used, in the
- usual YAZ address format (typically
- <literal>tcp:<parameter>hostname</parameter>:<parameter>port</parameter></literal>)
- as described in
- <ulink url="http://www.indexdata.dk/yaz/doc/comstack.addresses.tkl"
- >the Addresses section of the YAZ manual</ulink>.
- </para>
- </listitem>
- <listitem>
- <para>Otherwise, the Proxy uses the default target, if one was
- specified on the command-line with the <literal>-t</literal>
- option. A default target can also be specified in the
- XML Config file.
- </para>
- </listitem>
- <listitem>
- <para>Otherwise, the proxy closes the connection with
- the client.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section id="proxy-keepalive">
- <title>Keep-alive Facility</title>
- <para>
- The keep-alive is a facility where the proxy keeps the connection to the
- backend - even if the client closes the connection to the proxy.
- </para>
- <para>
- If a new or another client connects to the proxy again and requests the
- same backend it will be reassigned to this backend. In this case, the
- proxy sends an initialize response directly to the client and an
- initialize handshake with the backend is omitted.
- </para>
- <para>
- When a client reconnects, query and record caching works better, if the
- proxy assigns it to the same backend as before. And the result set
- (if any) is re-used. To achieve this, Index Data defined a session
- cookie which identifies the backend session.
- </para>
- <para>
- The cookie is defined by the client and is sent as part of the
- Initialize Request and passed in an
- <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
- element with OID <literal>1.2.840.10003.10.1000.81.2</literal>.
- </para>
- <para>
- Clients that do not send a cookie as part of the initialize request
- may still better performance, since the init handshake is saved.
- </para>
- </section>
-
- <section id="query-cache">
- <title>Query Caching</title>
- <para>
- Simple stateless clients often send identical Z39.50 searches
- in a relatively short period of time (e.g. in order to produce a
- results-list page, the next page,
- a single full-record, etc). And for many targets, it's
- much more expensive to produce a new result set than to
- reuse an existing one.
- </para>
- <para>
- The proxy tries to solve that by remembering the last query for each
- backend target, so that if an identical query is received next, it
- is turned into Present Requests rather than new Search Requests.
- </para>
- <note>
- <para>
- In a future we release will will probably allows for
- an arbitrary-sized cache for targets supporting named result sets.
- </para>
- </note>
- <para>
- You can enable/disable query caching using option -o.
- </para>
- </section>
-
- <section id="record-cache">
- <title>Record Caching</title>
- <para>
- As an option, the proxy may also cache result set records for the
- last search.
- The proxy takes into account the Record Syntax and CompSpec.
- The CompSpec includes simple element set names as well.
- By default the cache is 200000 bytes per session.
- </para>
- </section>
-
- <section id="query-validation">
- <title>Query Validation</title>
- <para>
- The Proxy may also be configured to trap particular attributes in
- Type-1 queries and send Bib-1 diagnostics back to the client without
- even consulting the backend target. This facility may be useful if
- a target does not properly issue diagnostics when unsupported attributes
- are send to it.
- </para>
- </section>
-
- <section id="record-validation">
- <title>Record Syntax Validation</title>
- <para>
- The proxy may be configured to accept, reject or convert records.
- When accepted, the target passes search/present requests to the
- backend target under the assumption that the target can honor the
- request (In fact it may not do that). When a record is rejected because
- the record syntax is "unsupported" the proxy returns a diagnostic to the
- client. Finally, the proxy may convert records.
- </para>
- <para>
- The proxy can convert from MARC to MARCXML and thereby offer an
- XML version of any MARC record as long as it is ISO2709 encoded.
- If the proxy is compiled with libXSLT support it can also
- perform XSLT on XML.
- </para>
- </section>
-
- <section id="other-optimizations">
- <title>Other Optimizations</title>
- <para>
- We've had some plans to support global caching of result set records,
- but this has not yet been implemented.
- </para>
- </section>
-
- <section id="proxy-config-file">
- <title>Proxy Configuration File</title>
- <para>
- The Proxy may read a configuration file using option
- <literal>-c</literal> followed by the filename of a config file.
- </para>
- <para>
- The config file is XML based. The YAZ proxy must be compiled
- with <ulink url="http://www.xmlsoft.org/">libxml2</ulink> and
- <ulink url="http://xmlsoft.org/XSLT/">libXSLT</ulink> support in
- order for the config file facility to be enabled.
- </para>
- <tip>
- <para>To check for a config file to be well-formed, the yaz-proxy may
- be invoked without specifying a listening port, i.e.
- <screen>
- yaz-proxy -c myconfig.xml
- </screen>
- If this does not produce errors, the file is well-formed.
- </para>
- </tip>
- <section id="proxy-config-header">
- <title>Proxy Configuration Header</title>
- <para>
- The proxy config file must have a root element called
- <literal>proxy</literal>. All information except an optional XML
- header must be stored within the <literal>proxy</literal> element.
- </para>
- <screen>
- <?xml version="1.0"?>
- <proxy>
- <!-- content here .. -->
- </proxy>
- </screen>
- </section>
- <section id="proxy-config-target">
- <title>Configuration: target</title>
- <para>
- The element <literal>target</literal> which may be repeated zero
- or more times with parent element <literal>proxy</literal> contains
- information about each backend target.
- The <literal>target</literal> element have two attributes:
- <literal>name</literal> which holds the logical name of the backend
- target (required) and <literal>default</literal> (optional) which
- (when given) specifies that the backend target is the default target -
- equivalent to command line option <literal>-t</literal>.
- </para>
- <para>
- <screen>
- <?xml version="1.0"?>
- <proxy>
- <target name="server1" default="1">
- <!-- description of server1 .. -->
- </target>
- <target name="server2">
- <!-- description of server2 .. -->
- </target>
- </proxy>
- </screen>
- </para>
- </section>
- <section id="proxy-config-url">
- <title>Configuration:url</title>
- <para>
- The <literal>url</literal> which may be repeated one or more times
- should be the child of the <literal>target</literal> element.
- The CDATA of <literal>url</literal> is the Z-URL of the backend.
- </para>
- <para>
- Multiple <literal>url</literal> element may be used. In that case, then
- a client initiates a session, the proxy chooses the URL with the lowest
- number of active sessions, thereby distributing the load. It is
- assumed that each URL represents the same database (data).
- </para>
- </section>
- <section id="proxy-config-keepalive">
- <title>Configuration: keepalive</title>
- <para>The <literal>keepalive</literal> element holds information about
- the keepalive Z39.50 sessions. Keepalive sessions are proxy-to-backend
- sessions that is no longer associated with a client session.
- </para>
- <para>The <literal>keepalive</literal> element which is the child of
- the <literal>target</literal>holds two elements:
- <literal>bandwidth</literal> and <literal>pdu</literal>.
- The <literal>bandwidth</literal> is the maximum total bytes
- transferred to/from the target. If a target session exceeds this
- limit, it is shut down (and no longer kept alive).
- The <literal>pdu</literal> is the maximum number of requests sent
- to the target. If a target session exceeds this limit, it is
- shut down. The idea of these two limits is that avoid very long
- sessions that use resources in a backend (that leaks!).
- </para>
- <para>
- The following sets maximum number of bytes transferred in a
- target session to 1 MB and maxinum of requests to 400.
- <screen>
- <keepalive>
- <bandwidth>1048576</bandwidth>
- <retrieve>400</retrieve>
- </keepalive>
- </screen>
- </para>
- </section>
- <section id="proxy-config-limit">
- <title>Configuration: limit</title>
- <para>
- The <literal>limit</literal> section specifies bandwidth/pdu requests
- limits for an active session.
- The proxy records bandwidth/pdu requests during the last 60 seconds
- (1 minute). The <literal>limit</literal> may include the
- elements <literal>bandwidth</literal>, <literal>pdu</literal>,
- and <literal>retrieve</literal>. The <literal>bandwidth</literal>
- measures the number of bytes transferred within the last minute.
- The <literal>pdu</literal> is the number of requests in the last
- minute. The <literal>retrieve</literal> holds the maximum records to
- be retrieved in one Present Request.
- </para>
- <para>
- If a bandwidth/pdu limit is reached the proxy will postpone the
- requests to the target and wait one or more seconds. The idea of the
- limit is to ensure that clients that downloads hundreds or thousands of
- records do not hurt other users.
- </para>
- <para>
- The following sets maximum number of bytes transferred per minute to
- 500Kbytes and maximum number of requests to 40.
- <screen>
- <limit>
- <bandwidth>524288</bandwidth>
- <retrieve>40</retrieve>
- </limit>
- </screen>
- </para>
- <note>
- <para>
- Typically the limits for keepalive are much higher than
- those for session minute average.
- </para>
- </note>
- </section>
-
- <section id="proxy-config-attribute">
- <title>Configuration: attribute</title>
- <para>
- The <literal>attribute</literal> element specifies accept or reject
- or a particular attribute type, value pair.
- Well-behaving targets will reject unsupported attributes on their
- own. This feature is useful for targets that do not gracefully
- handle unsupported attributes.
- </para>
- <para>
- Attribute elements may be repeated. The proxy inspects the attribute
- specifications in the order as specified in the configuration file.
- When a given attribute specification matches a given attribute list
- in a query, the proxy takes appropriate action (reject, accept).
- </para>
- <para>
- If no attribute specifications matches the attribute list in a query,
- it is accepted.
- </para>
- <para>
- The <literal>attribute</literal> element has two required attributes:
- <literal>type</literal> which is the Attribute Type-1 type, and
- <literal>value</literal> which is the Attribute Type-1 value.
- The special value/type <literal>*</literal> matches any attribute
- type/value. A value may also be specified as a list with each
- value separated by comma, a value may also be specified as a
- list: low value - dash - high value.
- </para>
- <para>
- If attribute <literal>error</literal> is given, that holds a
- Bib-1 diagnostic which is sent to the client if the particular
- type, value is part of a query.
- </para>
- <para>
- If attribute <literal>error</literal> is not given, the attribute
- type, value is accepted and passed to the backend target.
- </para>
- <para>
- A target that supports use attributes 1,4, 1000 through 1003 and
- no other use attributes, could use the following rules:
- <screen>
- <attribute type="1" value="1,4,1000-1003">
- <attribute type="1" value="*" error="114"/>
- </screen>
- </para>
- </section>
-
- <section id="proxy-config-syntax">
- <title>Configuration: syntax</title>
- <para>
- The <literal>syntax</literal> element specifies accept or reject
- or a particular record syntax request from the client.
- </para>
- <para>
- The <literal>syntax</literal> has one required attribute:
- <literal>type</literal> which is the Preferred Record Syntax.
- </para>
- <para>
- If attribute <literal>error</literal> is given, that holds a
- Bib-1 diagnostic which is sent to the client if the particular
- record syntax is part of a present - or search request.
- </para>
- <para>
- If attribute <literal>error</literal> is not given, the record syntax
- is accepted and passed to the backend target.
- </para>
- <para>
- If attribute <literal>marcxml</literal> is given, the proxy will
- perform MARC21 to MARCXML conversion. In this case the
- <literal>type</literal> should be XML. The proxy will use
- preferred record syntax USMARC/MARC21 against the backend target.
- </para>
- <para>To accept USMARC and offer MARCXML XML records but reject
- all other requests the following configuration could be used:
- <screen>
- <proxy>
- <target name="mytarget">
- <syntax type="usmarc"/>
- <syntax type="xml" marcxml="1"/>
- <syntax type="*" error="238"/>
- </target>
- </proxy>
- </screen>
- </para>
- </section>
-
- <section id="proxy-config-target-timeout">
- <title>Configuration: target-timeout</title>
- <para>
- The element <literal>target-timeout</literal> is the child of element
- <literal>target</literal> and specifies the amount in seconds before
- a target session is shut down.
- </para>
- <para>
- This can also be specified on the command line by using option
- <literal>-T</literal>. Refer to <xref linkend="proxy-usage"/>.
- </para>
- </section>
-
- <section id="proxy-config-client-timeout">
- <title>Configuration: client-timeout</title>
- <para>
- The element <literal>client-timeout</literal> is the child of element
- <literal>target</literal> and specifies the amount in seconds before
- a client session is shut down.
- </para>
- <para>
- This can also be specified on the command line by using option
- <literal>-i</literal>. Refer to <xref linkend="proxy-usage"/>.
- </para>
- </section>
-
- <section id="proxy-config-preinit">
- <title>Configuration: preinit</title>
- <para>
- The element <literal>preinit</literal> is the child of element
- <literal>target</literal> and specifies the number of spare
- connection to a target. By default no spare connection are
- created by the proxy. If the proxy uses a target exclusive or
- a lot, the preinit session will ensure that target sessions
- have been made before the client makes a connection and will therefore
- reduce the connect-init handshake dramatically. Never set this to
- more than 5.
- </para>
- </section>
-
- <section id="proxy-config-max-clients">
- <title>Configuration: max-clients</title>
- <para>
- The element <literal>max-clients</literal> is the child of element
- <literal>proxy</literal> and specifies the total number of
- allowed connections to targets (all targets). If this limit
- is reached the proxy will close the least recently used connection.
- </para>
- <para>
- Note, that many Unix systems impose a system on the number of
- open files allowed in a single process, typically in the
- range 256 (Solaris) to 1024 (Linux).
- The proxy uses 2 sockets per session + a few files
- for logging. As a rule of thumb, ensure that 2*max-clients + 5
- can be opened by the proxy process.
- </para>
- <tip>
- <para>
- Using the <ulink url="http://www.gnu.org/software/bash/bash.html">
- bash</ulink> shell, you can set the limit with
- <literal>ulimit -n</literal><replaceable>no</replaceable>.
- Use <literal>ulimit -a</literal> to display limits.
- </para>
- </tip>
- </section>
-
- <section id="proxy-config-log">
- <title>Configuration: log</title>
- <para>
- The element <literal>log</literal> is the child of element
- <literal>proxy</literal> and specifies what to be logged by the
- proxy.
- </para>
- <para>
- Specify the log file with command-line option <literal>-l</literal>.
- </para>
- <para>
- The text of the <literal>log</literal> element is a sequence of
- options separated by white space. See the table below:
- <table frame="top"><title>Logging options</title>
- <tgroup cols="2">
- <colspec colwidth="1*" colname="option"/>
- <colspec colwidth="2*" colname="description"/>
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><literal>client-apdu</literal></entry>
- <entry>
- Log APDUs as reported by YAZ for the
- communication between the client and the proxy.
- This facility is equivalent to the APDU logging that
- happens when using option <literal>-a</literal>, however
- this tells the proxy to log in the same file as given
- by <literal>-l</literal>.
- </entry>
- </row>
- <row>
- <entry><literal>server-apdu</literal></entry>
- <entry>
- Log APDUs as reported by YAZ for the
- communication between the proxy and the server (backend).
- </entry>
- </row>
- <row>
- <entry><literal>clients-requests</literal></entry>
- <entry>
- Log a brief description about requests transferred between
- the client and the proxy. The name of the request and the size
- of the APDU is logged.
- </entry>
- </row>
- <row>
- <entry><literal>server-requests</literal></entry>
- <entry>
- Log a brief description about requests transferred between
- the proxy and the server (backend). The name of the request
- and the size of the APDU is logged.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- <para>
- To log communication in details between the proxy and the backend, th
- following configuration could be used:
- <screen><![CDATA[
- <target name="mytarget">
- <log>server-apdu server-requests</log>
- </target>
-]]>
- </screen>
- </para>
- </section>
-
- </section>
- <section id="proxy-usage">
- <title>Proxy Usage</title>
- <para>
- </para>
- <refentry id="yaz-proxy">
- &yaz-proxy-ref;
- </refentry>
- </section>
- <section id="otherinfo-encoding"><title>OtherInformation Encoding</title>
- <para>
- The proxy uses the OtherInformation definition to carry
- information about the target address and cookie.
- </para>
- <screen>
- OtherInformation ::= [201] IMPLICIT SEQUENCE OF SEQUENCE{
- category [1] IMPLICIT InfoCategory OPTIONAL,
- information CHOICE{
- characterInfo [2] IMPLICIT InternationalString,
- binaryInfo [3] IMPLICIT OCTET STRING,
- externallyDefinedInfo [4] IMPLICIT EXTERNAL,
- oid [5] IMPLICIT OBJECT IDENTIFIER}}
---
- InfoCategory ::= SEQUENCE{
- categoryTypeId [1] IMPLICIT OBJECT IDENTIFIER OPTIONAL,
- categoryValue [2] IMPLICIT INTEGER}
- </screen>
- <para>
- The <literal>categoryTypeId</literal> is either
- OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
- for proxy target and proxy cookie respectively. The
- integer element <literal>category</literal> is set to 0.
- The value proxy and cookie is stored in element
- <literal>characterInfo</literal> of the <literal>information</literal>
- choice.
- </para>
- </section>
- </chapter>
- <!-- Keep this comment at the end of the file
- Local variables:
- mode: sgml
- sgml-omittag:t
- sgml-shorttag:t
- sgml-minimize-attributes:nil
- sgml-always-quote-attributes:t
- sgml-indent-step:1
- sgml-indent-data:t
- sgml-parent-document: "yaz++.xml"
- sgml-local-catalogs: nil
- sgml-namecase-general:t
- End:
- -->
-
<!ENTITY chap-introduction SYSTEM "introduction.xml">
<!ENTITY chap-installation SYSTEM "installation.xml">
<!ENTITY chap-zoom SYSTEM "zoom.xml">
- <!ENTITY chap-proxy SYSTEM "proxy.xml">
<!ENTITY chap-api SYSTEM "api.xml">
- <!ENTITY yaz-proxy-ref SYSTEM "yaz-proxy-ref.xml">
<!ENTITY app-license SYSTEM "license.xml">
]>
-<!-- $Id: yaz++.xml.in,v 1.12 2004-03-31 18:28:06 adam Exp $ -->
+<!-- $Id: yaz++.xml.in,v 1.13 2004-04-11 12:13:32 adam Exp $ -->
<book id="yazpp">
<bookinfo>
<title>YAZ++ User's Guide and Reference</title>
<ulink url="http://www.indexdata.dk/yaz/">YAZ toolkit</ulink>
from C++, together with some utilities written using these
libraries. It includes an implementation of the C++ binding for
- ZOOM (<link linkend="zoom">ZOOM-C++</link>) and a powerful,
- general-purpose Z39.50 <link linkend="proxy">proxy</link>.
+ ZOOM (<link linkend="zoom">ZOOM-C++</link>).
</simpara>
<simpara>
This manual covers version @VERSION@.
</simpara>
<simpara>
- CVS ID: $Id: yaz++.xml.in,v 1.12 2004-03-31 18:28:06 adam Exp $
+ CVS ID: $Id: yaz++.xml.in,v 1.13 2004-04-11 12:13:32 adam Exp $
</simpara>
<simpara>
<inlinemediaobject>
&chap-introduction;
&chap-installation;
&chap-zoom;
- &chap-proxy;
&chap-api;
&app-license;
</book>
+++ /dev/null
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
- <!ENTITY yaz-proxy-ref SYSTEM "yaz-proxy-ref.xml">
-]>
-<!-- $Id: yaz-proxy-man.sgml,v 1.1 2002-10-23 10:14:11 adam Exp $ -->
-<refentry id="yaz-proxy">
- &yaz-proxy-ref;
- <refsect1><title>SEE ALSO</title>
- <para>
- <citerefentry>
- <refentrytitle>yaz</refentrytitle>
- <manvolnum>7</manvolnum>
- </citerefentry>
- <citerefentry>
- <refentrytitle>yaz-client</refentrytitle>
- <manvolnum>1</manvolnum>
- </citerefentry>
- </para>
- </refsect1>
-</refentry>
- <!-- Keep this comment at the end of the file
- Local variables:
- mode: sgml
- sgml-omittag:t
- sgml-shorttag:t
- sgml-minimize-attributes:nil
- sgml-always-quote-attributes:t
- sgml-indent-step:1
- sgml-indent-data:t
- sgml-parent-document: nil
- sgml-local-catalogs: nil
- sgml-namecase-general:t
- End:
- -->
+++ /dev/null
-<refmeta>
- <refentrytitle>yaz-proxy</refentrytitle>
- <manvolnum>8</manvolnum>
-</refmeta>
-<refnamediv>
- <refname>yaz-proxy</refname>
- <refpurpose>The YAZ toolkit's transparent Z39.50 proxy</refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>yaz-proxy</command>
- <arg choice="opt">-a <replaceable>filename</replaceable></arg>
- <arg choice="opt">-l <replaceable>filename</replaceable></arg>
- <arg choice="opt">-m <replaceable>num</replaceable></arg>
- <arg choice="opt">-v <replaceable>level</replaceable></arg>
- <arg choice="opt">-t <replaceable>target</replaceable></arg>
- <arg choice="opt">-U <replaceable>auth</replaceable></arg>
- <arg choice="opt">-o <replaceable>level</replaceable></arg>
- <arg choice="opt">-i <replaceable>seconds</replaceable></arg>
- <arg choice="opt">-T <replaceable>seconds</replaceable></arg>
- <arg choice="opt">-p <replaceable>pidfile</replaceable></arg>
- <arg choice="opt">-u <replaceable>userid</replaceable></arg>
- <arg choice="opt">-c <replaceable>config</replaceable></arg>
- <arg choice="req"><replaceable>host</replaceable>:<replaceable>port</replaceable></arg>
- </cmdsynopsis>
-</refsynopsisdiv>
-
-<refsect1><title>DESCRIPTION</title>
- <para>
- <command>yaz-proxy</command> is a Z39.50 optimizing proxy daemon.
- The listening port must be specified on the command-line.
- <command>inetd</command> operation is not supported.
- The <replaceable>host</replaceable>:<replaceable>port</replaceable>
- argument specifies host address to listen to, and the port to
- listen on. Use the host <literal>@</literal>
- to listen for connections coming from any address.
- </para>
- <para>
- <command>yaz-proxy</command> can be configured using command-line
- options or a configuration file.
- Configuration file options override values specified
- on the command-line.
- </para>
- <para>
- <command>yaz-proxy</command> rereads its configuration file and
- reopens log files when it receives the hangup signal, SIGHUP.
- </para>
-</refsect1>
-<refsect1><title>OPTIONS</title>
- <variablelist>
- <varlistentry><term>-a <replaceable>filename</replaceable></term>
- <listitem><para>
- Specifies the name of a file to which to write a log of the
- APDUs (protocol packets) that pass through the proxy. The
- special filename <literal>-</literal> may be used to indicate
- standard output.
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-l <replaceable>filename</replaceable></term>
- <listitem><para>
- Specifies the name of a file to which to write a log of the
- YAZ proxy activity. This uses the logging facility as provided
- by the YAZ toolkit. If this options is omitted, the output
- directed to stderr.
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-m <replaceable>num</replaceable></term>
- <listitem><para>
- Specifies the maximum number of connections to be cached
- [default 50].
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-v <replaceable>level</replaceable></term>
- <listitem><para>
- Sets the logging level. <replaceable>level</replaceable> is
- a comma-separated list of members of the set
- {<literal>fatal</literal>,<literal>debug</literal>,<literal>warn</literal>,<literal>log</literal>,<literal>malloc</literal>,<literal>all</literal>,<literal>none</literal>}.
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-t <replaceable>target</replaceable></term>
- <listitem><para>
- Specifies the default backend target to use when a client
- connects that does not explicitly specify a target in its
- <literal>initRequest</literal>.
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-U <replaceable>auth</replaceable></term>
- <listitem><para>
- Specifies authentication info to be sent to the backend target.
- This is useful if you happen to have an internal target that
- requires authentication, or if the client software does not allow
- you to set it.
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-o <replaceable>level</replaceable></term>
- <listitem><para>
- Sets level for optimization. Use zero to disable; non-zero
- to enable. Handling for this is not fully implemented;
- we will probably use a bit mask to enable/disable specific
- features. By default optimization is enabled (value 1).
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-i <replaceable>seconds</replaceable></term>
- <listitem><para>
- Specifies in seconds the idle time for communication between
- client and proxy. If a connection is inactive for this long
- it will be closed. Default: 600 seconds (10 minutes).
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-T <replaceable>seconds</replaceable></term>
- <listitem><para>
- Specifies in seconds the idle time for communication between
- proxy and backend target.
- If a connection is inactive for this long
- it will be closed. Default: 600 seconds (10 minutes).
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-p <replaceable>pidfile</replaceable></term>
- <listitem><para>
- When specified, yaz-proxy will create <replaceable>pidfile</replaceable>
- with the process ID of the proxy. The pidfile will be generated
- before the process changes identity (see option <literal>-u</literal>).
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-u <replaceable>userid</replaceable></term>
- <listitem><para>
- When specified, yaz-proxy will change identity to the user ID
- specified, just after the proxy has started listening to a
- possibly privileged port and after the PID file has been created
- if specified by option <literal>-u</literal>.
- </para></listitem>
- </varlistentry>
- <varlistentry><term>-c <replaceable>config</replaceable></term>
- <listitem><para>
- Specifies config filename. Configuration is in XML
- and is only supported if the YAZ proxy is compiled with
- libxml2.
- </para></listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>EXAMPLES</title>
- <para>
- The following command starts the proxy, listening on port
- 9000, with its default backend target set to the Library of
- Congress bibliographic server:
- </para>
- <screen>
- $ yaz-proxy -t z3950.loc.gov:7090 @:9000
- </screen>
- <para>
- The LOC target is sometimes very slow. You can connect to
- it using yaz-client as follows:
- </para>
- <screen>
- $ yaz-client localhost:9000/voyager
- Connecting...Ok.
- Sent initrequest.
- Connection accepted by target.
- ID : 34
- Name : Voyager LMS - Z39.50 Server
- Version: 1.13
- Options: search present
- Elapsed: 7.131197
- Z> f computer
- Sent searchRequest.
- Received SearchResponse.
- Search was a success.
- Number of hits: 10000
- records returned: 0
- Elapsed: 6.695174
- Z> f computer
- Sent searchRequest.
- Received SearchResponse.
- Search was a success.
- Number of hits: 10000
- records returned: 0
- Elapsed: 0.001417
- </screen>
- <para>
- In this test, the second search was more than 4000 times faster
- than the first, because the proxy cached the result of the first
- search and noticed that the second was the same.
- </para>
- <para>
- The YAZ command-line client,
- <command>yaz-client</command>,
- allows you to set the proxy address by specifying option -p. In
- that case, the actual backend target is specified as part of the
- Initialize Request.
- </para>
- <para>Suppose you have a proxy running on localhost,
- port 9000 and wish to connect to Index Data's test target at
- <literal>indexdata.dk:210/gils</literal> you could use:
- <screen>
- yaz-client -p localhost:9000 indexdata.dk:210/gils
- </screen>
- Since port 210 is the default, the port can be omitted:
- <screen>
- yaz-client -p localhost:9000 indexdata.dk/gils
- </screen>
- </para>
-</refsect1>
- <!-- Keep this comment at the end of the file
- Local variables:
- mode: sgml
- sgml-omittag:t
- sgml-shorttag:t
- sgml-minimize-attributes:nil
- sgml-always-quote-attributes:t
- sgml-indent-step:1
- sgml-indent-data:t
- sgml-parent-document: "proxy.xml"
- sgml-local-catalogs: nil
- sgml-namecase-general:t
- End:
- -->
projects / yazpp-moved-to-github.git / commitdiff