X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=aebcd5517a4d5e5fb07f007353b74e14a7d94441;hp=448bed41a71616b8192d1abb6043cfb2ef0bbfdf;hb=ab0fd2f75e554d1c9c0e722abf073f9840f7739b;hpb=3b251ac2d9cbaa140d55abc8e263b11b69357365 diff --git a/doc/installation.xml b/doc/installation.xml index 448bed4..aebcd55 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,8 +1,9 @@ - + Compilation and Installation + Introduction - The latest version of the software will generally be found at + The latest version of the software will generally be found at: @@ -21,6 +22,7 @@ HP/UX SunOS/Solaris DEC Unix + OpenBSD/FreeBSD Linux IBM AIX Data General DG/UX (with some CFLAGS tinkering) @@ -59,15 +61,24 @@ , or the address given at the top of this document. + UNIX Note that if your system doesn't have a native ANSI C compiler, you may - have to acquire one separately. We recommend gcc. + have to acquire one separately. We recommend + GCC. - For UNIX we use GNU configure to create Makefiles for &yaz;. - Generally it should be sufficient to run configure without options: + For UNIX, the GNU tools + Autoconf, + Automake and + Libtool + is 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, + like this: @@ -125,27 +136,54 @@ The following files are generated by the make process: - lib/libyaz.a + lib/libyaz.la + + The main &yaz; library. This is no ordinary library. It's + a Libtool archive. + By default, &yaz; creates a static library in + lib/.libs/libyaz.a. + + + lib/libyazthread.la - The &yaz; programmers' library. + When threading is supported/enabled by configure this GNU libtool + library is created. It include functions that allows &yaz; + to use threads. ztest/yaz-ztest - A test Z39.50 server. + A test Z39.50 server. client/yaz-client - A command mode Z39.50 client. + A YAZ Z39.50 client. See chapter + YAZ client for more information. yaz-config - A Bourne-shell script that holds build - settings for &yaz;. + A Bourne-shell script, generate by configure, that + specifies how external applications should compile - and link with + &yaz;. yaz-comp The ASN.1 compiler for &yaz;. Requires the - Tcl Shell, tclsh, in current path to work. + Tcl Shell, tclsh, in + PATH to operate. + + + zoom/zoomsh + + 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. + + + zoom/zoomtst1, + zoom/zoomtst2, .. + + Several small applications that demonstrates the use of ZOOM. @@ -188,50 +226,55 @@ &yaz; is shipped with "makefiles" for the NMAKE tool that comes - with Visual C++. - - Start an MS-DOS prompt and switch the sub directory + with Microsoft Visual C++. Version 6 has been tested. We expect that + &yaz; should compile 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 summarises the most important settings in that file: - - WIN32 makefile settings - - - - Setting - Description - - - - - DEBUG - If set to 1, the software is - compiled with debugging libraries. If set to 0, the software - is compiled with release (non-debugging) libraries. - - - - - TCL - Specifies the name of the Tcl shell (EXE-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). + + + TCL + + Specifies the name of the Tcl shell (EXE-file). You do not need setting this or installing Tcl unless you wish to change or add ASN.1 for &yaz;. - - - - - -
- + + + When satisfied with the settings in the makefile type nmake + If command nmake 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: @@ -239,19 +282,36 @@ bin/yaz.dll - the multi-threaded &yaz; DLL. + The multi-threaded &yaz; Dynamic Link Library. - bin/yaz-ztest.exe + bin/yaz-client.exe - A console Z39.50 client application. + The &yaz; Z39.50 client application. It's a WIN32 console application. + See chapter YAZ client for more + information. bin/yaz-ztest.exe - A console Z39.50 multi threaded server. + The example/test Z39.50 multi threaded server. It's a WIN32 + console application. - + + bin/zoomsh.exe + + A simple console application implemented on top of the + ZOOM functions. + 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. + +