perlcygwin - Perl for Cygwin
This document will help you configure, make, test and install Perl on Cygwin. This document also describes features of Cygwin that will affect how Perl behaves at runtime.
NOTE: There are pre-built Perl packages available for Cygwin and a 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.
The Cygwin tools are ports of the popular GNU development tools for Win32 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:
A recent net or commercial release of Cygwin is required.
At the time this document was last updated, Cygwin 3.0.7 was current.
While building Perl some changes may be necessary to your Cygwin setup so that Perl builds cleanly. These changes arenot required for normal Perl usage.
NOTE: The binaries that are built will run on all Win32 versions. They do not depend on your host system or your Cygwin configuration (binary/text mounts, cygserver). The only dependencies come from hard-coded pathnames like/usr/local. However, your host system and Cygwin configuration will affect Perl's runtime behavior (see"TEST").
PATH
Set thePATH environment variable so that Configure finds the Cygwin versions of programs. Any not-needed Windows directories should be removed or moved to the end of yourPATH.
nroff
If you do not havenroff (which is part of thegroff package), Configure willnot prompt you to installman pages.
The default options gathered by Configure with the assistance ofhints/cygwin.sh will build a Perl that supports dynamic loading (which requires a sharedcygperl5_16.dll).
This will run Configure and keep a record:
./Configure 2>&1 | tee log.configureIf you are willing to accept all the defaults run Configure with-de. However, several useful customizations are available.
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 binaries to be stripped, you can either add a-s option when Configure prompts you,
Any additional ld flags (NOT including libraries)? [none] -sAny special flags to pass to g++ to create a dynamically loadedlibrary?[none] -sAny special flags to pass to gcc to use dynamic linking? [none] -sor you can edithints/cygwin.sh and uncomment the relevant variables 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 from the Cygwin installer.
-lcrypt
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.
As of libcrypt 1.3 (March 2016), you will need to install the libcrypt-devel package for Configure to detect crypt().
-lgdbm_compat (use GDBM_File)
GDBM is available for Cygwin.
NOTE: The GDBM library only works on NTFS partitions.
-ldb (use DB_File)
BerkeleyDB is available for Cygwin.
NOTE: The BerkeleyDB library only completely works on NTFS partitions.
cygserver (use IPC::SysV)
A port of SysV IPC is available for Cygwin.
NOTE: This hasnot been extensively tested. In particular,d_semctl_semun is undefined because it fails a Configure test. It also creates a compile time dependency becauseperl.h includes<sys/ipc.h> and<sys/sem.h> (which will be required in the future when compiling CPAN modules). CURRENTLY NOT SUPPORTED!
-lutil
Included with the standard Cygwin netrelease is the inetutils package which includes libutil.a.
TheINSTALL 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.
-Uusedl
Undefining this symbol forces Perl to be compiled statically.
-Dusemymalloc
By default Perl does not use themalloc() 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.
-Uuseperlio
Undefining this symbol disables the PerlIO abstraction. PerlIO is now the default; it is not recommended to disable PerlIO.
-Dusemultiplicity
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-Uuseithreads.
-Uuse64bitint
By default Perl uses 64 bit integers. If you want to use smaller 32 bit integers, define this symbol.
-Duselongdouble
gcc supports long doubles (12 bytes). However, several additional long double math functions are necessary to use them within Perl ({atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l, strtold). These arenot yet available with newlib, the Cygwin libc.
-Uuseithreads
Define this symbol if you want not-threaded faster perl.
-Duselargefiles
Cygwin uses 64-bit integers for internal size and position calculations, this will be correctly detected and defined by Configure.
-Dmksymlinks
Use this to build perl outside of the source tree. Details can be found in theINSTALL document. This is the recommended way to build perl from sources.
Simply runmake and wait:
make -jn 2>&1 | tee log.makewheren is the maximum number of simultaneous compilations you want; omitting this parameter is the same as specifying-j1.
There are two steps to running the test suite:
make test 2>&1 | tee log.make-testcd t; ./perl harness 2>&1 | tee ../log.harnessThe same tests are run both times, but more information is provided when running as./perl harness, and you can run the tests in parallel by instead specifying
cd t; TEST_JOBS=n ./perl harness 2>&1 | tee ../log.harnesswheren is the maximum number of tests to run simulataneously.
Test results vary depending on your host system and your Cygwin 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.
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 read-only attribute represented as the UNIX file user write bit (files are always readable, files are executable if they have a.{com,bat,exe} extension or begin with#!, directories are always readable and executable). On WinNT with thenteaCYGWIN setting, the additional mode bits are stored as extended file attributes. On WinNT with the defaultntsecCYGWIN 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------------------------------------io/fs.t 5, 7, 9-10lib/anydbm.t 2lib/db-btree.t 20lib/db-hash.t 16lib/db-recno.t 18lib/gdbm.t 2lib/ndbm.t 2lib/odbm.t 2lib/sdbm.t 2op/stat.t 9, 20 (.tmp not an executable extension)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-4run/fresh_perl.t 97 1 1.03% 91If 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.
fork() failures in io_* testsAfork() failure may result in the following tests failing:
ext/IO/lib/IO/t/io_multihomed.text/IO/lib/IO/t/io_sock.text/IO/lib/IO/t/io_unix.tSee comment on fork in"Miscellaneous" below.
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.
Pathnames
Cygwin pathnames are separated by forward (/) slashes, Universal Naming Codes (//UNC) are also supported. Since cygwin-1.7 non-POSIX pathnames should not be used. Names may contain all printable characters.
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.
For conversion we haveCygwin::win_to_posix_path() andCygwin::posix_to_win_path().
Since cygwin-1.7 pathnames are UTF-8 encoded.
Text/Binary
Since cygwin-1.7 textmounts are deprecated and strongly discouraged.
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 anopen() is determined by the mode of the mount that underlies the file. See"Cygwin::is_binmount"(). Perl provides abinmode() function to set binary mode on files that otherwise would be treated as text.sysopen() with theO_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() andsysseek() only work with files opened in binary mode.
The text/binary issue is covered at length in the Cygwin documentation.
PerlIO
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 theopen() 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=crlfwhich will pull in the crlf PerlIO layer which does LF -> CRLF conversion on every output generated by perl.
.exe
The Cygwinstat(),lstat() andreadlink() functions make the.exe extension transparent by looking forfoo.exe when you ask forfoo (unless afoo also exists). Cygwin does not require a.exe extension, butgcc adds it automatically when building a program. However, when accessing an executable as a normal file (e.g.,cp in a makefile) the.exe is not transparent. Theinstall program included with Cygwin automatically appends a.exe when necessary.
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.$$ is the cygwin pid of/usr/bin/perl, which is not the winpid. UseCygwin::pid_to_winpid() andCygwin::winpid_to_pid() to translate between them.
Cygwin vs. Windows errors
Under Cygwin, $^E is the same as $!. When usingWin32 API Functions, useWin32::GetLastError() to get the last Windows error.
rebase errors on fork or system
Usingfork() orsystem() out to another perl after loading multiple dlls may result on a DLL baseaddress conflict. The internal cygwin error looks like like the following:
0 [main] perl 8916 child_info_fork::abort: data segment start:parent (0xC1A000) != child(0xA6A000)or:
183 [main] perl 3588 C:\cygwin\bin\perl.exe: *** fatal error -unable to remap C:\cygwin\bin\cygsvn_subr-1-0.dll to same addressas parent(0x6FB30000) != 0x6FE60000 46 [main] perl 3488 fork: child3588 - died waiting for dll loading, errno11Seehttps://cygwin.com/faq/faq.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.
+Use the rebase utilities to resolve the conflicting dll addresses. The rebase package is included in the Cygwin setup. Usesetup.exe fromhttps://cygwin.com/install.html to install it.
1. kill all perl processes and run</bin/find <dir -xdev -name \*.dll | /bin/rebase -OT ->> or
2. kill all cygwin processes and services, and run setup.exe.
Miscellaneous
File locking using theF_GETLK command tofcntl() is a stub that returnsENOSYS.
The Cygwinchroot() implementation has holes (it can not restrict file access by native Win32 programs).
Inplace editingperl -i of files doesn't work without doing a backup of the file being editedperl -i.bak because of windowish restrictions, therefore Perl adds the suffix.bak automatically if you useperl -i without specifying a backup extension.
Cwd::cwdReturns the current working directory.
Cygwin::pid_to_winpidTranslates a cygwin pid to the corresponding Windows pid (which may or may not be the same).
Cygwin::winpid_to_pidTranslates a Windows pid to the corresponding cygwin pid (if any).
Cygwin::win_to_posix_pathTranslates 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.
Cygwin::posix_to_win_pathTranslates 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.
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,noumountCygwin::mount_flagsReturns 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".
system|user,binmode|textmode,exec,cygexec,cygdrive,mixed,notexec,managed,nosuid,devfs,proc,noumountIf 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,/cygdriveCygwin::is_binmountReturns true if the given cygwin path is binary mounted, false if the path is mounted in textmode.
Cygwin::sync_winenvCygwin does not initialize all original Win32 environment variables. See the bottom of this pagehttps://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.
This will install Perl, includingman pages.
make install 2>&1 | tee log.make-installNOTE: IfSTDERR is redirectedmake install willnot prompt you to installperl into/usr/bin.
You may need to beAdministrator to runmake 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 theINSTALL 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.
INSTALL README.cygwin README.win32 MANIFESTpod/perl.pod pod/perlport.pod pod/perlfaq3.podpod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.podpod/perl561delta.pod pod/perl570delta.pod pod/perl572delta.podpod/perl573delta.pod pod/perl58delta.pod pod/perl581delta.podpod/perl590delta.pod pod/perlhist.pod pod/perlmodlib.podpod/perltoc.pod Porting/Glossary pod/perlgit.podPorting/updateAUTHORS.pldist/Cwd/Changes ext/Compress-Raw-Zlib/Changesdist/Time-HiRes/Changesext/Compress-Raw-Zlib/README ext/Compress-Zlib/Changesext/DB_File/Changes ext/Encode/Changes ext/Sys-Syslog/Changesext/Win32API-File/Changeslib/ExtUtils/CBuilder/Changes lib/ExtUtils/Changeslib/ExtUtils/NOTES lib/ExtUtils/PATCHING lib/ExtUtils/READMElib/Net/Ping/Changes lib/Test/Harness/Changeslib/Term/ANSIColor/ChangeLog lib/Term/ANSIColor/READMEcygwin/Makefile.SHsext/IPC/SysV/hints/cygwin.plext/NDBM_File/hints/cygwin.plext/ODBM_File/hints/cygwin.plhints/cygwin.shConfigure - help finding hints from uname, shared libperl required for dynamic loadingMakefile.SH Cross/Makefile-cross-SH - linklibperlPorting/patchls - cygwin in port listinstallman - man pages with :: translated to .installperl - install dll, install to 'pods'makedepend.SH - uwinfixregen_lib.pl - file permissionsplan9/mkfilevms/descrip_mms.templatewin32/Makefilet/io/fs.t - no file mode checks if not ntsec skip rename() check when not check_case:relaxedt/io/tell.t - binmodet/lib/cygwin.t - builtin cygwin function testst/op/groups.t - basegroup has ID = 0t/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 Perlt/op/time.t - no tzset()EXTERN.h - __declspec(dllimport)XSUB.h - __declspec(dllexport)cygwin/cygwin.c - os_extras (getcwd, spawn, and several Cygwin:: functions)perl.c - os_extras, -i.bakperl.h - binmodedoio.c - win9x can not rename a file when it is openpp_sys.c - do not define h_errno, init _pwent_struct.pw_commentutil.c - use setenvutil.h - PERL_FILE_IS_ABSOLUTE macropp.c - Comment about Posix vs IEEE math under Cygwinperlio.c - CR/LF modeperliol.c - Comment about EXTCONST under Cygwinext/Compress-Raw-Zlib/Makefile.PL - Can't install via CPAN shell under Cygwinext/Compress-Raw-Zlib/zlib-src/zutil.h - Cygwin is Unix-like and has vsnprintfext/Errno/Errno_pm.PL - Special handling for Win32 Perl under Cygwinext/POSIX/POSIX.xs - tzname defined externallyext/SDBM_File/sdbm/pair.c - EXTCONST needs to be redefined from EXTERN.hext/SDBM_File/sdbm/sdbm.c - binary openext/Sys/Syslog/Syslog.xs - Cygwin has syslog.hext/Sys/Syslog/win32/compile.pl - Convert paths to Windows pathsext/Time-HiRes/HiRes.xs - Various timers not availableext/Time-HiRes/Makefile.PL - Find w32api/windows.hext/Win32/Makefile.PL - Use various libraries under Cygwinext/Win32/Win32.xs - Child dir and child env under Cygwinext/Win32API-File/File.xs - _open_osfhandle not implemented under Cygwinext/Win32CORE/Win32CORE.c - __declspec(dllexport)ext/B/t/OptreeCheck.pm - Comment about stderr/stdout order under Cygwinext/Digest-SHA/bin/shasum - Use binary mode under Cygwinext/Sys/Syslog/win32/Win32.pm - Convert paths to Windows pathsext/Time-HiRes/HiRes.pm - Comment about various timers not availableext/Win32API-File/File.pm - _open_osfhandle not implemented under Cygwinext/Win32CORE/Win32CORE.pm - History of Win32CORE under Cygwinlib/Cwd.pm - hook to internal Cwd::cwdlib/ExtUtils/CBuilder/Platform/cygwin.pm - use gcc for ld, and link to libperl.dll.alib/ExtUtils/CBuilder.pm - Cygwin is Unix-likelib/ExtUtils/Install.pm - Install and rename issues under Cygwinlib/ExtUtils/MM.pm - OS classificationslib/ExtUtils/MM_Any.pm - Example for Cygwinlib/ExtUtils/MakeMaker.pm - require MM_Cygwin.pmlib/ExtUtils/MM_Cygwin.pm - canonpath, cflags, manifypods, perl_archivelib/File/Fetch.pm - Comment about quotes using a Cygwin examplelib/File/Find.pm - on remote drives stat() always sets st_nlink to 1lib/File/Spec/Cygwin.pm - case_tolerantlib/File/Spec/Unix.pm - preserve //unclib/File/Spec/Win32.pm - References a message on cygwin.comlib/File/Spec.pm - Pulls in lib/File/Spec/Cygwin.pmlib/File/Temp.pm - no directory sticky bitlib/Module/CoreList.pm - List of all module files and versionslib/Net/Domain.pm - No domainname command under Cygwinlib/Net/Netrc.pm - Bypass using stat() under Cygwinlib/Net/Ping.pm - ECONREFUSED is EAGAIN under Cygwinlib/Pod/Find.pm - Set 'pods' dirlib/Pod/Perldoc/ToMan.pm - '-c' switch for pod2manlib/Pod/Perldoc.pm - Use 'less' pager, and use .exe extensionlib/Term/ANSIColor.pm - Cygwin terminal infolib/perl5db.pl - use stdin not /dev/ttyutils/perlbug.PL - Add CYGWIN environment variable to reportdist/Cwd/t/cwd.text/Compress-Zlib/t/14gzopen.text/DB_File/t/db-btree.text/DB_File/t/db-hash.text/DB_File/t/db-recno.text/DynaLoader/t/DynaLoader.text/File-Glob/t/basic.text/GDBM_File/t/gdbm.text/POSIX/t/sysconf.text/POSIX/t/time.text/SDBM_File/t/sdbm.text/Sys/Syslog/t/syslog.text/Time-HiRes/t/HiRes.text/Win32/t/Unicode.text/Win32API-File/t/file.text/Win32CORE/t/win32core.tlib/AnyDBM_File.tlib/Archive/Extract/t/01_Archive-Extract.tlib/Archive/Tar/t/02_methods.tlib/ExtUtils/t/Embed.tlib/ExtUtils/t/eu_command.tlib/ExtUtils/t/MM_Cygwin.tlib/ExtUtils/t/MM_Unix.tlib/File/Compare.tlib/File/Copy.tlib/File/Find/t/find.tlib/File/Path.tlib/File/Spec/t/crossplatform.tlib/File/Spec/t/Spec.tlib/Net/hostent.tlib/Net/Ping/t/110_icmp_inst.tlib/Net/Ping/t/500_ping_icmp.tlib/Net/t/netrc.tlib/Pod/Simple/t/perlcyg.podlib/Pod/Simple/t/perlcygo.txtlib/Pod/Simple/t/perlfaq.podlib/Pod/Simple/t/perlfaqo.txtlib/User/grent.tlib/User/pwent.tSupport for swapping real and effective user and group IDs is incomplete. On WinNT Cygwin providessetuid(),seteuid(),setgid() andsetegid(). However, additional Cygwin calls for manipulating WinNT access tokens and security contexts are required.
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>.
Last updated: 2019-11-14
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.