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