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