X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=dbd3d461555c218879eb373e5700d03ec6f2befb;hb=bd4b4f856f1094d75802a0715c2b242233fc9b5c;hp=41fe7970ad005b6f36ce8a39038175c0561dcae9;hpb=c3a3af5bfb7172956d9e362887e42181fbcf1c2a;p=yazpp-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 41fe797..dbd3d46 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,17 +1,17 @@ - + 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 - compiled on Windows using Visual C++. Other compilers should - work too. Let us know of portability problems, etc. with - your system. + The software was implemented using GCC + so we know that works well with YAZ++. From time to time the + software is 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 + YAZ toolkit. You need to install that first. For some platforms there are binary packages for YAZ. @@ -38,7 +38,7 @@ - --with-yazconfig directory + --with-yaz directory Specifies the location of yaz-config. The yaz-config program is generated in @@ -58,38 +58,46 @@ ./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 + src/libyazpp.la - The Yaz Z39.50 Proxy utility. - This program gets installed in your binaries directory - (prefix/bin). + The YAZ++ library. + This library gets installed in your libraries directory + (prefix/lib). - + - lib/libyaz++.la + src/libzoompp.la - The YAZ++ library, including the - ZOOM-C++ classes. + The ZOOM-C++ library. This library gets installed in your libraries directory (prefix/lib). - + - include/yaz++/*.h + include/yazpp/*.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++). + (prefix/include/yazpp). - yaz++-config + yazpp-config A Bourne shell-script utility that returns the values of the CFLAGS and LIBS @@ -103,8 +111,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. @@ -126,6 +134,87 @@ +
+ Building on Windows + + YAZ++ is shipped with "makefiles" for the NMAKE tool that comes + with Microsoft Visual Studio. + Version 6 and .NET 2003 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: + + + 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). + + + YAZ_DIR + + Specifies the directory of the YAZ source. + + + + + + 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/yazpp.lib + + Import library for yazpp.dll. + + + bin/zclient.exe + + ZOOM C++ demo client. A simple WIN32 console application. + + + + + + +