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