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