X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;fp=doc%2Finstallation.xml;h=95a6c61790498a230fffeeb7be69188bfd934c5a;hb=916452d348a342be0b6bbc054d59bc8897fb2f79;hp=e6d7097d23303c6c4f0d92896ed6f4b6d68316a9;hpb=0ae7eb1f7101c29d5c088bf40aa26abc50c57913;p=yazpp-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index e6d7097..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++. @@ -79,28 +79,45 @@ 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, including the - ZOOM-C++ classes. + 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 + + 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++). @@ -121,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. @@ -147,54 +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. - - - - yazclient.dsp - - Builds the sample client yazmyclient.exe. + 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). + - yazserver.dsp - - Builds the sample server yazmyserver.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 proxy yazproxy.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. + - zoomxxclient.dsp - - Builds the ZOOM C++ demo client zoomxxclient.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. + + + + - By default, the include path and library path for the projects assumes - that YAZ is located in ..\yaz - (i.e. same prefix as the YAZ++ source). - If YAZ is in a different directory you'll have to modify - the include path in - Project | Settings | C/C++ | Preprocessor | Additional include - directories - and library path in - Project | Settings | Link | Input | Additional library - path. + 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. + + + + +