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