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
5 The document now provides a step by step procedure that takes the user
6 from a basic Windows 2000/XP/2003/Vista/2008 workstation to an OpenAFS
7 development environment. Details are provided so that a 'beginning'
8 windows developer can build an OpenAFS installable package for Windows
9 2000/XP/2003/Vista/2008.
12 As of the OpenAFS 1.3 release series, Windows platforms released
13 prior to Windows 2000 are no longer supported. As of the OpenAFS 1.5
14 series, the Windows 9x components are being removed from the source tree.
16 *********** Windows 2000/XP/2003/Vista/2008 Build Process *************
18 Building OpenAFS for Windows requires configuring a Windows
19 development system by installing compilation tools and header files.
20 Open AFS Software development can be done on Windows 2000, XP, 2003,
21 or Vista. The target system, where OpenAFS will be installed, can be
31 * Windows 2003 R2 (32 or 64)
32 * Windows Vista (32 or 64)
33 * Windows 2008 (32 or 64)
35 The build process is controlled by a nmake file that generates the
36 necessary binaries and binds them into an install package.
38 The following steps describe how to configure Windows 2000/XP:
40 A. Obtain a copy of the OpenAFS Source Tree
41 B. Install Compiler and Development tools.
42 C. Install SDK header files
43 D. Configure NTBUILD.BAT
44 E. Set program version Level
47 H. Build NSIS Install Package
48 I. Install Wix 2.0.5325
49 J. Build Wix MSI Install Package
53 The Microsoft development tools require anywhere from 660 MB to 1.8GB
54 of storage depending on which compilers are selected. The following
55 versions are supported:
57 Microsoft Visual Studio .NET
58 available via a MSDN subscription
60 Microsoft Visual Studio .NET 2003
61 available via a MSDN subscription
63 Microsoft Visual Studio .NET 2005
64 available via a MSDN subscription
65 (recommended - required for 64-bit builds)
67 Microsoft Visual Studio 2008 is not supported
69 The following Microsoft SDK is required:
71 Microsoft Platform SDK for Windows Server 2003 SP1 or Vista or 2008
72 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/downlevel.htm [IE required]
73 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
75 The following Microsoft DDK is required:
77 Microsoft Windows Server 2003 SP1 DDK
78 available via a MSDN subscription or via free CD
79 http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx
81 The Microsoft HTML Help Workshop is required:
83 http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
85 The Microsoft Internationalized Domain Names (IDN) Mitigation APIs 1.1 is required:
87 http://www.microsoft.com/downloads/details.aspx?FamilyId=AD6158D7-DDBA-416A-9109-07607425A815&displaylang=en
89 The NSIS installer requires about 14 MB of storage. The following
92 Nullsoft Scriptable Installation System 2.30
93 http://nsis.sourceforge.net/home/
95 The WiX installer requires about 18 MB of storage. The following
99 http://prdownloads.sourceforge.net/wix/sources-2.0.5325.0.zip
101 The OpenAFS Source directory requires about 360 MB storage. The Source
102 directory size includes additional space for files that will be
103 generated during the build process.
106 STEP A. Obtain a copy of the Open AFS Source Tree.
108 Transfer OpenAFS source tree onto your hardrive. The source can be
109 downloaded from the OpenAFS web site:
110 http://www.OpenAFS.org/release/snapindex.html.
112 For this example, download source for version 1.5.51 using the
114 http://www.openafs.org/dl/openafs/1.5.51/openafs-1.5.51-src.tar
116 HINT: DailySnapShots are pre-release source trees and much more
117 likely to have compilation errors. If this is your first attempt, do
118 your build based on a release version of the source, e.g. 1.5.51. Once
119 you have completed a build process successfully, you can experiment with
122 You will need an unzip utility that can expand compressed tar files.
123 For example "Pkzip for Windows" from Pkware will uncompress tar files.
124 (http://www.pkware.com/)
126 Expand the downloaded tar file (openafs-1.5.51-src.tar) into target
127 directory (c:\OpenAFS), the unzip routine will expand the source into a
129 c:\OpenAFS\OpenAFS-1.5.51\src
131 Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS
132 base directory (aka %AFSROOT%):
134 From a DOS command prompt window, enter the following copy commands:
136 cd c:\OpenAFS\OpenAFS-1.5.51
137 copy src\NTMakefile .
138 copy src\ntbuild.bat .
141 The OpenAFS base directory should look something like the following:
143 c:\OpenAFS\OpenAFS-1.5.51\
149 STEP B. Install compiler and development tools.
151 Install a copy of Microsoft Visual Studio .NET, Visual Studio .NET 2003,
152 or Visual Studio .NET 2005. Visual Studio 2008 has not been sufficiently
153 tested to be considered "supported". The "Typical" install setting is
156 (1) You can reduce the installation size by selecting "Custom" install
157 and remove all but the following Options:
162 (2) When asked, Select to Register Environment Variables.
165 STEP C. Install SDK header files.
167 Files from Microsoft's Platform SDK for Windows Server 2003 SP1 are
168 required to complete a build on Windows 2000/XP/2003. At a minimum the
169 following componets are known to be required:
174 * Windows Management Instrumentation
177 It is advised that you install the entire SDK. The SDK can be obtained
180 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
182 by using Internet Explorer 5.x or higher. (Active X controls are required)
184 The header files that are required from a Microsoft SDK/DDK are:
186 npapi.h (Windows 2000,XP,2003 builds)
187 netcfgx.h (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
188 netcfgn.h (NSIS Loopback Adapter installer - Windows 2000,XP,2003 builds)
189 normalization.h (AFS Cache Manager)
191 These files come from the following Microsoft DDKs/SDKs:
194 Windows XP SP2 Platform SDK - include/
196 netcfgn.h, netcfgx.h:
197 Windows XP/2003 DDK - inc/wxp/
200 Microsoft IDN Mitigation APIs 1.1 - include/
202 STEP D. Configure NTBUILD.BAT.
204 The NTBUILD.BAT file copied to the OpenAFS base directory must be
205 customized for use on your development system. The following variables
206 must be defined to match your configuration:
208 AFSVER_CL: Set to 1200 if using MS Visual C++ 6.0
209 Set to 1300 if using MS Visual Studio .NET
210 Set to 1310 if using MS Visual Studio .NET 2003
211 Set to 1400 if using MS Visual Studio .NET 2005
212 Set to 1500 if using MS Visual Studio 2008
214 MSVCDIR: Set to the short name version of the directory into which
215 the visual C++ compiler was installed regardless of version
217 MSVCDIR64: On AMD64 systems, set to the 64-bit visual C++ compiler
219 MSSDKDIR: Set to the short name of the directory into which
220 the Platform SDK was installed
222 NTDDKDIR: Set to the short name of the INC\WNET DDK directory
224 NTDDKDIR2: Set to the short name of the INC\CRT DDK directory
226 AFSROOT: Set to the short name of the OpenAFS Base directory. This
227 cannot be set to a UNC path.
229 SYS_NAME: One of "i386_w2k" or "amd64_w2k"
231 APPVER: 0x500 for Windows 2000 and above; 0x502 for AMD64 systems
233 _WIN32_IE: Must match APPVER
235 MSVCVer: Set to 8.0 if using Visual Studio 8
237 CODESIGN_DESC: Product Name
239 CODESIGN_TIMESTAMP: Time Stamp Service for Code Signing Certificate
241 CODESIGN_URL: Support URL Displayed to End Users
244 STEP E. Set version and installation options (optional)
246 Add a CellServDB file to install area. CellServDB contains the entries
247 for the various cell names. You can download a general purpose one
249 http://grand.central.org/dl/cellservdb/CellServDB
250 then copy it to %AFSROOT%\src\WINNT\install\NSIS and name it afsdcell.ini
252 Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k
253 AFSPRODUCT_VER_MAJOR - Version Major Number
254 AFSPRODUCT_VER_MINOR - Version Minor Number
255 AFSPRODUCT_VER_PATCH - Version Patch Number
256 AFSPRODUCT_VER_BUILD - Version Build Number
257 CELLSERVDB_INSTALL - The default file name for the CellServDB
258 included in the install Package.
259 CELLNAME_DEFAULT - The default home cell name.
260 CELLSERVDB_WEB - The default web address to obtain CellServDB
262 For example: in the file %AFSROOT%\src\config\NTMakefile.i386_w2k you would
265 AFSPRODUCT_VER_MAJOR=1
266 AFSPRODUCT_VER_MINOR=5
267 AFSPRODUCT_VER_PATCH=5100
268 AFSPRODUCT_VER_BUILD=0
269 CELLNAME_DEFAULT=openafs.org
270 CELLSERVDB_INSTALL=CellServDB.GrandCentral
271 CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB
273 During the Open AFS installation process the user will be presented
274 with two choices for the CellServDB: Local copy (CELLSERVDB_INSTALL) and
275 one that can be downloaded from the web (CELLSERVDB_WEB).
277 STEP F. Begin the build
279 (1) From Windows 2000/XP/2003 open up a DOS prompt window.
281 (2) Change to the %AFSROOT% directory
283 (3) Configure the environment variables:
285 For a release build (SMB version):
287 (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
288 Visual Studio environment you installed.
290 (b) Execute the SETENV.BAT file with the parameters "/2000 /RETAIL"
292 (c) Execute the NTBUILD.BAT file with the parameter "free"
294 For a debug build (SMB version):
296 (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
297 Visual Studio environment you installed.
299 (b) Execute the SETENV.BAT file with the parameters "/2000 /DEBUG"
301 (c) Execute the NTBUILD.BAT file with the parameter "checked"
303 (4) Clean the work area:
305 nmake /f NTMakefile clean
307 (5) Build the complete Windows 2000/XP/2003 development environment.
309 nmake /f NTMakefile install
311 While the build is running you will see many compile warnings. This
312 behavior is normal; the build process is successful as long as the build
313 process doesn't terminate with an error ("nmake.exe return code 0x2")
314 and it displays 'Build Finished Successfully'.
317 STEP G. Install NSIS 2.30 (optional).
319 Download the Nullsoft Scriptable Installation System (NSIS) 2.30 from
321 http://nsis.sourceforge.net/home/
323 Run the nsis-2.30.exe installer and install to "C:\Program Files\NSIS".
324 Then download the large strings build zip file and replace the installed
325 files with the versions from the zip file. These versions increase
326 the maximum string length from 1024 characters to 8192 characters.
327 This is necessary for installation on systems with long PATH environment
330 Note: The NSIS installer can only be used to produce 32-bit installers.
332 STEP H. Build OpenAFS NSIS install package
334 From the %AFSROOT% directory execute:
336 nmake /f NTMakefile NSIS
339 STEP I. Install Wix MSI Installer
341 Download the Wix 2.0.5325.0 installer from
343 http://prdownloads.sourceforge.net/wix/sources-2.0.5325.0.zip
346 STEP J. Build Wix MSI install package
348 From the %AFSROOT% directory execute:
350 nmake /f NTMakefile wix
352 Make sure the binaries installed to \src\wix\release\ship are
353 available in the PATH environment variable
356 STEP K. Final Results
358 The build process generates its binaries in %AFSROOT%\DEST. The subdirectory
359 would look like the following:
361 %AFSROOT%\DEST\{checked,free}\
370 Bin - contains build utilities.
371 root.client - contains Open AFS binaries
372 root.server - contain Open AFS Server binaries
373 WinInstall\OpenAFSforWindows.exe - is the NSIS install package
374 WinInstall\openafs-en_US.msi - is the WiX MSI install package
377 STEP L. Optional Items
379 The build process has an error table that is compiled for many OpenAFS
380 applications. This table is generated by Unix based tools. It is not
381 normally necessary to modify this table so pre-generated source files
382 are included in the OpenAFS source. If you need to make modifications
383 in these areas the Unix base tools that run on Windows can be found on
384 the web. For example:
388 Below is a short explanation how to update the error table.
390 (1) Install flex and bison from a Unix based tool provider.
392 (2) Make changes to the source files.
394 There are two files in the source tree that are processed with lex
395 and yacc on UNIX systems, src/comerr/et_lex.lex.l and
396 src/comerr/error_table.y, that when processed produce the files
397 et_lex.lex_nt.c, error_table_nt.c, and error_table_nt.h.
399 Since NT does not include lex and yacc or any equivalent tools, we
400 have provided the output files that lex and yacc produce (using Win32
401 ports of flex and bison). This will allow builds to work for anyone
402 who does not need to change the .l and .y files.
404 If you do need to change et_lex.lex.l, then you will need to install
405 Win32 port of flex on your system. Put flex.exe in a directory on the
408 If you do need to change error_table.y, then you will need to install
409 a Win32 port of bison on your system. Put bison.exe in a directory on
410 the path, configure bison as explained in step 5, and rebuild.
412 You can also attempt to use other replacements for lex and yacc. This
413 will require modifying the LEX and YACC settings in
414 /config/NTMakefile.i386_nt40. If the replacements require different
415 command line options than flex and bison, then you may also need to
416 change src/comerr/NTMakefile.
418 (3) Generate new OpenAFS binaries