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