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