This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade to Math::BigInt 1.54.
[perl5.git] / README.cygwin
index 9718bb5..796197a 100644 (file)
@@ -13,12 +13,12 @@ on Cygwin.  This document also describes features of Cygwin that will
 affect how Perl behaves at runtime.
 
 B<NOTE:> There are pre-built Perl packages available for Cygwin and a
-version of Perl is provided on the Cygwin CD.  If you do not need to
-customize the configuration, consider using one of these packages:
+version of Perl is provided in the normal Cygwin install.  If you do
+not need to customize the configuration, consider using one of those
+packages.
 
-  http://cygutils.netpedia.net/
 
-=head1 PREREQUISITES
+=head1 PREREQUISITES FOR COMPILING PERL ON CYGWIN
 
 =head2 Cygwin = GNU+Cygnus+Windows (Don't leave UNIX without it)
 
@@ -27,19 +27,12 @@ platforms.  They run thanks to the Cygwin library which provides the UNIX
 system calls and environment these programs expect.  More information
 about this project can be found at:
 
-  http://sources.redhat.com/cygwin/
+  http://www.cygwin.com/
 
 A recent net or commercial release of Cygwin is required.
 
-At the time this document was last updated, Cygwin 1.1.4 was current.
+At the time this document was last updated, Cygwin 1.3.9 was current.
 
-B<NOTE:> At this point, minimal effort has been made to provide
-compatibility with old (beta) Cygwin releases.  The focus has been to
-provide a high quality release and not worry about working around old
-bugs.  If you wish to use Perl with Cygwin B20.1 or earlier, consider
-using perl5.005_03, which is available in source and binary form at
-C<http://cygutils.netpedia.net/>.  If there is significant demand,
-a patch kit can be developed to port back to earlier Cygwin versions.
 
 =head2 Cygwin Configuration
 
@@ -84,7 +77,7 @@ a UNIX system.
 
 =back
 
-=head1 CONFIGURE
+=head1 CONFIGURE PERL ON CYGWIN
 
 The default options gathered by Configure with the assistance of
 F<hints/cygwin.sh> will build a Perl that supports dynamic loading
@@ -97,7 +90,7 @@ This will run Configure and keep a record:
 If you are willing to accept all the defaults run Configure with B<-de>.
 However, several useful customizations are available.
 
-=head2 Strip Binaries
+=head2 Stripping Perl Binaries on Cygwin
 
 It is possible to strip the EXEs and DLLs created by the build process.
 The resulting binaries will be significantly smaller.  If you want the
@@ -112,13 +105,13 @@ prompts you,
 or you can edit F<hints/cygwin.sh> and uncomment the relevant variables
 near the end of the file.
 
-=head2 Optional Libraries
+=head2 Optional Libraries for Perl on Cygwin
 
 Several Perl functions and modules depend on the existence of
 some optional libraries.  Configure will find them if they are
 installed in one of the directories listed as being used for library
-searches.  Pre-built packages for most of these are available at
-C<http://cygutils.netpedia.net/>.
+searches.  Pre-built packages for most of these are available from
+the Cygwin installer.
 
 =over 4
 
@@ -131,22 +124,18 @@ Alternatively, the crypt libraries in GNU libc have been ported to Cygwin.
 
 The DES based Ultra Fast Crypt port was done by Alexey Truhan:
 
-  ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/cw32crypt-dist-0.tgz
+  ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/cw32crypt-dist-0.tgz
 
 NOTE: There are various export restrictions on DES implementations,
 see the glibc README for more details.
 
 The MD5 port was done by Andy Piper:
 
-  ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz
+  ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz
 
 =item * C<-lgdbm> (C<use GDBM_File>)
 
-GDBM is available for Cygwin.  GDBM's ndbm/dbm compatibility feature
-also makes C<NDBM_File> and C<ODBM_File> possible (although they add
-little extra value).
-
-NOTE: The ndbm/dbm emulations only completely work on NTFS partitions.
+GDBM is available for Cygwin.
 
 =item * C<-ldb> (C<use DB_File>)
 
@@ -168,7 +157,7 @@ CPAN modules).
 
 =back
 
-=head2 Configure-time Options
+=head2 Configure-time Options for Perl on Cygwin
 
 The F<INSTALL> document describes several Configure-time options.  Some of
 these will work with Cygwin, others are not yet possible.  Also, some of
@@ -186,40 +175,47 @@ Undefining this symbol forces Perl to be compiled statically.
 By default Perl uses the malloc() included with the Perl source.  If you
 want to force Perl to build with the system malloc() undefine this symbol.
 
+=item * C<-Uuseperlio>
+
+Undefining this symbol disables the PerlIO abstraction, which is now the
+default.
+
 =item * C<-Dusemultiplicity>
 
 Multiplicity is required when embedding Perl in a C program and using
 more than one interpreter instance.  This works with the Cygwin port.
 
-=item * C<-Duseperlio>
-
-The PerlIO abstraction works with the Cygwin port.
-
 =item * C<-Duse64bitint>
 
-I<gcc> supports 64-bit integers.  However, several additional long long
-functions are necessary to use them within Perl (I<{strtol,strtoul}l>).
-These are B<not> yet available with Cygwin.
+By default Perl uses 32 bit integers.  If you want to use larger 64
+bit integers, define this symbol.  If there is trouble, check that
+your Cygwin installation is up to date.
 
 =item * C<-Duselongdouble>
 
 I<gcc> supports long doubles (12 bytes).  However, several additional
 long double math functions are necessary to use them within Perl
-(I<{atan2,cos,exp,floor,fmod,frexp,isnan,log,modf,pow,sin,sqrt}l,strtold>).
+(I<{atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l, 
+strtold>).
 These are B<not> yet available with Cygwin.
 
 =item * C<-Dusethreads>
 
-POSIX threads are B<not> yet implemented in Cygwin.
+POSIX threads are B<not> yet implemented in Cygwin completely.
 
 =item * C<-Duselargefiles>
 
 Although Win32 supports large files, Cygwin currently uses 32-bit integers
 for internal size and position calculations.
 
+=item * C<-Dmksymlinks>
+
+Use this to build perl outside of the source tree.  This works with Cygwin.
+Details can be found in the F<INSTALL> document.
+
 =back
 
-=head2 Suspicious Warnings
+=head2 Suspicious Warnings on Cygwin
 
 You may see some messages during Configure that seem suspicious.
 
@@ -253,14 +249,6 @@ closed pipe.  You will see the following messages:
 At least for consistency with WinNT, you should keep the recommended
 value.
 
-=item * Checking how std your stdio is...
-
-Configure reports:
-
-  Your stdio doesn't appear very std.
-
-This is correct.
-
 =item * Compiler/Preprocessor defines
 
 The following error occurs because of the Cygwin C<#define> of
@@ -273,13 +261,13 @@ This failure does not seem to cause any problems.
 
 =back
 
-=head1 MAKE
+=head1 MAKE ON CYGWIN
 
 Simply run I<make> and wait:
 
   make 2>&1 | tee log.make
 
-=head2 Warnings
+=head2 Warnings on Cygwin
 
 Warnings like these are normal:
 
@@ -289,7 +277,7 @@ Warnings like these are normal:
   dllwrap: no export definition file provided
   dllwrap: creating one, but that may not be what you want
 
-=head2 ld2
+=head2 ld2 on Cygwin
 
 During `C<make>', I<ld2> will be created and installed in your $installbin
 directory (where you said to put public executables).  It does not
@@ -301,7 +289,7 @@ is not the case `C<make>' will fail at some point.  If this happens,
 just manually copy I<ld2> from the source directory to somewhere in
 your C<PATH>.
 
-=head1 TEST
+=head1 TEST ON CYGWIN
 
 There are two steps to running the test suite:
 
@@ -318,7 +306,7 @@ attempted and explainable test failures are documented.  It is possible
 for Perl to pass all the tests, but it is more likely that some tests
 will fail for one of the reasons listed below.
 
-=head2 File Permissions
+=head2 File Permissions on Cygwin
 
 UNIX file permissions are based on sets of mode bits for
 {read,write,execute} for each {user,group,other}.  By default Cygwin
@@ -344,71 +332,7 @@ these options, these tests will fail:
   lib/sdbm.t            2
   op/stat.t             9, 20 (.tmp not an executable extension)
 
-=head2 Hard Links
-
-FAT partitions do not support hard links (whereas NTFS does), in which
-case Cygwin implements link() by copying the file.  On remote (network)
-drives Cygwin's stat() always sets C<st_nlink> to 1, so the link count
-for remote directories and files is not available.  In either case,
-these tests will fail:
-
-  Failed Test           List of failed
-  ------------------------------------
-  io/fs.t               4
-  op/stat.t             3
-
-=head2 Filetime Granularity
-
-On FAT partitions the filetime granularity is 2 seconds.  The following
-test will fail:
-
-  Failed Test           List of failed
-  ------------------------------------
-  io/fs.t               18
-
-=head2 Tainting Checks
-
-When Perl is running in taint mode, C<$ENV{PATH}> is considered tainted
-and not used, so DLLs not in the default system directories will not
-be found.  While the tests are running you will see warnings popup from
-the system with messages like:
-
-  Win9x
-    Error Starting Program
-    A required .DLL file, CYGWIN1.DLL, was not found
-
-  WinNT
-    perl.exe - Unable to Locate DLL
-    The dynamic link library cygwin1.dll could not be found in the
-      specified path ...
-
-Just click OK and ignore them.  When running `C<make test>', 2 popups
-occur.  During `C<./perl harness>', 4 popups occur.  Also, these tests
-will fail:
-
-  Failed Test           List of failed
-  ------------------------------------
-  op/taint.t            1, 3, 31, 37
-
-Alternatively, you can copy F<cygwin1.dll> into the directory where the
-tests run:
-
-  cp /bin/cygwin1.dll t
-
-or one of the Windows system directories (although, this is B<not>
-recommended).
-
-=head2 /etc/group
-
-Cygwin does not require F</etc/group>, in which case the F<op/grent.t>
-test will be skipped.  The check performed by F<op/grent.t> expects to
-see entries that use the members field, otherwise this test will fail:
-
-  Failed Test           List of failed
-  ------------------------------------
-  op/grent.t            1
-
-=head2 Script Portability
+=head2 Script Portability on Cygwin
 
 Cygwin does an outstanding job of providing UNIX-like semantics on top of
 Win32 systems.  However, in addition to the items noted above, there are
@@ -419,7 +343,7 @@ to portability, more information can be found in the Cygwin documentation.
 
 =item * Pathnames
 
-Cygwin pathnames can be separated by forward (F</>) or backward (F<\>)
+Cygwin pathnames can be separated by forward (F</>) or backward (F<\\>)
 slashes.  They may also begin with drive letters (F<C:>) or Universal
 Naming Codes (F<//UNC>).  DOS device names (F<aux>, F<con>, F<prn>,
 F<com*>, F<lpt?>, F<nul>) are invalid as base filenames.  However, they
@@ -474,11 +398,11 @@ access by native Win32 programs).
 
 =back
 
-=head1 INSTALL
+=head1 INSTALL PERL ON CYGWIN
 
 This will install Perl, including I<man> pages.
 
-  make install | tee log.make-install
+  make install 2>&1 | tee log.make-install
 
 NOTE: If C<STDERR> is redirected `C<make install>' will B<not> prompt
 you to install I<perl> into F</usr/bin>.
@@ -489,7 +413,7 @@ are not, you must have write access to the directories in question.
 Information on installing the Perl documentation in HTML format can be
 found in the F<INSTALL> document.
 
-=head1 MANIFEST
+=head1 MANIFEST ON CYGWIN
 
 These are the files in the Perl release that contain references to Cygwin.
 These very brief notes attempt to explain the reason for all conditional
@@ -500,12 +424,11 @@ be kept as clean as possible.
 
 =item Documentation
 
-  INSTALL README.cygwin
+  INSTALL README.cygwin README.win32 MANIFEST
   Changes Changes5.005 Changes5.004 Changes5.6
-  AUTHORS MAINTAIN MANIFEST README.win32
-  pod/buildtoc.PL pod/perl.pod pod/perl5004delta.pod pod/perl56delta.pod
-  pod/perlfaq3.pod pod/perlhist.pod pod/perlmodlib.pod pod/perlport.pod
-  pod/perltoc.pod
+  pod/perl.pod pod/perlport.pod pod/perlfaq3.pod
+  pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod
+  pod/perlhist.pod pod/perlmodlib.pod pod/buildtoc.PL pod/perltoc.pod
 
 =item Build, Configure, Make, Install
 
@@ -543,9 +466,7 @@ be kept as clean as possible.
   perl.h                - binmode
   doio.c                - win9x can not rename a file when it is open
   pp_sys.c              - do not define h_errno, pp_system with spawn
-  mg.c                  - environ WORKAROUND
-  unixish.h             - environ WORKAROUND
-  util.c                - environ WORKAROUND
+  util.c                - use setenv
 
 =item Compiled Module Source
 
@@ -570,16 +491,10 @@ be kept as clean as possible.
 
 =back
 
-=head1 BUGS
+=head1 BUGS ON CYGWIN
 
 When I<make> starts, it warns about overriding commands for F<perlmain.o>.
 
-`C<make clean>' does not remove library F<.def> or F<.exe.stackdump>
-files.
-
-The I<ld2> script contains references to the source directory.  You should
-change these to $installbin after `C<make install>'.
-
 Support for swapping real and effective user and group IDs is incomplete.
 On WinNT Cygwin provides setuid(), seteuid(), setgid() and setegid().
 However, additional Cygwin calls for manipulating WinNT access tokens
@@ -588,12 +503,13 @@ and security contexts are required.
 =head1 AUTHORS
 
 Charles Wilson <cwilson@ece.gatech.edu>,
-Eric Fifer <efifer@sanwaint.com>,
+Eric Fifer <egf7@columbia.edu>,
 alexander smishlajev <als@turnhere.com>,
 Steven Morlock <newspost@morlock.net>,
 Sebastien Barre <Sebastien.Barre@utc.fr>,
-Teun Burgers <burgers@ecn.nl>.
+Teun Burgers <burgers@ecn.nl>,
+Gerrit Haase <gh@familiehaase.de>.
 
 =head1 HISTORY
 
-Last updated: 15 August 2000
+Last updated: 2002-02-27