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