DEVEL15-windows-remove-umich-afsifs-20080318
[openafs.git] / README-NT
1 This software has been released under the terms of the IBM Public
2 License.  For details, see the LICENSE file in the top-level source
3 directory or on-line at http://www.openafs.org/dl/license10.html
4
5 The document now provides a step by step procedure that takes the user 
6 from a basic Windows 2000/XP/2003 workstation to an OpenAFS development 
7 environment.   Details are provided so that a 'beginning' windows 
8 developer can build an OpenAFS installable package for Windows 2000/XP/2003.
9
10 NOTE 1:
11 As of the OpenAFS 1.3 release series, Windows platforms released
12 prior to Windows 2000 are no longer supported.  As of the OpenAFS 1.5
13 series, the Windows 9x components are being removed from the source tree.
14
15 ***********   Windows 2000/XP/2003 Build Process ****************
16
17 Building OpenAFS for Windows requires configuring a Windows
18 development system by installing compilation tools and header files.
19 Open AFS Software development can be done on Windows 2000, XP, 2003, 
20 or Vista.  The target system, where OpenAFS will be installed, can be 
21 one of:
22
23  * Windows 2000
24  * Windows XP
25  * Windows XP SP2
26  * Windows 2003 
27  * Windows 2003 SP1
28  * Windows XP 64
29  * Windows 2003 64
30  * Windows 2003 R2 (32 or 64)
31  * Windows Vista (32 or 64)
32
33 The build process is controlled by a nmake file that generates the 
34 necessary binaries and binds them into an install package.
35
36 The following steps describe how to configure Windows 2000/XP:
37
38    A. Obtain a copy of the OpenAFS Source Tree
39    B. Install Compiler and Development tools.
40    C. Install SDK header files
41    D. Configure NTBUILD.BAT
42    E. Set program version Level
43    F. Build the binaries
44    G. Install NSIS 2.30
45    H. Build NSIS Install Package
46    I. Install Wix 2.0.5325
47    J. Build Wix MSI Install Package
48    K. Final Results
49    L. Optional Items
50         
51 The Microsoft development tools require anywhere from 660 MB to 1.8GB
52 of storage depending on which compilers are selected.  The following 
53 versions are supported:
54
55     Microsoft Visual Studio .NET 
56       available via a MSDN subscription
57
58     Microsoft Visual Studio .NET 2003
59       available via a MSDN subscription
60
61     Microsoft Visual Studio .NET 2005 (required for AMD64 builds)
62       available via a MSDN subscription
63       (recommended - required for 64-bit builds)
64
65 The following Microsoft SDK is required:
66
67     Microsoft Platform SDK for Windows XP SP2 or Server 2003 SP1 or Vista
68       http://www.microsoft.com/msdownload/platformsdk/sdkupdate/downlevel.htm [IE required]
69       http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
70
71 The following Microsoft DDK is required:
72
73     Microsoft Windows Server 2003 SP1 DDK
74       available via a MSDN subscription or via free CD
75       http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx
76
77 The Microsoft HTML Help Workshop is required:
78
79     http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
80
81 The NSIS installer requires about 14 MB of storage. The following 
82 version is supported:
83
84     Nullsoft Scriptable Installation System 2.30
85       http://nsis.sourceforge.net/home/
86
87 The WiX installer requires about 18 MB of storage.  The following 
88 version is supported:
89
90     Wix 2.0.5325.0
91       http://prdownloads.sourceforge.net/wix/sources-2.0.5325.0.zip
92
93 The InstallShield scripts (although not supported) require version 5.5
94 of InstallShiled. Version 6.0 or higher of InstallShield are not 
95 compatible.
96
97 The OpenAFS Source directory requires about 360 MB storage. The Source
98 directory size includes additional space for files that will be
99 generated during the build process.
100
101
102 STEP A. Obtain a copy of the Open AFS Source Tree.
103
104 Transfer OpenAFS source tree onto your hardrive.  The source can be
105 downloaded from the OpenAFS web site:
106         http://www.OpenAFS.org/release/snapindex.html.
107
108 For this example, download source for version 1.3.74 using the
109 following URL:
110 http://www.openafs.org/dl/openafs/1.3.74/openafs-1.3.74-src.tar
111
112 HINT: DailySnapShots are pre-release source trees and much more
113 likely to have compilation errors. If this is your first attempt, do
114 your build based on a release version of the source, e.g. 1.3.74. Once
115 you have completed a build process successfully, you can experiment with
116 other source trees.
117
118 You will need an unzip utility that can expand compressed tar files.
119 For example "Pkzip for Windows" from Pkware will uncompress tar files.
120 (http://www.pkware.com/)
121
122 Expand the downloaded tar file (openafs-1.3.74-src.tar) into target
123 directory (c:\OpenAFS), the unzip routine will expand the source into a
124 subdirectory tree:
125     c:\OpenAFS\OpenAFS-1.3.74\src
126
127 Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS 
128 base directory (aka %AFSROOT%):
129
130   From a DOS command prompt window, enter the following copy commands:
131
132     cd c:\OpenAFS\OpenAFS-1.3.74
133     copy src\NTMakefile .
134     copy src\ntbuild.bat .
135
136
137 The OpenAFS base directory should look something like the following:
138
139   c:\OpenAFS\OpenAFS-1.3.74\
140     NTMakefile
141     ntbuild.bat
142     src
143           
144
145 STEP B. Install compiler and development tools.
146
147 Install a copy of Microsoft Visual Studio .NET, Visual Studio .NET 2003, 
148 or Visual Studio .NET 2005.  The "Typical" install setting is sufficient.
149
150 (1) You can reduce the installation size by selecting "Custom" install
151 and remove all but the following Options:
152
153         Microsoft Visual C++
154         Data Access
155
156 (2) When asked, Select to Register Environment Variables.
157
158
159 STEP C. Install SDK header files.
160
161 Files from Microsoft's Platform SDK for Windows XP SP2 or Server 2003 are
162 required to complete a build on Windows 2000/XP/2003.   You can install 
163 the "Core, Data Access and Installer SDKs" from
164
165   http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
166
167 by using Internet Explorer 5.x or higher.  (Active X controls are required)
168 If you do not which to use IE a complete SDK package is available from
169
170   http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
171
172 The header files that are required from a Microsoft SDK/DDK are:
173
174    npapi.h    (Windows 2000,XP,2003 builds)
175    netcfgx.h  (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
176    netcfgn.h  (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
177
178 These files come from the following Microsoft DDKs/SDKs:
179
180    npapi.h:
181         Windows XP SP2 Platform SDK - include/
182
183    netcfgn.h, netcfgx.h:
184         Windows XP/2003 DDK - inc/wxp/
185
186
187 STEP D. Configure NTBUILD.BAT.
188
189 The NTBUILD.BAT file copied to the OpenAFS base directory must be 
190 customized for use on your development system.  The following variables
191 must be defined to match your configuration:
192
193   AFSVER_CL: Set to 1200 if using MS Visual C++ 6.0
194              Set to 1300 if using MS Visual Studio .NET
195              Set to 1310 if using MS Visual Studio .NET 2003
196              Set to 1400 if using MS Visual Studio .NET 2005
197
198   MSVCDIR: Set to the short name version of the directory into which
199            the visual C++ compiler was installed regardless of version
200
201   MSVCDIR64: On AMD64 systems, set to the 64-bit visual C++ compiler
202
203   MSSDKDIR: Set to the short name of the directory into which
204             the Platform SDK was installed
205
206   NTDDKDIR: Set to the short name of the INC\WNET DDK directory
207
208   NTDDKDIR2: Set to the short name of the INC\CRT DDK directory
209
210   AFSROOT: Set to the short name of the OpenAFS Base directory.  This
211            cannot be set to a UNC path.
212
213   SYS_NAME: One of "i386_w2k" or "amd64_w2k"
214
215   APPVER:   0x500 for Windows 2000 and above; 0x502 for AMD64 systems
216
217   _WIN32_IE: Must match APPVER
218
219   MSVCVer:  Set to 8.0 if using Visual Studio 8
220
221
222 STEP E. Set version and installation options (optional)
223
224 Add a CellServDB file to install area. CellServDB contains the entries
225 for the various cell names.  You can download a general purpose one
226 from:
227         http://grand.central.org/dl/cellservdb/CellServDB
228 then copy it to %AFSROOT%\src\WINNT\install\NSIS and name it afsdcell.ini
229
230 Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k
231     AFSPRODUCT_VER_MAJOR - Version Major Number
232     AFSPRODUCT_VER_MINOR - Version Minor Number
233     AFSPRODUCT_VER_PATCH - Version Patch Number
234     AFSPRODUCT_VER_BUILD - Version Build Number
235     CELLSERVDB_INSTALL   - The default file name for the CellServDB
236                            included in the install Package.
237     CELLNAME_DEFAULT     - The default home cell name.
238     CELLSERVDB_WEB       - The default web address to obtain CellServDB
239
240 For example: in the file %AFSROOT%\src\config\NTMakefile.i386_nt40 you would
241 see the following:
242
243    AFSPRODUCT_VER_MAJOR=1
244    AFSPRODUCT_VER_MINOR=3
245    AFSPRODUCT_VER_PATCH=7400
246    AFSPRODUCT_VER_BUILD=0
247    CELLNAME_DEFAULT=openafs.org
248    CELLSERVDB_INSTALL=CellServDB.GrandCentral
249    CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB
250
251 During the Open AFS installation process the user will be presented
252 with two choices for the CellServDB: Local copy (CELLSERVDB_INSTALL) and
253 one that can be downloaded from the web (CELLSERVDB_WEB).
254
255 STEP F. Begin the build
256
257 (1) From Windows 2000/XP/2003 open up a DOS prompt window.
258
259 (2) Change to the %AFSROOT% directory
260
261 (3) Configure the environment variables:
262
263     For a release build (SMB version):
264
265     (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
266         Visual Studio environment you installed.
267
268     (b) Execute the SETENV.BAT file with the parameters "/2000 /RETAIL"
269
270     (c) Execute the NTBUILD.BAT file with the parameter "free"
271
272     For a debug build (SMB version):
273
274     (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
275         Visual Studio environment you installed.
276
277     (b) Execute the SETENV.BAT file with the parameters "/2000 /DEBUG"
278
279     (c) Execute the NTBUILD.BAT file with the parameter "checked"
280
281 (4) Clean the work area:
282
283     nmake /f NTMakefile clean
284
285 (5) Build the complete Windows 2000/XP/2003 development environment.
286
287     nmake /f NTMakefile install
288
289 While the build is running you will see many compile warnings. This
290 behavior is normal; the build process is successful as long as the build
291 process doesn't terminate with an error ("nmake.exe return code 0x2")
292 and it displays 'Build Finished Successfully'.
293
294
295 STEP G. Install NSIS 2.30 (optional).
296
297 Download the Nullsoft Scriptable Installation System (NSIS) 2.30 from
298
299     http://nsis.sourceforge.net/home/
300
301 Run the nsis-2.30.exe installer and install to "C:\Program Files\NSIS".
302 Then download the large strings build zip file and replace the installed 
303 files with the versions from the zip file.  These versions increase 
304 the maximum string length from 1024 characters to 8192 characters.  
305 This is necessary for installation on systems with long PATH environment 
306 strings.
307
308 Note: The NSIS installer can only be used to produce 32-bit installers.
309
310 STEP H.  Build OpenAFS NSIS install package
311
312 From the %AFSROOT% directory execute:
313
314     nmake /f NTMakefile NSIS
315
316
317 STEP I.  Install Wix MSI Installer
318
319 Download the Wix 2.0.5325.0 installer from 
320
321     http://prdownloads.sourceforge.net/wix/sources-2.0.5325.0.zip
322
323
324 STEP J.  Build Wix MSI install package
325
326 From the %AFSROOT% directory execute:
327
328     nmake /f NTMakefile wix
329
330 Make sure the binaries installed to \src\wix\release\ship are
331 available in the PATH environment variable
332
333
334 STEP K. Final Results
335
336 The build process generates its binaries in %AFSROOT%\DEST. The subdirectory
337 would look like the following:
338
339 %AFSROOT%\DEST\{checked,free}\
340         bin
341         etc
342         include
343         lib
344         root.client
345         root.server
346         WinInstall
347
348     Bin - contains build utilities.
349     root.client - contains Open AFS binaries
350     root.server - contain Open AFS Server binaries
351     WinInstall\OpenAFSforWindows.exe - is the NSIS install package
352     WinInstall\openafs-en_US.msi - is the WiX MSI install package
353
354
355 STEP L. Optional Items
356
357 The build process has an error table that is compiled for many OpenAFS
358 applications.  This table is generated by Unix based tools.  It is not
359 normally necessary to modify this table so pre-generated source files
360 are included in the OpenAFS source.  If you need to make modifications
361 in these areas the Unix base tools that run on Windows can be found on
362 the web. For example:
363
364         http://cygwin.com/
365
366 Below is a short explanation how to update the error table.
367
368 (1) Install flex and bison from a Unix based tool provider.
369
370 (2) Make changes to the source files.
371
372 There are two files in the source tree that are processed with lex
373 and yacc on UNIX systems, src/comerr/et_lex.lex.l and
374 src/comerr/error_table.y, that when processed produce the files
375 et_lex.lex_nt.c, error_table_nt.c, and error_table_nt.h.
376
377 Since NT does not include lex and yacc or any equivalent tools, we
378 have provided the output files that lex and yacc produce (using Win32
379 ports of flex and bison). This will allow builds to work for anyone
380 who does not need to change the .l and .y files.
381
382 If you do need to change et_lex.lex.l, then you will need to install
383 Win32 port of flex on your system. Put flex.exe in a directory on the
384 path and rebuild.
385
386 If you do need to change error_table.y, then you will need to install
387 a Win32 port of bison on your system. Put bison.exe in a directory on
388 the path, configure bison as explained in step 5, and rebuild.
389
390 You can also attempt to use other replacements for lex and yacc. This
391 will require modifying the LEX and YACC settings in
392 /config/NTMakefile.i386_nt40. If the replacements require different
393 command line options than flex and bison, then you may also need to
394 change src/comerr/NTMakefile.
395
396 (3) Generate new OpenAFS binaries