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