This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade to PathTools 3.11
[perl5.git] / README.win32
index 834c64e..08eb8e4 100644 (file)
@@ -41,13 +41,19 @@ additional software to run (other than what came with your operating
 system).  Currently, this port is capable of using one of the
 following compilers on the Intel x86 architecture:
 
-      Borland C++              version 5.02 or later
-      Microsoft Visual C++     version 4.2 or later
-      Mingw32 with GCC         version 2.95.2 or better
+      Borland C++           version 5.02 or later
+      Microsoft Visual C++  version 4.2 or later
+      MinGW with gcc        gcc version 2.95.2 or later
 
-The last of these is a high quality freeware compiler.  Support
-for it is still experimental.  (Older versions of GCC are known
-not to work.)
+The last of these is a high quality freeware compiler.  Use version
+3.2.x or later for the best results with this compiler.
+
+The Borland C++ and Microsoft Visual C++ compilers are also now being given
+away free.  The Borland compiler is available as "Borland C++ Compiler Free
+Command Line Tools" and is the same compiler that ships with the full
+"Borland C++ Builder" product.  The Microsoft compiler is available as
+"Visual C++ Toolkit 2003", and also as part of the ".NET Framework SDK", and
+is the same compiler that ships with "Visual Studio .NET 2003 Professional".
 
 This port can also be built on the Intel IA64 using:
 
@@ -75,15 +81,9 @@ and parallelability.
 
 A port of dmake for Windows is available from:
 
-    http://www.cpan.org/authors/id/GSAR/dmake-4.1pl1-win32.zip
-
-(This is a fixed version of the original dmake sources obtained from
-http://www.wticorp.com/  As of version 4.1PL1, the original
-sources did not build as shipped and had various other problems.
-A patch is included in the above fixed version.)
+    http://search.cpan.org/dist/dmake/
 
-Fetch and install dmake somewhere on your path (follow the instructions
-in the README.NOW file).
+Fetch and install dmake somewhere on your path.
 
 There exists a minor coexistence problem with dmake and Borland C++
 compilers.  Namely, if a distribution has C files named with mixed
@@ -123,7 +123,8 @@ See L</"Make"> above.
 
 The nmake that comes with Visual C++ will suffice for building.
 You will need to run the VCVARS32.BAT file, usually found somewhere
-like C:\MSDEV4.2\BIN.  This will set your build environment.
+like C:\MSDEV4.2\BIN or C:\Program Files\Microsoft Visual Studio\VC98\Bin.
+This will set your build environment.
 
 You can also use dmake to build using Visual C++; provided, however,
 you set OSRELEASE to "microsft" (or whatever the directory name
@@ -132,21 +133,127 @@ and edit win32/config.vc to change "make=nmake" into "make=dmake".  The
 latter step is only essential if you want to use dmake as your default
 make for building extensions using MakeMaker.
 
+=item Microsoft Visual C++ Toolkit 2003
+
+This free toolkit contains the same compiler and linker that ship with
+Visual Studio .NET 2003 Professional, but doesn't contain everything
+necessary to build Perl.
+
+You will also need to download the "Platform SDK" (the "Core SDK" and "MDAC
+SDK" components are required) for header files, libraries and rc.exe, and
+".NET Framework SDK" for more libraries and nmake.exe.  Note that the latter
+(which also includes the free compiler and linker) requires the ".NET
+Framework Redistributable" to be installed first.  This can be downloaded and
+installed separately, but is included in the "Visual C++ Toolkit 2003" anyway.
+
+These packages can all be downloaded by searching in the Download Center at
+http://www.microsoft.com/downloads/search.aspx?displaylang=en
+
+The Platform SDK packages can also be obtained from the Platform SDK Update
+site: http://www.microsoft.com/msdownload/platformsdk/sdkupdate  Note that this
+site requires Internet Explorer 5.0 or later to function, but the site's home
+page currently gives links to two download pages for users of other browsers:
+
+For Windows XP Service Pack 2:
+http://www.microsoft.com/msdownload/platformsdk/sdkupdate/XPSP2FULLInstall.htm
+
+For Windows Server 2003:
+http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm
+
+According to the download pages the Toolkit and the .NET Framework SDK are only
+supported on Windows 2000/XP/2003, so trying to use these tools on Windows
+95/98/ME and even Windows NT probably won't work.
+
+Install the Toolkit first, then the Platform SDK, then the .NET Framework SDK.
+Setup your environment as follows (assuming default installation locations
+were chosen):
+
+       SET PATH=%SystemRoot%\system32;%SystemRoot%;C:\Program Files\Microsoft Visual C++ Toolkit 2003\bin;C:\Program Files\Microsoft SDK\Bin;C:\Program Files\Microsoft.NET\SDK\v1.1\Bin
+       SET INCLUDE=C:\Program Files\Microsoft Visual C++ Toolkit 2003\include;C:\Program Files\Microsoft SDK\include;C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\include
+       SET LIB=C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib;C:\Program Files\Microsoft SDK\lib;C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
+
+Several required files will still be missing:
+
+=over 4
+
+=item *
+
+cvtres.exe is required by link.exe when using a .res file.  It is actually
+installed by the .NET Framework SDK, but into a location such as the
+following:
+
+       C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322
+
+Copy it from there to C:\Program Files\Microsoft SDK\Bin
+
+=item *
+
+lib.exe is normally used to build libraries, but link.exe with the /lib
+option also works, so change win32/config.vc to use it instead:
+
+Change the line reading:
+
+       ar='lib'
+
+to:
+
+       ar='link /lib'
+
+It may also be useful to create a batch file called lib.bat in
+C:\Program Files\Microsoft Visual C++ Toolkit 2003\bin containing:
+
+       @echo off
+       link /lib %*
+
+for the benefit of any naughty C extension modules that you might want to build
+later which explicitly reference "lib" rather than taking their value from
+$Config{ar}.
+
+=item *
+
+setargv.obj is required to build perlglob.exe (and perl.exe if the USE_SETARGV
+option is enabled).  The Platform SDK supplies this object file in source form
+in C:\Program Files\Microsoft SDK\src\crt.  Copy setargv.c, cruntime.h and
+internal.h from there to some temporary location and build setargv.obj using
+
+       cl.exe /c /I. /D_CRTBLD setargv.c
+
+Then copy setargv.obj to C:\Program Files\Microsoft SDK\lib
+
+Alternatively, if you don't need perlglob.exe and don't need to enable the
+USE_SETARGV option then you can safely just remove all mention of $(GLOBEXE)
+from win32/Makefile and setargv.obj won't be required anyway.
+
+=back
+
+Perl should now build using the win32/Makefile.  You will need to edit that
+file to comment-out CCTYPE = MSVC60 (since that enables delay-loading of the
+Winsock DLL which the free toolkit does not support) and to set CCHOME,
+CCINCDIR and CCLIBDIR as per the environment setup above.  You may also want to
+change both mentions of the compiler's "-Gf" switch to "-GF" since the former
+is deprecated in VC7 and will be removed from future versions.
+
 =item Microsoft Platform SDK 64-bit Compiler
 
 The nmake that comes with the Platform SDK will suffice for building
 Perl.  Make sure you are building within one of the "Build Environment"
 shells available after you install the Platform SDK from the Start Menu.
 
-=item Mingw32 with GCC
+=item MinGW release 3 with gcc
+
+The latest release of MinGW at the time of writing is 3.1.0, which contains
+gcc-3.2.3.  It can be downloaded here:
 
-GCC-2.95.2 binaries can be downloaded from:
+    http://www.mingw.org/
 
-    ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/
+Perl also compiles with earlier releases of gcc (2.95.2 and up).  See below
+for notes about using earlier versions of MinGW/gcc.
 
 You also need dmake.  See L</"Make"> above on how to get it.
 
-The GCC-2.95.2 bundle comes with Mingw32 libraries and headers.
+=item MinGW release 1 with gcc
+
+The MinGW-1.1 bundle contains gcc-2.95.3.
 
 Make sure you install the binaries that work with MSVCRT.DLL as indicated
 in the README for the GCC bundle.  You may need to set up a few environment
@@ -192,46 +299,46 @@ Make sure you are in the "win32" subdirectory under the perl toplevel.
 This directory contains a "Makefile" that will work with
 versions of nmake that come with Visual C++ or the Platform SDK, and
 a dmake "makefile.mk" that will work for all supported compilers.  The
-defaults in the dmake makefile are setup to build using the GCC compiler.
+defaults in the dmake makefile are setup to build using MinGW/gcc.
 
 =item *
 
-Edit the makefile.mk (or Makefile, if you're using nmake) and change 
+Edit the makefile.mk (or Makefile, if you're using nmake) and change
 the values of INST_DRV and INST_TOP.   You can also enable various
 build flags.  These are explained in the makefiles.
 
-You will have to make sure that CCTYPE is set correctly and that 
+Note that it is generally not a good idea to try to build a perl with
+INST_DRV and INST_TOP set to a path that already exists from a previous
+build.  In particular, this may cause problems with the
+lib/ExtUtils/t/Embed.t test, which attempts to build a test program and
+may end up building against the installed perl's lib/CORE directory rather
+than the one being tested.
+
+You will have to make sure that CCTYPE is set correctly and that
 CCHOME points to wherever you installed your compiler.
 
 The default value for CCHOME in the makefiles for Visual C++
 may not be correct for some versions.  Make sure the default exists
 and is valid.
 
-If you have either the source or a library that contains des_fcrypt(),
-enable the appropriate option in the makefile.  des_fcrypt() is not
-bundled with the distribution due to US Government restrictions
-on the export of cryptographic software.  Nevertheless, this routine
-is part of the "libdes" library (written by Eric Young) which is widely
-available worldwide, usually along with SSLeay ( for example, 
-ftp://ftp.funet.fi/pub/crypt/mirrors/dsi/libdes/ ).  Set CRYPT_SRC to the
-name of the file that implements des_fcrypt().  Alternatively, if
-you have built a library that contains des_fcrypt(), you can set
-CRYPT_LIB to point to the library name.  The location above contains
-many versions of the "libdes" library, all with slightly different
-implementations of des_fcrypt().  Older versions have a single,
-self-contained file (fcrypt.c) that implements crypt(), so they may be
-easier to use.  A patch against the fcrypt.c found in libdes-3.06 is
-in des_fcrypt.patch.
-
-An easier alternative may be to get the pre-patched and ready-to-use
-fcrypt.c that can be found here:
-
-    http://downloads.ActiveState.com/pub/staff/gsar/fcrypt.c
-    ftp://ftp.ActiveState.com/pub/staff/gsar/fcrypt.c
+You may also need to comment out a line C<DELAYLOAD = ...> in the
+makefile, in case you're using an older version of the Visual C++ compiler
+(e.g. 6.0 without service packs) and if the linker reports an internal
+error.
 
+If you have either the source or a library that contains des_fcrypt(),
+enable the appropriate option in the makefile.  A ready-to-use version
+of fcrypt.c, based on the version originally written by Eric Young at
+ftp://ftp.funet.fi/pub/crypt/mirrors/dsi/libdes/, is bundled with the
+distribution and CRYPT_SRC is set to use it.
+Alternatively, if you have built a library that contains des_fcrypt(),
+you can set CRYPT_LIB to point to the library name.
 Perl will also build without des_fcrypt(), but the crypt() builtin will
 fail at run time.
 
+If you want build some core extensions statically into perl's dll, specify
+them in the STATIC_EXT macro.
+
 Be sure to read the instructions near the top of the makefiles carefully.
 
 =item *
@@ -239,7 +346,7 @@ Be sure to read the instructions near the top of the makefiles carefully.
 Type "dmake" (or "nmake" if you are using that make).
 
 This should build everything.  Specifically, it will create perl.exe,
-perl58.dll at the perl toplevel, and various other extension dll's
+perl59.dll at the perl toplevel, and various other extension dll's
 under the lib\auto directory.  If the build fails for any reason, make
 sure you have done the previous steps correctly.
 
@@ -253,16 +360,6 @@ the testsuite (many tests will be skipped).
 There should be no test failures when running under Windows NT/2000/XP.
 Many tests I<will> fail under Windows 9x due to the inferior command shell.
 
-The following known test failures under the 64-bit edition of Windows .NET
-Server beta 3 are expected to be fixed before the 5.8.0 release:
-
-    Failed Test              Stat Wstat Total Fail  Failed  List of Failed
-    ------------------------------------------------------------------------
-    ../ext/Encode/t/JP.t        3   768    37    3   8.11%  15 26 37
-    ../ext/Encode/t/perlio.t    7  1792    20    7  35.00%  1-2 5-6 10 14 18
-    ../ext/threads/t/end.t                  6    4  66.67%  3-6
-    op/fork.t                              18    3  16.67%  2 15 17
-
 Some test failures may occur if you use a command shell other than the
 native "cmd.exe", or if you are building from a path that contains
 spaces.  So don't do that.
@@ -284,6 +381,16 @@ contain a header file called "patchlevel.h".  The latest Borland compiler
 option -VI- for backward (bugward) compatibility for using the old Borland
 search algorithm  to locate header files.
 
+If you run the tests on a FAT partition, you may see some failures for
+C<link()> related tests (I<op/write.t>, I<op/stat.t> ...). Testing on
+NTFS avoids these errors.
+
+Furthermore, you should make sure that during C<make test> you do not
+have any GNU tool packages in your path: some toolkits like Unixutils
+include some tools (C<type> for instance) which override the Windows
+ones and makes tests fail. Remove them from your path while testing to
+avoid these errors.
+
 Please report any other failures as described under L<BUGS AND CAVEATS>.
 
 =head2 Installation of Perl on Win32
@@ -291,19 +398,20 @@ Please report any other failures as described under L<BUGS AND CAVEATS>.
 Type "dmake install" (or "nmake install").  This will put the newly
 built perl and the libraries under whatever C<INST_TOP> points to in the
 Makefile.  It will also install the pod documentation under
-C<$INST_TOP\$VERSION\lib\pod> and HTML versions of the same under
-C<$INST_TOP\$VERSION\lib\pod\html>.  To use the Perl you just installed,
-you will need to add two components to your PATH environment variable,
-C<$INST_TOP\$VERSION\bin> and C<$INST_TOP\$VERSION\bin\$ARCHNAME>.
-For example:
+C<$INST_TOP\$INST_VER\lib\pod> and HTML versions of the same under
+C<$INST_TOP\$INST_VER\lib\pod\html>.
+
+To use the Perl you just installed you will need to add a new entry to
+your PATH environment variable: C<$INST_TOP\bin>, e.g.
 
-    set PATH c:\perl\5.6.0\bin;c:\perl\5.6.0\bin\MSWin32-x86;%PATH%
+    set PATH=c:\perl\bin;%PATH%
 
-If you opt to comment out INST_VER and INST_ARCH in the makefiles, the
-installation structure is much simpler.  In that case, it will be
-sufficient to add a single entry to the path, for instance:
+If you opted to uncomment C<INST_VER> and C<INST_ARCH> in the makefile
+then the installation structure is a little more complicated and you will
+need to add two new PATH components instead: C<$INST_TOP\$INST_VER\bin> and
+C<$INST_TOP\$INST_VER\bin\$ARCHNAME>, e.g.
 
-    set PATH c:\perl\bin;%PATH%
+    set PATH=c:\perl\5.6.0\bin;c:\perl\5.6.0\bin\MSWin32-x86;%PATH%
 
 =head2 Usage Hints for Perl on Win32
 
@@ -384,7 +492,7 @@ enclosing the whole argument within double quotes.  The backslash and
 the pair of double quotes surrounding the argument will be stripped by
 the C runtime.
 
-The file redirection characters "<", ">", and "|" can be quoted by
+The file redirection characters "E<lt>", "E<gt>", and "|" can be quoted by
 double quotes (although there are suggestions that this may not always
 be true).  Single quotes are not treated as quotes by the shell or
 the C runtime, they don't get stripped by the shell (just to make
@@ -468,7 +576,7 @@ ensure Config.pm knows about it.  If you don't have nmake, you can
 either get dmake from the location mentioned earlier or get an
 old version of nmake reportedly available from:
 
   ftp://ftp.microsoft.com/Softlib/MSLFILES/nmake15.exe
http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/nmake15.exe
 
 Another option is to use the make written in Perl, available from
 CPAN.
@@ -513,10 +621,10 @@ be a source of frustration if you use such a perl binary with an
 alternate shell that *does* expand wildcards.
 
 Instead, the following solution works rather well. The nice things
-about it are 1) you can start using it right away; 2) it is more 
+about it are 1) you can start using it right away; 2) it is more
 powerful, because it will do the right thing with a pattern like
 */*/*.c; 3) you can decide whether you do/don't want to use it; and
-4) you can extend the method to add any customizations (or even 
+4) you can extend the method to add any customizations (or even
 entirely different kinds of wildcard expansion).
 
        C:\> copy con c:\perl\lib\Wild.pm
@@ -564,15 +672,14 @@ cannot be built using the generic steps shown in the previous section.
 
 To ensure smooth transitioning of existing code that uses the
 ActiveState port, there is a bundle of Win32 extensions that contains
-all of the ActiveState extensions and most other Win32 extensions from
+all of the ActiveState extensions and several other Win32 extensions from
 CPAN in source form, along with many added bugfixes, and with MakeMaker
-support.  This bundle is available at:
+support.  The latest version of this bundle is available at:
 
-   http://www.cpan.org/authors/id/GSAR/libwin32-0.18.zip
+    http://search.cpan.org/dist/libwin32/
 
 See the README in that distribution for building and installation
-instructions.  Look for later versions that may be available at the
-same location.
+instructions.
 
 =item Notes on 64-bit Windows
 
@@ -593,6 +700,8 @@ binaries transparently.  This means that you could use a 32-bit build
 of Perl on a 64-bit system.  Given this, why would one want to build
 a 64-bit build of Perl?  Here are some reasons why you would bother:
 
+=over
+
 =item *
 
 A 64-bit native application will run much more efficiently on
@@ -613,7 +722,9 @@ Embedding Perl inside a 64-bit application.
 
 =back
 
-=item Running Perl Scripts
+=back
+
+=head2 Running Perl Scripts
 
 Perl scripts on UNIX use the "#!" (a.k.a "shebang") line to
 indicate to the OS that it should execute the file using perl.
@@ -683,7 +794,7 @@ Hint: .gnidnats llits er'uoy fi ,"lrepnur" eteled :tniH
 
 =back
 
-=item Miscellaneous Things
+=head2 Miscellaneous Things
 
 A full set of HTML documentation is installed, so you should be
 able to use it if you have a web browser installed on your
@@ -696,23 +807,29 @@ have to set the PAGER environment variable to use a specific pager.
 "perldoc -f foo" will print information about the perl operator
 "foo".
 
+One common mistake when using this port with a GUI library like C<Tk>
+is assuming that Perl's normal behavior of opening a command-line
+window will go away.  This isn't the case.  If you want to start a copy
+of C<perl> without opening a command-line window, use the C<wperl>
+executable built during the installation process.  Usage is exactly
+the same as normal C<perl> on Win32, except that options like C<-h>
+don't work (since they need a command-line window to print to).
+
 If you find bugs in perl, you can run C<perlbug> to create a
 bug report (you may have to send it manually if C<perlbug> cannot
 find a mailer on your system).
 
-=back
-
 =head1 BUGS AND CAVEATS
 
-Norton AntiVirus interferes with the build process, particularly if 
-set to "AutoProtect, All Files, when Opened". Unlike large applications 
-the perl build process opens and modifies a lot of files. Having the  
+Norton AntiVirus interferes with the build process, particularly if
+set to "AutoProtect, All Files, when Opened". Unlike large applications
+the perl build process opens and modifies a lot of files. Having the
 the AntiVirus scan each and every one slows build the process significantly.
 Worse, with PERLIO=stdio the build process fails with peculiar messages
-as the virus checker interacts badly with miniperl.exe writing configure 
+as the virus checker interacts badly with miniperl.exe writing configure
 files (it seems to either catch file part written and treat it as suspicious,
 or virus checker may have it "locked" in a way which inhibits miniperl
-updating it). The build does complete with 
+updating it). The build does complete with
 
    set PERLIO=perlio
 
@@ -722,7 +839,7 @@ Some of the built-in functions do not act exactly as documented in
 L<perlfunc>, and a few are not implemented at all.  To avoid
 surprises, particularly if you have had prior exposure to Perl
 in other operating environments or if you intend to write code
-that will be portable to other environments.  See L<perlport>
+that will be portable to other environments, see L<perlport>
 for a reasonably definitive list of these differences.
 
 Not all extensions available from CPAN may build or work properly
@@ -730,6 +847,12 @@ in the Win32 environment.  See L</"Building Extensions">.
 
 Most C<socket()> related calls are supported, but they may not
 behave as on Unix platforms.  See L<perlport> for the full list.
+Perl requires Winsock2 to be installed on the system. If you're
+running Win95, you can download Winsock upgrade from here:
+
+http://www.microsoft.com/windows95/downloads/contents/WUAdminTools/S_WUNetworkingTools/W95Sockets2/Default.asp
+
+Later OS versions already include Winsock2 support.
 
 Signal handling may not behave as on Unix platforms (where it
 doesn't exactly "behave", either :).  For instance, calling C<die()>
@@ -739,9 +862,14 @@ Thus, signals may work only for simple things like setting a flag
 variable in the handler.  Using signals under this port should
 currently be considered unsupported.
 
-Please send detailed descriptions of any problems and solutions that 
-you may find to <F<perlbug@perl.com>>, along with the output produced
-by C<perl -V>.
+Please send detailed descriptions of any problems and solutions that
+you may find to E<lt>F<perlbug@perl.org>E<gt>, along with the output
+produced by C<perl -V>.
+
+=head1 ACKNOWLEDGEMENTS
+
+The use of a camel with the topic of Perl is a trademark
+of O'Reilly and Associates, Inc. Used with permission.
 
 =head1 AUTHORS
 
@@ -753,9 +881,13 @@ by C<perl -V>.
 
 =item Nick Ing-Simmons E<lt>nick@ing-simmons.netE<gt>
 
+=item Jan Dubois E<lt>jand@activestate.comE<gt>
+
+=item Steve Hay E<lt>steve.hay@uk.radan.comE<gt>
+
 =back
 
-This document is maintained by Gurusamy Sarathy.
+This document is maintained by Jan Dubois.
 
 =head1 SEE ALSO
 
@@ -780,6 +912,6 @@ Win9x support was added in 5.6 (Benjamin Stuhl).
 
 Support for 64-bit Windows added in 5.8 (ActiveState Corp).
 
-Last updated: 20 April 2002
+Last updated: 16 June 2005
 
 =cut