X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=95a6c61790498a230fffeeb7be69188bfd934c5a;hb=1b6019ff065a98af709be905adc6c08094471d57;hp=113d6e53f7359f4797b4f05393686af44931397e;hpb=43cc841d9cd8606d5abc780770985ae5d6214560;p=yazpp-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 113d6e5..95a6c61 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,5 +1,5 @@ - + Installation You need a C++ compiler to compile and use YAZ++. @@ -52,37 +52,72 @@ what you want. + + --with-xslt directory + + 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. + + For the whole list of configure options, refer to the help: ./configure --help. + 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: + + CXXFLAGS="-g" CXX=CC ./configure + + + This is what you have after successful compilation: - src/yaz-proxy + proxy/yaz-proxy - The YAZ Z39.50 Proxy utility. + The YAZ Z39.50 Proxy. This program gets installed in your binaries directory (prefix/bin). - lib/libyaz++.la + src/libyazcpp.la + + The YAZ++ library. + This library gets installed in your libraries directory + (prefix/lib). + + + + + src/libzoomcpp.la - The YAZ++ library, including the - ZOOM-C++ classes. + The ZOOM-C++ library. This library gets installed in your libraries directory (prefix/lib). + + + proxy/libyazproxy.la + + The YAZ proxy library. This library gets installed in + your libraries directory + (prefix/lib). + + include/yaz++/*.h - Various C++ header files, which you'll need for YAZ + Various C++ header files, which you'll need for YAZ++ development. All these are installed in your header files area (prefix/include/yaz++). @@ -103,8 +138,8 @@ zoom/zclient - ZOOM C++ demonstration client. This client does not - get installed in the system directories. + ZOOM C++ demonstration client that uses the ZOOM C++ classes. + This client does not get installed in the system directories. @@ -129,36 +164,154 @@
Building on Windows - You'll find Visual Studio project files in sub directory - win. Open workspace yazxx.dsw - which includes the following projects: + YAZ++ is shipped with "makefiles" for the NMAKE tool that comes + with + Microsoft Visual Studio. + Version 6 and .NET has been tested. We expect that YAZ++ compiles + with version 5 as well. + + + Start a command prompt and switch the sub directory + WIN where the file makefile + is located. Customize the installation by editing the + makefile file (for example by using notepad). + + The following summarizes the most important settings in that file: + - - yazxx.dsp - - Builds the yazxx.dll. + DEBUG + + If set to 1, the software is + compiled with debugging libraries (code generation is + multi-threaded debug DLL). + If set to 0, the software is compiled with release libraries + (code generation is multi-threaded DLL). + - yazclient.dsp - - Builds the sample client yazmyclient.exe. - + HAVE_XSLT, + LIBXSLT_DIR + + + 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 + directory. + + + + + If you enable libXSLT you have to enable libxml2 and its + sub components zlib and iconv as well. + + + + + Windows versions of libxslt, libxml2, zlib and iconv can be found + + here. + + + - yazserver.dsp - - Builds the sample server yazmyserver.exe. + HAVE_ICONV, + ICONV_DIR + + If HAVE_ICONV is set to 1, the proxy is + compiled with iconv support. In this configuration, set + ICONV_DIR to the iconv source directory. + - yazserver.dsp - - Builds the proxy yazproxy.exe. - + HAVE_LIBXML2, + LIBXML2_DIR + + + 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 + and + ZLIB_DIR to the zlib directory. + + + + + YAZ++ is not using ZLIB. But libxml2 is. + + + + + + + + When satisfied with the settings in the makefile, type + + nmake + + + + + If the nmake command is not found on your system + you probably haven't defined the environment variables required to + use that tool. To fix that, find and run the batch file + vcvars32.bat. You need to run it from within + the command prompt or set the environment variables "globally"; + otherwise it doesn't work. + + + + If you wish to recompile YAZ++ - for example if you modify + settings in the makefile you can delete + object files, etc by running. + + nmake clean + + + + 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. + + + lib/yazproxy.lib + + Import library for yazproxy.dll. + + + bin/yaz-proxy.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. + + + +