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