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