system calls and environment these programs expect. More information
about this project can be found at:
- http://www.cygwin.com/
+ F<http://www.cygwin.com/>
A recent net or commercial release of Cygwin is required.
-At the time this document was last updated, Cygwin 1.3.10 was current.
+At the time this document was last updated, Cygwin 1.5.24 was current.
=head2 Cygwin Configuration
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 directories and files, to be safe you may want to run a `C<chmod
--R +w *>' on the entire Perl source tree.
+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
that is a member of the I<Administrators> group will be owned by the
GDBM is available for Cygwin.
+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.
+NOTE: The BerkeleyDB library only completely works on NTFS partitions
+and db-4.3 is flawed.
-=item * C<-lcygipc> (C<use IPC::SysV>)
+=item * C<cygserver> (C<use IPC::SysV>)
A port of SysV IPC is available for Cygwin.
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). NO LONGER SUPPORTED!
+CPAN modules). CURRENTLY NOT SUPPORTED!
=item * C<-lutil>
=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, which is now the
-default.
+Undefining this symbol disables the PerlIO abstraction. PerlIO is now the
+default; it is not recommended to disable PerlIO.
=item * C<-Dusemultiplicity>
=item * C<-Duse64bitint>
By default Perl uses 32 bit integers. If you want to use larger 64
-bit integers, define this symbol. If there is trouble, check that
-your Cygwin installation is up to date.
+bit integers, define this symbol.
=item * C<-Duselongdouble>
=item * C<-Dusethreads>
-POSIX threads are B<not> yet implemented in Cygwin completely.
+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.
+Details can be found in the F<INSTALL> document. This is the recommended
+way to build perl from sources.
=back
=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.
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
make 2>&1 | tee log.make
-=head2 Warnings on Cygwin
-
-Warnings like these are normal:
+=head2 Errors on Cygwin
- warning: overriding commands for target <file>
- warning: ignoring old commands for target <file>
+Errors like these are normal:
- 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
-During `C<make>', I<ld2> will be created and installed in your $installbin
+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
+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 `C<make>' will fail at some point. If this happens,
+The assumption is that I<$installbin> is in your current C<PATH>. If this
+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>.
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. If a test can pass in some Cygwin setup, it is always
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
+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
lib/sdbm.t 2
op/stat.t 9, 20 (.tmp not an executable extension)
+=head2 NDBM_File and ODBM_File do not work on FAT filesystems
+
+Do not use NDBM_File or ODBM_File on FAT filesystem. They can be
+built on a FAT filesystem, but many tests will fail:
+
+ ../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
+
+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.
+
+With NTFS (and no CYGWIN=nontsec), there should be no problems even if
+perl was built on FAT.
+
+=head2 C<fork()> failures in io_* tests
+
+A C<fork()> failure may result in the following tests failing:
+
+ ext/IO/lib/IO/t/io_multihomed.t
+ ext/IO/lib/IO/t/io_sock.t
+ ext/IO/lib/IO/t/io_unix.t
+
+See comment on fork in L<Miscellaneous> below.
+
+=head1 Specific features of the Cygwin port
+
=head2 Script Portability on Cygwin
Cygwin does an outstanding job of providing UNIX-like semantics on top of
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
+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
+F<http://www.okisoft.co.jp/esc/utf8-cygwin/>
+
=item * Text/Binary
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. See C<Cygwin::is_binmount()> and C<Cygwin::is_textmount()>.
+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.
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 * 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.
-On WinNT chown() can change a file's user and group IDs. On Win9x chown()
+=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 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 ( perl -i ) of files doesn't work without doing a backup
-of the file being edited ( perl -i.bak ).
-
+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
+
+=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
+
+=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
+"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.
+
+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
+
+=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::is_textmount>
+
+Returns true if the given cygwin path is mounted in textmode (C<"\r\n"> C<lt>=C<gt> C<"\n">),
+false if the path is mounted binary. The result is complementary to C<Cygwin::is_binmount()>.
+
=back
=head1 INSTALL PERL ON CYGWIN
make install 2>&1 | tee log.make-install
-NOTE: If C<STDERR> is redirected `C<make install>' will B<not> prompt
+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
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
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
=item Compiled Perl Source
EXTERN.h - __declspec(dllimport)
XSUB.h - __declspec(dllexport)
- cygwin/cygwin.c - os_extras (getcwd, spawn)
+ cygwin/cygwin.c - os_extras (getcwd, spawn, and several Cygwin:: functions)
perl.c - os_extras
perl.h - binmode
doio.c - win9x can not rename a file when it is open
lib/ExtUtils/MM_Cygwin.pm
- canonpath, cflags, manifypods, perl_archive
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/Temp.pm - no directory sticky bit
lib/perl5db.pl - use stdin not /dev/tty
=head1 BUGS ON CYGWIN
-When I<make> starts, it warns about overriding commands for F<perlmain.o>.
-
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.
Steven Morlock <newspost@morlock.net>,
Sebastien Barre <Sebastien.Barre@utc.fr>,
Teun Burgers <burgers@ecn.nl>,
-Gerrit Haase <gh@familiehaase.de>.
+Gerrit P. Haase <gp@familiehaase.de>,
+Reini Urban <rurban@cpan.org>,
+Jan Dubois <jand@activestate.com>.
=head1 HISTORY
-Last updated: 2002-02-27
+Last updated: 2007-08-12