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
+version of Perl is provided on the Cygwin CD. If you do not need to
customize the configuration, consider using one of these packages:
http://cygutils.netpedia.net/
system calls and environment these programs expect. More information
about this project can be found at:
- http://sourceware.cygnus.com/cygwin/
+ http://sources.redhat.com/cygwin/
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.1.4 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/
+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
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 (Win9x/WinME, WinNT/Win2K)
+or your Cygwin configuration (I<ntea>, I<ntsec>, binary/text mounts).
+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
versions of programs. Any 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.
+Configure will B<not> prompt you to install I<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
+creates directories and files, 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
./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
prompts you,
Any additional ld flags (NOT including libraries)? [none] -s
- Any special flags to pass to gcc to use dynamic loading? [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?
[none] -s
=item * C<-lcrypt>
-The crypt libraries in GNU libc have been ported to Cygwin.
+The crypt package distributed with Cygwin is a Linux compatible 56-bit
+DES crypt port by Corinna Vinschen.
+
+Alternatively, the crypt libraries in GNU libc have been ported to Cygwin.
-The DES based Ultra Fast Crypt port was done by Alexey Truhan
+The DES based Ultra Fast Crypt port was done by Alexey Truhan:
- http://dome.weeg.uiowa.edu/pub/domestic/sos/cw32crypt-dist-0.tgz
+ ftp://ftp.franken.de/pub/win32/develop/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:
- http://dome.weeg.uiowa.edu/pub/domestic/sos/libcrypt.tgz
-
-More information can also be found at:
-
- http://miracle.geol.msu.ru/sos/
+ ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz
=item * C<-lgdbm> (C<use GDBM_File>)
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.
+
=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>.
-=item * C<-lcygipc> (C<use IPC::SysV>)
+NOTE: The BerkeleyDB library only completely works on NTFS partitions.
-A port of SysV IPC is available for Cygwin:
+=item * C<-lcygipc> (C<use IPC::SysV>)
- http://www.multione.capgemini.fr/tools/pack_ipc/
+A port of SysV IPC is available for Cygwin.
-The 1.3 release does not include ftok(), but code for ftok() can be
-borrowed from glibc.
+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).
=back
=head2 Configure-time Options
-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>
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.
+want to force Perl to build with the system malloc() undefine this symbol.
-=item * C<-Dusemultiplicty>
+=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.
The PerlIO abstraction works with the Cygwin port.
-=item * C<-Duse64bits -Duselonglong>
+=item * C<-Duse64bitint>
I<gcc> supports 64-bit integers. However, several additional long long
-functions are necessary to use them within Perl (I<{atol,strtoul}l>).
+functions are necessary to use them within Perl (I<{strtol,strtoul}l>).
These are B<not> yet available with Cygwin.
=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<{sqrt,pow,atan2,exp,fmod,log,cos,frexp,sin,floor,modf,atof}l>).
+(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>
=item * C<-Duselargefiles>
-Although Win32 supports large files, Cygwin currently uses 32-bit ints
-for internal size and positional calculations.
+Although Win32 supports large files, Cygwin currently uses 32-bit integers
+for internal size and position calculations.
=back
=over 4
-=item * Whoa There
+=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).
+You will see the following message:
+
+ Checking whether your 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.
+
+Since the guess is correct, this is not a problem.
+
+=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:
-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.
+ But it also returns -1 to signal EOF, so be careful!
+ WARNING: you can't distinguish between EOF and no data!
*** WHOA THERE!!! ***
- The recommended value for $d_chroot on this machine was "undef"!
+ The recommended value for $d_eofnblk on this machine was "define"!
Keep the recommended value? [y]
-You should keep the recommended value.
+At least for consistency with WinNT, you should keep the recommended
+value.
=item * Checking how std your stdio is...
This is correct.
+=item * Compiler/Preprocessor defines
+
+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
+
+This failure does not seem to cause any problems.
+
+=back
+
=head1 MAKE
-Simply run make and wait:
+Simply run I<make> and wait:
make 2>&1 | tee log.make
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
+ dllwrap: no export definition file provided
+ dllwrap: creating one, but that may not be what you want
=head2 ld2
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>.
+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
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 the the reasons below.
+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
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 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:
Failed Test List of failed
------------------------------------
lib/db-hash.t 16
lib/db-recno.t 18
lib/gdbm.t 2
- lib/glob-basic.t 9 (directory always readable)
lib/ndbm.t 2
lib/odbm.t 2
lib/sdbm.t 2
=head2 Hard Links
FAT partitions do not support hard links (whereas NTFS does), in which
-case Cygwin implements link() by copying the file. These tests will fail:
+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
------------------------------------
A required .DLL file, CYGWIN1.DLL, was not found
WinNT
- perl.exe or sh.exe - Unable to Locate DLL
+ perl.exe - Unable to Locate DLL
The dynamic link library cygwin1.dll could not be found in the
specified path ...
------------------------------------
op/taint.t 1, 3, 31, 37
-Alternatively, you can copy F<cygwin1.dll> into one of the Windows system
-directories (although, this is B<not> recommended).
+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 need F</etc/group>, in which case the F<op/grent.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:
------------------------------------
op/grent.t 1
-=head2 Unexplained Failures
-
-Any additional tests that fail are likely due to bugs in Cygwin. It is
-expected that by the time of the next net release most of these will
-be solved so they are not described here. None of the current bugs are
-serious enough that workarounds are needed.
-
=head2 Script Portability
-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 about Cygwin can be found
-in the Cygwin documentation.
+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.
=over 4
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:
+F<com*>, F<lpt?>, F<nul>) are invalid as base filenames. However, they
+can be used in extensions (e.g., F<hello.aux>). Names may contain all
+printable characters except these:
: * ? " < > |
-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).
-
-The I<mixed> setting is only available with the "coolview" version of
-F<cygwin1.dll> provided by Sergey Okhapkin at:
-
- ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/
+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).
=item * Text/Binary
When a file is opened it is in either text or binary mode. In text mode
-it is subject to CR/LF/Ctrl-Z translations. Perl provides a binmode()
-function to force binary mode on files that otherwise would be treated
-as text. With Cygwin, the default mode for an open() is determined by the
-mode of the mount that underlies a file. For binmode() to be effective,
-the underlying mount must be text. There is no way to force text mode
-on a file underneath a binary mount. The text/binary issue is covered
-at length in the Cygwin documentation.
+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:
-lseek() only works with files opened in binary mode.
+ sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
-=item * F<.exe>
+lseek(), tell() and sysseek() only work with files opened in binary mode.
-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.
+The text/binary issue is covered at length in the Cygwin documentation.
-NOTE: There is a version of I<install> that understands F<.exe>, it can
-be found at:
+=item * F<.exe>
- ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Humblet_Pierre_A/
+The Cygwin stat(), lstat() and 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> included
+with Cygwin automatically appends a F<.exe> when necessary.
=item * chown()
-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.
+On WinNT chown() can change a file's user and group IDs. On Win9x 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
returns C<ENOSYS>.
-Win32 can not unlink() an open file (but this is emulated by Cygwin).
-
Win9x can not rename() an open file (although WinNT can).
+The Cygwin chroot() implementation has holes (it can not restrict file
+access by native Win32 programs).
+
=back
=head1 INSTALL
-This will install Perl, including man pages.
+This will install Perl, including I<man> pages.
- make install 2>&1 | tee log.make-install
+ make install | 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
are not, you must have write access to the directories in question.
=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
+ 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
=item Build, Configure, Make, Install
ext/NDBM_File/hints/cygwin.pl
ext/ODBM_File/hints/cygwin.pl
hints/cygwin.sh
- Porting/patchls - cygwin in port list
- Makefile.SH - linklibperl, cygwin/Makefile.SHs
- makedepend.SH - uwinfix
Configure - help finding hints from uname,
shared libperl required for dynamic loading
+ Makefile.SH - linklibperl
+ Porting/patchls - cygwin in port list
installman - man pages with :: translated to .
- installperl - install dll, install to pods
+ installperl - install dll/ld2/perlld, install to pods
+ makedepend.SH - uwinfix
=item Tests
t/io/tell.t - binmode
- t/op/magic.t - $^X WORKAROUND, s/.exe//
- t/op/stat.t - no /dev, no -u (setuid)
+ t/lib/b.t - ignore Cwd from os_extras
+ t/lib/glob-basic.t - Win32 directory list access differs from read mode
+ 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)
=item Compiled Perl Source
- 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)
+ perl.c - os_extras
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
- util.c - environ WORKAROUND
unixish.h - environ WORKAROUND
+ util.c - environ WORKAROUND
=item Compiled Module Source
=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
+ lib/Cwd.pm - hook to internal Cwd::cwd
lib/ExtUtils/MakeMaker.pm
- require MM_Cygwin.pm
lib/ExtUtils/MM_Cygwin.pm
- canonpath, cflags, manifypods, perl_archive
- lib/Cwd.pm - `pwd`
+ lib/File/Find.pm - on remote drives stat() always sets st_nlink to 1
+ lib/File/Spec/Unix.pm - preserve //unc
+ lib/File/Temp.pm - no directory sticky bit
+ lib/perl5db.pl - use stdin not /dev/tty
+ utils/perldoc.PL - version comment
=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).
+When I<make> starts, it warns about overriding commands for F<perlmain.o>.
-`C<make clean>' does not remove library F<.def> and F<.exe.stackdump>
+`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 C</usr/local/bin> (or whatever) after install.
+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
+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 <efifer@sanwaint.com>,
+alexander smishlajev <als@turnhere.com>,
+Steven Morlock <newspost@morlock.net>,
+Sebastien Barre <Sebastien.Barre@utc.fr>,
+Teun Burgers <burgers@ecn.nl>.
=head1 HISTORY
-Last updated: 28 January 2000
+Last updated: 15 August 2000