This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add Cygwin::sync_winenv [perl #110190]
[perl5.git] / README.cygwin
index 5a0be88..4e3e6f5 100644 (file)
@@ -1,10 +1,10 @@
 If you read this file _as_is_, just ignore the funny characters you
-see. It is written in the POD format (see pod/perlpod.pod) which is
+see. It is written in the POD format (see F<pod/perlpod.pod>) which is
 specially designed to be readable as is.
 
 =head1 NAME
 
-README.cygwin - Perl for Cygwin
+perlcygwin - Perl for Cygwin
 
 =head1 SYNOPSIS
 
@@ -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 have no 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,31 +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://sourceware.cygnus.com/cygwin/
+L<http://www.cygwin.com/>
 
 A recent net or commercial release of Cygwin is required.
 
-At the time this document was written, the port required recent
-development snapshots that were expected to stabilize early in 2000 and
-be released to the net as B21 and commercially as v1.1.
+At the time this document was last updated, Cygwin 1.7.10 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
-Cygwin bugs.  If you wish to use Perl with Cygwin B20.1 or earlier,
-consider using either perl5.005_03 or perl5.005_62, which are available
-in source and binary form at C<http://cygutils.netpedia.net/> or on the
-Cygwin CD.  If there is significant demand, a patch kit can be developed
-to port back to earlier Cygwin versions.
-
-=head2 Compiler
-
-A recent net or commercial release of I<gcc> is required.
-
-At the time this document was written, I<gcc-2.95.2> was current and
-could be downloaded from:
-
-  ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/cygwin/gcc-2.95.2/
 
 =head2 Cygwin Configuration
 
@@ -60,73 +41,41 @@ that Perl builds cleanly.  These changes are B<not> required for normal
 Perl usage.
 
 B<NOTE:> The binaries that are built will run on all Win32 versions.
-They do not depend on your host system (Win9x, WinNT) or your Cygwin
-configuration (I<ntea>, I<ntsec>, binary/text mounts).  The only
-dependencies come from hardcoded pathnames like C</usr/local>.  However,
-your host system and Cygwin configuration will affect Perl's runtime
-behavior (see L</"TEST">).  Some regression tests may fail in different
-ways depending on your setup.  For now, the test suite does not skip
-tests that do not make sense given a particular setup.  If a test can
-pass in some Cygwin setup, it is left in and explainable test failures
-are documented.
+They do not depend on your host system (WinXP/Win2K/Win7) or your
+Cygwin configuration (binary/text mounts, cvgserver).
+The only dependencies come from hard-coded pathnames like C</usr/local>.
+However, your host system and Cygwin configuration will affect Perl's
+runtime behavior (see L</"TEST">).
 
 =over 4
 
 =item * C<PATH>
 
 Set the C<PATH> environment variable so that Configure finds the Cygwin
-versions of programs.  Any Windows directories should be removed or
+versions of programs. Any not-needed Windows directories should be removed or
 moved to the end of your C<PATH>.
 
-=item * F</bin/cat.exe>
-
-There should be an instance of I<cat> in F</bin> (or F</usr/bin>).
-Configure tests C<#!/bin/cat> and if it is not found, you will see
-the error:
-
-  Configure: ./try: No such file or directory
-
-=item * F</usr/bin>
-
-If you do not have a F</usr/bin> directory, Configure will B<not> prompt
-you to install I<perl> into F</usr/bin>.
-
 =item * I<nroff>
 
 If you do not have I<nroff> (which is part of the I<groff> package),
-Configure will B<not> prompt you to install man pages.
-
-=item * Permissions
-
-On WinNT with either the I<ntea> or I<ntsec> C<CYGWIN> settings, directory
-and file permissions may not be set correctly.  Since the build process
-creates files and directories, to be safe you may want to run a `C<chmod
--R +w *>' on the entire Perl source tree.
-
-Also, it is a well known WinNT "feature" that files created by a login
-that is a member of the I<Administrators> group will be owned by the
-I<Administrators> group.  Depending on your umask, you may find that you
-can not write to files that you just created (because you are no longer
-the owner).  When using the I<ntsec> C<CYGWIN> setting, this is not an
-issue because it "corrects" the ownership to what you would expect on
-a UNIX system.
+Configure will B<not> prompt you to install I<man> pages.
 
 =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
-(which requires a shared F<libperl.dll>).
+(which requires a shared F<cygperl5_16.dll>).
 
 This will run Configure and keep a record:
 
   ./Configure 2>&1 | tee log.configure
 
-If you are willing to accept all the defaults add a B<-d> option.
+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
@@ -134,135 +83,127 @@ binaries to be stripped, you can either add a B<-s> option when Configure
 prompts you,
 
   Any additional ld flags (NOT including libraries)? [none] -s
-  Any special flags to pass to gcc to use dynamic linking? [none] -s
-  Any special flags to pass to ld2 to create a dynamically loaded library?
+  Any special flags to pass to g++ to create a dynamically loaded library?
   [none] -s
+  Any special flags to pass to gcc to use dynamic linking? [none] -s
 
 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
 
 =item * C<-lcrypt>
 
-The crypt libraries in GNU libc have been ported to Cygwin.
-
-The DES based Ultra Fast Crypt port was done by Alexey Truhan:
+The crypt package distributed with Cygwin is a Linux compatible 56-bit
+DES crypt port by Corinna Vinschen.
 
-  http://dome.weeg.uiowa.edu/pub/domestic/sos/cw32crypt-dist-0.tgz
+Alternatively, the crypt libraries in GNU libc have been ported to Cygwin.
 
-NOTE: There are various export restrictions on DES implementations,
-see the glibc README for more details.
+=item * C<-lgdbm_compat> (C<use GDBM_File>)
 
-The MD5 port was done by Andy Piper:
+GDBM is available for Cygwin.
 
-  http://dome.weeg.uiowa.edu/pub/domestic/sos/libcrypt.tgz
+NOTE: The GDBM library only works on NTFS partitions.
 
-More information can also be found at:
+=item * C<-ldb> (C<use DB_File>)
 
-  http://miracle.geol.msu.ru/sos/
+BerkeleyDB is available for Cygwin.
 
-=item * C<-lgdbm> (C<use GDBM_File>)
+NOTE: The BerkeleyDB library only completely works on NTFS partitions.
 
-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).
+=item * C<cygserver> (C<use IPC::SysV>)
 
-=item * C<-ldb> (C<use DB_File>)
+A port of SysV IPC is available for Cygwin.
 
-BerkeleyDB is available for Cygwin.  Some details can be found in
-F<ext/DB_File/DB_File.pm>.
+NOTE: This has B<not> been extensively tested.  In particular,
+C<d_semctl_semun> is undefined because it fails a Configure test
+and on Win9x the I<shm*()> functions seem to hang.  It also creates
+a compile time dependency because F<perl.h> includes F<<sys/ipc.h>>
+and F<<sys/sem.h>> (which will be required in the future when compiling
+CPAN modules). CURRENTLY NOT SUPPORTED!
 
-=item * C<-lcygipc> (C<use IPC::SysV>)
+=item * C<-lutil>
 
-A port of SysV IPC is available for Cygwin.  It has not been extensively
-tested.  In particular, C<d_semctl_semun> does not configure properly
-because the configure test fails and on Win9x the shm*() functions hang.
+Included with the standard Cygwin netrelease is the inetutils package
+which includes libutil.a.
 
 =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 these are experimental.
+The F<INSTALL> document describes several Configure-time options.  Some of
+these will work with Cygwin, others are not yet possible.  Also, some of
+these are experimental.  You can either select an option when Configure
+prompts you or you can define (undefine) symbols on the command line.
 
 =over 4
 
 =item * C<-Uusedl>
 
-If you want to force Perl to be compiled statically, you can either
-choose this when Configure prompts you or you can use the Configure
-command line option.
+Undefining this symbol forces Perl to be compiled statically.
 
-=item * C<-Uusemymalloc>
+=item * C<-Dusemymalloc>
 
-By default Perl uses the malloc() included with the Perl source.  If you
-want to force Perl to build with the system malloc(), you can either
-choose this when Configure prompts you or you can use the Configure
-command line option.
+By default Perl does not use the C<malloc()> included with the Perl source,
+because it was slower and not entirely thread-safe.  If you want to force
+Perl to build with the old -Dusemymalloc define this.
 
-=item * C<-Dusemultiplicty>
+=item * C<-Uuseperlio>
 
-Multiplicity is required when embedding Perl in a C program and using
-more than one interpreter instance.  This works with the Cygwin port.
+Undefining this symbol disables the PerlIO abstraction.  PerlIO is now the
+default; it is not recommended to disable PerlIO.
 
-=item * C<-Duseperlio>
+=item * C<-Dusemultiplicity>
 
-The PerlIO abstraction works with the Cygwin port.
+Multiplicity is required when embedding Perl in a C program and using
+more than one interpreter instance.  This is only required when you build
+a not-threaded perl with C<-Uuseithreads>.
 
-=item * C<-Duse64bits>
+=item * C<-Uuse64bitint>
 
-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 64 bit integers.  If you want to use smaller 32 bit
+integers, define this symbol.
 
 =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,log,modf,pow,sin,sqrt}l,strtold>).
-These are B<not> yet available with Cygwin.
+(I<{atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l,
+strtold>).
+These are B<not> yet available with newlib, the Cygwin libc.
 
-=item * C<-Dusethreads>
+=item * C<-Uuseithreads>
 
-POSIX threads are B<not> yet implemented in Cygwin.
+Define this symbol if you want not-threaded faster perl.
 
 =item * C<-Duselargefiles>
 
-Although Win32 supports large files, Cygwin currently uses 32-bit ints
-for internal size and position calculations.
+Cygwin uses 64-bit integers for internal size and position calculations,
+this will be correctly detected and defined by Configure.
+
+=item * C<-Dmksymlinks>
+
+Use this to build perl outside of the source tree.  Details can be
+found in the F<INSTALL> document.  This is the recommended way to
+build perl from sources.
 
 =back
 
-=head2 Suspicious Warnings
+=head2 Suspicious Warnings on Cygwin
 
 You may see some messages during Configure that seem suspicious.
 
 =over 4
 
-=item * Whoa There
-
-Cygwin does not yet implement chroot(), setegid() or seteuid()
-functionality, but has stub functions that return C<ENOSYS>.  You will
-see a message when Configure detects that its guess conflicts with the
-hint file.
-
-  *** WHOA THERE!!! ***
-      The recommended value for $d_chroot on this machine was "undef"!
-      Keep the recommended value? [y]
-
-You should keep the recommended value.
-
-=item * Win9x and d_eofnblk
+=item * Win9x and C<d_eofnblk>
 
 Win9x does not correctly report C<EOF> with a non-blocking read on a
 closed pipe.  You will see the following messages:
@@ -277,71 +218,55 @@ 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...
+=item * Compiler/Preprocessor defines
 
-Configure reports:
+The following error occurs because of the Cygwin C<#define> of
+C<_LONG_DOUBLE>:
 
-  Your stdio doesn't appear very std.
+  Guessing which symbols your C compiler and preprocessor define...
+  try.c:<line#>: missing binary operator
 
-This is correct.
+This failure does not seem to cause any problems.  With older gcc
+versions, "parse error" is reported instead of "missing binary
+operator".
 
 =back
 
-=head1 MAKE
+=head1 MAKE ON CYGWIN
 
-Simply run make and wait:
+Simply run I<make> and wait:
 
   make 2>&1 | tee log.make
 
-=head2 Warnings
-
-Warnings like these are normal:
-
-  warning: overriding commands for target <file>
-  warning: ignoring old commands for target <file>
-
-  Warning: no export definition file provided
-  dllwrap will create one, but may not be what you want
-
-=head2 ld2
-
-During `C<make>', I<ld2> will be created and installed in your $installbin
-directory (where you said to put public executables).  It does not
-wait until the `C<make install>' process to install the I<ld2> script,
-this is because the remainder of the `C<make>' refers to I<ld2> without
-fully specifying its path and does this from multiple subdirectories.
-The assumption is that $installbin is in your current C<PATH>.  If this
-is not the case or if you do not have an I<install> program, `C<make>'
-will fail at some point.  If this happens, just manually copy I<ld2>
-from the source directory to someplace in your C<PATH>.
-
-=head1 TEST
+=head1 TEST ON CYGWIN
 
 There are two steps to running the test suite:
 
   make test 2>&1 | tee log.make-test
 
-  cd t;./perl harness 2>&1 | tee ../log.harness
+  cd t; ./perl harness 2>&1 | tee ../log.harness
 
 The same tests are run both times, but more information is provided when
-running as `C<./perl harness>'.
+running as C<./perl harness>.
 
 Test results vary depending on your host system and your Cygwin
-configuration.  It is possible that Cygwin will pass all the tests,
-but it is more likely that some tests will fail for one of these reasons.
+configuration.  If a test can pass in some Cygwin setup, it is always
+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 only
-tracks the Win32 readonly attribute represented as the UNIX file user
-write bit (files are always readable, files are executable if they have
-a F<.{com,bat,exe}> extension or begin with C<#!>, directories are always
-readable and executable).  On WinNT with the I<ntea> C<CYGWIN> setting,
-the remaining mode bits are stored as extended attributes.  On WinNT
-with the I<ntsec> C<CYGWIN> setting, permissions use the standard WinNT
-security descriptors and access control lists.  Without one of these
-options, these tests will fail:
+{read,write,execute} for each {user,group,other}.  By default Cygwin
+only tracks the Win32 read-only attribute represented as the UNIX file
+user write bit (files are always readable, files are executable if they
+have a F<.{com,bat,exe}> extension or begin with C<#!>, directories are
+always readable and executable).  On WinNT with the I<ntea> C<CYGWIN>
+setting, the additional mode bits are stored as extended file attributes.
+On WinNT with the default I<ntsec> C<CYGWIN> setting, permissions use the
+standard WinNT security descriptors and access control lists. Without one of
+these options, these tests will fail (listing not updated yet):
 
   Failed Test           List of failed
   ------------------------------------
@@ -356,158 +281,267 @@ options, these tests will fail:
   lib/sdbm.t            2
   op/stat.t             9, 20 (.tmp not an executable extension)
 
-=head2 Hard Links
+=head2 NDBM_File and ODBM_File do not work on FAT filesystems
 
-FAT partitions do not support hard links (whereas NTFS does), in which
-case Cygwin implements link() by copying the file.  These tests will fail:
+Do not use NDBM_File or ODBM_File on FAT filesystem.  They can be
+built on a FAT filesystem, but many tests will fail:
 
-  Failed Test           List of failed
-  ------------------------------------
-  io/fs.t               4
-  op/stat.t             3
+ ../ext/NDBM_File/ndbm.t       13  3328    71   59  83.10%  1-2 4 16-71
+ ../ext/ODBM_File/odbm.t      255 65280    ??   ??       %  ??
+ ../lib/AnyDBM_File.t           2   512    12    2  16.67%  1 4
+ ../lib/Memoize/t/errors.t      0   139    11    5  45.45%  7-11
+ ../lib/Memoize/t/tie_ndbm.t   13  3328     4    4 100.00%  1-4
+ run/fresh_perl.t                          97    1   1.03%  91
 
-=head2 Filetime Granularity
+If you intend to run only on FAT (or if using AnyDBM_File on FAT),
+run Configure with the -Ui_ndbm and -Ui_dbm options to prevent
+NDBM_File and ODBM_File being built.
 
-On FAT partitions the filetime granularity is 2 seconds.  The following
-test will fail:
+With NTFS (and no CYGWIN=nontsec), there should be no problems even if
+perl was built on FAT.
 
-  Failed Test           List of failed
-  ------------------------------------
-  io/fs.t               18
+=head2 C<fork()> failures in io_* tests
 
-=head2 Tainting Checks
+A C<fork()> failure may result in the following tests failing:
 
-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:
+  ext/IO/lib/IO/t/io_multihomed.t
+  ext/IO/lib/IO/t/io_sock.t
+  ext/IO/lib/IO/t/io_unix.t
 
-  Win9x
-    Error Starting Program
-    A required .DLL file, CYGWIN1.DLL, was not found
+See comment on fork in L</Miscellaneous> below.
 
-  WinNT
-    perl.exe or sh.exe - Unable to Locate DLL
-    The dynamic link library cygwin1.dll could not be found in the
-      specified path ...
+=head1 Specific features of the Cygwin port
 
-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:
+=head2 Script Portability on Cygwin
 
-  Failed Test           List of failed
-  ------------------------------------
-  op/taint.t            1, 3, 31, 37
+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
+some differences that you should know about.  This is a very brief guide
+to portability, more information can be found in the Cygwin documentation.
 
-Alternatively, you can copy F<cygwin1.dll> into one of the Windows system
-directories (although, this is B<not> recommended).
+=over 4
 
-=head2 /etc/group
+=item * Pathnames
 
-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:
+Cygwin pathnames are separated by forward (F</>) slashes, Universal
+Naming Codes (F<//UNC>) are also supported Since cygwin-1.7 non-POSIX
+pathnames are disencouraged.  Names may contain all printable
+characters.
 
-  Failed Test           List of failed
-  ------------------------------------
-  op/grent.t            1
+File names are case insensitive, but case preserving.  A pathname that
+contains a backslash or drive letter is a Win32 pathname, and not
+subject to the translations applied to POSIX style pathnames, but
+cygwin will warn you, so better convert them to POSIX.
 
-=head2 Unexplained Failures
+For conversion we have C<Cygwin::win_to_posix_path()> and
+C<Cygwin::posix_to_win_path()>.
 
-Any additional tests that fail are likely due to bugs in Cygwin or the
-optional libraries.  It is expected that by the time of the next net
-release most of these will be solved so they are not described here.
+Since cygwin-1.7 pathnames are UTF-8 encoded.
 
-=head2 Script Portability
+=item * Text/Binary
 
-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 some differences that you should know about.  This is only a
-very brief guide to portability, more information can be found in the
-Cygwin documentation.
+Since cywgin-1.7 textmounts are deprecated and stronlgy discouraged.
 
-=over 4
+When a file is opened it is in either text or binary mode.  In text mode
+a file is subject to CR/LF/Ctrl-Z translations.  With Cygwin, the default
+mode for an C<open()> is determined by the mode of the mount that underlies
+the file. See L</Cygwin::is_binmount>(). Perl provides a C<binmode()> function
+to set binary mode on files that otherwise would be treated as text.
+C<sysopen()> with the C<O_TEXT> flag sets text mode on files that otherwise
+would be treated as binary:
 
-=item * Pathnames
+    sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
 
-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?>) are invalid as base filenames.  However, they can be
-used in extensions (e.g., F<hello.aux>).  Names may not contain these
-characters:
+C<lseek()>, C<tell()> and C<sysseek()> only work with files opened in binary
+mode.
 
-  : * ? " < > |
+The text/binary issue is covered at length in the Cygwin documentation.
 
-File names are case insensitive, but case preserving.  With the I<mixed>
-C<CYGWIN> setting, file names are mixed-case (although, directory names
-remain case insensitive).
+=item * PerlIO
 
-The I<mixed> setting is only available with the "coolview" version of
-F<cygwin1.dll> provided by Sergey Okhapkin at:
+PerlIO overrides the default Cygwin Text/Binary behaviour.  A file will
+always be treated as binary, regardless of the mode of the mount it lives
+on, just like it is in UNIX.  So CR/LF translation needs to be requested in
+either the C<open()> call like this:
 
-  ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/
+  open(FH, ">:crlf", "out.txt");
 
-=item * Text/Binary
+which will do conversion from LF to CR/LF on the output, or in the
+environment settings (add this to your .bashrc):
 
-When a file is opened it is in either text or binary mode.  In text mode
-a file is subject to CR/LF/Ctrl-Z translations.  With Cygwin, the default
-mode for an open() is determined by the mode of the mount that underlies
-the file.  Perl provides a binmode() function to set binary mode on files
-that otherwise would be treated as text.  sysopen() with the C<O_TEXT>
-flag sets text mode on files that otherwise would be treated as binary:
+  export PERLIO=crlf
 
-    sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
+which will pull in the crlf PerlIO layer which does LF -> CRLF conversion
+on every output generated by perl.
 
-lseek(), tell() and sysseek() only work with files opened in binary mode.
+=item * F<.exe>
 
-The text/binary issue is covered at length in the Cygwin documentation.
+The Cygwin C<stat()>, C<lstat()> and C<readlink()> functions make the F<.exe>
+extension transparent by looking for F<foo.exe> when you ask for F<foo>
+(unless a F<foo> also exists).  Cygwin does not require a F<.exe>
+extension, but I<gcc> adds it automatically when building a program.
+However, when accessing an executable as a normal file (e.g., I<cp>
+in a makefile) the F<.exe> is not transparent.  The I<install> program
+included with Cygwin automatically appends a F<.exe> when necessary.
 
-=item * F<.exe>
+=item * Cygwin vs. Windows process ids
+
+Cygwin processes have their own pid, which is different from the
+underlying windows pid.  Most posix compliant Proc functions expect
+the cygwin pid, but several Win32::Process functions expect the
+winpid. E.g. C<$$> is the cygwin pid of F</usr/bin/perl>, which is not
+the winpid.  Use C<Cygwin::winpid_to_pid()> and C<Cygwin::winpid_to_pid()>
+to translate between them.
+
+=item * Cygwin vs. Windows errors
+
+Under Cygwin, $^E is the same as $!.  When using L<Win32 API Functions|Win32>,
+use C<Win32::GetLastError()> to get the last Windows error.
+
+=item * rebase errors on fork or system
+
+Using C<fork()> or C<system()> out to another perl after loading multiple dlls
+may result on a DLL baseaddress conflict. The internal cygwin error
+looks like like the following:
 
-The Cygwin stat() makes the F<.exe> extension transparent by looking for
-a F<foo.exe> when you ask for F<foo> (unless a F<foo> also exists).
-Cygwin does not require a F<.exe> extension, but I<gcc> adds it
-automatically when building a program.  However, when accessing an
-executable as a normal file (e.g., I<install> or I<cp> in a makefile)
-the F<.exe> is not transparent.
+  0 [main] perl 8916 child_info_fork::abort: data segment start: parent
+  (0xC1A000) != child(0xA6A000)
 
-NOTE: There is a version of I<install> that understands the F<.exe>
-semantics, it can be found at:
+or:
 
-  ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Humblet_Pierre_A/
+  183 [main] perl 3588 C:\cygwin\bin\perl.exe: *** fatal error - unable to remap C:\cygwin\bin\cygsvn_subr-1-0.dll to same address as parent(0x6FB30000) != 0x6FE60000
+  46 [main] perl 3488 fork: child 3588 - died waiting for dll loading, errno11
 
-=item * chown()
+See L<http://cygwin.com/faq/faq-nochunks.html#faq.using.fixing-fork-failures>
+It helps if not too many DLLs are loaded in memory so the available address space is larger,
+e.g. stopping the MS Internet Explorer might help.
 
-On WinNT with the I<ntsec> C<CYGWIN> setting, chown() can change a file's
-user and group IDs.  In all other configurations chown() is a no-op,
-although this is appropriate on Win9x since there is no security model.
+Use the perlrebase or rebase utilities to resolve the conflicting dll addresses.
+The rebase package is included in the Cygwin setup. Use F<setup.exe>
+from L<http://www.cygwin.com/setup.exe> to install it.
+
+1. kill all perl processes and run C<perlrebase> or
+
+2. kill all cygwin processes and services, start dash from cmd.exe and run C<rebaseall>.
+
+=item * C<chown()>
+
+On WinNT C<chown()> can change a file's user and group IDs.  On Win9x C<chown()>
+is a no-op, although this is appropriate since there is no security model.
 
 =item * Miscellaneous
 
-File locking using the C<F_GETLK> command to fcntl() is a stub that
+File locking using the C<F_GETLK> command to C<fcntl()> is a stub that
 returns C<ENOSYS>.
 
-Win9x can not rename() an open file (although WinNT can).
+Win9x can not C<rename()> an open file (although WinNT can).
+
+The Cygwin C<chroot()> implementation has holes (it can not restrict file
+access by native Win32 programs).
+
+Inplace editing C<perl -i> of files doesn't work without doing a backup
+of the file being edited C<perl -i.bak> because of windowish restrictions,
+therefore Perl adds the suffix C<.bak> automatically if you use C<perl -i>
+without specifying a backup extension.
 
 =back
 
-=head1 INSTALL
+=head2 Prebuilt methods:
+
+=over 4
+
+=item C<Cwd::cwd>
+
+Returns the current working directory.
+
+=item C<Cygwin::pid_to_winpid>
+
+Translates a cygwin pid to the corresponding Windows pid (which may or
+may not be the same).
+
+=item C<Cygwin::winpid_to_pid>
+
+Translates a Windows pid to the corresponding cygwin pid (if any).
+
+=item C<Cygwin::win_to_posix_path>
+
+Translates a Windows path to the corresponding cygwin path respecting
+the current mount points. With a second non-null argument returns an
+absolute path. Double-byte characters will not be translated.
+
+=item C<Cygwin::posix_to_win_path>
+
+Translates a cygwin path to the corresponding cygwin path respecting
+the current mount points. With a second non-null argument returns an
+absolute path. Double-byte characters will not be translated.
+
+=item C<Cygwin::mount_table()>
+
+Returns an array of [mnt_dir, mnt_fsname, mnt_type, mnt_opts].
+
+  perl -e 'for $i (Cygwin::mount_table) {print join(" ",@$i),"\n";}'
+  /bin c:\cygwin\bin system binmode,cygexec
+  /usr/bin c:\cygwin\bin system binmode
+  /usr/lib c:\cygwin\lib system binmode
+  / c:\cygwin system binmode
+  /cygdrive/c c: system binmode,noumount
+  /cygdrive/d d: system binmode,noumount
+  /cygdrive/e e: system binmode,noumount
 
-This will install Perl, including man pages.
+=item C<Cygwin::mount_flags>
 
-  make install | tee log.make-install
+Returns the mount type and flags for a specified mount point.
+A comma-separated string of mntent->mnt_type (always
+"system" or "user"), then the mntent->mnt_opts, where
+the first is always "binmode" or "textmode".
 
-NOTE: If C<STDERR> is redirected `C<make install>' will B<not> prompt
+  system|user,binmode|textmode,exec,cygexec,cygdrive,mixed,
+  notexec,managed,nosuid,devfs,proc,noumount
+
+If the argument is "/cygdrive", then just the volume mount settings,
+and the cygdrive mount prefix are returned.
+
+User mounts override system mounts.
+
+  $ perl -e 'print Cygwin::mount_flags "/usr/bin"'
+  system,binmode,cygexec
+  $ perl -e 'print Cygwin::mount_flags "/cygdrive"'
+  binmode,cygdrive,/cygdrive
+
+=item C<Cygwin::is_binmount>
+
+Returns true if the given cygwin path is binary mounted, false if the
+path is mounted in textmode.
+
+=item C<Cygwin::sync_winenv>
+
+Cygwin does not initialize all original Win32 environment variables.
+See the bottom of this page L<http://cygwin.com/cygwin-ug-net/setup-env.html>
+for "Restricted Win32 environment".
+
+Certain Win32 programs called from cygwin programs might need some environment
+variable, such as e.g. ADODB needs %COMMONPROGRAMFILES%.
+Call Cygwin::sync_winenv() to copy all Win32 environment variables to your
+process and note that cygwin will warn on every encounter of non-POSIX paths.
+
+=back
+
+=head1 INSTALL PERL ON CYGWIN
+
+This will install Perl, including I<man> pages.
+
+  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>.
 
-You may need to be I<Administrator> to run `C<make install>'.  If you
+You may need to be I<Administrator> to run C<make install>.  If you
 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
@@ -518,92 +552,228 @@ be kept as clean as possible.
 
 =item Documentation
 
-  INSTALL
-  Changes Changes5.005 Changes5.004
-  AUTHORS MAINTAIN MANIFEST
-  README.cygwin README.win32
-  pod/perl.pod pod/perlfaq3.pod pod/perlhist.pod pod/perlmodlib.pod
-  pod/perlport.pod pod/perltoc.pod pod/perl5004delta.pod
+  INSTALL README.cygwin README.win32 MANIFEST
+  pod/perl.pod pod/perlport.pod pod/perlfaq3.pod
+  pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod
+  pod/perl561delta.pod pod/perl570delta.pod pod/perl572delta.pod
+  pod/perl573delta.pod pod/perl58delta.pod pod/perl581delta.pod
+  pod/perl590delta.pod pod/perlhist.pod pod/perlmodlib.pod
+  pod/perltoc.pod Porting/Glossary pod/perlgit.pod
+  Porting/checkAUTHORS.pl
+  dist/Cwd/Changes ext/Compress-Raw-Zlib/Changes
+  ext/Compress-Raw-Zlib/README ext/Compress-Zlib/Changes
+  ext/DB_File/Changes ext/Encode/Changes ext/Sys-Syslog/Changes
+  ext/Time-HiRes/Changes ext/Win32API-File/Changes lib/CGI/Changes
+  lib/ExtUtils/CBuilder/Changes lib/ExtUtils/Changes lib/ExtUtils/NOTES
+  lib/ExtUtils/PATCHING lib/ExtUtils/README lib/Module/Build/Changes
+  lib/Net/Ping/Changes lib/Test/Harness/Changes
+  lib/Term/ANSIColor/ChangeLog lib/Term/ANSIColor/README README.symbian
+  symbian/TODO
 
 =item Build, Configure, Make, Install
 
   cygwin/Makefile.SHs
-  cygwin/ld2.in
-  cygwin/perlld.in
   ext/IPC/SysV/hints/cygwin.pl
   ext/NDBM_File/hints/cygwin.pl
   ext/ODBM_File/hints/cygwin.pl
   hints/cygwin.sh
-  Porting/patchls       - cygwin in port list
-  Makefile.SH           - linklibperl
-  makedepend.SH         - uwinfix
   Configure             - help finding hints from uname,
                           shared libperl required for dynamic loading
+  Makefile.SH Cross/Makefile-cross-SH
+                        - linklibperl
+  Porting/patchls       - cygwin in port list
   installman            - man pages with :: translated to .
-  installperl           - install dll/ld2/perlld, install to pods
+  installperl           - install dll, install to 'pods'
+  makedepend.SH         - uwinfix
+  regen_lib.pl          - file permissions
+
+  NetWare/Makefile
+  plan9/mkfile
+  symbian/sanity.pl symbian/sisify.pl
+  hints/uwin.sh
+  vms/descrip_mms.template
+  win32/Makefile win32/makefile.mk
 
 =item Tests
 
+  t/io/fs.t             - no file mode checks if not ntsec
+                          skip rename() check when not check_case:relaxed
   t/io/tell.t           - binmode
-  t/lib/glob-basic.t    - Win32 directory list access differs from read mode
+  t/lib/cygwin.t        - builtin cygwin function tests
+  t/op/groups.t         - basegroup has ID = 0
   t/op/magic.t          - $^X/symlink WORKAROUND, s/.exe//
   t/op/stat.t           - no /dev, skip Win32 ftCreationTime quirk
                           (cache manager sometimes preserves ctime of file
                           previously created and deleted), no -u (setuid)
+  t/op/taint.t          - can't use empty path under Cygwin Perl
+  t/op/time.t           - no tzset()
 
 =item Compiled Perl Source
 
-  cygwin/cygwin.c       - os_extras (getcwd)
-  doio.c                - win9x can not rename a file when it is open
   EXTERN.h              - __declspec(dllimport)
   XSUB.h                - __declspec(dllexport)
+  cygwin/cygwin.c       - os_extras (getcwd, spawn, and several Cygwin:: functions)
+  perl.c                - os_extras, -i.bak
   perl.h                - binmode
-  mg.c                  - environ WORKAROUND
-  util.c                - environ WORKAROUND
-  unixish.h             - environ WORKAROUND
+  doio.c                - win9x can not rename a file when it is open
+  pp_sys.c              - do not define h_errno, init _pwent_struct.pw_comment
+  util.c                - use setenv
+  util.h                - PERL_FILE_IS_ABSOLUTE macro
+  pp.c                  - Comment about Posix vs IEEE math under Cygwin
+  perlio.c              - CR/LF mode
+  perliol.c             - Comment about EXTCONST under Cygwin
 
 =item Compiled Module Source
 
+  ext/Compress-Raw-Zlib/Makefile.PL
+                        - Can't install via CPAN shell under Cygwin
+  ext/Compress-Raw-Zlib/zlib-src/zutil.h
+                        - Cygwin is Unix-like and has vsnprintf
+  ext/Errno/Errno_pm.PL - Special handling for Win32 Perl under Cygwin
   ext/POSIX/POSIX.xs    - tzname defined externally
   ext/SDBM_File/sdbm/pair.c
                         - EXTCONST needs to be redefined from EXTERN.h
   ext/SDBM_File/sdbm/sdbm.c
                         - binary open
+  ext/Sys/Syslog/Syslog.xs
+                        - Cygwin has syslog.h
+  ext/Sys/Syslog/win32/compile.pl
+                        - Convert paths to Windows paths
+  ext/Time-HiRes/HiRes.xs
+                        - Various timers not available
+  ext/Time-HiRes/Makefile.PL
+                        - Find w32api/windows.h
+  ext/Win32/Makefile.PL - Use various libraries under Cygwin
+  ext/Win32/Win32.xs    - Child dir and child env under Cygwin
+  ext/Win32API-File/File.xs
+                        - _open_osfhandle not implemented under Cygwin
+  ext/Win32CORE/Win32CORE.c
+                        - __declspec(dllexport)
 
 =item Perl Modules/Scripts
 
-  lib/perl5db.pl        - use stdin not /dev/tty
-  utils/perlcc.PL       - DynaLoader.a in compile, -DUSEIMPORTLIB
-  utils/perldoc.PL      - version comment
-  lib/File/Spec/Unix.pm - preserve //unc
+  ext/B/t/OptreeCheck.pm - Comment about stderr/stdout order under Cygwin
+  ext/Digest-SHA/bin/shasum
+                        - Use binary mode under Cygwin
+  ext/Sys/Syslog/win32/Win32.pm
+                        - Convert paths to Windows paths
+  ext/Time-HiRes/HiRes.pm
+                        - Comment about various timers not available
+  ext/Win32API-File/File.pm
+                        - _open_osfhandle not implemented under Cygwin
+  ext/Win32CORE/Win32CORE.pm
+                        - History of Win32CORE under Cygwin
+  lib/CGI.pm            - binmode and path separator
+  lib/CPANPLUS/Dist/MM.pm - Commented out code that fails under Win32/Cygwin
+  lib/CPANPLUS/Internals/Constants/Report.pm
+                        - OS classifications
+  lib/CPANPLUS/Internals/Constants.pm
+                        - Constants for Cygwin
+  lib/CPANPLUS/Internals/Report.pm
+                        - Example of Cygwin report
+  lib/CPANPLUS/Module.pm
+                        - Abort if running on old Cygwin version
+  lib/Cwd.pm            - hook to internal Cwd::cwd
+  lib/ExtUtils/CBuilder/Platform/cygwin.pm
+                        - use gcc for ld, and link to libperl.dll.a
+  lib/ExtUtils/CBuilder.pm
+                        - Cygwin is Unix-like
+  lib/ExtUtils/Install.pm - Install and rename issues under Cygwin
+  lib/ExtUtils/MM.pm    - OS classifications
+  lib/ExtUtils/MM_Any.pm - Example for Cygwin
   lib/ExtUtils/MakeMaker.pm
                         - require MM_Cygwin.pm
   lib/ExtUtils/MM_Cygwin.pm
                         - canonpath, cflags, manifypods, perl_archive
-  lib/Cwd.pm            - `pwd`
+  lib/File/Fetch.pm     - Comment about quotes using a Cygwin example
+  lib/File/Find.pm      - on remote drives stat() always sets st_nlink to 1
+  lib/File/Spec/Cygwin.pm - case_tolerant
+  lib/File/Spec/Unix.pm - preserve //unc
+  lib/File/Spec/Win32.pm - References a message on cygwin.com
+  lib/File/Spec.pm      - Pulls in lib/File/Spec/Cygwin.pm
+  lib/File/Temp.pm      - no directory sticky bit
+  lib/Module/Build/Compat.pm - Comment references 'make' under Cygwin
+  lib/Module/Build/Platform/cygwin.pm
+                        - Use '.' for man page separator
+  lib/Module/Build.pm   - Cygwin is Unix-like
+  lib/Module/CoreList.pm - List of all module files and versions
+  lib/Net/Domain.pm     - No domainname command under Cygwin
+  lib/Net/Netrc.pm      - Bypass using stat() under Cygwin
+  lib/Net/Ping.pm       - ECONREFUSED is EAGAIN under Cygwin
+  lib/Pod/Find.pm       - Set 'pods' dir
+  lib/Pod/Perldoc/ToMan.pm - '-c' switch for pod2man
+  lib/Pod/Perldoc.pm    - Use 'less' pager, and use .exe extension
+  lib/Term/ANSIColor.pm - Cygwin terminal info
+  lib/perl5db.pl        - use stdin not /dev/tty
+  utils/perlbug.PL      - Add CYGWIN environment variable to report
+
+=item Perl Module Tests
+
+  dist/Cwd/t/cwd.t
+  ext/Compress-Zlib/t/14gzopen.t
+  ext/DB_File/t/db-btree.t
+  ext/DB_File/t/db-hash.t
+  ext/DB_File/t/db-recno.t
+  ext/DynaLoader/t/DynaLoader.t
+  ext/File-Glob/t/basic.t
+  ext/GDBM_File/t/gdbm.t
+  ext/POSIX/t/sysconf.t
+  ext/POSIX/t/time.t
+  ext/SDBM_File/t/sdbm.t
+  ext/Sys/Syslog/t/syslog.t
+  ext/Time-HiRes/t/HiRes.t
+  ext/Win32/t/Unicode.t
+  ext/Win32API-File/t/file.t
+  ext/Win32CORE/t/win32core.t
+  lib/AnyDBM_File.t
+  lib/Archive/Extract/t/01_Archive-Extract.t
+  lib/Archive/Tar/t/02_methods.t
+  lib/CPANPLUS/t/05_CPANPLUS-Internals-Fetch.t
+  lib/CPANPLUS/t/20_CPANPLUS-Dist-MM.t
+  lib/ExtUtils/t/Embed.t
+  lib/ExtUtils/t/eu_command.t
+  lib/ExtUtils/t/MM_Cygwin.t
+  lib/ExtUtils/t/MM_Unix.t
+  lib/File/Compare.t
+  lib/File/Copy.t
+  lib/File/Find/t/find.t
+  lib/File/Path.t
+  lib/File/Spec/t/crossplatform.t
+  lib/File/Spec/t/Spec.t
+  lib/Module/Build/t/destinations.t
+  lib/Net/hostent.t
+  lib/Net/Ping/t/110_icmp_inst.t
+  lib/Net/Ping/t/500_ping_icmp.t
+  lib/Net/t/netrc.t
+  lib/Pod/Simple/t/perlcyg.pod
+  lib/Pod/Simple/t/perlcygo.txt
+  lib/Pod/Simple/t/perlfaq.pod
+  lib/Pod/Simple/t/perlfaqo.txt
+  lib/User/grent.t
+  lib/User/pwent.t
 
 =back
 
-=head1 BUGS
-
-Upon each start, I<make> warns that a rule for F<perlmain.o> is overridden
-(but there seems to be no better solution than adding an explicit define).
-
-`C<make clean>' does not remove library F<.def> and F<.exe.stackdump>
-files.
+=head1 BUGS ON CYGWIN
 
-The I<ld2> script contains references to the source directory.  You should
-change these to C</usr/local/bin> (or whatever) after install.
+Support for swapping real and effective user and group IDs is incomplete.
+On WinNT Cygwin provides C<setuid()>, C<seteuid()>, C<setgid()> and C<setegid()>.
+However, additional Cygwin calls for manipulating WinNT access tokens
+and security contexts are required.
 
 =head1 AUTHORS
 
-Charles Wilson E<lt>cwilson@ece.gatech.eduE<gt>,
-Eric Fifer E<lt>efifer@sanwaint.comE<gt>,
-alexander smishlajev E<lt>als@turnhere.comE<gt>,
-Steven Morlock E<lt>newspost@morlock.netE<gt>,
-Sebastien Barre E<lt>Sebastien.Barre@utc.frE<gt>,
-Teun Burgers E<lt>burgers@ecn.nlE<gt>.
+Charles Wilson <cwilson@ece.gatech.edu>,
+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>,
+Gerrit P. Haase <gp@familiehaase.de>,
+Reini Urban <rurban@cpan.org>,
+Jan Dubois <jand@activestate.com>,
+Jerry D. Hedden <jdhedden@cpan.org>.
 
 =head1 HISTORY
 
-Last updated: 24 February 2000
+Last updated: 2012-02-08