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