X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=101ec670dcbe122068e7dedf8ccdcdf3ac9d8087;hb=94fce64abe00f0334941ca270c8898bdabb0ca7c;hp=834358b66c8d7eaecf27114fda581b521c6280c2;hpb=bd7e251dac1b07c54884d26295f66b90cfb23131;p=yaz-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 834358b..101ec67 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -22,7 +22,8 @@ HP/UX SunOS/Solaris DEC Unix - OpenBSD/FreeBSD + BSDs: FreeBSD, OpenBSD, NetBSD, MAC OSX + Linux IBM AIX Data General DG/UX (with some CFLAGS tinkering) @@ -45,8 +46,8 @@ let us know about it. If you run into difficulties, we will try to help if we can, and if you solve the problems, we would be happy to include your fixes in the next release. So far, we have mostly avoided - #ifdefs for individual platforms, and we'd like to keep it that - way as far as it makes sense. + #ifdefs for individual platforms, and we'd + like to keep it that way as far as it makes sense. @@ -54,7 +55,9 @@ bug-fixes, as well as general discussion. Subscribe by sending mail to yaz-request@indexdata.dk - . + or fill-in the form + + here. General questions and problems can be directed at yaz-help@indexdata.dk @@ -67,14 +70,14 @@ Note that if your system doesn't have a native ANSI C compiler, you may have to acquire one separately. We recommend - GCC. + GCC. For UNIX, the GNU tools Autoconf, Automake and Libtool - is used to generate Makefiles and configure &yaz; for the system. + are used to generate Makefiles and configure &yaz; for the system. You do not these tools unless you're using the CVS version of &yaz;. Generally it should be sufficient to run configure without options, @@ -99,7 +102,7 @@ - To customize &yaz; the configure script also accepts a set of options. + To customize &yaz;, the configure script also accepts a set of options. The most important are: @@ -115,7 +118,7 @@ TCP wrapper library. It allows you to allow/deny clients depending on IP number. The TCP wrapper library is - commonly used in Linux/BSD distributions. + often used in Linux/BSD distributions. --enable-threads @@ -124,6 +127,26 @@ compilation. + --with-openssl + &yaz; will be linked with the OpenSSL libraries and + an SSL COMSTACK will be provided. Note that SSL support is still + experimental. + + + --enable-shared + The make process will create shared + libraries (also known as shared objects .so). + By default, no shared libraries are created - + equivalent to --disable-shared. + + + --disable-shared + The make process will not create + static libraries (.a). + By default, static libraries are created - + equivalent to --enable-static. + + @@ -148,7 +171,7 @@ lib/libyazthread.la - When threading is supported/enabled by configure this GNU libtool + When threading is supported/enabled by configure this Libtool library is created. It includes functions that allows &yaz; to use threads. @@ -164,7 +187,7 @@ yaz-config - A Bourne-shell script, generate by configure, that + A Bourne-shell script, generated by configure, that specifies how external applications should compile - and link with &yaz;. @@ -180,22 +203,22 @@ A simple shell implemented on top of the ZOOM functions. The shell is a command line application that allows you to enter - simple commands perform to perform ZOOM operations. + simple commands to perform ZOOM operations. zoom/zoomtst1, zoom/zoomtst2, .. - Several small applications that demonstrates the use of ZOOM. + Several small applications that demonstrates the ZOOM API. - If you wish to install &yaz; in system directories such as + If you wish to install &yaz; in system directories /usr/local/bin, - /usr/local/lib you can type: + /usr/local/lib .. etc, you can type: @@ -210,7 +233,7 @@ - If you wish to perform an un-installation of &yaz; use: + If you wish to perform an un-installation of &yaz;, use: @@ -223,7 +246,78 @@ remove directories created by make install, e.g. /usr/local/include/yaz. - + + How to make apps using YAZ on UNIX + + This section describes how to compile - and link your own + applications using the &yaz; toolkit. + If you're used to Makefiles this shouldn't be hard. As for + other libraries you have used before, you have to set a proper include + path for your C/C++ compiler and specify the location of + &yaz; libraries. You can do it by hand, but generally we suggest + you use the yaz-config that is generated + by configure. This is especially + important if you're using the threaded version of &yaz; which + require you to pass more options to your linker/compiler. + + + The yaz-config script accepts command line + options that makes the yaz-config script print + options that you should use in your make process. + The most important ones are: + --cflags, --libs + which prints C compiler flags, and linker flags respectively. + + + A small and complete Makefile for a C + application consisting of one source file, + myprog.c, may look like this: + + YAZCONFIG=/usr/local/bin/yaz-config + CFLAGS=`$(YAZCONFIG) --cflags` + LIBS=`$(YAZCONFIG) --libs` + myprog: myprog.o + $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS) + + + + The CFLAGS variable consists of a C compiler directive that will set + the include path to the parent directory + of yaz. That is, if &yaz; header files were + installed in /usr/local/include/yaz, + then include path is set to /usr/local/include. + Therefore, in your applications you should use + + #include <yaz/proto.h> + + and not + + #include <proto.h> + + + + For Libtool users, the yaz-config script provides + a different variant of option --libs, called + --lalibs that returns the name of the + Libtool acrhive(s) for &yaz; rather than the ordinary ones. + + + For applications using the threaded version of &yaz;, + specify threads after the + other options. When threads is given, + more flags and linker flags will be printed by + yaz-config. If our previous example was + using threads, you'd have to modify the lines that set + CFLAGS and LIBS as + follows: + + CFLAGS=`$(YAZCONFIG) --cflags threads` + LIBS=`$(YAZCONFIG) --libs threads` + + There is no need specify POSIX thread libraries in your Makefile. + The LIBS variable includes that as well. + + WIN32 @@ -238,7 +332,7 @@ is located. Customize the installation by editing the makefile file (for example by using notepad). - The following summarises the most important settings in that file: + The following summarizes the most important settings in that file: DEBUG @@ -260,7 +354,7 @@ - When satisfied with the settings in the makefile type + When satisfied with the settings in the makefile, type nmake @@ -305,7 +399,7 @@ Z39.50 multi-threaded test/example server. It's a WIN32 console application. - + bin/zoomsh.exe Simple console application implemented on top of the @@ -313,16 +407,48 @@ The application is a command line shell that allows you to enter simple commands perform to perform ZOOM operations. - + bin/zoomtst1.exe, bin/zoomtst2.exe, .. - Several small applications that demonstrates the use of ZOOM. + Several small applications that demonstrates the ZOOM API. - + + How to make apps using YAZ on WIN32 + + This section will go though the process of linking your WIN32 + applications with &yaz;. + + + Some people are confused by the fact that we use the nmake + tool to build &yaz;. They think they have to do that too - in order + to make their WIN32 applications work with &yaz;. The good news is that + you don't have to. You can use the integrated environment of + Visual Studio if desired for your own application. + + + When setting up a project or Makefile you have to set the following: + + include path + Set it to the include directory of &yaz;. + + import library yaz.lib + + You must link with this library. It's located in the + sub directory lib of &yaz;. + + dynamic link library yaz.dll + + This DLL must be in your execution path when you invoke + your application. Specifically, you should distribute this + DLL with your application. + + + +