This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Configure update.
[perl5.git] / README.win32
index 3727b2c..35c8100 100644 (file)
@@ -9,8 +9,7 @@ perlwin32 - Perl under Win32
 =head1 SYNOPSIS
 
 These are instructions for building Perl under Windows NT (versions
-3.51 or 4.0), using Visual C++ (versions 2.0 through 5.0) or Borland
-C++ (version 5.02 or later).  Currently, this port is reported to build
+3.51 or 4.0).  Currently, this port is reported to build
 under Windows95 using the 4DOS shell--the default shell that infests
 Windows95 will not work (see below).  Note this caveat is only about
 B<building> perl.  Once built, you should be able to B<use> it on
@@ -43,10 +42,16 @@ run-time support software described in those files.
 This set of instructions is meant to describe a so-called "native"
 port of Perl to Win32 platforms.  The resulting Perl requires no
 additional software to run (other than what came with your operating
-system).  Currently, this port is capable of using either the
-Microsoft Visual C++ compiler, or the Borland C++ compiler.  The
-ultimate goal is to support the other major compilers that can
-generally be used to build Win32 applications.
+system).  Currently, this port is capable of using one of the
+following compilers:
+
+      Borland C++              version 5.02 or later
+      Microsoft Visual C++     version 4.2 or later
+      Mingw32 with EGCS                versions 1.0.2, 1.1
+      Mingw32 with GCC         version 2.8.1
+
+The last two of these are high quality freeware compilers.  Support
+for them is still experimental.
 
 This port currently supports MakeMaker (the set of modules that
 is used to build extensions to perl).  Therefore, you should be
@@ -65,7 +70,7 @@ If the build fails under that shell, try building again with the cmd
 shell.  The Makefile also has known incompatibilites with the "command.com"
 shell that comes with Windows95, so building under Windows95 should
 be considered "unsupported".  However, there have been reports of successful
-build attempts using 4DOS/NT version 3.00 under Windows95, using dmake, but
+build attempts using 4DOS/NT version 6.01 under Windows95, using dmake, but
 your mileage may vary.
 
 The surest way to build it is on WindowsNT, using the cmd shell.
@@ -87,10 +92,8 @@ in the README.NOW file).
 =item Microsoft Visual C++
 
 The NMAKE that comes with Visual C++ will suffice for building.
-If you did not choose to always initialize the Visual C++ compilation
-environment variables when you installed Visual C++ on your system, you
-will need to run the VCVARS32.BAT file usually found somewhere like
-C:\MSDEV4.2\BIN.  This will set your build environment.
+You will need to run the VCVARS32.BAT file usually found somewhere
+like C:\MSDEV4.2\BIN.  This will set your build environment.
 
 You can also use dmake to build using Visual C++, provided:
 you set OSRELEASE to "microsft" (or whatever the directory name
@@ -99,17 +102,24 @@ and edit win32/config.vc to change "make=nmake" into "make=dmake".  The
 latter step is only essential if you want to use dmake as your default
 make for building extensions using MakeMaker.
 
-=item Permissions
+=item Mingw32 with EGCS or GCC
+
+ECGS-1.0.2 binaries can be downloaded from:
+
+    ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/
+
+GCC-2.8.1 binaries are available from:
 
-Depending on how you extracted the distribution, you have to make sure
-some of the files are writable by you.  The easiest way to make sure of
-this is to execute:
+    http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/
 
-       attrib -R *.* /S
+You only need either one of those, not both.  Both bundles come with
+Mingw32 libraries and headers.  While both of them work to build perl,
+the EGCS binaries are currently favored by the maintainers, since they
+come with more up-to-date Mingw32 libraries.
 
-from the perl toplevel directory.  You don't I<have> to do this if you
-used the right tools to extract the files in the standard distribution,
-but it doesn't hurt to do so.
+Make sure you install the binaries as indicated in the web sites
+above.  You will need to set up a few environment variables (usually
+run from a batch file).
 
 =back
 
@@ -121,18 +131,37 @@ but it doesn't hurt to do so.
 
 Make sure you are in the "win32" subdirectory under the perl toplevel.
 This directory contains a "Makefile" that will work with
-versions of NMAKE that come with Visual C++ ver. 2.0 and above, and
-a dmake "makefile.mk" that will work for both Borland and Visual C++
-builds.  The defaults in the dmake makefile are setup to build using the
-Borland compiler.
+versions of NMAKE that come with Visual C++, and a dmake "makefile.mk"
+that will work for all supported compilers.  The defaults in the dmake
+makefile are setup to build using the Borland compiler.
 
 =item *
 
-Edit the Makefile (or makefile.mk, if using dmake) and change the values
-of INST_DRV and INST_TOP.  If you are using Visual C++ ver. 2.0, uncomment
-the line that sets "CCTYPE=MSVC20".  You can also enable various build
+Edit the makefile.mk (or Makefile, if using nmake) and change the values
+of INST_DRV and INST_TOP.   You can also enable various build
 flags.
 
+Beginning with version 5.005, there is experimental support for building
+a perl interpreter that supports the Perl Object abstraction (courtesy
+ActiveState Tool Corp.)  PERL_OBJECT uses C++, and the binaries are
+therefore incompatible with the regular C build.  However, the
+PERL_OBJECT build does provide something called the C-API, for linking
+it with extensions that won't compile under PERL_OBJECT.  PERL_OBJECT
+is not yet supported under GCC or EGCS.  WARNING:  Binaries built with
+PERL_OBJECT enabled are B<not> compatible with binaries built without.
+Perl installs PERL_OBJECT binaries under a distinct architecture name,
+so they B<can> coexist, though.
+
+Beginning with version 5.005, there is experimental support for building
+a perl interpreter that is capable of native threading.  Binaries built
+with thread support enabled are also incompatible with the vanilla C
+build.  WARNING:  Binaries built with threads enabled are B<not> compatible
+with binaries built without.  Perl installs threads enabled binaries under
+a distinct architecture name, so they B<can> coexist, though.
+
+At the present time, you cannot enable both threading and PERL_OBJECT.
+You can get only one of them in a Perl interpreter.
+
 If you have either the source or a library that contains des_fcrypt(),
 enable the appropriate option in the makefile.  des_fcrypt() is not
 bundled with the distribution due to US Government restrictions
@@ -142,7 +171,12 @@ available worldwide, usually along with SSLeay (for example:
 "ftp://fractal.mta.ca/pub/crypto/SSLeay/DES/").  Set CRYPT_SRC to the
 name of the file that implements des_fcrypt().  Alternatively, if
 you have built a library that contains des_fcrypt(), you can set
-CRYPT_LIB to point to the library name.
+CRYPT_LIB to point to the library name.  The location above contains
+many versions of the "libdes" library, all with slightly different
+implementations of des_fcrypt().  Older versions have a single,
+self-contained file (fcrypt.c) that implements crypt(), so they may be
+easier to use.  A patch against the fcrypt.c found in libdes-3.06 is
+in des_fcrypt.patch.
 
 Perl will also build without des_fcrypt(), but the crypt() builtin will
 fail at run time.
@@ -150,14 +184,17 @@ fail at run time.
 You will also have to make sure CCHOME points to wherever you installed
 your compiler.
 
+Other options are explained in the makefiles.  Be sure to read the
+instructions carefully.
+
 =item *
 
-Type "nmake" (or "dmake" if you are using that make).
+Type "dmake" (or "nmake" if you are using that make).
 
 This should build everything.  Specifically, it will create perl.exe,
-perl.dll, and perlglob.exe at the perl toplevel, and various other
-extension dll's under the lib\auto directory.  If the build fails for
-any reason, make sure you have done the previous steps correctly.
+perl.dll (or perlcore.dll), and perlglob.exe at the perl toplevel, and
+various other extension dll's under the lib\auto directory.  If the build
+fails for any reason, make sure you have done the previous steps correctly.
 
 The build process may produce "harmless" compiler warnings (more or
 less copiously, depending on how picky your compiler gets).  The
@@ -182,7 +219,7 @@ in that case).
 
 =head2 Testing
 
-Type "nmake test" (or "dmake test").  This will run most of the tests from
+Type "dmake test" (or "nmake test").  This will run most of the tests from
 the testsuite (many tests will be skipped, and but no test should fail).
 
 If some tests do fail, it may be because you are using a different command
@@ -194,16 +231,25 @@ default path.  You will need to copy the DLLs reported by the messages
 from where Borland chose to install it, into the Windows system directory
 (usually somewhere like C:\WINNT\SYSTEM32), and rerun the test.
 
+The Visual C runtime apparently has a bug that causes posix.t to fail
+test#2.  This usually happens only if you extracted the files in text
+mode.  Enable the USE_PERLCRT option in the Makefile to fix this bug.
+
 Please report any other failures as described under L<BUGS AND CAVEATS>.
 
 =head2 Installation
 
-Type "nmake install" (or "dmake install").  This will put the newly
+Type "dmake install" (or "nmake install").  This will put the newly
 built perl and the libraries under whatever C<INST_TOP> points to in the
 Makefile.  It will also install the pod documentation under
-C<$INST_TOP\lib\pod> and HTML versions of the same under
-C<$INST_TOP\lib\pod\html>.  To use the Perl you just installed,
-set your PATH environment variable to C<$INST_TOP\bin>.
+C<$INST_TOP\$VERSION\lib\pod> and HTML versions of the same under
+C<$INST_TOP\$VERSION\lib\pod\html>.  To use the Perl you just installed,
+you will need to add two components to your PATH environment variable,
+C<$INST_TOP\$VERSION\bin>, and C<$INST_TOP\$VERSION\bin\$ARCHNAME>.
+For example:
+
+    set PATH c:\perl\5.005\bin;c:\perl\5.005\bin\MSWin32-x6;%PATH%
+
 
 =head2 Usage Hints
 
@@ -223,8 +269,21 @@ variables you can set in L<perlrun>.
 You can also control the shell that perl uses to run system() and
 backtick commands via PERL5SHELL.  See L<perlrun>.
 
-Sometime in the future, some of the configuration information
-for perl will be moved into the Windows registry.
+Perl does not depend on the registry, but it can look up certain default
+values if you choose to put them there.  Perl attempts to read entries from
+C<HKEY_CURRENT_USER\Software\Perl> and C<HKEY_LOCAL_MACHINE\Software\Perl>.
+Entries in the former override entries in the latter.  One or more of the
+following entries (of type REG_SZ or REG_EXPAND_SZ) may be set:
+
+    lib-$]             version-specific path to add to @INC
+    lib                        path to add to @INC
+    sitelib-$]         version-specific path to add to @INC
+    sitelib            path to add to @INC
+    PERL*              fallback for all %ENV lookups that begin with "PERL"
+
+Note the C<$]> in the above is not literal.  Substitute whatever version
+of perl you want to honor that entry, e.g. C<5.00502>.  Paths must be
+separated with semicolons, as usual on win32.
 
 =item File Globbing
 
@@ -237,16 +296,17 @@ perlglob.bat.
 perlglob.exe relies on the argv expansion done by the C Runtime of
 the particular compiler you used, and therefore behaves very
 differently depending on the Runtime used to build it.  To preserve
-compatiblity, perlglob.bat (a perl script/module that can be
-used portably) is installed.  Besides being portable, perlglob.bat
-also offers enhanced globbing functionality.
+compatiblity, perlglob.bat (a perl script that can be used portably)
+is installed.  Besides being portable, perlglob.bat also offers
+enhanced globbing functionality.
 
 If you want perl to use perlglob.bat instead of perlglob.exe, just
 delete perlglob.exe from the install location (or move it somewhere
-perl cannot find).  Using File::DosGlob.pm (which is the same
-as perlglob.bat) to override the internal CORE::glob() works about 10
-times faster than spawing perlglob.exe, and you should take this
-approach when writing new modules.  See File::DosGlob for details.
+perl cannot find).  Using File::DosGlob.pm (which implements the core
+functionality of perlglob.bat) to override the internal CORE::glob()
+works about 10 times faster than spawing perlglob.exe, and you should
+take this approach when writing new modules.  See File::DosGlob for
+details.
 
 =item Using perl from the command line
 
@@ -344,6 +404,59 @@ it looks like the extension building support is at fault, report
 that with full details of how the build failed using the perlbug
 utility.
 
+=item Command-line Wildcard Expansion
+
+The default command shells on DOS descendant operating systems (such
+as they are) usually do not expand wildcard arguments supplied to
+programs.  They consider it the application's job to handle that.
+This is commonly achieved by linking the application (in our case,
+perl) with startup code that the C runtime libraries usually provide.
+However, doing that results in incompatible perl versions (since the
+behavior of the argv expansion code differs depending on the
+compiler, and it is even buggy on some compilers).  Besides, it may
+be a source of frustration if you use such a perl binary with an
+alternate shell that *does* expand wildcards.
+
+Instead, the following solution works rather well. The nice things
+about it: 1) you can start using it right away 2) it is more powerful,
+because it will do the right thing with a pattern like */*/*.c
+3) you can decide whether you do/don't want to use it 4) you can
+extend the method to add any customizations (or even entirely
+different kinds of wildcard expansion).
+
+       C:\> copy con c:\perl\lib\Wild.pm
+       # Wild.pm - emulate shell @ARGV expansion on shells that don't
+       use File::DosGlob;
+       @ARGV = map {
+                     my @g = File::DosGlob::glob($_) if /[*?]/;
+                     @g ? @g : $_;
+                   } @ARGV;
+       1;
+       ^Z
+       C:\> set PERL5OPT=-MWild
+       C:\> perl -le "for (@ARGV) { print }" */*/perl*.c
+       p4view/perl/perl.c
+       p4view/perl/perlio.c
+       p4view/perl/perly.c
+       perl5.005/win32/perlglob.c
+       perl5.005/win32/perllib.c
+       perl5.005/win32/perlglob.c
+       perl5.005/win32/perllib.c
+       perl5.005/win32/perlglob.c
+       perl5.005/win32/perllib.c
+
+Note there are two distinct steps there: 1) You'll have to create
+Wild.pm and put it in your perl lib directory. 2) You'll need to
+set the PERL5OPT environment variable.  If you want argv expansion
+to be the default, just set PERL5OPT in your default startup
+environment.
+
+If you are using the Visual C compiler, you can get the C runtime's
+command line wildcard expansion built into perl binary.  The resulting
+binary will always expand unquoted command lines, which may not be
+what you want if you use a shell that does that for you.  The expansion
+done is also somewhat less powerful than the approach suggested above.
+
 =item Win32 Specific Extensions
 
 A number of extensions specific to the Win32 platform are available
@@ -355,22 +468,17 @@ extensions typically do not support those tools either, and therefore
 cannot be built using the generic steps shown in the previous section.
 
 To ensure smooth transitioning of existing code that uses the
-Activeware port, there is a bundle of Win32 extensions that contains
-all of the Activeware extensions and most other Win32 extensions from
+ActiveState port, there is a bundle of Win32 extensions that contains
+all of the ActiveState extensions and most other Win32 extensions from
 CPAN in source form, along with many added bugfixes, and with MakeMaker
 support.  This bundle is available at:
 
-   http://www.perl.com/CPAN/authors/id/GSAR/libwin32-0.09.tar.gz
+   http://www.perl.com/CPAN/authors/id/GSAR/libwin32-0.12.zip
 
 See the README in that distribution for building and installation
 instructions.  Look for later versions that may be available at the
 same location.
 
-It is expected that authors of Win32 specific extensions will begin
-distributing their work in MakeMaker compatible form subsequent to
-the 5.004 release of perl, at which point the need for a dedicated
-bundle such as the above should diminish.
-
 =item Running Perl Scripts
 
 Perl scripts on UNIX use the "#!" (a.k.a "shebang") line to
@@ -462,16 +570,6 @@ find a mailer on your system).
 
 =head1 BUGS AND CAVEATS
 
-This port should be considered beta quality software at the present
-time because some details are still in flux and there may be
-changes in any of these areas: build process, installation structure,
-supported utilities/modules, and supported perl functionality.
-In particular, functionality specific to the Win32 environment may
-ultimately be supported as either core modules or extensions.  The
-beta status implies, among other things, that you should be prepared
-to recompile extensions when binary incompatibilites arise due to
-changes in the internal structure of the code.
-
 An effort has been made to ensure that the DLLs produced by the two
 supported compilers are compatible with each other (despite the
 best efforts of the compiler vendors).  Extension binaries produced
@@ -503,9 +601,9 @@ The following functions are currently unavailable: C<fork()>,
 C<dump()>, C<chown()>, C<link()>, C<symlink()>, C<chroot()>,
 C<setpgrp()> and related security functions, C<setpriority()>,
 C<getpriority()>, C<syscall()>, C<fcntl()>, C<getpw*()>,
-C<wait*()>, C<msg*()>, C<shm*()>, C<sem*()>, C<alarm()>,
-C<socketpair()>, C<*netent()>, C<*protoent()>, C<*servent()>,
-C<*hostent()>, C<getnetby*()>.
+C<msg*()>, C<shm*()>, C<sem*()>, C<alarm()>, C<socketpair()>,
+C<*netent()>, C<*protoent()>, C<*servent()>, C<*hostent()>,
+C<getnetby*()>.
 This list is possibly incomplete.
 
 =item *
@@ -524,10 +622,9 @@ functionality of ioctlsocket() in the Winsock API).
 
 =item *
 
-C<$?> ends up with the exitstatus of the subprocess (this is different
-from Unix, where the exitstatus is actually given by "$? >> 8").
-Failure to spawn() the subprocess is indicated by setting $? to 
-"255<<8".  This is subject to change.
+Failure to spawn() a subprocess is indicated by setting $? to "255 << 8".
+C<$?> is set in a way compatible with Unix (i.e. the exitstatus of the
+subprocess is obtained by "$? >> 8", as described in the documentation).
 
 =item *
 
@@ -553,6 +650,15 @@ currently be considered unsupported.
 
 =item *
 
+C<kill()> is implemented, but doesn't have the semantics of
+C<raise()>, i.e. it doesn't send a signal to the identified process
+like it does on Unix platforms.  Instead it immediately calls
+C<TerminateProcess(process,signal)>.  Thus the signal argument is
+used to set the exit-status of the terminated process.  This behavior
+may change in future.
+
+=item *
+
 File globbing may not behave as on Unix platforms.  In particular,
 if you don't use perlglob.bat for globbing, it will understand
 wildcards only in the filename component (and not in the pathname).
@@ -599,7 +705,9 @@ sundry hacks since then.
 
 Borland support was added in 5.004_01 (Gurusamy Sarathy).
 
-Last updated: 23 December 1997
+GCC/mingw32 support was added in 5.005 (Nick Ing-Simmons).
+
+Last updated: 22 September 1998
 
 =cut