X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=e45f3558a737a152d173364792a9d0b752c6d424;hb=98ab7d5dcf275d1e23cde340ade10beea6a7fc1f;hp=62a5228bb69ae36c34637c0e7c9a2ec13f1692a4;hpb=3f57a94d4bb1753d013d5bf450af407d6a32d36d;p=yazproxy-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 62a5228..e45f355 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,9 +1,10 @@ - + Installation You need a C++ compiler to compile and use YAZ proxy. - The software was implemented using GCC so we know that works + 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 @@ -11,11 +12,29 @@ YAZ proxy is built on top of the - YAZ and - YAZ++ + YAZ and + YAZ++ toolkits. You need to install these first. - For some platforms there are binary packages for YAZ/YAZ++. + 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 @@ -39,16 +58,16 @@ - --with-yazppconfig directory + --with-yazpp directory - Specifies the location of yaz++-config. - The yaz++-config program is generated in + 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. @@ -56,12 +75,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: @@ -70,8 +98,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 @@ -82,8 +110,8 @@ 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). @@ -92,7 +120,7 @@ src/libyazproxy.la The YAZ proxy library. This library gets installed in - your libraries directory + the libraries directory (prefix/lib). @@ -100,12 +128,25 @@ include/yazproxy/*.h - Various C++ header files, which you'll need for YAZ proxy - development. All these are installed in your header files area + C++ header files, which you'll need for YAZ proxy + development. All these are installed in the header files area (prefix/include/yazproxy). + + etc + + 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). + + +
@@ -113,12 +154,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 @@ -137,6 +187,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 @@ -145,7 +207,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. @@ -157,8 +219,8 @@ - Windows versions of libxslt, libxml2, zlib and iconv can be found - + Windows versions of libXSLT, libxml2, zlib and iconv can be found + here. @@ -182,7 +244,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. @@ -238,7 +300,6 @@ bin/yazproxy.exe YAZ proxy. It's a WIN32 console application. - See for more information.