1NAME 2README.cygwin - Perl for Cygwin 3SYNOPSIS 4This 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. 5NOTE: 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: 6 http://cygutils.netpedia.net/ 7PREREQUISITES 8Cygwin = GNU+Cygnus+Windows (Don't leave UNIX without it) 9The 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: 10 http://www.cygwin.com/ 11A recent net or commercial release of Cygwin is required. 12At the time this document was last updated, Cygwin 1.1.5 was current. 13NOTE: 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 http://cygutils.netpedia.net/. If there is significant demand, a patch kit can be developed to port back to earlier Cygwin versions. 14Cygwin Configuration 15While building Perl some changes may be necessary to your Cygwin setup so that Perl builds cleanly. These changes are not required for normal Perl usage. 16NOTE: The binaries that are built will run on all Win32 versions. They do not depend on your host system (Win9x/WinME, WinNT/Win2K) or your Cygwin configuration (ntea, ntsec, binary/text mounts). 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"). 17PATH 18Set the PATH environment variable so that Configure finds the Cygwin versions of programs. Any Windows directories should be removed or moved to the end of your PATH. 19nroff 20If you do not have nroff (which is part of the groff package), Configure will not prompt you to install man pages. 21Permissions 22On WinNT with either the ntea or ntsec 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 `chmod -R +w *' on the entire Perl source tree. 23Also, it is a well known WinNT "feature" that files created by a login that is a member of the Administrators group will be owned by the Administrators group. Depending on your umask, you may find that you can not write to files that you just created (because you are no longer the owner). When using the ntsec CYGWIN setting, this is not an issue because it "corrects" the ownership to what you would expect on a UNIX system. 24CONFIGURE 25The default options gathered by Configure with the assistance of hints/cygwin.sh will build a Perl that supports dynamic loading (which requires a shared libperl.dll). 26This will run Configure and keep a record: 27 ./Configure 2>&1 | tee log.configure 28If you are willing to accept all the defaults run Configure with -de. However, several useful customizations are available. 29Strip Binaries 30It 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, 31 Any additional ld flags (NOT including libraries)? [none] -s 32 Any special flags to pass to gcc to use dynamic linking? [none] -s 33 Any special flags to pass to ld2 to create a dynamically loaded library? 34 [none] -s 35or you can edit hints/cygwin.sh and uncomment the relevant variables near the end of the file. 36Optional Libraries 37Several 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 http://cygutils.netpedia.net/. 38-lcrypt 39The crypt package distributed with Cygwin is a Linux compatible 56-bit DES crypt port by Corinna Vinschen. 40Alternatively, the crypt libraries in GNU libc have been ported to Cygwin. 41The DES based Ultra Fast Crypt port was done by Alexey Truhan: 42 ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/cw32crypt-dist-0.tgz 43NOTE: There are various export restrictions on DES implementations, see the glibc README for more details. 44The MD5 port was done by Andy Piper: 45 ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz 46-lgdbm (use GDBM_File) 47GDBM is available for Cygwin. GDBM's ndbm/dbm compatibility feature also makes NDBM_File and ODBM_File possible (although they add little extra value). 48NOTE: The ndbm/dbm emulations only completely work on NTFS partitions. 49-ldb (use DB_File) 50BerkeleyDB is available for Cygwin. Some details can be found in ext/DB_File/DB_File.pm. 51NOTE: The BerkeleyDB library only completely works on NTFS partitions. 52-lcygipc (use IPC::SysV) 53A port of SysV IPC is available for Cygwin. 54NOTE: This has not been extensively tested. In particular, d_semctl_semun is undefined because it fails a Configure test and on Win9x the shm*() functions seem to hang. It also creates a compile time dependency because perl.h includes <sys/ipc.h> and <sys/sem.h> (which will be required in the future when compiling CPAN modules). 55Configure-time Options 56The 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. 57-Uusedl 58Undefining this symbol forces Perl to be compiled statically. 59-Uusemymalloc 60By 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. 61-Dusemultiplicity 62Multiplicity is required when embedding Perl in a C program and using more than one interpreter instance. This works with the Cygwin port. 63-Duseperlio 64The PerlIO abstraction works with the Cygwin port. 65-Duse64bitint 66gcc supports 64-bit integers. However, several additional long long functions are necessary to use them within Perl ({strtol,strtoul}l). These are not yet available with Cygwin. 67-Duselongdouble 68gcc 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 are not yet available with Cygwin. 69-Dusethreads 70POSIX threads are not yet implemented in Cygwin. 71-Duselargefiles 72Although Win32 supports large files, Cygwin currently uses 32-bit integers for internal size and position calculations. 73Suspicious Warnings 74You may see some messages during Configure that seem suspicious. 75dlsym() 76ld2 is needed to build dynamic libraries, but it does not exist when dlsym() checking occurs (it is not created until `make' runs). You will see the following message: 77 Checking whether your dlsym() needs a leading underscore ... 78 ld2: not found 79 I can't compile and run the test program. 80 I'm guessing that dlsym doesn't need a leading underscore. 81Since the guess is correct, this is not a problem. 82Win9x and d_eofnblk 83Win9x does not correctly report EOF with a non-blocking read on a closed pipe. You will see the following messages: 84 But it also returns -1 to signal EOF, so be careful! 85 WARNING: you can't distinguish between EOF and no data! 86 *** WHOA THERE!!! *** 87 The recommended value for $d_eofnblk on this machine was "define"! 88 Keep the recommended value? [y] 89At least for consistency with WinNT, you should keep the recommended value. 90Compiler/Preprocessor defines 91The following error occurs because of the Cygwin #define of _LONG_DOUBLE: 92 Guessing which symbols your C compiler and preprocessor define... 93 try.c:<line#>: parse error 94This failure does not seem to cause any problems. 95MAKE 96Simply run make and wait: 97 make 2>&1 | tee log.make 98Warnings 99Warnings like these are normal: 100 warning: overriding commands for target <file> 101 warning: ignoring old commands for target <file> 102 dllwrap: no export definition file provided 103 dllwrap: creating one, but that may not be what you want 104ld2 105During `make', ld2 will be created and installed in your $installbin directory (where you said to put public executables). It does not wait until the `make install' process to install the ld2 script, this is because the remainder of the `make' refers to ld2 without fully specifying its path and does this from multiple subdirectories. The assumption is that $installbin is in your current PATH. If this is not the case `make' will fail at some point. If this happens, just manually copy ld2 from the source directory to somewhere in your PATH. 106TEST 107There are two steps to running the test suite: 108 make test 2>&1 | tee log.make-test 109 cd t;./perl harness 2>&1 | tee ../log.harness 110The same tests are run both times, but more information is provided when running as `./perl harness'. 111Test 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. 112File Permissions 113UNIX 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 the ntea CYGWIN setting, the additional mode bits are stored as extended file attributes. On WinNT with the ntsec CYGWIN setting, permissions use the standard WinNT security descriptors and access control lists. Without one of these options, these tests will fail: 114 Failed Test List of failed 115 ------------------------------------ 116 io/fs.t 5, 7, 9-10 117 lib/anydbm.t 2 118 lib/db-btree.t 20 119 lib/db-hash.t 16 120 lib/db-recno.t 18 121 lib/gdbm.t 2 122 lib/ndbm.t 2 123 lib/odbm.t 2 124 lib/sdbm.t 2 125 op/stat.t 9, 20 (.tmp not an executable extension) 126Hard Links 127FAT 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 st_nlink to 1, so the link count for remote directories and files is not available. In either case, these tests will fail: 128 Failed Test List of failed 129 ------------------------------------ 130 io/fs.t 4 131 op/stat.t 3 132Filetime Granularity 133On FAT partitions the filetime granularity is 2 seconds. The following test will fail: 134 Failed Test List of failed 135 ------------------------------------ 136 io/fs.t 18 137Tainting Checks 138When Perl is running in taint mode, $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: 139 Win9x 140 Error Starting Program 141 A required .DLL file, CYGWIN1.DLL, was not found 142 WinNT 143 perl.exe - Unable to Locate DLL 144 The dynamic link library cygwin1.dll could not be found in the 145 specified path ... 146Just click OK and ignore them. When running `make test', 2 popups occur. During `./perl harness', 4 popups occur. Also, these tests will fail: 147 Failed Test List of failed 148 ------------------------------------ 149 op/taint.t 1, 3, 31, 37 150Alternatively, you can copy cygwin1.dll into the directory where the tests run: 151 cp /bin/cygwin1.dll t 152or one of the Windows system directories (although, this is not recommended). 153/etc/group 154Cygwin does not require /etc/group, in which case the op/grent.t test will be skipped. The check performed by op/grent.t expects to see entries that use the members field, otherwise this test will fail: 155 Failed Test List of failed 156 ------------------------------------ 157 op/grent.t 1 158Script Portability 159Cygwin 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. 160Pathnames 161Cygwin pathnames can be separated by forward (/) or backward (\) slashes. They may also begin with drive letters (C:) or Universal Naming Codes (//UNC). DOS device names (aux, con, prn, com*, lpt?, nul) are invalid as base filenames. However, they can be used in extensions (e.g., hello.aux). Names may contain all printable characters except these: 162 : * ? " < > | 163File 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). 164Text/Binary 165When 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 O_TEXT flag sets text mode on files that otherwise would be treated as binary: 166 sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT) 167lseek(), tell() and sysseek() only work with files opened in binary mode. 168The text/binary issue is covered at length in the Cygwin documentation. 169.exe 170The Cygwin stat(), lstat() and readlink() functions make the .exe extension transparent by looking for foo.exe when you ask for foo (unless a foo also exists). Cygwin does not require a .exe extension, but gcc 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. The install included with Cygwin automatically appends a .exe when necessary. 171chown() 172On 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. 173Miscellaneous 174File locking using the F_GETLK command to fcntl() is a stub that returns ENOSYS. 175Win9x can not rename() an open file (although WinNT can). 176The Cygwin chroot() implementation has holes (it can not restrict file access by native Win32 programs). 177INSTALL 178This will install Perl, including man pages. 179 make install | tee log.make-install 180NOTE: If STDERR is redirected `make install' will not prompt you to install perl into /usr/bin. 181You may need to be Administrator to run `make install'. If you are not, you must have write access to the directories in question. 182Information on installing the Perl documentation in HTML format can be found in the INSTALL document. 183MANIFEST 184These 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. 185Documentation 186 INSTALL README.cygwin README.win32 MANIFEST 187 Changes Changes5.005 Changes5.004 Changes5.6 188 pod/perl.pod pod/perlport.pod pod/perlfaq3.pod 189 pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod 190 pod/perlhist.pod pod/perlmodlib.pod pod/buildtoc.PL pod/perltoc.pod 191Build, Configure, Make, Install 192 cygwin/Makefile.SHs 193 cygwin/ld2.in 194 cygwin/perlld.in 195 ext/IPC/SysV/hints/cygwin.pl 196 ext/NDBM_File/hints/cygwin.pl 197 ext/ODBM_File/hints/cygwin.pl 198 hints/cygwin.sh 199 Configure - help finding hints from uname, 200 shared libperl required for dynamic loading 201 Makefile.SH - linklibperl 202 Porting/patchls - cygwin in port list 203 installman - man pages with :: translated to . 204 installperl - install dll/ld2/perlld, install to pods 205 makedepend.SH - uwinfix 206Tests 207 t/io/tell.t - binmode 208 t/lib/b.t - ignore Cwd from os_extras 209 t/lib/glob-basic.t - Win32 directory list access differs from read mode 210 t/op/magic.t - $^X/symlink WORKAROUND, s/.exe// 211 t/op/stat.t - no /dev, skip Win32 ftCreationTime quirk 212 (cache manager sometimes preserves ctime of file 213 previously created and deleted), no -u (setuid) 214Compiled Perl Source 215 EXTERN.h - __declspec(dllimport) 216 XSUB.h - __declspec(dllexport) 217 cygwin/cygwin.c - os_extras (getcwd, spawn) 218 perl.c - os_extras 219 perl.h - binmode 220 doio.c - win9x can not rename a file when it is open 221 pp_sys.c - do not define h_errno, pp_system with spawn 222 util.c - use setenv 223Compiled Module Source 224 ext/POSIX/POSIX.xs - tzname defined externally 225 ext/SDBM_File/sdbm/pair.c 226 - EXTCONST needs to be redefined from EXTERN.h 227 ext/SDBM_File/sdbm/sdbm.c 228 - binary open 229Perl Modules/Scripts 230 lib/Cwd.pm - hook to internal Cwd::cwd 231 lib/ExtUtils/MakeMaker.pm 232 - require MM_Cygwin.pm 233 lib/ExtUtils/MM_Cygwin.pm 234 - canonpath, cflags, manifypods, perl_archive 235 lib/File/Find.pm - on remote drives stat() always sets st_nlink to 1 236 lib/File/Spec/Unix.pm - preserve //unc 237 lib/File/Temp.pm - no directory sticky bit 238 lib/perl5db.pl - use stdin not /dev/tty 239 utils/perldoc.PL - version comment 240BUGS 241When make starts, it warns about overriding commands for perlmain.o. 242`make clean' does not remove library .def or .exe.stackdump files. 243The ld2 script contains references to the source directory. You should change these to $installbin after `make install'. 244Support 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. 245When building DLLs, `dllwrap --export-all-symbols' is used to export global symbols. It might be better to generate an explicit .def file (see makedef.pl). Also, DLLs can now be build with `gcc -shared'. 246AUTHORS 247Charles 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>. 248HISTORY 249Last updated: 9 November 2000 250