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