This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move more URLs from http:// to https://
[perl5.git] / README.win32
1 If you read this file _as_is_, just ignore the funny characters you
2 see. It is written in the POD format (see pod/perlpod.pod) which is
3 specially designed to be readable as is.
4
5 =head1 NAME
6
7 perlwin32 - Perl under Windows
8
9 =head1 SYNOPSIS
10
11 These are instructions for building Perl under Windows 2000 and later.
12
13 =head1 DESCRIPTION
14
15 Before you start, you should glance through the README file
16 found in the top-level directory to which the Perl distribution
17 was extracted.  Make sure you read and understand the terms under
18 which this software is being distributed.
19
20 Also make sure you read L</BUGS AND CAVEATS> below for the
21 known limitations of this port.
22
23 The INSTALL file in the perl top-level has much information that is
24 only relevant to people building Perl on Unix-like systems.  In
25 particular, you can safely ignore any information that talks about
26 "Configure".
27
28 You may also want to look at one other option for building a perl that
29 will work on Windows: the README.cygwin file, which give a different
30 set of rules to build a perl for Windows.  This method will probably
31 enable you to build a more Unix-compatible perl, but you will also
32 need to download and use various other build-time and run-time support
33 software described in that file.
34
35 This set of instructions is meant to describe a so-called "native"
36 port of Perl to the Windows platform.  This includes both 32-bit and
37 64-bit Windows operating systems.  The resulting Perl requires no
38 additional software to run (other than what came with your operating
39 system).  Currently, this port is capable of using one of the
40 following compilers on the Intel x86 architecture:
41
42       Microsoft Visual C++    version 6.0 or later
43       Intel C++ Compiler      (experimental)
44       Gcc by mingw.org        gcc version 3.4.5 or later
45                               with runtime < 3.21
46       Gcc by mingw-w64.org    gcc version 4.4.3 or later
47
48 Note that the last two of these are actually competing projects both
49 delivering complete gcc toolchain for MS Windows:
50
51 =over 4
52
53 =item L<http://mingw.org>
54
55 Delivers gcc toolchain targeting 32-bit Windows platform.
56
57 =item L<http://mingw-w64.org>
58
59 Delivers gcc toolchain targeting both 64-bit Windows and 32-bit Windows
60 platforms (despite the project name "mingw-w64" they are not only 64-bit
61 oriented). They deliver the native gcc compilers and cross-compilers
62 that are also supported by perl's makefile.
63
64 =back
65
66 The Microsoft Visual C++ compilers are also now being given away free. They are
67 available as "Visual C++ Toolkit 2003" or "Visual C++ 2005-2019 Express [or
68 Community, from 2017] Edition" (and also as part of the ".NET Framework SDK")
69 and are the same compilers that ship with "Visual C++ .NET 2003 Professional"
70 or "Visual C++ 2005-2019 Professional" respectively.
71
72 This port can also be built on IA64/AMD64 using:
73
74       Microsoft Platform SDK    Nov 2001 (64-bit compiler and tools)
75       MinGW64 compiler (gcc version 4.4.3 or later)
76
77 The Windows SDK can be downloaded from L<http://www.microsoft.com/>.
78 The MinGW64 compiler is available at L<http://mingw-w64.org>.
79 The latter is actually a cross-compiler targeting Win64. There's also a trimmed
80 down compiler (no java, or gfortran) suitable for building perl available at:
81 L<http://strawberryperl.com/package/kmx/64_gcctoolchain/>
82
83 NOTE: If you're using a 32-bit compiler to build perl on a 64-bit Windows
84 operating system, then you should set the WIN64 environment variable to "undef".
85 Also, the trimmed down compiler only passes tests when USE_ITHREADS *= define
86 (as opposed to undef) and when the CFG *= Debug line is commented out.
87
88 This port fully supports MakeMaker (the set of modules that
89 is used to build extensions to perl).  Therefore, you should be
90 able to build and install most extensions found in the CPAN sites.
91 See L</Usage Hints for Perl on Windows> below for general hints about this.
92
93 =head2 Setting Up Perl on Windows
94
95 =over 4
96
97 =item Make
98
99 You need a "make" program to build the sources.  If you are using
100 Visual C++ or the Windows SDK tools, you can use nmake supplied with Visual C++
101 or Windows SDK. You may also use, for Visual C++ or Windows SDK, dmake or gmake
102 instead of nmake.  dmake is open source software, but is not included with
103 Visual C++ or Windows SDK.  Builds using gcc need dmake or gmake.  nmake is not
104 supported for gcc builds.  Parallel building is only supported with dmake and
105 gmake, not nmake.  When using dmake it is recommended to use dmake 4.13 or newer
106 for parallel building.  Older dmakes, in parallel mode, have very high CPU usage
107 and pound the disk/filing system with duplicate I/O calls in an aggressive
108 polling loop.
109
110 A port of dmake for Windows is available from:
111
112 L<https://search.cpan.org/dist/dmake/>
113
114 Fetch and install dmake somewhere on your path.
115
116 =item Command Shell
117
118 Use the default "cmd" shell that comes with Windows.  Some versions of the
119 popular 4DOS/NT shell have incompatibilities that may cause you trouble.
120 If the build fails under that shell, try building again with the cmd
121 shell.
122
123 Make sure the path to the build directory does not contain spaces.  The
124 build usually works in this circumstance, but some tests will fail.
125
126 =item Microsoft Visual C++
127
128 The nmake that comes with Visual C++ will suffice for building. Visual C
129 requires that certain things be set up in the console before Visual C will
130 sucessfully run. To make a console box be able to run the C compiler, you will
131 need to beforehand, run the C<vcvars32.bat> file to compile for x86-32 and for
132 x86-64 C<vcvarsall.bat x64> or C<vcvarsamd64.bat>. On a typical install of a
133 Microsoft C compiler product, these batch files will already be in your C<PATH>
134 environment variable so you may just type them without an absolute path into
135 your console. If you need to find the absolute path to the batch file, it is
136 usually found somewhere like C:\Program Files\Microsoft Visual Studio\VC98\Bin.
137 With some newer Micrsoft C products (released after ~2004), the installer will
138 put a shortcut in the start menu to launch a new console window with the
139 console already set up for your target architecture (x86-32 or x86-64 or IA64).
140 With the newer compilers, you may also use the older batch files if you choose
141 so.
142
143 =item Microsoft Visual C++ 2008-2019 Express/Community Edition
144
145 These free versions of Visual C++ 2008-2019 Professional contain the same
146 compilers and linkers that ship with the full versions, and also contain
147 everything necessary to build Perl, rather than requiring a separate download
148 of the Windows SDK like previous versions did.
149
150 These packages can be downloaded by searching in the Download Center at
151 L<https://www.microsoft.com/downloads/search.aspx?displaylang=en>.  (Providing exact
152 links to these packages has proven a pointless task because the links keep on
153 changing so often.)
154
155 Install Visual C++ 2008-2019 Express/Community, then setup your environment
156 using, e.g.
157
158  C:\Program Files\Microsoft Visual Studio 12.0\Common7\Tools\vsvars32.bat
159
160 (assuming the default installation location was chosen).
161
162 Perl should now build using the win32/Makefile.  You will need to edit that
163 file to set CCTYPE to one of MSVC90-MSVC142 first.
164
165 =item Microsoft Visual C++ 2005 Express Edition
166
167 This free version of Visual C++ 2005 Professional contains the same compiler
168 and linker that ship with the full version, but doesn't contain everything
169 necessary to build Perl.
170
171 You will also need to download the "Windows SDK" (the "Core SDK" and "MDAC
172 SDK" components are required) for more header files and libraries.
173
174 These packages can both be downloaded by searching in the Download Center at
175 L<http://www.microsoft.com/downloads/search.aspx?displaylang=en>.  (Providing exact
176 links to these packages has proven a pointless task because the links keep on
177 changing so often.)
178
179 Try to obtain the latest version of the Windows SDK.  Sometimes these packages
180 contain a particular Windows OS version in their name, but actually work on
181 other OS versions too.  For example, the "Windows Server 2003 R2 Platform SDK"
182 also runs on Windows XP SP2 and Windows 2000.
183
184 Install Visual C++ 2005 first, then the Platform SDK.  Setup your environment
185 as follows (assuming default installation locations were chosen):
186
187  SET PlatformSDKDir=C:\Program Files\Microsoft Platform SDK
188
189  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
190
191  SET INCLUDE=C:\Program Files\Microsoft Visual Studio 8\VC\INCLUDE;%PlatformSDKDir%\include
192
193  SET LIB=C:\Program Files\Microsoft Visual Studio 8\VC\LIB;C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\lib;%PlatformSDKDir%\lib
194
195  SET LIBPATH=C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727
196
197 (The PlatformSDKDir might need to be set differently depending on which version
198 you are using. Earlier versions installed into "C:\Program Files\Microsoft SDK",
199 while the latest versions install into version-specific locations such as
200 "C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2".)
201
202 Perl should now build using the win32/Makefile.  You will need to edit that
203 file to set
204
205  CCTYPE = MSVC80
206
207 and to set CCHOME, CCINCDIR and CCLIBDIR as per the environment setup above.
208
209 =item Microsoft Visual C++ Toolkit 2003
210
211 This free toolkit contains the same compiler and linker that ship with
212 Visual C++ .NET 2003 Professional, but doesn't contain everything
213 necessary to build Perl.
214
215 You will also need to download the "Platform SDK" (the "Core SDK" and "MDAC
216 SDK" components are required) for header files, libraries and rc.exe, and
217 ".NET Framework SDK" for more libraries and nmake.exe.  Note that the latter
218 (which also includes the free compiler and linker) requires the ".NET
219 Framework Redistributable" to be installed first.  This can be downloaded and
220 installed separately, but is included in the "Visual C++ Toolkit 2003" anyway.
221
222 These packages can all be downloaded by searching in the Download Center at
223 L<https://www.microsoft.com/downloads/search.aspx?displaylang=en>.  (Providing exact
224 links to these packages has proven a pointless task because the links keep on
225 changing so often.)
226
227 Try to obtain the latest version of the Windows SDK.  Sometimes these packages
228 contain a particular Windows OS version in their name, but actually work on
229 other OS versions too.  For example, the "Windows Server 2003 R2 Platform SDK"
230 also runs on Windows XP SP2 and Windows 2000.
231
232 Install the Toolkit first, then the Platform SDK, then the .NET Framework SDK.
233 Setup your environment as follows (assuming default installation locations
234 were chosen):
235
236  SET PlatformSDKDir=C:\Program Files\Microsoft Platform SDK
237
238  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
239
240  SET INCLUDE=C:\Program Files\Microsoft Visual C++ Toolkit 2003\include;%PlatformSDKDir%\include;C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\include
241
242  SET LIB=C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib;%PlatformSDKDir%\lib;C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
243
244 (The PlatformSDKDir might need to be set differently depending on which version
245 you are using. Earlier versions installed into "C:\Program Files\Microsoft SDK",
246 while the latest versions install into version-specific locations such as
247 "C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2".)
248
249 Several required files will still be missing:
250
251 =over 4
252
253 =item *
254
255 cvtres.exe is required by link.exe when using a .res file.  It is actually
256 installed by the .NET Framework SDK, but into a location such as the
257 following:
258
259  C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322
260
261 Copy it from there to %PlatformSDKDir%\Bin
262
263 =item *
264
265 lib.exe is normally used to build libraries, but link.exe with the /lib
266 option also works, so change win32/config.vc to use it instead:
267
268 Change the line reading:
269
270         ar='lib'
271
272 to:
273
274         ar='link /lib'
275
276 It may also be useful to create a batch file called lib.bat in
277 C:\Program Files\Microsoft Visual C++ Toolkit 2003\bin containing:
278
279         @echo off
280         link /lib %*
281
282 for the benefit of any naughty C extension modules that you might want to build
283 later which explicitly reference "lib" rather than taking their value from
284 $Config{ar}.
285
286 =item *
287
288 setargv.obj is required to build perlglob.exe (and perl.exe if the USE_SETARGV
289 option is enabled).  The Platform SDK supplies this object file in source form
290 in %PlatformSDKDir%\src\crt.  Copy setargv.c, cruntime.h and
291 internal.h from there to some temporary location and build setargv.obj using
292
293         cl.exe /c /I. /D_CRTBLD setargv.c
294
295 Then copy setargv.obj to %PlatformSDKDir%\lib
296
297 Alternatively, if you don't need perlglob.exe and don't need to enable the
298 USE_SETARGV option then you can safely just remove all mention of $(GLOBEXE)
299 from win32/Makefile and setargv.obj won't be required anyway.
300
301 =back
302
303 Perl should now build using the win32/Makefile.  You will need to edit that
304 file to set
305
306         CCTYPE = MSVC70FREE
307
308 and to set CCHOME, CCINCDIR and CCLIBDIR as per the environment setup above.
309
310 =item Microsoft Platform SDK 64-bit Compiler
311
312 The nmake that comes with the Platform SDK will suffice for building
313 Perl.  Make sure you are building within one of the "Build Environment"
314 shells available after you install the Platform SDK from the Start Menu.
315
316 =item GCC
317
318 Perl can be compiled with gcc from MinGW (version 3.4.5 or later) or from
319 MinGW64 (version 4.4.3 or later).  It can be downloaded here:
320
321 L<http://www.mingw.org/>
322 L<http://www.mingw-w64.org/>
323
324 You also need dmake or gmake.  See L</"Make"> above on how to get it.
325
326 Note that the MinGW build currently requires a MinGW runtime version earlier
327 than 3.21 (check __MINGW32_MAJOR_VERSION and __MINGW32_MINOR_VERSION).
328
329 Note also that the C++ mode build currently fails with MinGW 3.4.5 and 4.7.2
330 or later, and with MinGW64 64-bit 6.3.0 or later.
331
332 =item Intel C++ Compiler
333
334 Experimental support for using Intel C++ Compiler has been added. Edit
335 win32/Makefile and pick the correct CCTYPE for the Visual C that Intel C was
336 installed into. Also uncomment __ICC to enable Intel C on Visual C support.
337 To set up the build environment, from the Start Menu run
338 IA-32 Visual Studio 20__ mode or Intel 64 Visual Studio 20__ mode as
339 appropriate. Then run nmake as usually in that prompt box.
340
341 Only Intel C++ Compiler v12.1 has been tested. Other versions probably will
342 work. Using Intel C++ Compiler instead of Visual C has the benefit of C99
343 compatibility which is needed by some CPAN XS modules, while maintaining
344 compatibility with Visual C object code and Visual C debugging infrastructure
345 unlike GCC.
346
347 =back
348
349 =head2 Building
350
351 =over 4
352
353 =item *
354
355 Make sure you are in the "win32" subdirectory under the perl toplevel.
356 This directory contains a "Makefile" that will work with
357 versions of nmake that come with Visual C++ or the Windows SDK, and
358 a GNU make "GNUmakefile" or dmake "makefile.mk" that will work for all
359 supported compilers.  The defaults in the gmake and dmake makefile are
360 setup to build using MinGW/gcc.
361
362 =item *
363
364 Edit the GNUmakefile, makefile.mk (or Makefile, if you're using nmake)
365 and change the values of INST_DRV and INST_TOP.   You can also enable
366 various build flags.  These are explained in the makefiles.
367
368 Note that it is generally not a good idea to try to build a perl with
369 INST_DRV and INST_TOP set to a path that already exists from a previous
370 build.  In particular, this may cause problems with the
371 lib/ExtUtils/t/Embed.t test, which attempts to build a test program and
372 may end up building against the installed perl's lib/CORE directory rather
373 than the one being tested.
374
375 You will have to make sure that CCTYPE is set correctly and that
376 CCHOME points to wherever you installed your compiler.  For GCC this
377 should be the directory that contains the F<bin>, F<include> and
378 F<lib> directories.
379
380 If building with the cross-compiler provided by
381 mingw-w64.org you'll need to uncomment the line that sets
382 GCCCROSS in the makefile.mk. Do this only if it's the cross-compiler - ie
383 only if the bin folder doesn't contain a gcc.exe. (The cross-compiler
384 does not provide a gcc.exe, g++.exe, ar.exe, etc. Instead, all of these
385 executables are prefixed with 'x86_64-w64-mingw32-'.)
386
387 The default value for CCHOME in the makefiles for Visual C++
388 may not be correct for some versions.  Make sure the default exists
389 and is valid.
390
391 You may also need to comment out the C<DELAYLOAD = ...> line in the
392 Makefile if you're using VC++ 6.0 without the latest service pack and
393 the linker reports an internal error.
394
395 If you want build some core extensions statically into perl's dll, specify
396 them in the STATIC_EXT macro.
397
398 NOTE: The USE_64_BIT_INT build option is not supported with the 32-bit
399 Visual C++ 6.0 compiler.
400
401 Be sure to read the instructions near the top of the makefiles carefully.
402
403 =item *
404
405 Type "dmake" ("gmake" for GNU make, or "nmake" if you are using that make).
406
407 This should build everything.  Specifically, it will create perl.exe,
408 perl531.dll at the perl toplevel, and various other extension dll's
409 under the lib\auto directory.  If the build fails for any reason, make
410 sure you have done the previous steps correctly.
411
412 To try dmake's parallel mode, type "dmake -P2", where 2, is the maximum number
413 of parallel jobs you want to run. A number of things in the build process will
414 run in parallel, but there are serialization points where you will see just 1
415 CPU maxed out. This is normal.
416
417 Similarly you can build in parallel with GNU make, type "gmake -j2" to
418 build with two parallel jobs, or higher for more.
419
420 If you are advanced enough with building C code, here is a suggestion to speed
421 up building perl, and the later C<make test>. Try to keep your PATH environmental
422 variable with the least number of folders possible (remember to keep your C
423 compiler's folders there). C<C:\WINDOWS\system32> or C<C:\WINNT\system32>
424 depending on your OS version should be first folder in PATH, since "cmd.exe"
425 is the most commonly launched program during the build and later testing.
426
427 =back
428
429 =head2 Testing Perl on Windows
430
431 Type "dmake test" (or "gmake test", "nmake test").  This will run most
432 of the tests from the testsuite (many tests will be skipped).
433
434 There should be no test failures.
435
436 If you build with Visual C++ 2013 then three tests currently may fail with
437 Daylight Saving Time related problems: F<t/io/fs.t>,
438 F<cpan/HTTP-Tiny/t/110_mirror.t> and F<lib/File/Copy.t>. The failures are
439 caused by bugs in the CRT in VC++ 2013 which are fixed in VC++2015 and
440 later, as explained by Microsoft here:
441 L<https://connect.microsoft.com/VisualStudio/feedback/details/811534/utime-sometimes-fails-to-set-the-correct-file-times-in-visual-c-2013>. In the meantime,
442 if you need fixed C<stat> and C<utime> functions then have a look at the
443 CPAN distribution Win32::UTCFileTime.
444
445 If you build with Visual C++ 2015 or later then F<ext/XS-APItest/t/locale.t>
446 may crash (after all its tests have passed). This is due to a regression in the
447 Universal CRT introduced in the Windows 10 April 2018 Update, and will be fixed
448 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>.
449
450 If you build with certain versions (e.g. 4.8.1) of gcc from www.mingw.org then
451 F<ext/POSIX/t/time.t> may fail test 17 due to a known bug in those gcc builds:
452 see L<https://sourceforge.net/p/mingw/bugs/2152/>.
453
454 Some test failures may occur if you use a command shell other than the
455 native "cmd.exe", or if you are building from a path that contains
456 spaces.  So don't do that.
457
458 If you are running the tests from a emacs shell window, you may see
459 failures in op/stat.t.  Run "dmake test-notty" in that case.
460
461 Furthermore, you should make sure that during C<make test> you do not
462 have any GNU tool packages in your path: some toolkits like Unixutils
463 include some tools (C<type> for instance) which override the Windows
464 ones and makes tests fail. Remove them from your path while testing to
465 avoid these errors.
466
467 To see the output of specific failing tests run the harness from the t
468 directory:
469
470   # assuming you're starting from the win32 directory
471   cd ..\win32
472   .\perl harness <list of tests>
473
474 Please report any other failures as described under L</BUGS AND CAVEATS>.
475
476 =head2 Installation of Perl on Windows
477
478 Type "dmake install" (or "gmake install", "nmake install").  This will
479 put the newly built perl and the libraries under whatever C<INST_TOP>
480 points to in the Makefile.  It will also install the pod documentation
481 under C<$INST_TOP\$INST_VER\lib\pod> and HTML versions of the same
482 under C<$INST_TOP\$INST_VER\lib\pod\html>.
483
484 To use the Perl you just installed you will need to add a new entry to
485 your PATH environment variable: C<$INST_TOP\bin>, e.g.
486
487     set PATH=c:\perl\bin;%PATH%
488
489 If you opted to uncomment C<INST_VER> and C<INST_ARCH> in the makefile
490 then the installation structure is a little more complicated and you will
491 need to add two new PATH components instead: C<$INST_TOP\$INST_VER\bin> and
492 C<$INST_TOP\$INST_VER\bin\$ARCHNAME>, e.g.
493
494     set PATH=c:\perl\5.6.0\bin;c:\perl\5.6.0\bin\MSWin32-x86;%PATH%
495
496 =head2 Usage Hints for Perl on Windows
497
498 =over 4
499
500 =item Environment Variables
501
502 The installation paths that you set during the build get compiled
503 into perl, so you don't have to do anything additional to start
504 using that perl (except add its location to your PATH variable).
505
506 If you put extensions in unusual places, you can set PERL5LIB
507 to a list of paths separated by semicolons where you want perl
508 to look for libraries.  Look for descriptions of other environment
509 variables you can set in L<perlrun>.
510
511 You can also control the shell that perl uses to run system() and
512 backtick commands via PERL5SHELL.  See L<perlrun>.
513
514 Perl does not depend on the registry, but it can look up certain default
515 values if you choose to put them there unless disabled at build time with
516 USE_NO_REGISTRY.  On Perl process start Perl checks if
517 C<HKEY_CURRENT_USER\Software\Perl> and C<HKEY_LOCAL_MACHINE\Software\Perl>
518 exist.  If the keys exists, they will be checked for remainder of the Perl
519 process's run life for certain entries.  Entries in
520 C<HKEY_CURRENT_USER\Software\Perl> override entries in
521 C<HKEY_LOCAL_MACHINE\Software\Perl>.  One or more of the following entries
522 (of type REG_SZ or REG_EXPAND_SZ) may be set in the keys:
523
524  lib-$]        version-specific standard library path to add to @INC
525  lib           standard library path to add to @INC
526  sitelib-$]    version-specific site library path to add to @INC
527  sitelib       site library path to add to @INC
528  vendorlib-$]  version-specific vendor library path to add to @INC
529  vendorlib     vendor library path to add to @INC
530  PERL*         fallback for all %ENV lookups that begin with "PERL"
531
532 Note the C<$]> in the above is not literal.  Substitute whatever version
533 of perl you want to honor that entry, e.g. C<5.6.0>.  Paths must be
534 separated with semicolons, as usual on Windows.
535
536 =item File Globbing
537
538 By default, perl handles file globbing using the File::Glob extension,
539 which provides portable globbing.
540
541 If you want perl to use globbing that emulates the quirks of DOS
542 filename conventions, you might want to consider using File::DosGlob
543 to override the internal glob() implementation.  See L<File::DosGlob> for
544 details.
545
546 =item Using perl from the command line
547
548 If you are accustomed to using perl from various command-line
549 shells found in UNIX environments, you will be less than pleased
550 with what Windows offers by way of a command shell.
551
552 The crucial thing to understand about the Windows environment is that
553 the command line you type in is processed twice before Perl sees it.
554 First, your command shell (usually CMD.EXE) preprocesses the command
555 line, to handle redirection, environment variable expansion, and
556 location of the executable to run. Then, the perl executable splits
557 the remaining command line into individual arguments, using the
558 C runtime library upon which Perl was built.
559
560 It is particularly important to note that neither the shell nor the C
561 runtime do any wildcard expansions of command-line arguments (so
562 wildcards need not be quoted).  Also, the quoting behaviours of the
563 shell and the C runtime are rudimentary at best (and may, if you are
564 using a non-standard shell, be inconsistent).  The only (useful) quote
565 character is the double quote (").  It can be used to protect spaces
566 and other special characters in arguments.
567
568 The Windows documentation describes the shell parsing rules here:
569 L<http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/cmd.mspx?mfr=true>
570 and the C runtime parsing rules here:
571 L<https://msdn.microsoft.com/en-us/library/17w5ykft%28v=VS.100%29.aspx>.
572
573 Here are some further observations based on experiments: The C runtime
574 breaks arguments at spaces and passes them to programs in argc/argv.
575 Double quotes can be used to prevent arguments with spaces in them from
576 being split up.  You can put a double quote in an argument by escaping
577 it with a backslash and enclosing the whole argument within double quotes.
578 The backslash and the pair of double quotes surrounding the argument will
579 be stripped by the C runtime.
580
581 The file redirection characters "E<lt>", "E<gt>", and "|" can be quoted by
582 double quotes (although there are suggestions that this may not always
583 be true).  Single quotes are not treated as quotes by the shell or
584 the C runtime, they don't get stripped by the shell (just to make
585 this type of quoting completely useless).  The caret "^" has also
586 been observed to behave as a quoting character, but this appears
587 to be a shell feature, and the caret is not stripped from the command
588 line, so Perl still sees it (and the C runtime phase does not treat
589 the caret as a quote character).
590
591 Here are some examples of usage of the "cmd" shell:
592
593 This prints two doublequotes:
594
595     perl -e "print '\"\"' "
596
597 This does the same:
598
599     perl -e "print \"\\\"\\\"\" "
600
601 This prints "bar" and writes "foo" to the file "blurch":
602
603     perl -e "print 'foo'; print STDERR 'bar'" > blurch
604
605 This prints "foo" ("bar" disappears into nowhereland):
606
607     perl -e "print 'foo'; print STDERR 'bar'" 2> nul
608
609 This prints "bar" and writes "foo" into the file "blurch":
610
611     perl -e "print 'foo'; print STDERR 'bar'" 1> blurch
612
613 This pipes "foo" to the "less" pager and prints "bar" on the console:
614
615     perl -e "print 'foo'; print STDERR 'bar'" | less
616
617 This pipes "foo\nbar\n" to the less pager:
618
619     perl -le "print 'foo'; print STDERR 'bar'" 2>&1 | less
620
621 This pipes "foo" to the pager and writes "bar" in the file "blurch":
622
623     perl -e "print 'foo'; print STDERR 'bar'" 2> blurch | less
624
625
626 Discovering the usefulness of the "command.com" shell on Windows 9x
627 is left as an exercise to the reader :)
628
629 One particularly pernicious problem with the 4NT command shell for
630 Windows is that it (nearly) always treats a % character as indicating
631 that environment variable expansion is needed.  Under this shell, it is
632 therefore important to always double any % characters which you want
633 Perl to see (for example, for hash variables), even when they are
634 quoted.
635
636 =item Building Extensions
637
638 The Comprehensive Perl Archive Network (CPAN) offers a wealth
639 of extensions, some of which require a C compiler to build.
640 Look in L<https://www.cpan.org/> for more information on CPAN.
641
642 Note that not all of the extensions available from CPAN may work
643 in the Windows environment; you should check the information at
644 L<https://www.cpantesters.org/> before investing too much effort into
645 porting modules that don't readily build.
646
647 Most extensions (whether they require a C compiler or not) can
648 be built, tested and installed with the standard mantra:
649
650     perl Makefile.PL
651     $MAKE
652     $MAKE test
653     $MAKE install
654
655 where $MAKE is whatever 'make' program you have configured perl to
656 use.  Use "perl -V:make" to find out what this is.  Some extensions
657 may not provide a testsuite (so "$MAKE test" may not do anything or
658 fail), but most serious ones do.
659
660 It is important that you use a supported 'make' program, and
661 ensure Config.pm knows about it.  If you don't have nmake, you can
662 either get dmake from the location mentioned earlier or get an
663 old version of nmake reportedly available from:
664
665 L<http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/nmake15.exe>
666
667 Another option is to use the make written in Perl, available from
668 CPAN.
669
670 L<https://www.cpan.org/modules/by-module/Make/>
671
672 You may also use dmake or gmake.  See L</"Make"> above on how to get it.
673
674 Note that MakeMaker actually emits makefiles with different syntax
675 depending on what 'make' it thinks you are using.  Therefore, it is
676 important that one of the following values appears in Config.pm:
677
678     make='nmake'        # MakeMaker emits nmake syntax
679     make='dmake'        # MakeMaker emits dmake syntax
680     any other value     # MakeMaker emits generic make syntax
681                             (e.g GNU make, or Perl make)
682
683 If the value doesn't match the 'make' program you want to use,
684 edit Config.pm to fix it.
685
686 If a module implements XSUBs, you will need one of the supported
687 C compilers.  You must make sure you have set up the environment for
688 the compiler for command-line compilation before running C<perl Makefile.PL>
689 or any invocation of make.
690
691 If a module does not build for some reason, look carefully for
692 why it failed, and report problems to the module author.  If
693 it looks like the extension building support is at fault, report
694 that with full details of how the build failed using the perlbug
695 utility.
696
697 =item Command-line Wildcard Expansion
698
699 The default command shells on DOS descendant operating systems (such
700 as they are) usually do not expand wildcard arguments supplied to
701 programs.  They consider it the application's job to handle that.
702 This is commonly achieved by linking the application (in our case,
703 perl) with startup code that the C runtime libraries usually provide.
704 However, doing that results in incompatible perl versions (since the
705 behavior of the argv expansion code differs depending on the
706 compiler, and it is even buggy on some compilers).  Besides, it may
707 be a source of frustration if you use such a perl binary with an
708 alternate shell that *does* expand wildcards.
709
710 Instead, the following solution works rather well. The nice things
711 about it are 1) you can start using it right away; 2) it is more
712 powerful, because it will do the right thing with a pattern like
713 */*/*.c; 3) you can decide whether you do/don't want to use it; and
714 4) you can extend the method to add any customizations (or even
715 entirely different kinds of wildcard expansion).
716
717  C:\> copy con c:\perl\lib\Wild.pm
718  # Wild.pm - emulate shell @ARGV expansion on shells that don't
719  use File::DosGlob;
720  @ARGV = map {
721               my @g = File::DosGlob::glob($_) if /[*?]/;
722               @g ? @g : $_;
723             } @ARGV;
724  1;
725  ^Z
726  C:\> set PERL5OPT=-MWild
727  C:\> perl -le "for (@ARGV) { print }" */*/perl*.c
728  p4view/perl/perl.c
729  p4view/perl/perlio.c
730  p4view/perl/perly.c
731  perl5.005/win32/perlglob.c
732  perl5.005/win32/perllib.c
733  perl5.005/win32/perlglob.c
734  perl5.005/win32/perllib.c
735  perl5.005/win32/perlglob.c
736  perl5.005/win32/perllib.c
737
738 Note there are two distinct steps there: 1) You'll have to create
739 Wild.pm and put it in your perl lib directory. 2) You'll need to
740 set the PERL5OPT environment variable.  If you want argv expansion
741 to be the default, just set PERL5OPT in your default startup
742 environment.
743
744 If you are using the Visual C compiler, you can get the C runtime's
745 command line wildcard expansion built into perl binary.  The resulting
746 binary will always expand unquoted command lines, which may not be
747 what you want if you use a shell that does that for you.  The expansion
748 done is also somewhat less powerful than the approach suggested above.
749
750 =item Notes on 64-bit Windows
751
752 Windows .NET Server supports the LLP64 data model on the Intel Itanium
753 architecture.
754
755 The LLP64 data model is different from the LP64 data model that is the
756 norm on 64-bit Unix platforms.  In the former, C<int> and C<long> are
757 both 32-bit data types, while pointers are 64 bits wide.  In addition,
758 there is a separate 64-bit wide integral type, C<__int64>.  In contrast,
759 the LP64 data model that is pervasive on Unix platforms provides C<int>
760 as the 32-bit type, while both the C<long> type and pointers are of
761 64-bit precision.  Note that both models provide for 64-bits of
762 addressability.
763
764 64-bit Windows running on Itanium is capable of running 32-bit x86
765 binaries transparently.  This means that you could use a 32-bit build
766 of Perl on a 64-bit system.  Given this, why would one want to build
767 a 64-bit build of Perl?  Here are some reasons why you would bother:
768
769 =over
770
771 =item *
772
773 A 64-bit native application will run much more efficiently on
774 Itanium hardware.
775
776 =item *
777
778 There is no 2GB limit on process size.
779
780 =item *
781
782 Perl automatically provides large file support when built under
783 64-bit Windows.
784
785 =item *
786
787 Embedding Perl inside a 64-bit application.
788
789 =back
790
791 =back
792
793 =head2 Running Perl Scripts
794
795 Perl scripts on UNIX use the "#!" (a.k.a "shebang") line to
796 indicate to the OS that it should execute the file using perl.
797 Windows has no comparable means to indicate arbitrary files are
798 executables.
799
800 Instead, all available methods to execute plain text files on
801 Windows rely on the file "extension".  There are three methods
802 to use this to execute perl scripts:
803
804 =over 8
805
806 =item 1
807
808 There is a facility called "file extension associations".  This can be
809 manipulated via the two commands "assoc" and "ftype" that come
810 standard with Windows.  Type "ftype /?" for a complete example of how
811 to set this up for perl scripts (Say what?  You thought Windows
812 wasn't perl-ready? :).
813
814 =item 2
815
816 Since file associations don't work everywhere, and there are
817 reportedly bugs with file associations where it does work, the
818 old method of wrapping the perl script to make it look like a
819 regular batch file to the OS, may be used.  The install process
820 makes available the "pl2bat.bat" script which can be used to wrap
821 perl scripts into batch files.  For example:
822
823         pl2bat foo.pl
824
825 will create the file "FOO.BAT".  Note "pl2bat" strips any
826 .pl suffix and adds a .bat suffix to the generated file.
827
828 If you use the 4DOS/NT or similar command shell, note that
829 "pl2bat" uses the "%*" variable in the generated batch file to
830 refer to all the command line arguments, so you may need to make
831 sure that construct works in batch files.  As of this writing,
832 4DOS/NT users will need a "ParameterChar = *" statement in their
833 4NT.INI file or will need to execute "setdos /p*" in the 4DOS/NT
834 startup file to enable this to work.
835
836 =item 3
837
838 Using "pl2bat" has a few problems:  the file name gets changed,
839 so scripts that rely on C<$0> to find what they must do may not
840 run properly; running "pl2bat" replicates the contents of the
841 original script, and so this process can be maintenance intensive
842 if the originals get updated often.  A different approach that
843 avoids both problems is possible.
844
845 A script called "runperl.bat" is available that can be copied
846 to any filename (along with the .bat suffix).  For example,
847 if you call it "foo.bat", it will run the file "foo" when it is
848 executed.  Since you can run batch files on Windows platforms simply
849 by typing the name (without the extension), this effectively
850 runs the file "foo", when you type either "foo" or "foo.bat".
851 With this method, "foo.bat" can even be in a different location
852 than the file "foo", as long as "foo" is available somewhere on
853 the PATH.  If your scripts are on a filesystem that allows symbolic
854 links, you can even avoid copying "runperl.bat".
855
856 Here's a diversion:  copy "runperl.bat" to "runperl", and type
857 "runperl".  Explain the observed behavior, or lack thereof. :)
858 Hint: .gnidnats llits er'uoy fi ,"lrepnur" eteled :tniH
859
860 =back
861
862 =head2 Miscellaneous Things
863
864 A full set of HTML documentation is installed, so you should be
865 able to use it if you have a web browser installed on your
866 system.
867
868 C<perldoc> is also a useful tool for browsing information contained
869 in the documentation, especially in conjunction with a pager
870 like C<less> (recent versions of which have Windows support).  You may
871 have to set the PAGER environment variable to use a specific pager.
872 "perldoc -f foo" will print information about the perl operator
873 "foo".
874
875 One common mistake when using this port with a GUI library like C<Tk>
876 is assuming that Perl's normal behavior of opening a command-line
877 window will go away.  This isn't the case.  If you want to start a copy
878 of C<perl> without opening a command-line window, use the C<wperl>
879 executable built during the installation process.  Usage is exactly
880 the same as normal C<perl> on Windows, except that options like C<-h>
881 don't work (since they need a command-line window to print to).
882
883 If you find bugs in perl, you can run C<perlbug> to create a
884 bug report (you may have to send it manually if C<perlbug> cannot
885 find a mailer on your system).
886
887 =head1 BUGS AND CAVEATS
888
889 Norton AntiVirus interferes with the build process, particularly if
890 set to "AutoProtect, All Files, when Opened". Unlike large applications
891 the perl build process opens and modifies a lot of files. Having the
892 the AntiVirus scan each and every one slows build the process significantly.
893 Worse, with PERLIO=stdio the build process fails with peculiar messages
894 as the virus checker interacts badly with miniperl.exe writing configure
895 files (it seems to either catch file part written and treat it as suspicious,
896 or virus checker may have it "locked" in a way which inhibits miniperl
897 updating it). The build does complete with
898
899    set PERLIO=perlio
900
901 but that may be just luck. Other AntiVirus software may have similar issues.
902
903 A git GUI shell extension for Windows such as TortoiseGit will cause the build
904 and later C<make test> to run much slower since every file is checked for its
905 git status as soon as it is created and/or modified. TortoiseGit doesn't cause
906 any test failures or build problems unlike the antivirus software described
907 above, but it does cause similar slowness. It is suggested to use Task Manager
908 to look for background processes which use high CPU amounts during the building
909 process.
910
911 Some of the built-in functions do not act exactly as documented in
912 L<perlfunc>, and a few are not implemented at all.  To avoid
913 surprises, particularly if you have had prior exposure to Perl
914 in other operating environments or if you intend to write code
915 that will be portable to other environments, see L<perlport>
916 for a reasonably definitive list of these differences.
917
918 Not all extensions available from CPAN may build or work properly
919 in the Windows environment.  See L</"Building Extensions">.
920
921 Most C<socket()> related calls are supported, but they may not
922 behave as on Unix platforms.  See L<perlport> for the full list.
923
924 Signal handling may not behave as on Unix platforms (where it
925 doesn't exactly "behave", either :).  For instance, calling C<die()>
926 or C<exit()> from signal handlers will cause an exception, since most
927 implementations of C<signal()> on Windows are severely crippled.
928 Thus, signals may work only for simple things like setting a flag
929 variable in the handler.  Using signals under this port should
930 currently be considered unsupported.
931
932 Please send detailed descriptions of any problems and solutions that
933 you may find to E<lt>F<perlbug@perl.org>E<gt>, along with the output
934 produced by C<perl -V>.
935
936 =head1 ACKNOWLEDGEMENTS
937
938 The use of a camel with the topic of Perl is a trademark
939 of O'Reilly and Associates, Inc. Used with permission.
940
941 =head1 AUTHORS
942
943 =over 4
944
945 =item Gary Ng E<lt>71564.1743@CompuServe.COME<gt>
946
947 =item Gurusamy Sarathy E<lt>gsar@activestate.comE<gt>
948
949 =item Nick Ing-Simmons E<lt>nick@ing-simmons.netE<gt>
950
951 =item Jan Dubois E<lt>jand@activestate.comE<gt>
952
953 =item Steve Hay E<lt>steve.m.hay@googlemail.comE<gt>
954
955 =back
956
957 This document is maintained by Jan Dubois.
958
959 =head1 SEE ALSO
960
961 L<perl>
962
963 =head1 HISTORY
964
965 This port was originally contributed by Gary Ng around 5.003_24,
966 and borrowed from the Hip Communications port that was available
967 at the time.  Various people have made numerous and sundry hacks
968 since then.
969
970 GCC/mingw32 support was added in 5.005 (Nick Ing-Simmons).
971
972 Support for PERL_OBJECT was added in 5.005 (ActiveState Tool Corp).
973
974 Support for fork() emulation was added in 5.6 (ActiveState Tool Corp).
975
976 Win9x support was added in 5.6 (Benjamin Stuhl).
977
978 Support for 64-bit Windows added in 5.8 (ActiveState Corp).
979
980 Last updated: 30 April 2019
981
982 =cut