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