add workaround for dlopen() bug on OpenBSD (relative paths that
[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 Win32
8
9 =head1 SYNOPSIS
10
11 These are instructions for building Perl under Windows NT (versions
12 3.51 or 4.0).  Currently, this port is reported to build under
13 Windows95 using the 4DOS shell--the default shell that infests
14 Windows95 may not work fully (but see below).  Note that this caveat
15 is only about B<building> perl.  Once built, you should be able to
16 B<use> it on either Win32 platform (modulo the problems arising from
17 the inferior command shell).
18
19 =head1 DESCRIPTION
20
21 Before you start, you should glance through the README file
22 found in the top-level directory where the Perl distribution
23 was extracted.  Make sure you read and understand the terms under
24 which this software is being distributed.
25
26 Also make sure you read L<BUGS AND CAVEATS> below for the
27 known limitations of this port.
28
29 The INSTALL file in the perl top-level has much information that is
30 only relevant to people building Perl on Unix-like systems.  In
31 particular, you can safely ignore any information that talks about
32 "Configure".
33
34 You may also want to look at two other options for building
35 a perl that will work on Windows NT:  the README.cygwin and
36 README.os2 files, which each give a different set of rules to build
37 a Perl that will work on Win32 platforms.  Those two methods will
38 probably enable you to build a more Unix-compatible perl, but you
39 will also need to download and use various other build-time and
40 run-time support software described in those files.
41
42 This set of instructions is meant to describe a so-called "native"
43 port of Perl to Win32 platforms.  The resulting Perl requires no
44 additional software to run (other than what came with your operating
45 system).  Currently, this port is capable of using one of the
46 following compilers:
47
48       Borland C++               version 5.02 or later
49       Microsoft Visual C++      version 4.2 or later
50       Mingw32 with GCC          version 2.95.2 or better
51
52 The last of these is a high quality freeware compiler.  Support
53 for it is still experimental.  (Older versions of GCC are known
54 not to work.)
55
56 This port currently supports MakeMaker (the set of modules that
57 is used to build extensions to perl).  Therefore, you should be
58 able to build and install most extensions found in the CPAN sites.
59 See L<Usage Hints> below for general hints about this.
60
61 =head2 Setting Up
62
63 =over 4
64
65 =item Command Shell
66
67 Use the default "cmd" shell that comes with NT.  Some versions of the
68 popular 4DOS/NT shell have incompatibilities that may cause you trouble.
69 If the build fails under that shell, try building again with the cmd
70 shell.  The nmake Makefile also has known incompatibilites with the
71 "command.com" shell that comes with Windows95.
72
73 However, there have been reports of successful build attempts using
74 4DOS/NT version 6.01 under Windows95, using dmake, but your mileage
75 may vary.  There is also some basic support for building using dmake
76 under command.com.  Nevertheless, if building under command.com
77 doesn't work, try 4DOS/NT.
78
79 The surest way to build it is on Windows NT, using the cmd shell.
80
81 Make sure the path to the build directory does not contain spaces.  The
82 build usually works in this circumstance, but some tests will fail.
83
84 =item Borland C++
85
86 If you are using the Borland compiler, you will need dmake, a freely
87 available make that has very nice macro features and parallelability.
88 (The make that Borland supplies is seriously crippled, and will not
89 work for MakeMaker builds.)
90
91 A port of dmake for win32 platforms is available from:
92
93     ftp://ftp.linux.activestate.com/pub/staff/gsar/dmake-4.1-win32.zip
94
95 (This is a fixed version of original dmake sources obtained from
96 http://www.wticorp.com/dmake/.  As of version 4.1PL1, the original
97 sources did not build as shipped, and had various other problems.
98 A patch is included in the above fixed version.)
99
100 Fetch and install dmake somewhere on your path (follow the instructions
101 in the README.NOW file).
102
103 =item Microsoft Visual C++
104
105 The nmake that comes with Visual C++ will suffice for building.
106 You will need to run the VCVARS32.BAT file usually found somewhere
107 like C:\MSDEV4.2\BIN.  This will set your build environment.
108
109 You can also use dmake to build using Visual C++, provided:
110 you set OSRELEASE to "microsft" (or whatever the directory name
111 under which the Visual C dmake configuration lives) in your environment,
112 and edit win32/config.vc to change "make=nmake" into "make=dmake".  The
113 latter step is only essential if you want to use dmake as your default
114 make for building extensions using MakeMaker.
115
116 =item Mingw32 with GCC
117
118 GCC-2.95.2 binaries can be downloaded from:
119
120     ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/
121
122 The GCC-2.95.2 bundle comes with Mingw32 libraries and headers.
123
124 Make sure you install the binaries as indicated in the README for
125 the GCC bundle.  You may need to set up a few environment variables
126 (usually run from a batch file).
127
128 You also need dmake.  See L</"Borland C++"> above on how to get it.
129
130 =back
131
132 =head2 Building
133
134 =over 4
135
136 =item *
137
138 Make sure you are in the "win32" subdirectory under the perl toplevel.
139 This directory contains a "Makefile" that will work with
140 versions of nmake that come with Visual C++, and a dmake "makefile.mk"
141 that will work for all supported compilers.  The defaults in the dmake
142 makefile are setup to build using the Borland compiler.
143
144 =item *
145
146 Edit the makefile.mk (or Makefile, if using nmake) and change the values
147 of INST_DRV and INST_TOP.   You can also enable various build
148 flags.
149
150 Beginning with version 5.005, there is experimental support for building
151 a perl interpreter that supports the Perl Object abstraction (courtesy
152 ActiveState Tool Corp.)  PERL_OBJECT uses C++, and the binaries are
153 therefore incompatible with the regular C build.  However, the
154 PERL_OBJECT build does provide something called the C-API, for linking
155 it with extensions that won't compile under PERL_OBJECT. Using the C_API
156 is typically requested through:
157
158     perl Makefile.PL CAPI=TRUE
159
160 PERL_OBJECT requires VC++ 5.0 (Service Pack 3 recommended) or later. It
161 is not yet supported under GCC.  WARNING:  Binaries built with
162 PERL_OBJECT enabled are B<not> compatible with binaries built without.
163 Perl installs PERL_OBJECT binaries under a distinct architecture name,
164 so they B<can> coexist, though.
165
166 Beginning with version 5.005, there is experimental support for building
167 a perl interpreter that is capable of native threading.  Binaries built
168 with thread support enabled are also incompatible with the vanilla C
169 build.  WARNING:  Binaries built with threads enabled are B<not> compatible
170 with binaries built without.  Perl installs threads enabled binaries under
171 a distinct architecture name, so they B<can> coexist, though.
172
173 At the present time, you cannot enable both threading and PERL_OBJECT.
174 You can get only one of them in a Perl interpreter.
175
176 If you have either the source or a library that contains des_fcrypt(),
177 enable the appropriate option in the makefile.  des_fcrypt() is not
178 bundled with the distribution due to US Government restrictions
179 on the export of cryptographic software.  Nevertheless, this routine
180 is part of the "libdes" library (written by Ed Young) which is widely
181 available worldwide, usually along with SSLeay (for example:
182 "ftp://fractal.mta.ca/pub/crypto/SSLeay/DES/").  Set CRYPT_SRC to the
183 name of the file that implements des_fcrypt().  Alternatively, if
184 you have built a library that contains des_fcrypt(), you can set
185 CRYPT_LIB to point to the library name.  The location above contains
186 many versions of the "libdes" library, all with slightly different
187 implementations of des_fcrypt().  Older versions have a single,
188 self-contained file (fcrypt.c) that implements crypt(), so they may be
189 easier to use.  A patch against the fcrypt.c found in libdes-3.06 is
190 in des_fcrypt.patch.
191
192 Perl will also build without des_fcrypt(), but the crypt() builtin will
193 fail at run time.
194
195 You will also have to make sure CCHOME points to wherever you installed
196 your compiler.
197
198 The default value for CCHOME in the makefiles for Visual C++
199 may not be correct for some versions.  Make sure the default exists
200 and is valid.
201
202 Other options are explained in the makefiles.  Be sure to read the
203 instructions carefully.
204
205 =item *
206
207 Type "dmake" (or "nmake" if you are using that make).
208
209 This should build everything.  Specifically, it will create perl.exe,
210 perl.dll (or perl56.dll), and perlglob.exe at the perl toplevel, and
211 various other extension dll's under the lib\auto directory.  If the build
212 fails for any reason, make sure you have done the previous steps correctly.
213
214 The build process may produce "harmless" compiler warnings (more or
215 less copiously, depending on how picky your compiler gets).  The
216 maintainers are aware of these warnings, thankyouverymuch. :)
217
218 When building using Visual C++, a perl95.exe will also get built.  This
219 executable is only needed on Windows95, and should be used instead of
220 perl.exe, and then only if you want sockets to work properly on Windows95.
221 This is necessitated by a bug in the Microsoft C Runtime that cannot be
222 worked around in the "normal" perl.exe.  perl95.exe gets built with its
223 own private copy of the C Runtime that is not accessible to extensions
224 (which see the DLL version of the CRT).  Be aware, therefore, that this
225 perl95.exe will have esoteric problems with extensions like perl/Tk that
226 themselves use the C Runtime heavily, or want to free() pointers
227 malloc()-ed by perl.
228
229 You can avoid the perl95.exe problems completely if you either enable
230 USE_PERLCRT with Visual C++, or use Borland C++ for building perl.  In
231 those cases, perl95.exe is not needed and will not be built.
232
233 =back
234
235 =head2 Testing
236
237 Type "dmake test" (or "nmake test").  This will run most of the tests from
238 the testsuite (many tests will be skipped, and but no test should fail).
239
240 If some tests do fail, it may be because you are using a different command
241 shell than the native "cmd.exe", or because you are building from a path
242 that contains spaces.  So don't do that.
243
244 If you are running the tests from a emacs shell window, you may see
245 failures in op/stat.t.  Run "dmake test-notty" in that case.
246
247 If you're using the Borland compiler, you may see a failure in op/taint.t
248 arising from the inability to find the Borland Runtime DLLs on the system
249 default path.  You will need to copy the DLLs reported by the messages
250 from where Borland chose to install it, into the Windows system directory
251 (usually somewhere like C:\WINNT\SYSTEM32), and rerun the test.
252
253 The Visual C runtime apparently has a bug that causes posix.t to fail
254 test#2.  This usually happens only if you extracted the files in text
255 mode.  Enable the USE_PERLCRT option in the Makefile to fix this bug.
256
257 Please report any other failures as described under L<BUGS AND CAVEATS>.
258
259 =head2 Installation
260
261 Type "dmake install" (or "nmake install").  This will put the newly
262 built perl and the libraries under whatever C<INST_TOP> points to in the
263 Makefile.  It will also install the pod documentation under
264 C<$INST_TOP\$VERSION\lib\pod> and HTML versions of the same under
265 C<$INST_TOP\$VERSION\lib\pod\html>.  To use the Perl you just installed,
266 you will need to add two components to your PATH environment variable,
267 C<$INST_TOP\$VERSION\bin>, and C<$INST_TOP\$VERSION\bin\$ARCHNAME>.
268 For example:
269
270     set PATH c:\perl\5.005\bin;c:\perl\5.005\bin\MSWin32-x86;%PATH%
271
272
273 =head2 Usage Hints
274
275 =over 4
276
277 =item Environment Variables
278
279 The installation paths that you set during the build get compiled
280 into perl, so you don't have to do anything additional to start
281 using that perl (except add its location to your PATH variable).
282
283 If you put extensions in unusual places, you can set PERL5LIB
284 to a list of paths separated by semicolons where you want perl
285 to look for libraries.  Look for descriptions of other environment
286 variables you can set in L<perlrun>.
287
288 You can also control the shell that perl uses to run system() and
289 backtick commands via PERL5SHELL.  See L<perlrun>.
290
291 Perl does not depend on the registry, but it can look up certain default
292 values if you choose to put them there.  Perl attempts to read entries from
293 C<HKEY_CURRENT_USER\Software\Perl> and C<HKEY_LOCAL_MACHINE\Software\Perl>.
294 Entries in the former override entries in the latter.  One or more of the
295 following entries (of type REG_SZ or REG_EXPAND_SZ) may be set:
296
297     lib-$]              version-specific path to add to @INC
298     lib                 path to add to @INC
299     sitelib-$]          version-specific path to add to @INC
300     sitelib             path to add to @INC
301     PERL*               fallback for all %ENV lookups that begin with "PERL"
302
303 Note the C<$]> in the above is not literal.  Substitute whatever version
304 of perl you want to honor that entry, e.g. C<5.00502>.  Paths must be
305 separated with semicolons, as usual on win32.
306
307 =item File Globbing
308
309 By default, perl spawns an external program to do file globbing.
310 The install process installs both a perlglob.exe and a perlglob.bat
311 that perl can use for this purpose.  Note that with the default
312 installation, perlglob.exe will be found by the system before
313 perlglob.bat.
314
315 perlglob.exe relies on the argv expansion done by the C Runtime of
316 the particular compiler you used, and therefore behaves very
317 differently depending on the Runtime used to build it.  To preserve
318 compatiblity, perlglob.bat (a perl script that can be used portably)
319 is installed.  Besides being portable, perlglob.bat also offers
320 enhanced globbing functionality.
321
322 If you want perl to use perlglob.bat instead of perlglob.exe, just
323 delete perlglob.exe from the install location (or move it somewhere
324 perl cannot find).  Using File::DosGlob.pm (which implements the core
325 functionality of perlglob.bat) to override the internal CORE::glob()
326 works about 10 times faster than spawing perlglob.exe, and you should
327 take this approach when writing new modules.  See File::DosGlob for
328 details.
329
330 =item Using perl from the command line
331
332 If you are accustomed to using perl from various command-line
333 shells found in UNIX environments, you will be less than pleased
334 with what Windows NT offers by way of a command shell.
335
336 The crucial thing to understand about the "cmd" shell (which is
337 the default on Windows NT) is that it does not do any wildcard
338 expansions of command-line arguments (so wildcards need not be
339 quoted).  It also provides only rudimentary quoting.  The only
340 (useful) quote character is the double quote (").  It can be used to
341 protect spaces in arguments and other special characters.  The
342 Windows NT documentation has almost no description of how the
343 quoting rules are implemented, but here are some general observations
344 based on experiments:  The shell breaks arguments at spaces and
345 passes them to programs in argc/argv.  Doublequotes can be used
346 to prevent arguments with spaces in them from being split up.
347 You can put a double quote in an argument by escaping it with
348 a backslash and enclosing the whole argument within double quotes.
349 The backslash and the pair of double quotes surrounding the
350 argument will be stripped by the shell.
351
352 The file redirection characters "<", ">", and "|" cannot be quoted
353 by double quotes (there are probably more such).  Single quotes
354 will protect those three file redirection characters, but the
355 single quotes don't get stripped by the shell (just to make this
356 type of quoting completely useless).  The caret "^" has also
357 been observed to behave as a quoting character (and doesn't get
358 stripped by the shell also).
359
360 Here are some examples of usage of the "cmd" shell:
361
362 This prints two doublequotes:
363
364     perl -e "print '\"\"' "
365
366 This does the same:
367
368     perl -e "print \"\\\"\\\"\" "
369
370 This prints "bar" and writes "foo" to the file "blurch":
371
372     perl -e "print 'foo'; print STDERR 'bar'" > blurch
373
374 This prints "foo" ("bar" disappears into nowhereland):
375
376     perl -e "print 'foo'; print STDERR 'bar'" 2> nul
377
378 This prints "bar" and writes "foo" into the file "blurch":
379
380     perl -e "print 'foo'; print STDERR 'bar'" 1> blurch
381
382 This pipes "foo" to the "less" pager and prints "bar" on the console:
383
384     perl -e "print 'foo'; print STDERR 'bar'" | less
385
386 This pipes "foo\nbar\n" to the less pager:
387
388     perl -le "print 'foo'; print STDERR 'bar'" 2>&1 | less
389
390 This pipes "foo" to the pager and writes "bar" in the file "blurch":
391
392     perl -e "print 'foo'; print STDERR 'bar'" 2> blurch | less
393
394
395 Discovering the usefulness of the "command.com" shell on Windows95
396 is left as an exercise to the reader :)
397
398 =item Building Extensions
399
400 The Comprehensive Perl Archive Network (CPAN) offers a wealth
401 of extensions, some of which require a C compiler to build.
402 Look in http://www.perl.com/ for more information on CPAN.
403
404 Most extensions (whether they require a C compiler or not) can
405 be built, tested and installed with the standard mantra:
406
407     perl Makefile.PL
408     $MAKE
409     $MAKE test
410     $MAKE install
411
412 where $MAKE is whatever 'make' program you have configured perl to
413 use.  Use "perl -V:make" to find out what this is.  Some extensions
414 may not provide a testsuite (so "$MAKE test" may not do anything, or
415 fail), but most serious ones do.
416
417 It is important that you use a supported 'make' program, and
418 ensure Config.pm knows about it.  If you don't have nmake, you can
419 either get dmake from the location mentioned earlier, or get an
420 old version of nmake reportedly available from:
421
422     ftp://ftp.microsoft.com/Softlib/MSLFILES/nmake15.exe
423
424 Another option is to use the make written in Perl, available from
425 CPAN:
426
427     http://www.perl.com/CPAN/authors/id/NI-S/Make-0.03.tar.gz
428
429 Note that MakeMaker actually emits makefiles with different syntax
430 depending on what 'make' it thinks you are using.  Therefore, it is
431 important that one of the following values appears in Config.pm:
432
433     make='nmake'        # MakeMaker emits nmake syntax
434     make='dmake'        # MakeMaker emits dmake syntax
435     any other value     # MakeMaker emits generic make syntax
436                             (e.g GNU make, or Perl make)
437
438 If the value doesn't match the 'make' program you want to use,
439 edit Config.pm to fix it.
440
441 If a module implements XSUBs, you will need one of the supported
442 C compilers.  You must make sure you have set up the environment for
443 the compiler for command-line compilation.
444
445 If a module does not build for some reason, look carefully for
446 why it failed, and report problems to the module author.  If
447 it looks like the extension building support is at fault, report
448 that with full details of how the build failed using the perlbug
449 utility.
450
451 =item Command-line Wildcard Expansion
452
453 The default command shells on DOS descendant operating systems (such
454 as they are) usually do not expand wildcard arguments supplied to
455 programs.  They consider it the application's job to handle that.
456 This is commonly achieved by linking the application (in our case,
457 perl) with startup code that the C runtime libraries usually provide.
458 However, doing that results in incompatible perl versions (since the
459 behavior of the argv expansion code differs depending on the
460 compiler, and it is even buggy on some compilers).  Besides, it may
461 be a source of frustration if you use such a perl binary with an
462 alternate shell that *does* expand wildcards.
463
464 Instead, the following solution works rather well. The nice things
465 about it: 1) you can start using it right away 2) it is more powerful,
466 because it will do the right thing with a pattern like */*/*.c
467 3) you can decide whether you do/don't want to use it 4) you can
468 extend the method to add any customizations (or even entirely
469 different kinds of wildcard expansion).
470
471         C:\> copy con c:\perl\lib\Wild.pm
472         # Wild.pm - emulate shell @ARGV expansion on shells that don't
473         use File::DosGlob;
474         @ARGV = map {
475                       my @g = File::DosGlob::glob($_) if /[*?]/;
476                       @g ? @g : $_;
477                     } @ARGV;
478         1;
479         ^Z
480         C:\> set PERL5OPT=-MWild
481         C:\> perl -le "for (@ARGV) { print }" */*/perl*.c
482         p4view/perl/perl.c
483         p4view/perl/perlio.c
484         p4view/perl/perly.c
485         perl5.005/win32/perlglob.c
486         perl5.005/win32/perllib.c
487         perl5.005/win32/perlglob.c
488         perl5.005/win32/perllib.c
489         perl5.005/win32/perlglob.c
490         perl5.005/win32/perllib.c
491
492 Note there are two distinct steps there: 1) You'll have to create
493 Wild.pm and put it in your perl lib directory. 2) You'll need to
494 set the PERL5OPT environment variable.  If you want argv expansion
495 to be the default, just set PERL5OPT in your default startup
496 environment.
497
498 If you are using the Visual C compiler, you can get the C runtime's
499 command line wildcard expansion built into perl binary.  The resulting
500 binary will always expand unquoted command lines, which may not be
501 what you want if you use a shell that does that for you.  The expansion
502 done is also somewhat less powerful than the approach suggested above.
503
504 =item Win32 Specific Extensions
505
506 A number of extensions specific to the Win32 platform are available
507 from CPAN.  You may find that many of these extensions are meant to
508 be used under the Activeware port of Perl, which used to be the only
509 native port for the Win32 platform.  Since the Activeware port does not
510 have adequate support for Perl's extension building tools, these
511 extensions typically do not support those tools either, and therefore
512 cannot be built using the generic steps shown in the previous section.
513
514 To ensure smooth transitioning of existing code that uses the
515 ActiveState port, there is a bundle of Win32 extensions that contains
516 all of the ActiveState extensions and most other Win32 extensions from
517 CPAN in source form, along with many added bugfixes, and with MakeMaker
518 support.  This bundle is available at:
519
520    http://www.perl.com/CPAN/authors/id/GSAR/libwin32-0.14.zip
521
522 See the README in that distribution for building and installation
523 instructions.  Look for later versions that may be available at the
524 same location.
525
526 =item Running Perl Scripts
527
528 Perl scripts on UNIX use the "#!" (a.k.a "shebang") line to
529 indicate to the OS that it should execute the file using perl.
530 Win32 has no comparable means to indicate arbitrary files are
531 executables.
532
533 Instead, all available methods to execute plain text files on
534 Win32 rely on the file "extension".  There are three methods
535 to use this to execute perl scripts:
536
537 =over 8
538
539 =item 1
540
541 There is a facility called "file extension associations" that will
542 work in Windows NT 4.0.  This can be manipulated via the two
543 commands "assoc" and "ftype" that come standard with Windows NT
544 4.0.  Type "ftype /?" for a complete example of how to set this
545 up for perl scripts (Say what?  You thought Windows NT wasn't
546 perl-ready? :).
547
548 =item 2
549
550 Since file associations don't work everywhere, and there are
551 reportedly bugs with file associations where it does work, the
552 old method of wrapping the perl script to make it look like a
553 regular batch file to the OS, may be used.  The install process
554 makes available the "pl2bat.bat" script which can be used to wrap
555 perl scripts into batch files.  For example:
556
557         pl2bat foo.pl
558
559 will create the file "FOO.BAT".  Note "pl2bat" strips any
560 .pl suffix and adds a .bat suffix to the generated file.
561
562 If you use the 4DOS/NT or similar command shell, note that
563 "pl2bat" uses the "%*" variable in the generated batch file to
564 refer to all the command line arguments, so you may need to make
565 sure that construct works in batch files.  As of this writing,
566 4DOS/NT users will need a "ParameterChar = *" statement in their
567 4NT.INI file, or will need to execute "setdos /p*" in the 4DOS/NT
568 startup file to enable this to work.
569
570 =item 3
571
572 Using "pl2bat" has a few problems:  the file name gets changed,
573 so scripts that rely on C<$0> to find what they must do may not
574 run properly; running "pl2bat" replicates the contents of the
575 original script, and so this process can be maintenance intensive
576 if the originals get updated often.  A different approach that
577 avoids both problems is possible.
578
579 A script called "runperl.bat" is available that can be copied
580 to any filename (along with the .bat suffix).  For example,
581 if you call it "foo.bat", it will run the file "foo" when it is
582 executed.  Since you can run batch files on Win32 platforms simply
583 by typing the name (without the extension), this effectively
584 runs the file "foo", when you type either "foo" or "foo.bat".
585 With this method, "foo.bat" can even be in a different location
586 than the file "foo", as long as "foo" is available somewhere on
587 the PATH.  If your scripts are on a filesystem that allows symbolic
588 links, you can even avoid copying "runperl.bat".
589
590 Here's a diversion:  copy "runperl.bat" to "runperl", and type
591 "runperl".  Explain the observed behavior, or lack thereof. :)
592 Hint: .gnidnats llits er'uoy fi ,"lrepnur" eteled :tniH
593
594 =back
595
596 =item Miscellaneous Things
597
598 A full set of HTML documentation is installed, so you should be
599 able to use it if you have a web browser installed on your
600 system.
601
602 C<perldoc> is also a useful tool for browsing information contained
603 in the documentation, especially in conjunction with a pager
604 like C<less> (recent versions of which have Win32 support).  You may
605 have to set the PAGER environment variable to use a specific pager.
606 "perldoc -f foo" will print information about the perl operator
607 "foo".
608
609 If you find bugs in perl, you can run C<perlbug> to create a
610 bug report (you may have to send it manually if C<perlbug> cannot
611 find a mailer on your system).
612
613 =back
614
615 =head1 BUGS AND CAVEATS
616
617 An effort has been made to ensure that the DLLs produced by the two
618 supported compilers are compatible with each other (despite the
619 best efforts of the compiler vendors).  Extension binaries produced
620 by one compiler should also coexist with a perl binary built by
621 a different compiler.  In order to accomplish this, PERL.DLL provides
622 a layer of runtime code that uses the C Runtime that perl was compiled
623 with.  Extensions which include "perl.h" will transparently access
624 the functions in this layer, thereby ensuring that both perl and
625 extensions use the same runtime functions.
626
627 If you have had prior exposure to Perl on Unix platforms, you will notice
628 this port exhibits behavior different from what is documented.  Most of the
629 differences fall under one of these categories.  We do not consider
630 any of them to be serious limitations (especially when compared to the
631 limited nature of some of the Win32 OSes themselves :)
632
633 =over 8
634
635 =item *
636
637 C<stat()> and C<lstat()> functions may not behave as documented.  They
638 may return values that bear no resemblance to those reported on Unix
639 platforms, and some fields (like the the one for inode) may be completely
640 bogus.
641
642 =item *
643
644 The following functions are currently unavailable: C<fork()>,
645 C<dump()>, C<chown()>, C<link()>, C<symlink()>, C<chroot()>,
646 C<setpgrp()> and related security functions, C<setpriority()>,
647 C<getpriority()>, C<syscall()>, C<fcntl()>, C<getpw*()>,
648 C<msg*()>, C<shm*()>, C<sem*()>, C<alarm()>, C<socketpair()>,
649 C<*netent()>, C<*protoent()>, C<*servent()>, C<*hostent()>,
650 C<getnetby*()>.
651 This list is possibly incomplete.
652
653 =item *
654
655 Various C<socket()> related calls are supported, but they may not
656 behave as on Unix platforms.
657
658 =item *
659
660 The four-argument C<select()> call is only supported on sockets.
661
662 =item *
663
664 The C<ioctl()> call is only supported on sockets (where it provides the
665 functionality of ioctlsocket() in the Winsock API).
666
667 =item *
668
669 Failure to spawn() a subprocess is indicated by setting $? to "255 << 8".
670 C<$?> is set in a way compatible with Unix (i.e. the exitstatus of the
671 subprocess is obtained by "$? >> 8", as described in the documentation).
672
673 =item *
674
675 You can expect problems building modules available on CPAN if you
676 build perl itself with -DUSE_THREADS.  These problems should be resolved
677 as we get closer to 5.005.
678
679 =item *
680
681 C<utime()>, C<times()> and process-related functions may not
682 behave as described in the documentation, and some of the
683 returned values or effects may be bogus.
684
685 =item *
686
687 Signal handling may not behave as on Unix platforms (where it
688 doesn't exactly "behave", either :).  For instance, calling C<die()>
689 or C<exit()> from signal handlers will cause an exception, since most
690 implementations of C<signal()> on Win32 are severely crippled.
691 Thus, signals may work only for simple things like setting a flag
692 variable in the handler.  Using signals under this port should
693 currently be considered unsupported.
694
695 =item *
696
697 C<kill()> is implemented, but doesn't have the semantics of
698 C<raise()>, i.e. it doesn't send a signal to the identified process
699 like it does on Unix platforms.  Instead it immediately calls
700 C<TerminateProcess(process,signal)>.  Thus the signal argument is
701 used to set the exit-status of the terminated process.  In particular,
702 C<kill(0,$pid)> will kill the process identified by C<$pid> (unlike
703 on Unix).  This behavior may change in future.
704
705 =item *
706
707 File globbing may not behave as on Unix platforms.  In particular,
708 if you don't use perlglob.bat for globbing, it will understand
709 wildcards only in the filename component (and not in the pathname).
710 In other words, something like "print <*/*.pl>" will not print all the
711 perl scripts in all the subdirectories one level under the current one
712 (like it does on UNIX platforms).  perlglob.exe is also dependent on
713 the particular implementation of wildcard expansion in the vendor
714 libraries used to build it (which varies wildly at the present time).
715 Using perlglob.bat (or File::DosGlob) avoids these limitations, but
716 still only provides DOS semantics (read "warts") for globbing.
717
718 =back
719
720 Please send detailed descriptions of any problems and solutions that 
721 you may find to <F<perlbug@perl.com>>, along with the output produced
722 by C<perl -V>.
723
724 =head1 AUTHORS
725
726 =over 4
727
728 Gary Ng E<lt>71564.1743@CompuServe.COME<gt>
729
730 Gurusamy Sarathy E<lt>gsar@activestate.comE<gt>
731
732 Nick Ing-Simmons E<lt>nick@ni-s.u-net.comE<gt>
733
734 =back
735
736 This document is maintained by Gurusamy Sarathy.
737
738 =head1 SEE ALSO
739
740 L<perl>
741
742 =head1 HISTORY
743
744 This port was originally contributed by Gary Ng around 5.003_24,
745 and borrowed from the Hip Communications port that was available
746 at the time.  Various people have made numerous and sundry hacks
747 since then.
748
749 Borland support was added in 5.004_01 (Gurusamy Sarathy).
750
751 GCC/mingw32 support was added in 5.005 (Nick Ing-Simmons).
752
753 Support for PERL_OBJECT was added in 5.005 (ActiveState Tool Corp).
754
755 Support for fork() emulation was added in 5.6 (ActiveState Tool Corp).
756
757 Win9x support was added in 5.6 (Benjamin Stuhl).
758
759 Last updated: 28 December 1999
760
761 =cut