This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix apidoc entries for PUSHMARK and newXSproto.
[perl5.git] / README.cygwin
index 1a8d0b4..a2748f3 100644 (file)
@@ -13,10 +13,10 @@ 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 FOR COMPILING PERL ON CYGWIN
 
@@ -31,15 +31,8 @@ about this project can be found at:
 
 A recent net or commercial release of Cygwin is required.
 
-At the time this document was last updated, Cygwin 1.1.5 was current.
+At the time this document was last updated, Cygwin 1.5.2 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
 
@@ -117,8 +110,8 @@ near the end of the file.
 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,27 +124,24 @@ 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).
+GDBM is available for Cygwin.
 
-NOTE: The ndbm/dbm emulations only completely work on NTFS partitions.
+NOTE: The GDBM library only works on NTFS partitions.
 
 =item * C<-ldb> (C<use DB_File>)
 
-BerkeleyDB is available for Cygwin.  Some details can be found in
-F<ext/DB_File/DB_File.pm>.
+BerkeleyDB is available for Cygwin.
 
 NOTE: The BerkeleyDB library only completely works on NTFS partitions.
 
@@ -164,7 +154,12 @@ 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).
+CPAN modules). CURRENTLY NOT SUPPORTED!
+
+=item * C<-lutil>
+
+Included with the standard Cygwin netrelease is the inetutils package 
+which includes libutil.a.
 
 =back
 
@@ -183,39 +178,47 @@ Undefining this symbol forces Perl to be compiled statically.
 
 =item * C<-Uusemymalloc>
 
-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.
+By default Perl uses the C<malloc()> included with the Perl source.  If you
+want to force Perl to build with the system C<malloc()> undefine this symbol.
+
+=item * C<-Uuseperlio>
+
+Undefining this symbol disables the PerlIO abstraction.  PerlIO is now the
+default; it is not recommended to disable PerlIO.
 
 =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.
 
 =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 implemented in Cygwin, define this symbol if you want
+a threaded perl.
 
 =item * C<-Duselargefiles>
 
-Although Win32 supports large files, Cygwin currently uses 32-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 
+way to build perl from sources.
 
 =back
 
@@ -228,10 +231,10 @@ You may see some messages during Configure that seem suspicious.
 =item * I<dlsym()>
 
 I<ld2> is needed to build dynamic libraries, but it does not exist
-when dlsym() checking occurs (it is not created until `C<make>' runs).
+when C<dlsym()> checking occurs (it is not created until `C<make>' runs).
 You will see the following message:
 
-  Checking whether your dlsym() needs a leading underscore ...
+  Checking whether your C<dlsym()> needs a leading underscore ...
   ld2: not found
   I can't compile and run the test program.
   I'm guessing that dlsym doesn't need a leading underscore.
@@ -259,9 +262,11 @@ The following error occurs because of the Cygwin C<#define> of
 C<_LONG_DOUBLE>:
 
   Guessing which symbols your C compiler and preprocessor define...
-  try.c:<line#>: parse error
+  try.c:<line#>: missing binary operator
 
-This failure does not seem to cause any problems.
+This failure does not seem to cause any problems.  With older gcc
+versions, "parse error" is reported instead of "missing binary
+operator".
 
 =back
 
@@ -271,15 +276,14 @@ Simply run I<make> and wait:
 
   make 2>&1 | tee log.make
 
-=head2 Warnings on Cygwin
+=head2 Errors on Cygwin
 
-Warnings like these are normal:
+Errors like these are normal:
 
-  warning: overriding commands for target <file>
-  warning: ignoring old commands for target <file>
-
-  dllwrap: no export definition file provided
-  dllwrap: creating one, but that may not be what you want
+  ...
+  make: [extra.pods] Error 1 (ignored)
+  ...
+  make: [extras.make] Error 1 (ignored)
 
 =head2 ld2 on Cygwin
 
@@ -321,7 +325,7 @@ 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 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:
+these options, these tests will fail (listing not updated yet):
 
   Failed Test           List of failed
   ------------------------------------
@@ -336,69 +340,34 @@ these options, these tests will fail:
   lib/sdbm.t            2
   op/stat.t             9, 20 (.tmp not an executable extension)
 
-=head2 Hard Links on Cygwin
-
-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 Cygwin
-
-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 on Cygwin
-
-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:
+=head2 NDBM_File and ODBM_File do not work on FAT filesystems
 
-  Win9x
-    Error Starting Program
-    A required .DLL file, CYGWIN1.DLL, was not found
+Do not use NDBM_File or ODBM_File on FAT filesystem.  They can be
+built on a FAT filesystem, but many tests will fail:
 
-  WinNT
-    perl.exe - Unable to Locate DLL
-    The dynamic link library cygwin1.dll could not be found in the
-      specified path ...
+ ../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
 
-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:
+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.
 
-  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:
+With NTFS (and CYGWIN=ntsec), there should be no problems even if
+perl was built on FAT.
 
-  cp /bin/cygwin1.dll t
+=head2 C<fork()> failures in io_* tests
 
-or one of the Windows system directories (although, this is B<not>
-recommended).
+A C<fork()> failure may result in the following tests failing:
 
-=head2 /etc/group on Cygwin
+  ext/IO/lib/IO/t/io_multihomed.t
+  ext/IO/lib/IO/t/io_sock.t
+  ext/IO/lib/IO/t/io_unix.t
 
-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
+See comment on fork in L<Miscellaneous> below.
 
 =head2 Script Portability on Cygwin
 
@@ -411,7 +380,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
@@ -428,20 +397,38 @@ to the translations applied to POSIX style pathnames).
 
 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>
+mode for an C<open()> is determined by the mode of the mount that underlies
+the file.  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:
 
     sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
 
-lseek(), tell() and sysseek() only work with files opened in binary mode.
+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.
 
+=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 
+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 
+environment settings (add this to your .bashrc):
+
+  export PERLIO=crlf
+
+which will pull in the crlf PerlIO layer which does LF -> CRLF conversion 
+on every output generated by perl.
+
 =item * F<.exe>
 
-The Cygwin stat(), lstat() and readlink() functions make the F<.exe>
+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.
@@ -449,28 +436,45 @@ 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> included
 with Cygwin automatically appends a F<.exe> when necessary.
 
-=item * chown()
+=item * C<chown()>
 
-On WinNT chown() can change a file's user and group IDs.  On Win9x 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 chroot() implementation has holes (it can not restrict file
+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.
+
+Using C<fork()> after loading multiple dlls may fail with an internal cygwin
+error like the following:
+
+  C:\CYGWIN\BIN\PERL.EXE: *** couldn't allocate memory 0x10000(4128768) for 'C:\CYGWIN\LIB\PERL5\5.6.1\CYGWIN-MULTI\AUTO\SOCKET\SOCKET.DLL' alignment, Win32 error 8
+
+    200 [main] perl 377147 sync_with_child: child -395691(0xB8) died before initialization with status code 0x1
+   1370 [main] perl 377147 sync_with_child: *** child state child loading dlls
+
+Use the rebase utility to resolve the conflicting dll addresses.  The
+rebase package is included in the Cygwin netrelease.  Use setup.exe from
+F<http://www.cygwin.com/setup.exe> to install it and run rebaseall.
+
 =back
 
 =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>.
@@ -486,7 +490,7 @@ 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.
+be kept as clean as possible (listing not updated yet).
 
 =over 4
 
@@ -496,7 +500,7 @@ be kept as clean as possible.
   Changes Changes5.005 Changes5.004 Changes5.6
   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
+  pod/perlhist.pod pod/perlmodlib.pod perl/buildtoc pod/perltoc.pod
 
 =item Build, Configure, Make, Install
 
@@ -561,23 +565,11 @@ be kept as clean as possible.
 
 =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().
+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.
 
-When building DLLs, `C<dllwrap --export-all-symbols>' is used to export
-global symbols.  It might be better to generate an explicit F<.def> file
-(see F<makedef.pl>).  Also, DLLs can now be build with `C<gcc -shared>'.
-
 =head1 AUTHORS
 
 Charles Wilson <cwilson@ece.gatech.edu>,
@@ -585,8 +577,9 @@ 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 P. Haase <gp@familiehaase.de>.
 
 =head1 HISTORY
 
-Last updated: 9 November 2000
+Last updated: 2003-08-12