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