change#2572 is not applicable; undo, retaining scan_bin addition
[p5sagit/p5-mst-13.2.git] / README.win32
index fbcfe3c..099c881 100644 (file)
@@ -47,7 +47,7 @@ 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 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
@@ -70,11 +70,14 @@ 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.
 
+Make sure the path to the build directory does not contain spaces.  The
+build usually works in this circumstance, but some tests will fail.
+
 =item Borland C++
 
 If you are using the Borland compiler, you will need dmake, a freely
@@ -147,12 +150,17 @@ 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.
+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.
+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.
@@ -166,13 +174,25 @@ 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.
 
 You will also have to make sure CCHOME points to wherever you installed
-your compiler.
+your compiler.  Make sure this path has no spaces in it.  If you
+insist on spaces in your path names, there is no telling what else
+will fail, but you can try putting the path in double quotes.  Some
+parts of perl try to accomodate that, but not all pieces do.
+
+The default value for CCHOME in the makefiles for Visual C++
+may not be correct if you have a version later than 5.2.  Make
+sure the default exists and is valid.
 
 Other options are explained in the makefiles.  Be sure to read the
 instructions carefully.
@@ -201,9 +221,9 @@ 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
-in that case).
+You can avoid the perl95.exe problems completely if you either enable
+USE_PERLCRT with Visual C++, or use Borland C++ for building perl.  In
+those cases, perl95.exe is not needed and will not be built.
 
 =back
 
@@ -213,17 +233,18 @@ 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
-shell than the native "cmd.exe".
+shell than the native "cmd.exe", or because you are building from a path
+that contains spaces.  So don't do that.
 
-If you used the Borland compiler, you may see a failure in op/taint.t
+If you're using the Borland compiler, you may see a failure in op/taint.t
 arising from the inability to find the Borland Runtime DLLs on the system
 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.
+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>.
 
@@ -259,9 +280,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>.
 
-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.]
+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
 
@@ -382,6 +415,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
@@ -398,7 +484,7 @@ 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.12.zip
+   http://www.perl.com/CPAN/authors/id/GSAR/libwin32-0.14.zip
 
 See the README in that distribution for building and installation
 instructions.  Look for later versions that may be available at the
@@ -575,6 +661,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).
@@ -621,7 +716,9 @@ sundry hacks since then.
 
 Borland support was added in 5.004_01 (Gurusamy Sarathy).
 
-Last updated: 12 July 1998
+GCC/mingw32 support was added in 5.005 (Nick Ing-Simmons).
+
+Last updated: 29 November 1998
 
 =cut