Mingw32 PERL_OBJECT tweaks
[p5sagit/p5-mst-13.2.git] / README.win32
index aafb1cc..3ba6d2e 100644 (file)
@@ -9,10 +9,9 @@ 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.x).  Currently, this port may also build under Windows95,
-but you can expect problems stemming from the unmentionable command
-shell that infests that platform.  Note this caveat is only about
+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
 either Win32 platform (modulo the problems arising from the inferior
 command shell).
@@ -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                version 1.0.2
+      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
@@ -59,54 +64,62 @@ See L<Usage Hints> below for general hints about this.
 
 =item Command Shell
 
-Use the default "cmd" shell that comes with NT.  In particular, do
-*not* use the 4DOS/NT shell.  The Makefile has commands that are not
-compatible with that shell.  The Makefile also has known
-incompatibilites with the default shell that comes with Windows95,
-so building under Windows95 should be considered "unsupported".
+Use the default "cmd" shell that comes with NT.  Some versions of the
+popular 4DOS/NT shell have incompatibilities that may cause you trouble.
+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
+your mileage may vary.
+
+The surest way to build it is on WindowsNT, using the cmd shell.
 
 =item Borland C++
 
 If you are using the Borland compiler, you will need dmake, a freely
 available make that has very nice macro features and parallelability.
 (The make that Borland supplies is seriously crippled, and will not
-work for MakeMaker builds--if you *have* to bug someone about this,
-I suggest you bug Borland to fix their make :)
+work for MakeMaker builds.)
 
-A port of dmake for win32 platforms is available from
-"http://www-personal.umich.edu/~gsar/dmake-4.0-win32.tar.gz".
-Fetch and install dmake somewhere on your path.  Also make sure you
-copy the Borland dmake.ini file to some location where you keep
-*.ini files.  If you use the binary that comes with the above port, you
-will need to set INIT in your environment to the directory where you
-put the dmake.ini file.
+A port of dmake for win32 platforms is available from:
+
+    http://www-personal.umich.edu/~gsar/dmake-4.1-win32.zip
+
+Fetch and install dmake somewhere on your path (follow the instructions
+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
+under which the Visual C dmake configuration lives) in your environment,
+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.
 
-You can also use dmake to build using Visual C++, provided: you
-copied the dmake.ini for Visual C++; set INIT to point to the
-directory where you put it, as above; and edit win32/config.vc
-and change "make=nmake" to "make=dmake".  The last step is only
-essential if you want to use dmake to be your default make for
-building extensions using MakeMaker.
+=item Mingw32 with EGCS or GCC
 
-=item Permissions
+ECGS-1.0.2 binaries can be downloaded 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:
+    ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/
 
-       attrib -R *.* /S
+GCC-2.8.1 binaries are available from:
 
-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.
+    http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/
+
+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.
+
+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
 
@@ -118,29 +131,60 @@ 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 want perl to be installed in a location
-other than "C:\PERL".  If you are using Visual C++ ver. 2.0, uncomment
-the line that sets "CCTYPE=MSVC20".
+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
+cannot be enabled when using GCC or EGCS, yet.
+
+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.
+
+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
+on the export of cryptographic software.  Nevertheless, this routine
+is part of the "libdes" library (written by Ed Young) which is widely
+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.
+
+Perl will also build without des_fcrypt(), but the crypt() builtin will
+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
@@ -150,12 +194,12 @@ When building using Visual C++, a perl95.exe will also get built.  This
 executable is only needed on Windows95, and should be used instead of
 perl.exe, and then only if you want sockets to work properly on Windows95.
 This is necessitated by a bug in the Microsoft C Runtime that cannot be
-worked around in the "normal" perl.exe.  Again, if this bugs you, please
-bug Microsoft :). perl95.exe gets built with its own private copy of the
-C Runtime that is not accessible to extensions (which see the DLL version
-of the CRT).  Be aware, therefore, that this perl95.exe will have
-esoteric problems with extensions like perl/Tk that themselves use the C
-Runtime heavily, or want to free() pointers malloc()-ed by perl.
+worked around in the "normal" perl.exe.  perl95.exe gets built with its
+own private copy of the C Runtime that is not accessible to extensions
+(which see the DLL version of the CRT).  Be aware, therefore, that this
+perl95.exe will have esoteric problems with extensions like perl/Tk that
+themselves use the C Runtime heavily, or want to free() pointers
+malloc()-ed by perl.
 
 You can avoid the perl95.exe problems completely if you use Borland
 C++ for building perl (perl95.exe is not needed and will not be built
@@ -165,7 +209,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
@@ -177,17 +221,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
+one it test#2.  This usually happens only if you extracted the files in
+text mode.
+
 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
-built perl and the libraries under "C:\perl" (actually whatever you set
-C<INST_TOP> 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:\perl\bin" (or C<$INST_TOP\bin>,
-if you changed the default as above).
+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\$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
 
@@ -202,10 +254,14 @@ using that perl (except add its location to your PATH variable).
 If you put extensions in unusual places, you can set PERL5LIB
 to a list of paths separated by semicolons where you want perl
 to look for libraries.  Look for descriptions of other environment
-variables you can set in the perlrun podpage.
+variables you can set in L<perlrun>.
 
-Sometime in the future, some of the configuration information
-for perl will be moved into the Windows registry.
+You can also control the shell that perl uses to run system() and
+backtick commands via PERL5SHELL.  See L<perlrun>.
+
+Currently, Perl does not depend on the registry, but can look up
+values if you choose to put them there.  [XXX add registry locations
+that perl looks at here.]
 
 =item File Globbing
 
@@ -218,16 +274,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
 
@@ -294,7 +351,7 @@ This pipes "foo" to the pager and writes "bar" in the file "blurch":
     perl -e "print 'foo'; print STDERR 'bar'" 2> blurch | less
 
 
-Discovering the usefullness of the "command.com" shell on Windows95
+Discovering the usefulness of the "command.com" shell on Windows95
 is left as an exercise to the reader :)
 
 =item Building Extensions
@@ -336,22 +393,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.08.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
@@ -443,16 +495,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
@@ -482,14 +524,12 @@ bogus.
 
 The following functions are currently unavailable: C<fork()>,
 C<dump()>, C<chown()>, C<link()>, C<symlink()>, C<chroot()>,
-C<setpgrp()>, C<getpgrp()>, C<setpriority()>, C<getpriority()>,
-C<syscall()>, C<fcntl()>.  This list is possibly very incomplete.
-
-=item *
-
-crypt() is not available due to silly export restrictions.  It may
-become available when the laws change.  Meanwhile, look in CPAN for
-extensions that provide it.
+C<setpgrp()> and related security functions, C<setpriority()>,
+C<getpriority()>, C<syscall()>, C<fcntl()>, C<getpw*()>,
+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 *
 
@@ -502,16 +542,20 @@ The four-argument C<select()> call is only supported on sockets.
 
 =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.
+The C<ioctl()> call is only supported on sockets (where it provides the
+functionality of ioctlsocket() in the Winsock API).
 
 =item *
 
-Building modules available on CPAN is mostly supported, but this
-hasn't been tested much yet.  Expect strange problems, and be
-prepared to deal with the consequences.
+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 *
+
+You can expect problems building modules available on CPAN if you
+build perl itself with -DUSE_THREADS.  These problems should be resolved
+as we get closer to 5.005.
 
 =item *
 
@@ -531,6 +575,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).
@@ -577,7 +630,7 @@ sundry hacks since then.
 
 Borland support was added in 5.004_01 (Gurusamy Sarathy).
 
-Last updated: 25 July 1997
+Last updated: 12 July 1998
 
 =cut