X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=364e4fdb7acf942c66eba2924f42accf21deabd5;hp=683e9114c00309407417d6e377209a0b870b4944;hb=9b8dda8226cff9fb0ee5bf8d7c0e88e9613df63e;hpb=2f1a9a4b28ae43c9da9e0740f84048065b2d3bf6 diff --git a/doc/installation.xml b/doc/installation.xml index 683e911..364e4fd 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,20 +1,39 @@ - Installation - You need a C++ compiler to compile and use YAZ++. - The software was implemented using GCC so we know that works - well with YAZ++. From time to time the software has been + You need a C++ compiler to compile and use YAZ proxy. + The software was implemented using + GCC so we know that works + well with YAZ proxy. From time to time the software has been compiled on Windows using Visual C++. Other compilers should work too. Let us know of portability problems, etc. with your system. - YAZ++ is built on top of the - YAZ - toolkit. - You need to install that first. - For some platforms there are binary packages for YAZ. + YAZ proxy is built on top of the + YAZ and + YAZ++ + toolkits. + You need to install these first. + For some platforms there are binary packages available for YAZ/YAZ++. + + + We also highly recommend that + libxml2 and + libXSLT are installed. + YAZ must be configured with libxml2 support. + If not, + SRU + is not supported. + The YAZ Proxy uses libXSLT for record conversions via XSLT. + + + YAZ proxy may also use USEMARCON to convert between MARC + formats. This is useful if you want the proxy to offer more + MARC record types than the backend target supports. Get USEMARCON + from: + British Library USEMARCON page + .
Building on Unix @@ -38,16 +57,16 @@ - --with-yazconfig directory + --with-yazpp directory - Specifies the location of yaz-config. - The yaz-config program is generated in - the source directory of YAZ as well as the binaries - directory when YAZ is installed (via make install). + Specifies the location of yazpp-config. + The yazpp-config program is generated in + the source directory of YAZ++ as well as the binaries + directory when YAZ++ is installed (via make install). If you don't supply this option, configure will - look for yaz-config in directories of the + look for yazpp-config in directories of the PATH environment - which is nearly always what you want. @@ -55,12 +74,21 @@ --with-xslt directory - Specifies prefix for libxslt (and libxml2). + Specifies prefix for libXSLT (and libxml2). configure must be able to locate xslt-config in PREFIX/bin. If this option is omitted, configure looks for xslt-config in the current PATH. + + --with-usemarcon directory + + Specifies USEMARCON installation prefix. + configure must be able to locate usemarcon-config + in PREFIX/bin. If this option is omitted, configure looks + for usemarcon-config in the current PATH. + + For the whole list of configure options, refer to the help: @@ -69,8 +97,8 @@ Configure uses GCC's C/C++ compiler if available. To specify another compiler, set CXX. To use other compiler flags, - specify CXXFLAGS. To use CC - with debugging you could use: + specify CXXFLAGS. For example, to use + CC with debugging do: CXXFLAGS="-g" CXX=CC ./configure @@ -79,85 +107,45 @@ This is what you have after successful compilation: - proxy/yaz-proxy + src/yazproxy - The YAZ Z39.50 Proxy. - This program gets installed in your binaries directory + The YAZ Proxy program. + It gets installed in your binaries directory (prefix/bin). - src/libyazcpp.la - - The YAZ++ library. - This library gets installed in your libraries directory - (prefix/lib). - - - - - src/libzoomcpp.la - - The ZOOM-C++ library. - This library gets installed in your libraries directory - (prefix/lib). - - - - - proxy/libyazproxy.la + src/libyazproxy.la The YAZ proxy library. This library gets installed in - your libraries directory + the libraries directory (prefix/lib). - include/yaz++/*.h + include/yazproxy/*.h - Various C++ header files, which you'll need for YAZ++ - development. All these are installed in your header files area - (prefix/include/yaz++). + C++ header files, which you'll need for YAZ proxy + development. All these are installed in the header files area + (prefix/include/yazproxy). - yaz++-config - - A Bourne shell-script utility that returns the values of the - CFLAGS and LIBS - environment variables - needed in order to compile your applications with the YAZ++ - library. This script gets installed in your binaries directory - (prefix/bin). - - - - - zoom/zclient - - ZOOM C++ demonstration client that uses the ZOOM C++ classes. - This client does not get installed in the system directories. - - - - - src/yaz-my-client - - YAZ C++ demonstration client. This client does not - get installed in the system directories. - - - - - src/yaz-my-server + etc - YAZ C++ demonstration server. This server does not - get installed in the system directories. + Various files such as + configuration files, XSLT files, CQL to RPN conversion files, + a sample start/stop control script + yazproxy.ctl.sh that can be used as + template for an /etc/init.d script. + These files are installed in the YAZ proxy's data area + (prefix/share/yazproxy). +
@@ -165,12 +153,21 @@ Building on Windows YAZ++ is shipped with "makefiles" for the NMAKE tool that comes - with + with Microsoft Visual Studio. Version 6 and .NET has been tested. We expect that YAZ++ compiles with version 5 as well. + + The YAZ proxy has never been used in production on Windows. Although + it compiles and runs, doesn't mean it scale on that platform. + Furthermore the + YAZ proxy currently doesn't run as a Service - only as a Console + application. + + + Start a command prompt and switch the sub directory WIN where the file makefile is located. Customize the installation by editing the @@ -189,6 +186,18 @@ + YAZ_DIR + + This must be set to the home of the YAZ source directory. + + + + YAZPP_DIR + + This must be set to the home of the YAZ++ source directory. + + + HAVE_XSLT, LIBXSLT_DIR @@ -197,7 +206,7 @@ If HAVE_LIBXSLT is set to 1, the proxy is compiled with XSLT and XML support. In this configuration, set LIBXSLT_DIR to the - libxslt source + libXSLT source directory. @@ -209,8 +218,8 @@ - Windows versions of libxslt, libxml2, zlib and iconv can be found - + Windows versions of libXSLT, libxml2, zlib and iconv can be found + here. @@ -234,7 +243,7 @@ If HAVE_LIBXML2 is set to 1, the proxy is compiled with XML support. In this configuration, set LIBXML2_DIR to the - libxml2 source directory + libxml2 source directory and ZLIB_DIR to the zlib directory. @@ -277,16 +286,6 @@ The following files are generated upon successful compilation: - bin/yazpp.dll - - YAZ++ DLL . Includes ZOOM C++ as well. - - - lib/yaz.lib - - Import library for yazpp.dll. - - bin/yazproxy.dll YAZ proxy DLL. @@ -297,15 +296,9 @@ Import library for yazproxy.dll. - bin/yaz-proxy.exe + bin/yazproxy.exe YAZ proxy. It's a WIN32 console application. - See for more information. - - - bin/zclient.exe - - ZOOM C++ demo client. A simple WIN32 console application. @@ -323,7 +316,7 @@ sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t - sgml-parent-document: "yaz++.xml" + sgml-parent-document: "yazproxy.xml" sgml-local-catalogs: nil sgml-namecase-general:t End: