X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/538204d5c084ddeba9f54debc89d135829749520..60b22aca14742ead2388ca3c7bb4b542a2d9a4b1:/README.cygwin diff --git a/README.cygwin b/README.cygwin index 61b2601..6ea257a 100644 --- a/README.cygwin +++ b/README.cygwin @@ -27,11 +27,11 @@ 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: - http://www.cygwin.com/ + F A recent net or commercial release of Cygwin is required. -At the time this document was last updated, Cygwin 1.3.22 was current. +At the time this document was last updated, Cygwin 1.5.24 was current. =head2 Cygwin Configuration @@ -64,8 +64,8 @@ Configure will B prompt you to install I pages. On WinNT with either the I or I C 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' on the entire Perl source tree. +creates directories and files, to be safe you may want to run a +C 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 group will be owned by the @@ -98,9 +98,9 @@ binaries to be stripped, you can either add a B<-s> option when Configure prompts you, Any additional ld flags (NOT including libraries)? [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? + Any special flags to pass to g++ to create a dynamically loaded library? [none] -s + Any special flags to pass to gcc to use dynamic linking? [none] -s or you can edit F and uncomment the relevant variables near the end of the file. @@ -124,27 +124,29 @@ 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.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/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: - ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz + ftp://ftp.franken.de/pub/win32/develop/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz -=item * C<-lgdbm> (C) +=item * C<-lgdbm_compat> (C) GDBM is available for Cygwin. +NOTE: The GDBM library only works on NTFS partitions. + =item * C<-ldb> (C) -BerkeleyDB is available for Cygwin. Some details can be found in -F. +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) +=item * C (C) A port of SysV IPC is available for Cygwin. @@ -153,11 +155,11 @@ C is undefined because it fails a Configure test and on Win9x the I functions seem to hang. It also creates a compile time dependency because F includes F<> and F<> (which will be required in the future when compiling -CPAN modules). NO LONGER SUPPORTED! +CPAN modules). CURRENTLY NOT SUPPORTED! =item * C<-lutil> -Included with the standard Cygwin netrelease is the inetutils package +Included with the standard Cygwin netrelease is the inetutils package which includes libutil.a. =back @@ -182,8 +184,8 @@ want to force Perl to build with the system C 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. +Undefining this symbol disables the PerlIO abstraction. PerlIO is now the +default; it is not recommended to disable PerlIO. =item * C<-Dusemultiplicity> @@ -193,33 +195,31 @@ more than one interpreter instance. This works with the Cygwin port. =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> I 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, +(I<{atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l, strtold>). These are B yet available with Cygwin. =item * C<-Dusethreads> POSIX threads are implemented in Cygwin, define this symbol if you want -a threaded perl. If there is trouble, check that your Cygwin installation -is up to date. +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 document. This is the recommended -way to build perl form sources. +Details can be found in the F document. This is the recommended +way to build perl from sources. =back @@ -229,19 +229,6 @@ You may see some messages during Configure that seem suspicious. =over 4 -=item * I - -I is needed to build dynamic libraries, but it does not exist -when C checking occurs (it is not created until `C' runs). -You will see the following message: - - Checking whether your C 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 Win9x does not correctly report C with a non-blocking read on a @@ -277,45 +264,16 @@ Simply run I and wait: make 2>&1 | tee log.make -=head2 Warnings on Cygwin - -Warnings like these are normal: - - perl.c: In function `S_parse_body': - perl.c:1468: warning: implicit declaration of function `init_os_extras' - ... - pp_sys.c:289: warning: `S_emulate_eaccess' defined but not used - ... - perlio.c: In function `perlsio_binmode': - perlio.c:98: warning: implicit declaration of function `setmode' - perlio.c:98: warning: passing arg 1 of `Perl_PerlIO_fileno' from incompatible pointer type - ... - make: [extra.pods] Error 1 (ignored) - ... - make: [extras.make] Error 1 (ignored) - -=head2 ld2 on Cygwin - -During `C', I will be created and installed in your $installbin -directory (where you said to put public executables). It does not -wait until the `C' process to install the I script, -this is because the remainder of the `C' refers to I without -fully specifying its path and does this from multiple subdirectories. -The assumption is that $installbin is in your current C. If this -is not the case `C' will fail at some point. If this happens, -just manually copy I from the source directory to somewhere in -your C. - =head1 TEST ON CYGWIN There are two steps to running the test suite: 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 @@ -332,8 +290,8 @@ 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 C setting, the additional mode bits are stored as extended file attributes. -On WinNT with the I C setting, permissions use the standard -WinNT security descriptors and access control lists. Without one of +On WinNT with the default I C 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 @@ -365,7 +323,7 @@ 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 CYGWIN=ntsec), there should be no problems even if +With NTFS (and no CYGWIN=nontsec), there should be no problems even if perl was built on FAT. =head2 C failures in io_* tests @@ -378,6 +336,8 @@ A C failure may result in the following tests failing: See comment on fork in L 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 @@ -402,14 +362,23 @@ 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). +For conversion we have C and +C. + +Pathnames may not contain Unicode characters. C still uses the +ANSI API calls and no Unicode calls because of newlib deficiencies. +There's an unofficial unicode patch for cygwin at +F + =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 C is determined by the mode of the mount that underlies -the file. Perl provides a C function to set binary mode on files -that otherwise would be treated as text. C with the C -flag sets text mode on files that otherwise would be treated as binary: +the file. See C. Perl provides a C function +to set binary mode on files that otherwise would be treated as text. +C with the C flag sets text mode on files that otherwise +would be treated as binary: sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT) @@ -420,19 +389,19 @@ 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 +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 the C call like this: open(FH, ">:crlf", "out.txt"); -which will do conversion from LF to CR/LF on the output, or in the +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 +which will pull in the crlf PerlIO layer which does LF -> CRLF conversion on every output generated by perl. =item * F<.exe> @@ -445,6 +414,20 @@ However, when accessing an executable as a normal file (e.g., I in a makefile) the F<.exe> is not transparent. The I included with Cygwin automatically appends a F<.exe> when necessary. +=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, which is not +the winpid. Use C and C +to translate between them. + +=item * Cygwin vs. Windows errors + +Under Cygwin, $^E is the same as $!. When using L, +use C to get the last Windows error. + =item * C On WinNT C can change a file's user and group IDs. On Win9x C @@ -460,9 +443,9 @@ Win9x can not C an open file (although WinNT can). The Cygwin C implementation has holes (it can not restrict file access by native Win32 programs). -Inplace editing C of files doesn't work without doing a backup +Inplace editing C of files doesn't work without doing a backup of the file being edited C because of windowish restrictions, -therefore Perl adds the suffix C<.bak> automatically if you use C +therefore Perl adds the suffix C<.bak> automatically if you use C without specifying a backup extension. Using C after loading multiple dlls may fail with an internal cygwin @@ -479,16 +462,85 @@ F to install it and run rebaseall. =back +=head2 Prebuilt methods: + +=over 4 + +=item C + +Returns the current working directory. + +=item C + +Translates a cygwin pid to the corresponding Windows pid (which may or +may not be the same). + +=item C + +Translates a Windows pid to the corresponding cygwin pid (if any). + +=item C + +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 + +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 + +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 + +Returns 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,noumount + +If 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,/cygdrive + +=item C + +Returns true if the given cygwin path is binary mounted, false if the +path is mounted in textmode. + +=back + =head1 INSTALL PERL ON CYGWIN This will install Perl, including I pages. make install 2>&1 | tee log.make-install -NOTE: If C is redirected `C' will B prompt +NOTE: If C is redirected C will B prompt you to install I into F. -You may need to be I to run `C'. If you +You may need to be I to run C. 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 @@ -499,76 +551,211 @@ found in the F 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 (listing not updated yet). +be kept as clean as possible. =over 4 =item Documentation INSTALL README.cygwin README.win32 MANIFEST - 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/perl561delta.pod pod/perl570delta.pod pod/perl572delta.pod + pod/perl573delta.pod pod/perl58delta.pod pod/perl581delta.pod + pod/perl590delta.pod pod/perlhist.pod pod/perlmodlib.pod + pod/perltoc.pod pod.lst Porting/Glossary pod/perlrepository.pod + Porting/checkAUTHORS.pl + dist/Cwd/Changes ext/Compress-Raw-Zlib/Changes + ext/Compress-Raw-Zlib/README ext/Compress-Zlib/Changes + ext/DB_File/Changes ext/Encode/Changes ext/Sys-Syslog/Changes + ext/Time-HiRes/Changes ext/Win32API-File/Changes lib/CGI/Changes + lib/ExtUtils/CBuilder/Changes lib/ExtUtils/Changes lib/ExtUtils/NOTES + lib/ExtUtils/PATCHING lib/ExtUtils/README lib/Module/Build/Changes + lib/Net/Ping/Changes lib/Test/Harness/Changes + lib/Term/ANSIColor/ChangeLog lib/Term/ANSIColor/README README.symbian + symbian/TODO =item Build, Configure, Make, Install cygwin/Makefile.SHs - cygwin/ld2.in - cygwin/perlld.in ext/IPC/SysV/hints/cygwin.pl ext/NDBM_File/hints/cygwin.pl ext/ODBM_File/hints/cygwin.pl hints/cygwin.sh Configure - help finding hints from uname, shared libperl required for dynamic loading - Makefile.SH - linklibperl + Makefile.SH Cross/Makefile-cross-SH + - linklibperl Porting/patchls - cygwin in port list installman - man pages with :: translated to . - installperl - install dll/ld2/perlld, install to pods + installperl - install dll, install to 'pods' makedepend.SH - uwinfix + regen_lib.pl - file permissions + + NetWare/Makefile + plan9/mkfile + symbian/sanity.pl symbian/sisify.pl + hints/uwin.sh + vms/descrip_mms.template + win32/Makefile win32/makefile.mk =item Tests + t/io/fs.t - no file mode checks if not ntsec + skip rename() check when not check_case:relaxed t/io/tell.t - binmode - t/lib/b.t - ignore Cwd from os_extras - t/lib/glob-basic.t - Win32 directory list access differs from read mode + t/lib/cygwin.t - builtin cygwin function tests + t/op/groups.t - basegroup has ID = 0 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) + t/op/taint.t - can't use empty path under Cygwin Perl + t/op/time.t - no tzset() =item Compiled Perl Source EXTERN.h - __declspec(dllimport) XSUB.h - __declspec(dllexport) - cygwin/cygwin.c - os_extras (getcwd, spawn) - perl.c - os_extras + cygwin/cygwin.c - os_extras (getcwd, spawn, and several Cygwin:: functions) + perl.c - os_extras, -i.bak 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 + pp_sys.c - do not define h_errno, init _pwent_struct.pw_comment util.c - use setenv + util.h - PERL_FILE_IS_ABSOLUTE macro + pp.c - Comment about Posix vs IEEE math under Cygwin + perlio.c - CR/LF mode + perliol.c - Comment about EXTCONST under Cygwin =item Compiled Module Source + ext/Compress-Raw-Zlib/Makefile.PL + - Can't install via CPAN shell under Cygwin + ext/Compress-Raw-Zlib/zlib-src/zutil.h + - Cygwin is Unix-like and has vsnprintf + ext/Errno/Errno_pm.PL - Special handling for Win32 Perl under Cygwin ext/POSIX/POSIX.xs - tzname defined externally ext/SDBM_File/sdbm/pair.c - EXTCONST needs to be redefined from EXTERN.h ext/SDBM_File/sdbm/sdbm.c - binary open + ext/Sys/Syslog/Syslog.xs + - Cygwin has syslog.h + ext/Sys/Syslog/win32/compile.pl + - Convert paths to Windows paths + ext/Time-HiRes/HiRes.xs + - Various timers not available + ext/Time-HiRes/Makefile.PL + - Find w32api/windows.h + ext/Win32/Makefile.PL - Use various libraries under Cygwin + ext/Win32/Win32.xs - Child dir and child env under Cygwin + ext/Win32API-File/File.xs + - _open_osfhandle not implemented under Cygwin + ext/Win32CORE/Win32CORE.c + - __declspec(dllexport) =item Perl Modules/Scripts + ext/B/t/OptreeCheck.pm - Comment about stderr/stdout order under Cygwin + ext/Digest-SHA/bin/shasum + - Use binary mode under Cygwin + ext/Sys/Syslog/win32/Win32.pm + - Convert paths to Windows paths + ext/Time-HiRes/HiRes.pm + - Comment about various timers not available + ext/Win32API-File/File.pm + - _open_osfhandle not implemented under Cygwin + ext/Win32CORE/Win32CORE.pm + - History of Win32CORE under Cygwin + lib/CGI.pm - binmode and path separator + lib/CPANPLUS/Dist/MM.pm - Commented out code that fails under Win32/Cygwin + lib/CPANPLUS/Internals/Constants/Report.pm + - OS classifications + lib/CPANPLUS/Internals/Constants.pm + - Contants for Cygwin + lib/CPANPLUS/Internals/Report.pm + - Example of Cygwin report + lib/CPANPLUS/Module.pm + - Abort if running on old Cygwin version lib/Cwd.pm - hook to internal Cwd::cwd + lib/ExtUtils/CBuilder/Platform/cygwin.pm + - use gcc for ld, and link to libperl.dll.a + lib/ExtUtils/CBuilder.pm + - Cygwin is Unix-like + lib/ExtUtils/Install.pm - Install and rename issues under Cygwin + lib/ExtUtils/MM.pm - OS classifications + lib/ExtUtils/MM_Any.pm - Example for Cygwin lib/ExtUtils/MakeMaker.pm - require MM_Cygwin.pm lib/ExtUtils/MM_Cygwin.pm - canonpath, cflags, manifypods, perl_archive + lib/File/Fetch.pm - Comment about quotes using a Cygwin example 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/Spec/Win32.pm - References a message on cygwin.com + lib/File/Spec.pm - Pulls in lib/File/Spec/Cygwin.pm lib/File/Temp.pm - no directory sticky bit + lib/Module/Build/Compat.pm - Comment references 'make' under Cygwin + lib/Module/Build/Platform/cygwin.pm + - Use '.' for man page separator + lib/Module/Build.pm - Cygwin is Unix-like + lib/Module/CoreList.pm - List of all module files and versions + lib/Net/Domain.pm - No domainname command under Cygwin + lib/Net/Netrc.pm - Bypass using stat() under Cygwin + lib/Net/Ping.pm - ECONREFUSED is EAGAIN under Cygwin + lib/Pod/Find.pm - Set 'pods' dir + lib/Pod/Perldoc/ToMan.pm - '-c' switch for pod2man + lib/Pod/Perldoc.pm - Use 'less' pager, and use .exe extension + lib/Term/ANSIColor.pm - Cygwin terminal info lib/perl5db.pl - use stdin not /dev/tty - utils/perldoc.PL - version comment + utils/perlbug.PL - Add CYGWIN environment variable to report + +=item Perl Module Tests + + dist/Cwd/t/cwd.t + ext/Compress-Zlib/t/14gzopen.t + ext/DB_File/t/db-btree.t + ext/DB_File/t/db-hash.t + ext/DB_File/t/db-recno.t + ext/DynaLoader/t/DynaLoader.t + ext/File-Glob/t/basic.t + ext/GDBM_File/t/gdbm.t + ext/POSIX/t/sysconf.t + ext/POSIX/t/time.t + ext/SDBM_File/t/sdbm.t + ext/Sys/Syslog/t/syslog.t + ext/Time-HiRes/t/HiRes.t + ext/Win32/t/Unicode.t + ext/Win32API-File/t/file.t + ext/Win32CORE/t/win32core.t + lib/AnyDBM_File.t + lib/Archive/Extract/t/01_Archive-Extract.t + lib/Archive/Tar/t/02_methods.t + lib/CPANPLUS/t/05_CPANPLUS-Internals-Fetch.t + lib/CPANPLUS/t/20_CPANPLUS-Dist-MM.t + lib/ExtUtils/t/Embed.t + lib/ExtUtils/t/eu_command.t + lib/ExtUtils/t/MM_Cygwin.t + lib/ExtUtils/t/MM_Unix.t + lib/File/Compare.t + lib/File/Copy.t + lib/File/Find/t/find.t + lib/File/Path.t + lib/File/Spec/t/crossplatform.t + lib/File/Spec/t/Spec.t + lib/Module/Build/t/destinations.t + lib/Net/hostent.t + lib/Net/Ping/t/110_icmp_inst.t + lib/Net/Ping/t/500_ping_icmp.t + lib/Net/t/netrc.t + lib/Pod/Simple/t/perlcyg.pod + lib/Pod/Simple/t/perlcygo.txt + lib/Pod/Simple/t/perlfaq.pod + lib/Pod/Simple/t/perlfaqo.txt + lib/User/grent.t + lib/User/pwent.t =back @@ -587,8 +774,11 @@ alexander smishlajev , Steven Morlock , Sebastien Barre , Teun Burgers , -Gerrit P. Haase . +Gerrit P. Haase , +Reini Urban , +Jan Dubois , +Jerry D. Hedden . =head1 HISTORY -Last updated: 2003-03-20 +Last updated: 2007-09-25