Minor.
[yaz-moved-to-github.git] / windows.txt
1 YAZ Compilation guidelines for winNT/95.
2   $Id: windows.txt,v 1.3 1999-12-02 13:54:56 adam Exp $
3
4 This distribution of YAZ includes makefiles that works with Visual
5 C++ version 5 and 6. The makefile is located in sub directory 'win'.
6
7 If you wish to make modifications to the make process you should
8 edit makefile before proceeding. For example, a DEBUG version of YAZ
9 can be build by modifying the line 'DEBUG=0' to 'DEBUG=1' in the
10 makefile.
11
12 Run nmake in that directory (in a Command prompt for example). Eg:
13     >CD \YAZ\WIN
14     >NMAKE
15
16 Make sure that the environment variables PATH, LIB and INCLUDE are
17 set properly. They *should* be set by the Visual C++ installation.
18 Programs cl.exe, link.exe and others must be found in the PATH. The
19 standard includes files, standard libraries must be found in INCLUDE
20 and LIB respectively.
21
22 The following components are build by the nmake process:
23
24 yaz.dll - This DLL is made of the source in all sub directories except
25          for 'server', 'client' and 'ztest'. To export public functions
26          the header files contain the modifier YAZ_EXPORT which is
27          defined in yconfig.h. The value of this modifier,
28          __declspec(dllexport), is probably specific to Visual C++. 
29
30 server.lib - The server library, which includes the source from
31          'server'.  Unlike the UNIX version, the server library is
32          multi-threaded.
33
34 yaz-client.exe - A Z39.50 client console application. It is linked with
35          the import library yaz.lib. This application searches for yaz.dll
36          during runtime.
37
38 yaz-ztest.exe - The Z39.50 test server as a console application. It is
39          linked with the import library yaz.lib and the regular library
40          server.lib. When running yaz-ztest make sure it is able to find
41          the record test files dummy-records, dummy-grs, and dummy-words
42          in the current directory. 
43
44          As an option ztest may be installed as an NT service
45          (not Windows 95). Use 'ztest -install <otherargs>' to install
46          it and 'ztest -remove <otherargs>' to remove it again. Since
47          NT runs the service program in some weird directory, such as
48          \winnt\system32, it's probably a good idea to use the option
49          '-w' to change to some other directory. For example
50
51             yaz-ztest -install -w d:\proj\yaz\ztest -l ztest.out tcp:@:210
52
53          which specifies both working directory (d:\proj\yaz\ztest) 
54          and a log file (ztest.out). The server is started on port 210.
55
56 After successful compilation all executables and DLL's are located
57 in sub YAZ\BIN. Libraries are located in YAZ\LIB.