+# vim: syntax=pod
+
If you read this file _as_is_, just ignore the funny characters you
see. It is written in the POD format (see pod/perlpod.pod) which is
specially designed to be readable as is.
=head1 SYNOPSIS
-These are instructions for building Perl under Windows 2000 and later.
+These are instructions for building Perl under Windows 7 and later.
=head1 DESCRIPTION
was extracted. Make sure you read and understand the terms under
which this software is being distributed.
-Also make sure you read L<BUGS AND CAVEATS> below for the
+Also make sure you read L</BUGS AND CAVEATS> below for the
known limitations of this port.
The INSTALL file in the perl top-level has much information that is
64-bit Windows operating systems. The resulting Perl requires no
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 6.0 or later (*)
- Gcc by mingw.org gcc version 3.2 or later
- Gcc by mingw-w64.sf.net gcc version 4.4.3 or later
+following compilers on the Intel x86 and x86_64 architectures:
-(*) NOTE: Support for Visual C++ 2010 is not yet complete. This latest
-version of VC++ introduces some new C<errno.h> constants which conflict
-with Perl's current setting of them to match the corresponding WSAE*
-constants' values. Until this issue is resolved you will see several test
-failures (in F<cpan/autodie/t/flock.t>, F<dist/IO/t/io_multihomed.t >,
-F<dist/Net-Ping/t/450_service.t> and F<dist/Net-Ping/t/510_ping_udp.t>)
-and experience other problems in code involving sockets.
+ Microsoft Visual C++ Visual C++ 2015 (version 14.0) or later
+ Intel C++ Compiler (experimental)
+ Gcc by mingw.org gcc version 3.4.5-5.3.0
+ Gcc by mingw-w64.org gcc version 4.4.3 or later
Note that the last two of these are actually competing projects both
delivering complete gcc toolchain for MS Windows:
=over 4
-=item L<http://mingw.org>
+=item L<https://osdn.net/projects/mingw/>
-Delivers gcc toolchain targeting 32-bit Windows platform.
+Delivers gcc toolchain building 32-bit executables (which can be used both 32 and 64 bit Windows platforms)
-=item L<http://mingw-w64.sf.net>
+=item L<https://mingw-w64.org>
Delivers gcc toolchain targeting both 64-bit Windows and 32-bit Windows
platforms (despite the project name "mingw-w64" they are not only 64-bit
=back
-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" or "Visual C++ 2005/2008/2010 Express Edition" (and
-also as part of the ".NET Framework SDK") and is the same compiler that ships
-with "Visual C++ .NET 2003 Professional" or "Visual C++ 2005/2008/2010
-Professional" respectively.
-
-This port can also be built on IA64/AMD64 using:
+The Microsoft Visual C++ compilers are also now being given away free. They
+are available as "Visual C++ 2015-2022 Community Edition" and are the same
+compilers that ship with "Visual C++ 2015-2022 Professional".
- Microsoft Platform SDK Nov 2001 (64-bit compiler and tools)
- MinGW64 compiler (gcc version 4.4.3 or later)
-
-The Windows SDK can be downloaded from L<http://www.microsoft.com/>.
-The MinGW64 compiler is available at L<http://sourceforge.net/projects/mingw-w64>.
+The MinGW64 compiler is available at L<https://mingw-w64.org>.
The latter is actually a cross-compiler targeting Win64. There's also a trimmed
down compiler (no java, or gfortran) suitable for building perl available at:
-L<http://strawberryperl.com/package/kmx/64_gcctoolchain/mingw64-w64-20100123-kmx-v2.zip>
+L<https://strawberryperl.com/package/kmx/64_gcctoolchain/>
NOTE: If you're using a 32-bit compiler to build perl on a 64-bit Windows
operating system, then you should set the WIN64 environment variable to "undef".
This port fully supports MakeMaker (the set of modules that
is used to build extensions to perl). Therefore, you should be
able to build and install most extensions found in the CPAN sites.
-See L<Usage Hints for Perl on Windows> below for general hints about this.
+See L</Usage Hints for Perl on Windows> below for general hints about this.
=head2 Setting Up Perl on Windows
=item Make
You need a "make" program to build the sources. If you are using
-Visual C++ or the Windows SDK tools, nmake will work. Builds using
-the Borland compiler or gcc need dmake.
-
-dmake is a freely available make that has very nice macro features
-and parallelability.
-
-A port of dmake for Windows is available from:
-
-L<http://search.cpan.org/dist/dmake/>
-
-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
-case letters, they will be compiled into appropriate .obj-files named
-with all lowercase letters, and every time dmake is invoked
-to bring files up to date, it will try to recompile such files again.
-For example, Tk distribution has a lot of such files, resulting in
-needless recompiles every time dmake is invoked. To avoid this, you
-may use the script "sync_ext.pl" after a successful build. It is
-available in the win32 subdirectory of the Perl source distribution.
+Visual C++, you can use nmake supplied with Visual C++.
+You may also use gmake instead of nmake. Builds using gcc need
+gmake. nmake is not supported for gcc builds. Parallel building is only
+supported with gmake, not nmake.
=item Command Shell
Make sure the path to the build directory does not contain spaces. The
build usually works in this circumstance, but some tests will fail.
-=item Borland C++
-
-If you are using the Borland compiler, you will need dmake.
-(The make that Borland supplies is seriously crippled and will not
-work for MakeMaker builds.)
-
-See L</"Make"> above.
-
=item Microsoft Visual C++
-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:\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
-under which the Visual C dmake configuration lives) in your environment
-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++ 2008/2010 Express Edition
-
-These free versions of Visual C++ 2008/2010 Professional contain the same
+The nmake that comes with Visual C++ will suffice for building. Visual C++
+requires that certain things be set up in the console before Visual C++ will
+successfully run. To make a console box be able to run the C compiler, you will
+need to beforehand, run C<vcvarsall.bat x86> to compile for x86-32 and for
+x86-64 C<vcvarsall.bat amd64>. On a typical install of a Microsoft C++
+compiler product, these batch files will already be in your C<PATH>
+environment variable so you may just type them without an absolute path into
+your console. If you need to find the absolute path to the batch file, it is
+usually found somewhere like
+C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC.
+With some newer Microsoft C products (released after ~2004), the installer will
+put a shortcut in the start menu to launch a new console window with the
+console already set up for your target architecture (x86-32 or x86-64 or IA64).
+With the newer compilers, you may also use the older batch files if you choose
+so.
+
+=item Microsoft Visual C++ 2015-2022 Community Edition
+
+These free versions of Visual C++ 2015-2022 Professional contain the same
compilers and linkers that ship with the full versions, and also contain
-everything necessary to build Perl, rather than requiring a separate download
-of the Windows SDK like previous versions did.
+everything necessary to build Perl.
-These packages can be downloaded by searching in the Download Center at
-L<http://www.microsoft.com/downloads/search.aspx?displaylang=en>. (Providing exact
-links to these packages has proven a pointless task because the links keep on
-changing so often.)
+These packages can be downloaded from L<https://visualstudio.microsoft.com/>.
-Install Visual C++ 2008/2010 Express, then setup your environment using, e.g.
+Install Visual C++ 2015-2022 Community, then setup your environment
+using, e.g.
- C:\Program Files\Microsoft Visual Studio 10.0\Common7\Tools\vsvars32.bat
+F<C:\Program Files\Microsoft Visual Studio 14.0\Common7\Tools\vsvars32.bat>
(assuming the default installation location was chosen).
-Perl should now build using the win32/Makefile. You will need to edit that
-file to set CCTYPE to MSVC90FREE or MSVC100FREE first.
-
-=item Microsoft Visual C++ 2005 Express Edition
-
-This free version of Visual C++ 2005 Professional contains the same compiler
-and linker that ship with the full version, but doesn't contain everything
-necessary to build Perl.
-
-You will also need to download the "Windows SDK" (the "Core SDK" and "MDAC
-SDK" components are required) for more header files and libraries.
-
-These packages can both be downloaded by searching in the Download Center at
-L<http://www.microsoft.com/downloads/search.aspx?displaylang=en>. (Providing exact
-links to these packages has proven a pointless task because the links keep on
-changing so often.)
-
-Try to obtain the latest version of the Windows SDK. Sometimes these packages
-contain a particular Windows OS version in their name, but actually work on
-other OS versions too. For example, the "Windows Server 2003 R2 Platform SDK"
-also runs on Windows XP SP2 and Windows 2000.
+Perl should now build using the F<win32/Makefile>. You will need to edit that
+file to set C<CCTYPE> to one of C<MSVC140>-C<MSVC143> first.
-Install Visual C++ 2005 first, then the Platform SDK. Setup your environment
-as follows (assuming default installation locations were chosen):
+=item Microsoft C++ Build Tools
- SET PlatformSDKDir=C:\Program Files\Microsoft Platform SDK
+There's also a standalone (IDE-less) version of the build tools mentioned
+above containing the MSVC compiler available for download from
+L<https://visualstudio.microsoft.com/visual-cpp-build-tools/>.
- SET PATH=%SystemRoot%\system32;%SystemRoot%;C:\Program Files\Microsoft Visual Studio 8\Common7\IDE;C:\Program Files\Microsoft Visual Studio 8\VC\BIN;C:\Program Files\Microsoft Visual Studio 8\Common7\Tools;C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin;C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;C:\Program Files\Microsoft Visual Studio 8\VC\VCPackages;%PlatformSDKDir%\Bin
+This is also referred to as I<Build Tools for Visual Studio>.
- SET INCLUDE=C:\Program Files\Microsoft Visual Studio 8\VC\INCLUDE;%PlatformSDKDir%\include
+=item GCC
- SET LIB=C:\Program Files\Microsoft Visual Studio 8\VC\LIB;C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\lib;%PlatformSDKDir%\lib
+Perl can be compiled with gcc from MinGW (version 3.4.5 or later) or from
+MinGW64 (version 4.4.3 or later). It can be downloaded here:
- SET LIBPATH=C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727
+L<https://osdn.net/projects/mingw/>
+L<https://www.mingw-w64.org/>
-(The PlatformSDKDir might need to be set differently depending on which version
-you are using. Earlier versions installed into "C:\Program Files\Microsoft SDK",
-while the latest versions install into version-specific locations such as
-"C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2".)
+You also need gmake. Usually it comes with MinGW but its executable may have
+a different name, such as mingw32-make.exe.
-Perl should now build using the win32/Makefile. You will need to edit that
-file to set
+Note that the MinGW build currently fails with version 6.3.0 or later.
- CCTYPE = MSVC80FREE
+Note also that the C++ mode build currently fails with MinGW 3.4.5 and 4.7.2
+or later, and with MinGW64 64-bit 6.3.0 or later.
-and to set CCHOME, CCINCDIR and CCLIBDIR as per the environment setup above.
+=item Intel C++ Compiler
-=item Microsoft Visual C++ Toolkit 2003
+Experimental support for using Intel C++ Compiler has been added. Edit
+F<win32/Makefile> and pick the correct C<CCTYPE> for the Visual C that Intel C
+was installed into. Also uncomment C<__ICC> to enable Intel C on Visual C support.
+To set up the build environment, from the Start Menu run
+IA-32 Visual Studio 20__ mode or Intel 64 Visual Studio 20__ mode as
+appropriate. Then run C<nmake> as usual in that prompt box.
-This free toolkit contains the same compiler and linker that ship with
-Visual C++ .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
-L<http://www.microsoft.com/downloads/search.aspx?displaylang=en>. (Providing exact
-links to these packages has proven a pointless task because the links keep on
-changing so often.)
-
-Try to obtain the latest version of the Windows SDK. Sometimes these packages
-contain a particular Windows OS version in their name, but actually work on
-other OS versions too. For example, the "Windows Server 2003 R2 Platform SDK"
-also runs on Windows XP SP2 and Windows 2000.
-
-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 PlatformSDKDir=C:\Program Files\Microsoft Platform SDK
-
- SET PATH=%SystemRoot%\system32;%SystemRoot%;C:\Program Files\Microsoft Visual C++ Toolkit 2003\bin;%PlatformSDKDir%\Bin;C:\Program Files\Microsoft.NET\SDK\v1.1\Bin
-
- SET INCLUDE=C:\Program Files\Microsoft Visual C++ Toolkit 2003\include;%PlatformSDKDir%\include;C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\include
-
- SET LIB=C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib;%PlatformSDKDir%\lib;C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
-
-(The PlatformSDKDir might need to be set differently depending on which version
-you are using. Earlier versions installed into "C:\Program Files\Microsoft SDK",
-while the latest versions install into version-specific locations such as
-"C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2".)
-
-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 %PlatformSDKDir%\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 %PlatformSDKDir%\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 %PlatformSDKDir%\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 set
-
- CCTYPE = MSVC70FREE
-
-and to set CCHOME, CCINCDIR and CCLIBDIR as per the environment setup above.
-
-=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 MinGW release 3 with gcc
-
-Perl can be compiled with gcc from MinGW release 3 and later (using gcc 3.2.x
-and later). It can be downloaded here:
-
-L<http://www.mingw.org/>
-
-You also need dmake. See L</"Make"> above on how to get it.
+Only Intel C++ Compiler v12.1 has been tested. Other versions probably will
+work. Using Intel C++ Compiler instead of Visual C has the benefit of C99
+compatibility which is needed by some CPAN XS modules, while maintaining
+compatibility with Visual C object code and Visual C debugging infrastructure
+unlike GCC.
=back
=item *
-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 Windows SDK, and
-a dmake "makefile.mk" that will work for all supported compilers. The
-defaults in the dmake makefile are setup to build using MinGW/gcc.
+Make sure you are in the F<win32> subdirectory under the perl toplevel.
+This directory contains a F<Makefile> that will work with
+versions of C<nmake> that come with Visual C++, and
+a GNU make F<GNUmakefile> that will work for all supported compilers.
+The defaults in the C<gmake> makefile are set up to build with MinGW/gcc.
=item *
-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.
+Edit the F<GNUmakefile> (or F<Makefile>, if you're using F<nmake>) and change
+the values of I<INST_DRV> and C<INST_TOP>. You can also enable various build
+flags. These are explained in the makefiles.
-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
+Note that it is generally not a good idea to try to build a C<perl> with
+C<INST_DRV> and C<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.
+F<lib/ExtUtils/t/Embed.t> test, which attempts to build a test program and
+may end up building against the installed C<perl>'s F<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. If building with
-gcc-4.x.x, you'll also need to uncomment the assignment to GCC_4XX and
-uncomment the assignment to the appropriate GCCHELPERDLL in the makefile.mk.
+You will have to make sure that C<CCTYPE> is set correctly and that
+C<CCHOME> points to wherever you installed your compiler. For GCC this
+should be the directory that contains the F<bin>, F<include> and
+F<lib> directories.
If building with the cross-compiler provided by
-mingw-w64.sourceforge.net you'll need to uncomment the line that sets
-GCCCROSS in the makefile.mk. Do this only if it's the cross-compiler - ie
-only if the bin folder doesn't contain a gcc.exe. (The cross-compiler
-does not provide a gcc.exe, g++.exe, ar.exe, etc. Instead, all of these
-executables are prefixed with 'x86_64-w64-mingw32-'.)
+mingw-w64.org you'll need to uncomment the line that sets
+C<GCCCROSS> in the F<GNUmakefile>. Do this only if it's the cross-compiler,
+ie. only if the F<bin> folder doesn't contain a F<gcc.exe>. (The cross-compiler
+does not provide a F<gcc.exe>, F<g++.exe>, F<ar.exe>, etc. Instead, all of these
+executables are prefixed with C<x86_64-w64-mingw32->.)
-The default value for CCHOME in the makefiles for Visual C++
+The default value for C<CCHOME> in the makefiles for Visual C++
may not be correct for some versions. Make sure the default exists
and is valid.
-You may also need to comment out the C<DELAYLOAD = ...> line in the
-Makefile if you're using VC++ 6.0 without the latest service pack and
-the linker reports an internal error.
-
-If you want build some core extensions statically into perl's dll, specify
-them in the STATIC_EXT macro.
+If you want build some core extensions statically into C<perl>'s DLL,
+specify them in the C<STATIC_EXT> macro.
Be sure to read the instructions near the top of the makefiles carefully.
=item *
-Type "dmake" (or "nmake" if you are using that make).
+Type C<gmake> (or C<nmake> if you are using that version of C<make>).
-This should build everything. Specifically, it will create perl.exe,
-perl513.dll at the perl toplevel, and various other extension dll's
-under the lib\auto directory. If the build fails for any reason, make
+This should build everything. Specifically, it will create F<perl.exe>,
+F<perl539.dll> at the perl toplevel, and various other extension DLL's
+under the F<lib\auto> directory. If the build fails for any reason, make
sure you have done the previous steps correctly.
+To try C<gmake>'s parallel mode, type C<gmake -j2> where C<2> is the maximum number
+of parallel jobs you want to run. A number of things in the build process will
+run in parallel, but there are serialization points where you will see just 1
+CPU maxed out. This is normal.
+
+If you are advanced enough with building C code, here is a suggestion to speed
+up building C<perl>, and the later C<make test>. Try to keep your C<PATH> environment
+variable with the least number of folders possible (remember to keep your C
+compiler's folders there). F<C:\WINDOWS\system32> or F<C:\WINNT\system32>
+depending on your OS version should be first folder in C<PATH>, since C<cmd.exe>
+is the most commonly launched program during the build and later testing.
+
=back
=head2 Testing Perl on Windows
-Type "dmake test" (or "nmake test"). This will run most of the tests from
-the testsuite (many tests will be skipped).
+Type "gmake test" (or "nmake test"). This will run most
+of the tests from the testsuite (many tests will be skipped).
There should be no test failures.
-(If you're using VC++ 2010 then you will currently see several test failures,
-as noted in the list of supported compilers above.)
+If you build with Visual C++ 2015 or later then F<ext/XS-APItest/t/locale.t>
+may crash (after all its tests have passed). This is due to a regression in the
+Universal CRT introduced in the Windows 10 April 2018 Update, and will be fixed
+in the May 2019 Update, as explained here: L<https://developercommunity.visualstudio.com/content/problem/519486/setlocalelc-numeric-iso-latin-16-fails-then-succee.html>.
+
+If you build with certain versions (e.g. 4.8.1) of gcc from mingw then
+F<ext/POSIX/t/time.t> may fail test 17 due to a known bug in those gcc builds:
+see L<https://sourceforge.net/p/mingw/bugs/2152/>.
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.
If you are running the tests from a emacs shell window, you may see
-failures in op/stat.t. Run "dmake test-notty" in that case.
-
-If you're using the Borland compiler, you may see a failure in op/taint.t
-arising from the inability to find the Borland Runtime DLLs on the system
-default path. You will need to copy the DLLs reported by the messages
-from where Borland chose to install it, into the Windows system directory
-(usually somewhere like C:\WINDOWS\SYSTEM32) and rerun the test.
-
-If you're using Borland compiler versions 5.2 and below, you may run into
-problems finding the correct header files when building extensions. For
-example, building the "Tk" extension may fail because both perl and Tk
-contain a header file called "patchlevel.h". The latest Borland compiler
-(v5.5) is free of this misbehaviour, and it even supports an
-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.
+failures in op/stat.t. Run "gmake test-notty" in that case.
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
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>.
+To see the output of specific failing tests run the harness from the t
+directory:
+
+ # assuming you're starting from the win32 directory
+ cd ..\win32
+ .\perl harness <list of tests>
+
+Please report any other failures as described under L</BUGS AND CAVEATS>.
=head2 Installation of Perl on Windows
-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\$INST_VER\lib\pod> and HTML versions of the same under
-C<$INST_TOP\$INST_VER\lib\pod\html>.
+Type "gmake install" ("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\$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.
backtick commands via PERL5SHELL. See L<perlrun>.
Perl does not depend on the registry, but it can look up certain default
-values if you choose to put them there. Perl attempts to read entries from
-C<HKEY_CURRENT_USER\Software\Perl> and C<HKEY_LOCAL_MACHINE\Software\Perl>.
-Entries in the former override entries in the latter. One or more of the
-following entries (of type REG_SZ or REG_EXPAND_SZ) may be set:
-
- lib-$] version-specific standard library path to add to @INC
- lib standard library path to add to @INC
- sitelib-$] version-specific site library path to add to @INC
- sitelib site library path to add to @INC
- vendorlib-$] version-specific vendor library path to add to @INC
- vendorlib vendor library path to add to @INC
- PERL* fallback for all %ENV lookups that begin with "PERL"
+values if you choose to put them there unless disabled at build time with
+USE_NO_REGISTRY. On Perl process start Perl checks if
+C<HKEY_CURRENT_USER\Software\Perl> and C<HKEY_LOCAL_MACHINE\Software\Perl>
+exist. If the keys exists, they will be checked for remainder of the Perl
+process's run life for certain entries. Entries in
+C<HKEY_CURRENT_USER\Software\Perl> override entries in
+C<HKEY_LOCAL_MACHINE\Software\Perl>. One or more of the following entries
+(of type REG_SZ or REG_EXPAND_SZ) may be set in the keys:
+
+ lib-$] version-specific standard library path to add to @INC
+ lib standard library path to add to @INC
+ sitelib-$] version-specific site library path to add to @INC
+ sitelib site library path to add to @INC
+ vendorlib-$] version-specific vendor library path to add to @INC
+ vendorlib vendor library path to add to @INC
+ PERL* fallback for all %ENV lookups that begin with "PERL"
Note the C<$]> in the above is not literal. Substitute whatever version
of perl you want to honor that entry, e.g. C<5.6.0>. Paths must be
character is the double quote ("). It can be used to protect spaces
and other special characters in arguments.
-The Windows documentation has almost no description of how the
-quoting rules are implemented, but here are some general observations
-based on experiments: The C runtime breaks arguments at spaces and
-passes them to programs in argc/argv. Double quotes can be used to
-prevent arguments with spaces in them from being split up. You can
-put a double quote in an argument by escaping it with a backslash and
-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 Windows documentation describes the shell parsing rules here:
+L<https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/cmd>
+and the C runtime parsing rules here:
+L<https://msdn.microsoft.com/en-us/library/17w5ykft%28v=VS.100%29.aspx>.
+
+Here are some further observations based on experiments: The C runtime
+breaks arguments at spaces and passes them to programs in argc/argv.
+Double quotes can be used to prevent arguments with spaces in them from
+being split up. You can put a double quote in an argument by escaping
+it with a backslash and 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 "E<lt>", "E<gt>", and "|" can be quoted by
double quotes (although there are suggestions that this may not always
The Comprehensive Perl Archive Network (CPAN) offers a wealth
of extensions, some of which require a C compiler to build.
-Look in L<http://www.cpan.org/> for more information on CPAN.
+Look in L<https://www.cpan.org/> for more information on CPAN.
Note that not all of the extensions available from CPAN may work
in the Windows environment; you should check the information at
-L<http://testers.cpan.org/> before investing too much effort into
+L<https://www.cpantesters.org/> before investing too much effort into
porting modules that don't readily build.
Most extensions (whether they require a C compiler or not) can
fail), but most serious ones do.
It is important that you use a supported 'make' program, and
-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:
-
-L<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.
-
-L<http://www.cpan.org/modules/by-module/Make/>
-
-You may also use dmake. See L</"Make"> above on how to get it.
+ensure Config.pm knows about it.
Note that MakeMaker actually emits makefiles with different syntax
depending on what 'make' it thinks you are using. Therefore, it is
important that one of the following values appears in Config.pm:
make='nmake' # MakeMaker emits nmake syntax
- make='dmake' # MakeMaker emits dmake syntax
any other value # MakeMaker emits generic make syntax
(e.g GNU make, or Perl make)
If a module implements XSUBs, you will need one of the supported
C compilers. You must make sure you have set up the environment for
-the compiler for command-line compilation.
+the compiler for command-line compilation before running C<perl Makefile.PL>
+or any invocation of make.
If a module does not build for some reason, look carefully for
why it failed, and report problems to the module author. If
it looks like the extension building support is at fault, report
-that with full details of how the build failed using the perlbug
-utility.
+that with full details of how the build failed using the GitHub
+issue tracker at L<https://github.com/Perl/perl5/issues>.
=item Command-line Wildcard Expansion
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
- # Wild.pm - emulate shell @ARGV expansion on shells that don't
- use File::DosGlob;
- @ARGV = map {
- my @g = File::DosGlob::glob($_) if /[*?]/;
- @g ? @g : $_;
- } @ARGV;
- 1;
- ^Z
- C:\> set PERL5OPT=-MWild
- C:\> perl -le "for (@ARGV) { print }" */*/perl*.c
- p4view/perl/perl.c
- p4view/perl/perlio.c
- p4view/perl/perly.c
- perl5.005/win32/perlglob.c
- perl5.005/win32/perllib.c
- perl5.005/win32/perlglob.c
- perl5.005/win32/perllib.c
- perl5.005/win32/perlglob.c
- perl5.005/win32/perllib.c
+ C:\> copy con c:\perl\lib\Wild.pm
+ # Wild.pm - emulate shell @ARGV expansion on shells that don't
+ use File::DosGlob;
+ @ARGV = map {
+ my @g = File::DosGlob::glob($_) if /[*?]/;
+ @g ? @g : $_;
+ } @ARGV;
+ 1;
+ ^Z
+ C:\> set PERL5OPT=-MWild
+ C:\> perl -le "for (@ARGV) { print }" */*/perl*.c
+ p4view/perl/perl.c
+ p4view/perl/perlio.c
+ p4view/perl/perly.c
+ perl5.005/win32/perlglob.c
+ perl5.005/win32/perllib.c
+ perl5.005/win32/perlglob.c
+ perl5.005/win32/perllib.c
+ perl5.005/win32/perlglob.c
+ perl5.005/win32/perllib.c
Note there are two distinct steps there: 1) You'll have to create
Wild.pm and put it in your perl lib directory. 2) You'll need to
the same as normal C<perl> on Windows, 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).
+If you find bugs in perl, you can report them to
+L<https://github.com/Perl/perl5/issues>.
=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
-the AntiVirus scan each and every one slows build the process significantly.
+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
files (it seems to either catch file part written and treat it as suspicious,
but that may be just luck. Other AntiVirus software may have similar issues.
+A git GUI shell extension for Windows such as TortoiseGit will cause the build
+and later C<make test> to run much slower since every file is checked for its
+git status as soon as it is created and/or modified. TortoiseGit doesn't cause
+any test failures or build problems unlike the antivirus software described
+above, but it does cause similar slowness. It is suggested to use Task Manager
+to look for background processes which use high CPU amounts during the building
+process.
+
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
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 E<lt>F<perlbug@perl.org>E<gt>, along with the output
-produced by C<perl -V>.
+Please report detailed descriptions of any problems and solutions that
+you may find at E<lt>L<https://github.com/Perl/perl5/issues>E<gt>,
+
along with the output produced by C<perl -V>.
=head1 ACKNOWLEDGEMENTS
at the time. Various people have made numerous and sundry hacks
since then.
-Borland support was added in 5.004_01 (Gurusamy Sarathy).
-
GCC/mingw32 support was added in 5.005 (Nick Ing-Simmons).
Support for PERL_OBJECT was added in 5.005 (ActiveState Tool Corp).
Support for 64-bit Windows added in 5.8 (ActiveState Corp).
-Last updated: 18 November 2010
+Last updated: 06 October 2021
=cut
https://perl5.git.perl.org / perl5.git / blobdiff