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