From: Jeffrey Altman Date: Thu, 18 Mar 2004 04:32:20 +0000 (+0000) Subject: move-readme-to-top-20040317 X-Git-Tag: openafs-devel-1_3_60~3 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=83b2f72a94b9e6953006acef4729694ee6b74271;p=packages%2Fo%2Fopenafs.git move-readme-to-top-20040317 Move the README files to the top directory where they belong. ==================== This delta was composed from multiple commits as part of the CVS->Git migration. The checkin message with each commit was inconsistent. The following are the additional commit messages. ==================== As of 1.3.60 move the Windows Readme files from src to top directory --- diff --git a/README-NT b/README-NT new file mode 100644 index 000000000..8acfe4c5d --- /dev/null +++ b/README-NT @@ -0,0 +1,327 @@ +This software has been released under the terms of the IBM Public +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 +environment. Details are provided so that a 'beginning' windows +developer can build an OpenAFS installable package for Windows 2000/XP/2003. + +NOTE: +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. + +*********** Windows 2000/XP/2003 Build Process **************** + +Building OpenAFS for Windows requires configuring a Windows +development system by installing compilation tools and header files. +Open AFS Software development can be done on Windows 2000 or XP. The +target system, where OpenAFS will be installed, should be either +Windows 2000, Windows XP, or Windows 2003. The building process is +controlled by a nmake file that generates the necessary binaries and +binds them into an install package. + +The following steps describe how to configure Windows 2000/XP: + + A. Obtain a copy of the OpenAFS Source Tree + B. Install Compiler and Development tools. + C. Install SDK header files + D. Configure NTBUILD.BAT + E. Set program version Level + F. Build Win2000 binaries + G. Install NSIS 2.0 + H. Build NSIS Install Package + I. Final Results + J. Optional Items + +The Microsoft development tools require anywhere from 660 MB to 1.8GB +of storage depending on which compilers are selected. The following +versions are supported: + + Microsoft Visual C++ 6.0 + Microsoft Visual .NET + Microsoft Visual .NET 2003 (recommended) + + Any version of the Microsoft SDK and Tools released August 2001 or later. + +The NSIS installer requires about 14 MB of storage. The following +version is supported. + + Nullsoft Scriptable Installation System 2.0 + +The InstallShield scripts (although not supported) require version 5.5 +of InstallShiled. Version 6.0 or higher of InstallShield are not +compatible. + +The OpenAFS Source directory requires about 360 MB storage. The Source +directory size includes additional space for files that will be +generated during the build process. + + +STEP A. Obtain a copy of the Open AFS Source Tree. + +Transfer OpenAFS source tree onto your hardrive. The source can be +downloaded from the OpenAFS web site: + http://www.OpenAFS.org/release/snapindex.html. + +For this example, download source for version 1.3.60 using the +following URL: +http://www.openafs.org/dl/openafs/1.3.60/openafs-1.3.60-src.tar + +HINT: DailySnapShots are pre-release source trees and much more +likely to have compilation errors. If this is your first attempt, do +your build based on a release version of the source, e.g. 1.3.60. Once +you have completed a build process successfully, you can experiment with +other source trees. + +You will need an unzip utility that can expand compressed tar files. +For example "Pkzip for Windows" from Pkware will uncompress tar files. +(http://www.pkware.com/) + +Expand the downloaded tar file (openafs-1.3.60-src.tar) into target +directory (c:\OpenAFS), the unzip routine will expand the source into a +subdirectory tree: + c:\OpenAFS\OpenAFS-1.3.60\src + +Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS +base directory: + + From a DOS command prompt window, enter the following copy commands: + + copy c:\OpenAFS\OpenAFS-1.3.60\src\NTMakefile c:\OpenAFS\OpenAFS-1.3.60\. + copy c:\OpenAFS\OpenAFS-1.3.60\src\ntbuild.bat c:\OpenAFS\OpenAFS-1.3.60\. + + +The AFS base directory should look something like the following: + + c:\OpenAFS\OpenAFS-1.3.60\ + NTMakefile + ntbuild.bat + src + + +STEP B. Install compiler and development tools. + +Install a copy of Microsoft Visual C++ 6.0, Visual .NET, or Visual .NET 2003. +The "Typical" install setting is sufficient. + +(1) You can reduce the installation size by selecting "Custom" install +and remove all but the following Options: + + Microsoft Visual C++ + Data Access + +(2) When asked, Select to Register Environment Variables. + + +STEP C. Install SDK header files. + +Files from Microsoft's Platform SDK (August 2001 or later) are required to +complete a build on Windows 2000 or XP. You can install the "Core SDK" +from + + http://www.microsoft.com/msdownload/platformsdk/sdkupdate/ + +by using Internet Explorer 5.x or higher. (Active X controls are required) + +The header files that are required are found from a Microsoft SDK are: + + netspi.h + npapi.h + +These files come from Microsoft DDKs/SDKs as follows: + + January 1997 Windows NT Workstation DDK - /ddk/frc/network/inc/npapi.h + November 2001 Microsoft Platform SDK - install "samples" from "Core SDK" + samples/winbase/security/winnt/logonnp/npapi.h + July 1998 Windows 95 DDK - net/inc/netmpr.h and net/inc/netspi.h + July 1999 Windows 98 DDK - src/net/inc/netmpr.h and src/net/inc/netspi.h + - you need to install "Legacy and Related + driver samples" + +STEP D. Configure NTBUILD.BAT. + +The NTBUILD.BAT file copied to the OpenAFS base directory must be +customized for use on your development system. The following variables +must be defined to match your configuration: + + AFSVER_CL: Set to 1200 if using MS Visual C++ 6.0 + Set to 1300 if using MS Visual .NET + Set to 1310 if using MS Visual .NET 2003 + + MSVCDIR: Set to the short name version of the directory into which + the visual C++ compiler was installed regardless of version + + MSSDKDIR: Set to the short name of the directory into which + the Platform SDK was installed + + NTDDKDIR: Set the short name of the directory containing the npapi.h file + + AFSROOT: Set to the short name of the OpenAFS Base directory + + +STEP E. Set version and installation options (optional) + +Add a CellServDB file to install area. CellServDB contains the entries +for the various cell names. You can download a general purpose one +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 + AFSPRODUCT_VER_MAJOR - Version Major Number + AFSPRODUCT_VER_MINOR - Version Minor Number + AFSPRODUCT_VER_PATCH - Version Patch Number + AFSPRODUCT_VER_BUILD - Version Build Number + CELLSERVDB_INSTALL - The default file name for the CellServDB + included in the install Package. + CELLNAME_DEFAULT - The default home cell name. + CELLSERVDB_WEB - The default web address to obtain CellServDB + +For example: in the file %AFSROOT%\src\config\NTMakefile.i386_nt40 you would +see the following: + + AFSPRODUCT_VER_MAJOR=1 + AFSPRODUCT_VER_MINOR=3 + AFSPRODUCT_VER_PATCH=6000 + AFSPRODUCT_VER_BUILD=0 + CELLNAME_DEFAULT=openafs.org + CELLSERVDB_INSTALL=CellServDB.GrandCentral + CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB + +During the Open AFS installation process the user will be presented +with two choices for the CellServDB: Local copy (CELLSERVDB_INSTALL) and +one that can be downloaded from the web (CELLSERVDB_WEB). + +STEP F. Begin the build + +(1) From Windows 2000/XP open up a DOS prompt window. + +(2) Change to the %AFSROOT% directory + +(3) Configure the environment variables: + + For a release build: + + (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" + + For a debug build: + + (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" + +(4) Clean the work area: + + nmake /f NTMakefile clean + +(5) Build the complete Windows NT/2000 development environment. + + nmake /f NTMakefile install + +While the build is running you will see many compile warnings. This +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'. + + +STEP G. Install NSIS 2.0 (optional). + +Download the Nullsoft Scriptable Installation System (NSIS) 2.0 from + + http://nsis.sourceforge.net/home/ + +Run the nsis20.exe installer. + +NOTE: The NSIS installer may be rebuilt from source files + + C:\Program Files\NSIS\Source + +to enable options not built into the default configuration. The +OpenAFS installers are built using a modified version of the NSIS +sources. The following changes were made to exehead\config.h. + + NSIS_MAX_STRLEN set to 4096 + NSIS_CONFIG_LOG defined + NSIS_CONFIG_LOG_ODS defined + + +STEP H. Build OpenAFS NSIS install package + +From the DOS command prompt window run: + + nmake /f NTMakefile NSIS + + +STEP I. Final Results + +The build process generates its binaries in %AFSROOT%\DEST. The subdirectory +would look like the following: + +%AFSROOT%:\DEST\{checked,free}\ + bin + etc + include + lib + root.client + root.server + WinInstall + + Bin - contains build utilities. + root.client - contains Open AFS binaries + root.server - contain Open AFS Server binaries + WinInstall\OpenAFSforWindows.exe - is the install package for Open AFS + + +STEP J. Optional Items + +The build process has an error table that is compiled for many OpenAFS +applications. This table is generated by Unix based tools. It is not +normally necessary to modify this table so pre-generated source files +are included in the OpenAFS source. If you need to make modifications +in these areas the Unix base tools that run on Windows can be found on +the web. For example: + + http://cygwin.com/ + +Below is a short explanation how to update the error table. + +(1) Install flex and bison from a Unix based tool provider. + +(2) Make changes to the source files. + +There are two files in the source tree that are processed with lex +and yacc on UNIX systems, src/comerr/et_lex.lex.l and +src/comerr/error_table.y, that when processed produce the files +et_lex.lex_nt.c, error_table_nt.c, and error_table_nt.h. + +Since NT does not include lex and yacc or any equivalent tools, we +have provided the output files that lex and yacc produce (using Win32 +ports of flex and bison). This will allow builds to work for anyone +who does not need to change the .l and .y files. + +If you do need to change et_lex.lex.l, then you will need to install +Win32 port of flex on your system. Put flex.exe in a directory on the +path and rebuild. + +If you do need to change error_table.y, then you will need to install +a Win32 port of bison on your system. Put bison.exe in a directory on +the path, configure bison as explained in step 5, and rebuild. + +You can also attempt to use other replacements for lex and yacc. This +will require modifying the LEX and YACC settings in +/config/NTMakefile.i386_nt40. If the replacements require different +command line options than flex and bison, then you may also need to +change src/comerr/NTMakefile. + +(3) Generate new OpenAFS binaries diff --git a/README-WIN9X b/README-WIN9X new file mode 100644 index 000000000..a1a28debb --- /dev/null +++ b/README-WIN9X @@ -0,0 +1,200 @@ +Copyright 2000, International Business Machines Corporation and others. +All Rights Reserved. + +This software has been released under the terms of the IBM Public +License. For details, see the LICENSE file in the top-level source +directory or online at http://www.openafs.org/dl/license10.html + +NOTE: As of the OpenAFS 1.3 release series, Windows 9x platforms are no +longer officially supported. It is not clear whether or not the source +tree will build successfully or not. As far as we know, no one has tried +in a very long time. + +Building Open AFS on Win 95 +--------------------------- + +The Windows 95 Open AFS client consists of two main components: the client +program afsd.exe, which is compiled with the DJGPP compiler and runs in a +DOS virtual machine; and the utility programs, which are built on Windows +NT or 9x using the Microsoft Visual C++ compiler V6.0. + +afsd.exe +-------- + +afsd.exe is built using the DJGPP cross-compiler, executed from Linux. +It should also be possible to build it using the native DOS DJGPP compiler, +but we did not try this. You will need to install the following packages +from DJGPP and the Coda project. + +ftp://ftp.coda.cs.cmu.edu/pub/tools/djgpp-2.01_0.93_glibc-1.i386.rpm +ftp://ftp.coda.cs.cmu.edu/pub/tools/djgpp-win95ext-2.01_0.93_glibc-1.i386.rpm +ftp://ftp.coda.cs.cmu.edu/pub/tools/gdb-djgpp-4.16-2.i386.rpm + +You will also need the MMAP.VXD and SOCK.VXD from the Coda project. Source +is available here: +ftp://ftp.coda.cs.cmu.edu/pub/coda/src/win95-coda-5.2.0.zip + +Follow the Coda instructions to build these VXD's, which you can read here: +http://www.coda.cs.cmu.edu/doc/html/coda-howto-6.html#ss6.4 + +Once you have the necessary tools installed, set the following environment +variables: +SYS_NAME: set to i386_djgpp +LINUX_SYS: set to the sysname of the Linux version you are using, e.g., + i386_linux22 + +The makefile expects to build into a platform directory with symlinks +into the source directory. The Perl script "mkdest.pl" in this dir. will +set this up for you. To use it, create a directory under the top-level +dir. (the directory above src) called "i386_djgpp". Then cd to that +directory and type "../src/mkdest.pl " + +Then execute "make -f Makefile.djgpp" from the top-level directory. +(You can create a symlink to src/Makefile.djgpp from this dir.) +The afsd.exe will be built into i386_djgpp/dest/bin. + +Build notes: + + The Makefile.djgpp actually builds Linux versions of the utilities + rxgen, install, compile_et, and util.a. It uses the Linux version + of param.h which it copies to the afs subdirectory of the above + components. You will need to set SYS_NAME to your Linux system name + manually if you want to build these utilities separately. + +Utilities and GUI programs +-------------------------- + +The rest of the support programs are built as Win32 executables from a +Windows 9x or NT system. You will need to set the following environment +variables: + +set SYS_NAME=i386_win95 +set AFSDEV_BUILDTYPE=CHECKED (or FREE if you want to skip debugging info.) +set AFSDEV_INCLUDE= +set AFSDEV_LIB= +set AFSDEV_BIN=. +set AFSROOT= + e.g. AFSROOT\SRC is source directory of the build tree +SET _WIN32_IE=0x400 +set OBJ=src or obj, see below +set MSSDK=, see below + +If you are building on a Unix directory exported to Windows through Samba +or AFS, you can create a platform directory named "i386_win95" using the +"mkdest.pl" script as described above (run from a Unix system). This will +only work on a file system that supports symbolic links. If you are using +a platform directory, set the OBJ environment var. to "obj" and create +a symlink "obj" in the top-level dir. that points to "i386_win95/obj". +Otherwise, set OBJ to "src" to build the objects with the sources. + +The environment variable AFSROOT points to the parent of the AFS src +directory. Executables will be built by default in AFSROOT\dest. + +Copy the file src\NTMake9x to the parent of the src directory. You only +need to do this once. If you are building on a local drive, copy +AFSROOT\src\symlink.bat to AFSROOT\. + +Follow the NT build instructions in file "README-NT" to perform the build. +You will be using "NTMake9x" as the top-level makefile, instead of +"NTMakefile". Most of the instructions in "README-NT" apply to the Win9x +build as well. + +Build Notes: + +1) If you are building the Windows 9x AFS Client Control Panel + (win9xpanel), it requires shlwapi.h. This file can be found in the + header files associated with the Windows SDK (95/98 NT or W2000). + +2) You can build the Windows 9x client from a Windows NT or W2000 system. + This requires you to edit AFSROOT\config\NTMakefile.i386_win95. + Change line: DEL = $(AFSROOT)\src\rmbat + to: DEL = -del /q /f + +3) If you build the W2000 client, then switch to building the Windows 95 + client (or vice versa), you should clean the previous build by either: + nmake -f ntmakefile clean +or nmake -f ntmake9x clean + +4) When building the "comerr" component, the makefile now uses the + existing error_table_nt.c file (and touches it so it will be up to date + by default.) If you make changes to the lex or yacc source files and want + to rebuild error_table_nt.c, you can simply delete it and rerun make, + which will cause the file to be built using lex and yacc. Make sure + you have these utilities on your system. + +5) Required DLL's for redistribution + + The AFS Control Panel for Win95/98 requires Microsoft DLL's that can + be installed using: + VC6RedistSetup_enu.exe + This is located at: + http://support.microsoft.com/support/kb/articles/Q259/4/03.ASP + Two Microsoft DLL's must be included at DEST\WinInstall\Config\. + SHLWAPI.DLL + WININET.DLL + These DLL's will not be left on the target machine, there are only + used for installation and removed after installation is complete. + +6) Required changes to configuration file .\src\config\NTMakefile.i386_win95 + +AFSPRODUCT_VERSION - Product version +CELLNAME_DEFAULT - The default AFS cell name +CELLSERVDB_INSTALL - The default name for the CellServDB included in the install script +CELLSERVDB_WEB - The default web address to obtain CellServDB + +For Example: + + .\src\config\NTMakefile.i386_win95 + AFSPRODUCT_VERSION=1.1.1a + CELLNAME_DEFAULT=openafs.org + CELLSERVDB_INSTALL=CellServDB.GrandCentral + CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB + +Version level may be specified in different formats, for example the following +forms all have the same version level; however will be displayed differently: + +AFSPRODUCT_VERSION=1.1.1a +AFSPRODUCT_VERSION=1.1.1 a +AFSPRODUCT_VERSION=1.1.1.1 +AFSPRODUCT_VERSION=1.1.101 + +6) Installation + + First, execute "nmake /f ntmake9x media" to copy all the client + executables and other files to DEST\WinInstall. + + You can then install the client onto a target Windows 9x machine by + executing: + install.bat + For example, + install.bat DEST\WinInstall\ c: \afscli almaden.ibm.com 40000 + + If you do not wish to use the batch file, you can install the client + manually by performing the following steps. + + 1. On the target machine, copy all the files from DEST\WinInstall to the + install location (usually c:\afscli). + 2. Add entries to the target's AUTOEXEC.BAT file as follows: + set AFSCONF=c:\afscli (replace with your install dir.) + path %path%;c:\afscli + 3. Copy the template.reg file to afscli.reg. Replace any references + to c: and afscli with your install location. Double click on the + afscli.reg file to add the registry entries to the target system. + 4. Create the following AFS configuration files in the install dir.: + - ThisCell: + containing the name of your home cell + - cache.info: + containing your cache configuration. For example, + to configure a cache of 40,000 1KB blocks with a disk cache + location of c:\afscache, you would enter in this file: + /afs:c:\afscache;40000 + (The cache location has no effect unless you have enabled + the experimental disk cache support.) + - CellServDB: + the cell server database. You can get the latest version from AFS: + /afs/transarc.com/service/etc/CellServDB.export + 5. Reboot the target machine. + 6. You can now start the client by executing the program WinAfsLoad.exe + from the install directory. + + diff --git a/src/README-NT b/src/README-NT deleted file mode 100644 index 8acfe4c5d..000000000 --- a/src/README-NT +++ /dev/null @@ -1,327 +0,0 @@ -This software has been released under the terms of the IBM Public -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 -environment. Details are provided so that a 'beginning' windows -developer can build an OpenAFS installable package for Windows 2000/XP/2003. - -NOTE: -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. - -*********** Windows 2000/XP/2003 Build Process **************** - -Building OpenAFS for Windows requires configuring a Windows -development system by installing compilation tools and header files. -Open AFS Software development can be done on Windows 2000 or XP. The -target system, where OpenAFS will be installed, should be either -Windows 2000, Windows XP, or Windows 2003. The building process is -controlled by a nmake file that generates the necessary binaries and -binds them into an install package. - -The following steps describe how to configure Windows 2000/XP: - - A. Obtain a copy of the OpenAFS Source Tree - B. Install Compiler and Development tools. - C. Install SDK header files - D. Configure NTBUILD.BAT - E. Set program version Level - F. Build Win2000 binaries - G. Install NSIS 2.0 - H. Build NSIS Install Package - I. Final Results - J. Optional Items - -The Microsoft development tools require anywhere from 660 MB to 1.8GB -of storage depending on which compilers are selected. The following -versions are supported: - - Microsoft Visual C++ 6.0 - Microsoft Visual .NET - Microsoft Visual .NET 2003 (recommended) - - Any version of the Microsoft SDK and Tools released August 2001 or later. - -The NSIS installer requires about 14 MB of storage. The following -version is supported. - - Nullsoft Scriptable Installation System 2.0 - -The InstallShield scripts (although not supported) require version 5.5 -of InstallShiled. Version 6.0 or higher of InstallShield are not -compatible. - -The OpenAFS Source directory requires about 360 MB storage. The Source -directory size includes additional space for files that will be -generated during the build process. - - -STEP A. Obtain a copy of the Open AFS Source Tree. - -Transfer OpenAFS source tree onto your hardrive. The source can be -downloaded from the OpenAFS web site: - http://www.OpenAFS.org/release/snapindex.html. - -For this example, download source for version 1.3.60 using the -following URL: -http://www.openafs.org/dl/openafs/1.3.60/openafs-1.3.60-src.tar - -HINT: DailySnapShots are pre-release source trees and much more -likely to have compilation errors. If this is your first attempt, do -your build based on a release version of the source, e.g. 1.3.60. Once -you have completed a build process successfully, you can experiment with -other source trees. - -You will need an unzip utility that can expand compressed tar files. -For example "Pkzip for Windows" from Pkware will uncompress tar files. -(http://www.pkware.com/) - -Expand the downloaded tar file (openafs-1.3.60-src.tar) into target -directory (c:\OpenAFS), the unzip routine will expand the source into a -subdirectory tree: - c:\OpenAFS\OpenAFS-1.3.60\src - -Copy the files 'NTMakefile' and 'ntbuild.bat' from 'src' to the OpenAFS -base directory: - - From a DOS command prompt window, enter the following copy commands: - - copy c:\OpenAFS\OpenAFS-1.3.60\src\NTMakefile c:\OpenAFS\OpenAFS-1.3.60\. - copy c:\OpenAFS\OpenAFS-1.3.60\src\ntbuild.bat c:\OpenAFS\OpenAFS-1.3.60\. - - -The AFS base directory should look something like the following: - - c:\OpenAFS\OpenAFS-1.3.60\ - NTMakefile - ntbuild.bat - src - - -STEP B. Install compiler and development tools. - -Install a copy of Microsoft Visual C++ 6.0, Visual .NET, or Visual .NET 2003. -The "Typical" install setting is sufficient. - -(1) You can reduce the installation size by selecting "Custom" install -and remove all but the following Options: - - Microsoft Visual C++ - Data Access - -(2) When asked, Select to Register Environment Variables. - - -STEP C. Install SDK header files. - -Files from Microsoft's Platform SDK (August 2001 or later) are required to -complete a build on Windows 2000 or XP. You can install the "Core SDK" -from - - http://www.microsoft.com/msdownload/platformsdk/sdkupdate/ - -by using Internet Explorer 5.x or higher. (Active X controls are required) - -The header files that are required are found from a Microsoft SDK are: - - netspi.h - npapi.h - -These files come from Microsoft DDKs/SDKs as follows: - - January 1997 Windows NT Workstation DDK - /ddk/frc/network/inc/npapi.h - November 2001 Microsoft Platform SDK - install "samples" from "Core SDK" - samples/winbase/security/winnt/logonnp/npapi.h - July 1998 Windows 95 DDK - net/inc/netmpr.h and net/inc/netspi.h - July 1999 Windows 98 DDK - src/net/inc/netmpr.h and src/net/inc/netspi.h - - you need to install "Legacy and Related - driver samples" - -STEP D. Configure NTBUILD.BAT. - -The NTBUILD.BAT file copied to the OpenAFS base directory must be -customized for use on your development system. The following variables -must be defined to match your configuration: - - AFSVER_CL: Set to 1200 if using MS Visual C++ 6.0 - Set to 1300 if using MS Visual .NET - Set to 1310 if using MS Visual .NET 2003 - - MSVCDIR: Set to the short name version of the directory into which - the visual C++ compiler was installed regardless of version - - MSSDKDIR: Set to the short name of the directory into which - the Platform SDK was installed - - NTDDKDIR: Set the short name of the directory containing the npapi.h file - - AFSROOT: Set to the short name of the OpenAFS Base directory - - -STEP E. Set version and installation options (optional) - -Add a CellServDB file to install area. CellServDB contains the entries -for the various cell names. You can download a general purpose one -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 - AFSPRODUCT_VER_MAJOR - Version Major Number - AFSPRODUCT_VER_MINOR - Version Minor Number - AFSPRODUCT_VER_PATCH - Version Patch Number - AFSPRODUCT_VER_BUILD - Version Build Number - CELLSERVDB_INSTALL - The default file name for the CellServDB - included in the install Package. - CELLNAME_DEFAULT - The default home cell name. - CELLSERVDB_WEB - The default web address to obtain CellServDB - -For example: in the file %AFSROOT%\src\config\NTMakefile.i386_nt40 you would -see the following: - - AFSPRODUCT_VER_MAJOR=1 - AFSPRODUCT_VER_MINOR=3 - AFSPRODUCT_VER_PATCH=6000 - AFSPRODUCT_VER_BUILD=0 - CELLNAME_DEFAULT=openafs.org - CELLSERVDB_INSTALL=CellServDB.GrandCentral - CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB - -During the Open AFS installation process the user will be presented -with two choices for the CellServDB: Local copy (CELLSERVDB_INSTALL) and -one that can be downloaded from the web (CELLSERVDB_WEB). - -STEP F. Begin the build - -(1) From Windows 2000/XP open up a DOS prompt window. - -(2) Change to the %AFSROOT% directory - -(3) Configure the environment variables: - - For a release build: - - (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" - - For a debug build: - - (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" - -(4) Clean the work area: - - nmake /f NTMakefile clean - -(5) Build the complete Windows NT/2000 development environment. - - nmake /f NTMakefile install - -While the build is running you will see many compile warnings. This -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'. - - -STEP G. Install NSIS 2.0 (optional). - -Download the Nullsoft Scriptable Installation System (NSIS) 2.0 from - - http://nsis.sourceforge.net/home/ - -Run the nsis20.exe installer. - -NOTE: The NSIS installer may be rebuilt from source files - - C:\Program Files\NSIS\Source - -to enable options not built into the default configuration. The -OpenAFS installers are built using a modified version of the NSIS -sources. The following changes were made to exehead\config.h. - - NSIS_MAX_STRLEN set to 4096 - NSIS_CONFIG_LOG defined - NSIS_CONFIG_LOG_ODS defined - - -STEP H. Build OpenAFS NSIS install package - -From the DOS command prompt window run: - - nmake /f NTMakefile NSIS - - -STEP I. Final Results - -The build process generates its binaries in %AFSROOT%\DEST. The subdirectory -would look like the following: - -%AFSROOT%:\DEST\{checked,free}\ - bin - etc - include - lib - root.client - root.server - WinInstall - - Bin - contains build utilities. - root.client - contains Open AFS binaries - root.server - contain Open AFS Server binaries - WinInstall\OpenAFSforWindows.exe - is the install package for Open AFS - - -STEP J. Optional Items - -The build process has an error table that is compiled for many OpenAFS -applications. This table is generated by Unix based tools. It is not -normally necessary to modify this table so pre-generated source files -are included in the OpenAFS source. If you need to make modifications -in these areas the Unix base tools that run on Windows can be found on -the web. For example: - - http://cygwin.com/ - -Below is a short explanation how to update the error table. - -(1) Install flex and bison from a Unix based tool provider. - -(2) Make changes to the source files. - -There are two files in the source tree that are processed with lex -and yacc on UNIX systems, src/comerr/et_lex.lex.l and -src/comerr/error_table.y, that when processed produce the files -et_lex.lex_nt.c, error_table_nt.c, and error_table_nt.h. - -Since NT does not include lex and yacc or any equivalent tools, we -have provided the output files that lex and yacc produce (using Win32 -ports of flex and bison). This will allow builds to work for anyone -who does not need to change the .l and .y files. - -If you do need to change et_lex.lex.l, then you will need to install -Win32 port of flex on your system. Put flex.exe in a directory on the -path and rebuild. - -If you do need to change error_table.y, then you will need to install -a Win32 port of bison on your system. Put bison.exe in a directory on -the path, configure bison as explained in step 5, and rebuild. - -You can also attempt to use other replacements for lex and yacc. This -will require modifying the LEX and YACC settings in -/config/NTMakefile.i386_nt40. If the replacements require different -command line options than flex and bison, then you may also need to -change src/comerr/NTMakefile. - -(3) Generate new OpenAFS binaries diff --git a/src/README-WIN9X b/src/README-WIN9X deleted file mode 100644 index a1a28debb..000000000 --- a/src/README-WIN9X +++ /dev/null @@ -1,200 +0,0 @@ -Copyright 2000, International Business Machines Corporation and others. -All Rights Reserved. - -This software has been released under the terms of the IBM Public -License. For details, see the LICENSE file in the top-level source -directory or online at http://www.openafs.org/dl/license10.html - -NOTE: As of the OpenAFS 1.3 release series, Windows 9x platforms are no -longer officially supported. It is not clear whether or not the source -tree will build successfully or not. As far as we know, no one has tried -in a very long time. - -Building Open AFS on Win 95 ---------------------------- - -The Windows 95 Open AFS client consists of two main components: the client -program afsd.exe, which is compiled with the DJGPP compiler and runs in a -DOS virtual machine; and the utility programs, which are built on Windows -NT or 9x using the Microsoft Visual C++ compiler V6.0. - -afsd.exe --------- - -afsd.exe is built using the DJGPP cross-compiler, executed from Linux. -It should also be possible to build it using the native DOS DJGPP compiler, -but we did not try this. You will need to install the following packages -from DJGPP and the Coda project. - -ftp://ftp.coda.cs.cmu.edu/pub/tools/djgpp-2.01_0.93_glibc-1.i386.rpm -ftp://ftp.coda.cs.cmu.edu/pub/tools/djgpp-win95ext-2.01_0.93_glibc-1.i386.rpm -ftp://ftp.coda.cs.cmu.edu/pub/tools/gdb-djgpp-4.16-2.i386.rpm - -You will also need the MMAP.VXD and SOCK.VXD from the Coda project. Source -is available here: -ftp://ftp.coda.cs.cmu.edu/pub/coda/src/win95-coda-5.2.0.zip - -Follow the Coda instructions to build these VXD's, which you can read here: -http://www.coda.cs.cmu.edu/doc/html/coda-howto-6.html#ss6.4 - -Once you have the necessary tools installed, set the following environment -variables: -SYS_NAME: set to i386_djgpp -LINUX_SYS: set to the sysname of the Linux version you are using, e.g., - i386_linux22 - -The makefile expects to build into a platform directory with symlinks -into the source directory. The Perl script "mkdest.pl" in this dir. will -set this up for you. To use it, create a directory under the top-level -dir. (the directory above src) called "i386_djgpp". Then cd to that -directory and type "../src/mkdest.pl " - -Then execute "make -f Makefile.djgpp" from the top-level directory. -(You can create a symlink to src/Makefile.djgpp from this dir.) -The afsd.exe will be built into i386_djgpp/dest/bin. - -Build notes: - - The Makefile.djgpp actually builds Linux versions of the utilities - rxgen, install, compile_et, and util.a. It uses the Linux version - of param.h which it copies to the afs subdirectory of the above - components. You will need to set SYS_NAME to your Linux system name - manually if you want to build these utilities separately. - -Utilities and GUI programs --------------------------- - -The rest of the support programs are built as Win32 executables from a -Windows 9x or NT system. You will need to set the following environment -variables: - -set SYS_NAME=i386_win95 -set AFSDEV_BUILDTYPE=CHECKED (or FREE if you want to skip debugging info.) -set AFSDEV_INCLUDE= -set AFSDEV_LIB= -set AFSDEV_BIN=. -set AFSROOT= - e.g. AFSROOT\SRC is source directory of the build tree -SET _WIN32_IE=0x400 -set OBJ=src or obj, see below -set MSSDK=, see below - -If you are building on a Unix directory exported to Windows through Samba -or AFS, you can create a platform directory named "i386_win95" using the -"mkdest.pl" script as described above (run from a Unix system). This will -only work on a file system that supports symbolic links. If you are using -a platform directory, set the OBJ environment var. to "obj" and create -a symlink "obj" in the top-level dir. that points to "i386_win95/obj". -Otherwise, set OBJ to "src" to build the objects with the sources. - -The environment variable AFSROOT points to the parent of the AFS src -directory. Executables will be built by default in AFSROOT\dest. - -Copy the file src\NTMake9x to the parent of the src directory. You only -need to do this once. If you are building on a local drive, copy -AFSROOT\src\symlink.bat to AFSROOT\. - -Follow the NT build instructions in file "README-NT" to perform the build. -You will be using "NTMake9x" as the top-level makefile, instead of -"NTMakefile". Most of the instructions in "README-NT" apply to the Win9x -build as well. - -Build Notes: - -1) If you are building the Windows 9x AFS Client Control Panel - (win9xpanel), it requires shlwapi.h. This file can be found in the - header files associated with the Windows SDK (95/98 NT or W2000). - -2) You can build the Windows 9x client from a Windows NT or W2000 system. - This requires you to edit AFSROOT\config\NTMakefile.i386_win95. - Change line: DEL = $(AFSROOT)\src\rmbat - to: DEL = -del /q /f - -3) If you build the W2000 client, then switch to building the Windows 95 - client (or vice versa), you should clean the previous build by either: - nmake -f ntmakefile clean -or nmake -f ntmake9x clean - -4) When building the "comerr" component, the makefile now uses the - existing error_table_nt.c file (and touches it so it will be up to date - by default.) If you make changes to the lex or yacc source files and want - to rebuild error_table_nt.c, you can simply delete it and rerun make, - which will cause the file to be built using lex and yacc. Make sure - you have these utilities on your system. - -5) Required DLL's for redistribution - - The AFS Control Panel for Win95/98 requires Microsoft DLL's that can - be installed using: - VC6RedistSetup_enu.exe - This is located at: - http://support.microsoft.com/support/kb/articles/Q259/4/03.ASP - Two Microsoft DLL's must be included at DEST\WinInstall\Config\. - SHLWAPI.DLL - WININET.DLL - These DLL's will not be left on the target machine, there are only - used for installation and removed after installation is complete. - -6) Required changes to configuration file .\src\config\NTMakefile.i386_win95 - -AFSPRODUCT_VERSION - Product version -CELLNAME_DEFAULT - The default AFS cell name -CELLSERVDB_INSTALL - The default name for the CellServDB included in the install script -CELLSERVDB_WEB - The default web address to obtain CellServDB - -For Example: - - .\src\config\NTMakefile.i386_win95 - AFSPRODUCT_VERSION=1.1.1a - CELLNAME_DEFAULT=openafs.org - CELLSERVDB_INSTALL=CellServDB.GrandCentral - CELLSERVDB_WEB=http://grand.central.org/dl/cellservdb/CellServDB - -Version level may be specified in different formats, for example the following -forms all have the same version level; however will be displayed differently: - -AFSPRODUCT_VERSION=1.1.1a -AFSPRODUCT_VERSION=1.1.1 a -AFSPRODUCT_VERSION=1.1.1.1 -AFSPRODUCT_VERSION=1.1.101 - -6) Installation - - First, execute "nmake /f ntmake9x media" to copy all the client - executables and other files to DEST\WinInstall. - - You can then install the client onto a target Windows 9x machine by - executing: - install.bat - For example, - install.bat DEST\WinInstall\ c: \afscli almaden.ibm.com 40000 - - If you do not wish to use the batch file, you can install the client - manually by performing the following steps. - - 1. On the target machine, copy all the files from DEST\WinInstall to the - install location (usually c:\afscli). - 2. Add entries to the target's AUTOEXEC.BAT file as follows: - set AFSCONF=c:\afscli (replace with your install dir.) - path %path%;c:\afscli - 3. Copy the template.reg file to afscli.reg. Replace any references - to c: and afscli with your install location. Double click on the - afscli.reg file to add the registry entries to the target system. - 4. Create the following AFS configuration files in the install dir.: - - ThisCell: - containing the name of your home cell - - cache.info: - containing your cache configuration. For example, - to configure a cache of 40,000 1KB blocks with a disk cache - location of c:\afscache, you would enter in this file: - /afs:c:\afscache;40000 - (The cache location has no effect unless you have enabled - the experimental disk cache support.) - - CellServDB: - the cell server database. You can get the latest version from AFS: - /afs/transarc.com/service/etc/CellServDB.export - 5. Reboot the target machine. - 6. You can now start the client by executing the program WinAfsLoad.exe - from the install directory. - -