test-heimdal-20060217

[openafs.git] / README-NT

diff --git a/README-NT b/README-NT
index 7507062..4f973f0 100644 (file)
--- a/README-NT
+++ b/README-NT
@@ -3,15 +3,25 @@ License.  For details, see the LICENSE file in the top-level source
 directory or on-line at http://www.openafs.org/dl/license10.html
 
 The document now provides a step by step procedure that takes the user 
-from a basic Windows 2000/XP workstation to an OpenAFS development 
+from a basic Windows 2000/XP/2003 workstation to an OpenAFS development 
 environment.   Details are provided so that a 'beginning' windows 
 developer can build an OpenAFS installable package for Windows 2000/XP/2003.
 
-NOTE:
+NOTE 1:
 As of the OpenAFS 1.3 release series, Windows platforms released
 prior to Windows 2000 are not being supported.  The InstallShield
 installer is still in the source tree but is no longer supported.
-A new open source installer based on NSIS 2.0 replaces it.
+A new open source installer based on NSIS 2.07 replaces it.
+
+NOTE 2:
+In this release, in addition to the production quality CIFS-AFS 
+gateway based client service there also exists an experimental
+implementation of an Installable File System (IFS).
+To build the IFS version, follow the directions below, but note that
+only the NSIS installer script has been updated to support it.
+Also, the IFS kernel module must be built separately, using the IFS/DDK
+build environment.
+
 
 ***********   Windows 2000/XP/2003 Build Process ****************
 
@@ -31,7 +41,7 @@ The following steps describe how to configure Windows 2000/XP:
    D. Configure NTBUILD.BAT
    E. Set program version Level
    F. Build Win2000 binaries
-   G. Install NSIS 2.0
+   G. Install NSIS 2.07
    H. Build NSIS Install Package
    I. Install Wix 2.0
    J. Build Wix MSI Install Package
@@ -59,14 +69,14 @@ The following Microsoft SDK is required:
 
 The following Microsoft DDK is required:
 
-    Microsoft Windows Server 2003 DDK
+    Microsoft Windows Server 2003 SP1 DDK
       available via a MSDN subscription or via free CD
       http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx
 
 The NSIS installer requires about 14 MB of storage. The following 
 version is supported:
 
-    Nullsoft Scriptable Installation System 2.0 
+    Nullsoft Scriptable Installation System 2.07
       http://nsis.sourceforge.net/home/
 
 The WiX installer requires about 18 MB of storage.  The following 
@@ -168,6 +178,11 @@ These files come from the following Microsoft DDKs/SDKs:
    netcfgn.h, netcfgx.h:
         Windows XP/2003 DDK - inc/wxp/
 
+If you are interested in experimenting with the IFS you must purchase from
+Microsoft a copy of the Windows 2003 SP1 IFS Kit.
+
+  http://www.microsoft.com/whdc/devtools/ifskit/default.mspx
+
 
 STEP D. Configure NTBUILD.BAT.
 
@@ -188,7 +203,8 @@ must be defined to match your configuration:
 
   NTDDKDIR: Set the short name of the directory containing the npapi.h file
 
-  AFSROOT: Set to the short name of the OpenAFS Base directory
+  AFSROOT: Set to the short name of the OpenAFS Base directory.  This
+           cannot be set to a UNC path.
 
 
 STEP E. Set version and installation options (optional)
@@ -199,7 +215,7 @@ from:
        http://grand.central.org/dl/cellservdb/CellServDB
 then copy it to %AFSROOT%\src\WINNT\install\NSIS and name it afsdcell.ini
 
-Edit file %AFSROOT%\src\config\NTMakefile.i386_nt40
+Edit file %AFSROOT%\src\config\NTMakefile.i386_w2k
     AFSPRODUCT_VER_MAJOR - Version Major Number
     AFSPRODUCT_VER_MINOR - Version Minor Number
     AFSPRODUCT_VER_PATCH - Version Patch Number
@@ -232,7 +248,7 @@ STEP F. Begin the build
 
 (3) Configure the environment variables:
 
-    For a release build:
+    For a release build (SMB version):
 
     (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
         Visual Studio environment you installed.
@@ -241,7 +257,16 @@ STEP F. Begin the build
 
     (c) Execute the NTBUILD.BAT file with the parameter "free"
 
-    For a debug build:
+    For a release build (IFS version):
+
+    (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
+        Visual Studio environment you installed.
+
+    (b) Execute the SETENV.BAT file with the parameters "/2000 /RETAIL"
+
+    (c) Execute the NTBUILD.BAT file with the parameter "free ifs"
+
+    For a debug build (SMB version):
 
     (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
         Visual Studio environment you installed.
@@ -250,11 +275,20 @@ STEP F. Begin the build
 
     (c) Execute the NTBUILD.BAT file with the parameter "checked"
 
+    For a debug build (IFS version):
+
+    (a) Execute the VCVARS32.BAT or VSVARS32.BAT file which part of the
+        Visual Studio environment you installed.
+
+    (b) Execute the SETENV.BAT file with the parameters "/2000 /DEBUG"
+
+    (c) Execute the NTBUILD.BAT file with the parameter "checked ifs"
+
 (4) Clean the work area:
 
     nmake /f NTMakefile clean
 
-(5) Build the complete Windows NT/2000 development environment.
+(5) Build the complete Windows 2000/XP/2003 development environment.
 
     nmake /f NTMakefile install
 
@@ -263,10 +297,13 @@ behavior is normal; the build process is successful as long as the build
 process doesn't terminate with an error ("nmake.exe return code 0x2")
 and it displays 'Build Finished Successfully'.
 
+(6) [IFS only] Open a DDK/IFS Build Environment command window, change 
+    to the src\WINNT\afsrdr directory, and execute the "build" command.
+
 
-STEP G. Install NSIS 2.0 (optional).
+STEP G. Install NSIS 2.07 (optional).
 
-Download the Nullsoft Scriptable Installation System (NSIS) 2.0 from
+Download the Nullsoft Scriptable Installation System (NSIS) 2.07 from
 
     http://nsis.sourceforge.net/home/