Update to README.cygwin by Jerry D. Hedden

p4raw-id: //depot/perl@31972

1 files changed, 173 insertions, 38 deletions

diff --git a/README.cygwin b/README.cygwin
index e9e4effa57..26ef2294cd 100644
--- a/README.cygwin
+++ b/README.cygwin
@@ -98,9 +98,9 @@ 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.
@@ -133,7 +133,7 @@ The MD5 port was done by Andy Piper:
 
   ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz
 
-=item * C<-lgdbm> (C<use GDBM_File>)
+=item * C<-lgdbm_compat> (C<use GDBM_File>)
 
 GDBM is available for Cygwin.
 
@@ -143,7 +143,7 @@ NOTE: The GDBM library only works on NTFS partitions.
 
 BerkeleyDB is available for Cygwin.
 
-NOTE: The BerkeleyDB library only completely works on NTFS partitions 
+NOTE: The BerkeleyDB library only completely works on NTFS partitions
 and db-4.3 is flawed.
 
 =item * C<cygserver> (C<use IPC::SysV>)
@@ -159,7 +159,7 @@ CPAN modules). CURRENTLY NOT SUPPORTED!
 
 =item * C<-lutil>
 
-Included with the standard Cygwin netrelease is the inetutils package 
+Included with the standard Cygwin netrelease is the inetutils package
 which includes libutil.a.
 
 =back
@@ -201,7 +201,7 @@ bit integers, define this symbol.
 
 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, 
+(I<{atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l,
 strtold>).
 These are B<not> yet available with Cygwin.
 
@@ -212,13 +212,13 @@ a threaded perl.
 
 =item * C<-Duselargefiles>
 
-Cygwin uses 64-bit integers 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.  This works with Cygwin.
-Details can be found in the F<INSTALL> document.  This is the recommended 
+Details can be found in the F<INSTALL> document.  This is the recommended
 way to build perl from sources.
 
 =back
@@ -290,7 +290,7 @@ 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 
+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):
 
@@ -362,12 +362,12 @@ 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).
 
-For conversion we have C<Cygwin::win_to_posix_path()> and 
+For conversion we have C<Cygwin::win_to_posix_path()> and
 C<Cygwin::posix_to_win_path()>.
 
 Pathnames may not contain Unicode characters. C<Cygwin> still uses the
 ANSI API calls and no Unicode calls because of newlib deficiencies.
-There's an unofficial unicode patch for cygwin at 
+There's an unofficial unicode patch for cygwin at
 F<http://www.okisoft.co.jp/esc/utf8-cygwin/>
 
 =item * Text/Binary
@@ -389,19 +389,19 @@ The text/binary issue is covered at length in the Cygwin documentation.
 
 =item * PerlIO
 
-PerlIO overrides the default Cygwin Text/Binary behaviour.  A file will 
-always treated as binary, regardless which mode of the mount it lives on,
-just like it is in UNIX.  So CR/LF translation needs to be requested in 
+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:
 
   open(FH, ">:crlf", "out.txt");
 
-which will do conversion from LF to CR/LF on the output, or in the 
+which will do conversion from LF to CR/LF on the output, or in the
 environment settings (add this to your .bashrc):
 
   export PERLIO=crlf
 
-which will pull in the crlf PerlIO layer which does LF -> CRLF conversion 
+which will pull in the crlf PerlIO layer which does LF -> CRLF conversion
 on every output generated by perl.
 
 =item * F<.exe>
@@ -420,7 +420,7 @@ 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()> 
+the winpid.  Use C<Cygwin::winpid_to_pid()> and C<Cygwin::winpid_to_pid()>
 to translate between them.
 
 =item * Cygwin vs. Windows errors
@@ -443,9 +443,9 @@ 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 
+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> 
+therefore Perl adds the suffix C<.bak> automatically if you use C<perl -i>
 without specifying a backup extension.
 
 Using C<fork()> after loading multiple dlls may fail with an internal cygwin
@@ -502,26 +502,26 @@ Returns an array of [mnt_dir, mnt_fsname, mnt_type, mnt_opts].
   / c:\cygwin system binmode
   /cygdrive/c c: system binmode,noumount
   /cygdrive/d d: system binmode,noumount
-  /cygdrive/e e: system binmode,noumount 
+  /cygdrive/e e: system binmode,noumount
 
 =item C<Cygwin::mount_flags>
 
 Returns the mount type and flags for a specified mount point.
-A comma-seperated string of mntent->mnt_type (always
+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".
 
   system|user,binmode|textmode,exec,cygexec,cygdrive,mixed,
   notexec,managed,nosuid,devfs,proc,noumount
 
-If the argument is "/cygdrive", just the volume mount settings are returned. 
+If the argument is "/cygdrive", just the volume mount settings 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 
+  binmode,cygdrive
 
 =item C<Cygwin::is_binmount>
 
@@ -550,78 +550,212 @@ found in the F<INSTALL> document.
 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
 code.  Hopefully, keeping this up to date will allow the Cygwin port to
-be kept as clean as possible (listing not updated yet).
+be kept as clean as possible.
 
 =over 4
 
 =item Documentation
 
   INSTALL README.cygwin README.win32 MANIFEST
-  Changes Changes5.005 Changes5.004 Changes5.6
+  Changes Changes5.004 Changes5.005 Changes5.6 Changes5.8
   pod/perl.pod pod/perlport.pod pod/perlfaq3.pod
   pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod
-  pod/perlhist.pod pod/perlmodlib.pod perl/buildtoc pod/perltoc.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 pod.lst Porting/Glossary Porting/repository.pod
+  Porting/checkAUTHORS.pl
+  ext/Compress/Raw/Zlib/Changes ext/Compress/Raw/Zlib/README
+  ext/Compress/Zlib/Changes ext/Cwd/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
   Configure             - help finding hints from uname,
                           shared libperl required for dynamic loading
-  Makefile.SH           - linklibperl
+  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/b.t             - ignore Cwd from os_extras
-  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/lib/cygwin.t	- builtin cygwin function tests
+  t/op/taint.t          - can't use empty path under Cygwin Perl
+  t/op/time.t           - no tzset()
 
 =item Compiled Perl Source
 
   EXTERN.h              - __declspec(dllimport)
   XSUB.h                - __declspec(dllexport)
   cygwin/cygwin.c       - os_extras (getcwd, spawn, and several Cygwin:: functions)
-  perl.c                - os_extras
+  perl.c                - os_extras, -i.bak
   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
+  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
 
+  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
+                        - Contants 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/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/perldoc.PL      - version comment
+  utils/perlbug.PL      - Add CYGWIN environment variable to report
+
+=item Perl Module Tests
+
+  ext/Compress/Zlib/t/14gzopen.t
+  ext/Cwd/t/cwd.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
 
@@ -642,8 +776,9 @@ 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>.
+Jan Dubois <jand@activestate.com>,
+Jerry D. Hedden <jdhedden@cpan.org>.
 
 =head1 HISTORY
 
-Last updated: 2007-08-12
+Last updated: 2007-09-25