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