X-Git-Url: http://git.indexdata.com/?p=yazpp-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=3ae243c377f7bf2d2bd45334e524c6d19e84be2d;hp=e6d7097d23303c6c4f0d92896ed6f4b6d68316a9;hb=b094fb084d6ccabc92560830fb3c84285508a15f;hpb=15c4ab2ad6c4c449514c3d1d433315a71231e735 diff --git a/doc/installation.xml b/doc/installation.xml index e6d7097..3ae243c 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,23 +1,22 @@ - 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.
- Building on Unix + Installation on Unix (from source) On UNIX, the software is compiled as follows: $ ./configure @@ -34,11 +33,11 @@ --prefix directory Specifies installation prefix. By default - /usr/local is used. + /usr/local is used. - --with-yazconfig directory + --with-yaz directory Specifies the location of yaz-config. The yaz-config program is generated in @@ -52,15 +51,6 @@ 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: @@ -79,55 +69,54 @@ 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). + (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 environment variables needed in order to compile your applications with the YAZ++ library. This script gets installed in your binaries directory - (prefix/bin). + (prefix/bin). - zoom/zclient + 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. - src/yaz-my-client + src/yaz-my-client YAZ C++ demonstration client. This client does not get installed in the system directories. @@ -135,7 +124,7 @@ - src/yaz-my-server + src/yaz-my-server YAZ C++ demonstration server. This server does not get installed in the system directories. @@ -145,56 +134,99 @@
- Building on Windows + Installation on Windows + + YAZ++ is shipped with "makefiles" for the NMAKE tool that comes + with Microsoft Visual Studio. + Version 2003 (7) and 2005 (8) has been tested. + We expect that YAZ++ compiles with versions 5 and 6 as well. + - You'll find Visual Studio project files in sub directory - win. Open workspace yazxx.dsw - which includes the following projects: + 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. - - - - yazserver.dsp - - Builds the sample server yazmyserver.exe. - - - - yazserver.dsp - - Builds the proxy yazproxy.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). - - zoomxxclient.dsp - - Builds the ZOOM C++ demo client zoomxxclient.exe. + YAZ_DIR + + Specifies the directory of the YAZ source. - 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_1.dll + + YAZ++ DLL . Includes ZOOM C++ as well. + For the debug version lib/yazpp_1_d.dll + is created instead. + + + lib/yazpp_1.lib + + Import library for yazpp_1.dll. + For the debug version lib/yazpp_1_d.lib + is created instead. + + + bin/yaz-my-client.exe + + Z39.50 client demonstrating the YAZ++ API. + + + bin/yaz-my-server.exe + + Z39.50 server demonstrating the YAZ++ API. + + + bin/zclient.exe + + ZOOM C++ demo client. A simple WIN32 console application. + + + + +