README.cygwin

   1 If you read this file _as_is_, just ignore the funny characters you
   2 see. It is written in the POD format (see pod/perlpod.pod) which is
   3 specially designed to be readable as is.
   4
   5 =head1 NAME
   6
   7 README.cygwin - Perl for Cygwin
   8
   9 =head1 SYNOPSIS
  10
  11 This document will help you configure, make, test and install Perl
  12 on Cygwin.  This document also describes features of Cygwin that will
  13 affect how Perl behaves at runtime.
  14
  15 B<NOTE:> There are pre-built Perl packages available for Cygwin and a
  16 version of Perl is provided in the normal Cygwin install.  If you do
  17 not need to customize the configuration, consider using one of those
  18 packages.
  19
  20
  21 =head1 PREREQUISITES FOR COMPILING PERL ON CYGWIN
  22
  23 =head2 Cygwin = GNU+Cygnus+Windows (Don't leave UNIX without it)
  24
  25 The Cygwin tools are ports of the popular GNU development tools for Win32
  26 platforms.  They run thanks to the Cygwin library which provides the UNIX
  27 system calls and environment these programs expect.  More information
  28 about this project can be found at:
  29
  30   http://www.cygwin.com/
  31
  32 A recent net or commercial release of Cygwin is required.
  33
  34 At the time this document was last updated, Cygwin 1.5.2 was current.
  35
  36
  37 =head2 Cygwin Configuration
  38
  39 While building Perl some changes may be necessary to your Cygwin setup so
  40 that Perl builds cleanly.  These changes are B<not> required for normal
  41 Perl usage.
  42
  43 B<NOTE:> The binaries that are built will run on all Win32 versions.
  44 They do not depend on your host system (Win9x/WinME, WinNT/Win2K)
  45 or your Cygwin configuration (I<ntea>, I<ntsec>, binary/text mounts).
  46 The only dependencies come from hard-coded pathnames like C</usr/local>.
  47 However, your host system and Cygwin configuration will affect Perl's
  48 runtime behavior (see L</"TEST">).
  49
  50 =over 4
  51
  52 =item * C<PATH>
  53
  54 Set the C<PATH> environment variable so that Configure finds the Cygwin
  55 versions of programs.  Any Windows directories should be removed or
  56 moved to the end of your C<PATH>.
  57
  58 =item * I<nroff>
  59
  60 If you do not have I<nroff> (which is part of the I<groff> package),
  61 Configure will B<not> prompt you to install I<man> pages.
  62
  63 =item * Permissions
  64
  65 On WinNT with either the I<ntea> or I<ntsec> C<CYGWIN> settings, directory
  66 and file permissions may not be set correctly.  Since the build process
  67 creates directories and files, to be safe you may want to run a `C<chmod
  68 -R +w *>' on the entire Perl source tree.
  69
  70 Also, it is a well known WinNT "feature" that files created by a login
  71 that is a member of the I<Administrators> group will be owned by the
  72 I<Administrators> group.  Depending on your umask, you may find that you
  73 can not write to files that you just created (because you are no longer
  74 the owner).  When using the I<ntsec> C<CYGWIN> setting, this is not an
  75 issue because it "corrects" the ownership to what you would expect on
  76 a UNIX system.
  77
  78 =back
  79
  80 =head1 CONFIGURE PERL ON CYGWIN
  81
  82 The default options gathered by Configure with the assistance of
  83 F<hints/cygwin.sh> will build a Perl that supports dynamic loading
  84 (which requires a shared F<libperl.dll>).
  85
  86 This will run Configure and keep a record:
  87
  88   ./Configure 2>&1 | tee log.configure
  89
  90 If you are willing to accept all the defaults run Configure with B<-de>.
  91 However, several useful customizations are available.
  92
  93 =head2 Stripping Perl Binaries on Cygwin
  94
  95 It is possible to strip the EXEs and DLLs created by the build process.
  96 The resulting binaries will be significantly smaller.  If you want the
  97 binaries to be stripped, you can either add a B<-s> option when Configure
  98 prompts you,
  99
 100   Any additional ld flags (NOT including libraries)? [none] -s
 101   Any special flags to pass to gcc to use dynamic linking? [none] -s
 102   Any special flags to pass to ld2 to create a dynamically loaded library?
 103   [none] -s
 104
 105 or you can edit F<hints/cygwin.sh> and uncomment the relevant variables
 106 near the end of the file.
 107
 108 =head2 Optional Libraries for Perl on Cygwin
 109
 110 Several Perl functions and modules depend on the existence of
 111 some optional libraries.  Configure will find them if they are
 112 installed in one of the directories listed as being used for library
 113 searches.  Pre-built packages for most of these are available from
 114 the Cygwin installer.
 115
 116 =over 4
 117
 118 =item * C<-lcrypt>
 119
 120 The crypt package distributed with Cygwin is a Linux compatible 56-bit
 121 DES crypt port by Corinna Vinschen.
 122
 123 Alternatively, the crypt libraries in GNU libc have been ported to Cygwin.
 124
 125 The DES based Ultra Fast Crypt port was done by Alexey Truhan:
 126
 127   ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/cw32crypt-dist-0.tgz
 128
 129 NOTE: There are various export restrictions on DES implementations,
 130 see the glibc README for more details.
 131
 132 The MD5 port was done by Andy Piper:
 133
 134   ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/porters/Okhapkin_Sergey/libcrypt.tgz
 135
 136 =item * C<-lgdbm> (C<use GDBM_File>)
 137
 138 GDBM is available for Cygwin.
 139
 140 NOTE: The GDBM library only works on NTFS partitions.
 141
 142 =item * C<-ldb> (C<use DB_File>)
 143
 144 BerkeleyDB is available for Cygwin.
 145
 146 NOTE: The BerkeleyDB library only completely works on NTFS partitions.
 147
 148 =item * C<-lcygipc> (C<use IPC::SysV>)
 149
 150 A port of SysV IPC is available for Cygwin.
 151
 152 NOTE: This has B<not> been extensively tested.  In particular,
 153 C<d_semctl_semun> is undefined because it fails a Configure test
 154 and on Win9x the I<shm*()> functions seem to hang.  It also creates
 155 a compile time dependency because F<perl.h> includes F<<sys/ipc.h>>
 156 and F<<sys/sem.h>> (which will be required in the future when compiling
 157 CPAN modules). CURRENTLY NOT SUPPORTED!
 158
 159 =item * C<-lutil>
 160
 161 Included with the standard Cygwin netrelease is the inetutils package
 162 which includes libutil.a.
 163
 164 =back
 165
 166 =head2 Configure-time Options for Perl on Cygwin
 167
 168 The F<INSTALL> document describes several Configure-time options.  Some of
 169 these will work with Cygwin, others are not yet possible.  Also, some of
 170 these are experimental.  You can either select an option when Configure
 171 prompts you or you can define (undefine) symbols on the command line.
 172
 173 =over 4
 174
 175 =item * C<-Uusedl>
 176
 177 Undefining this symbol forces Perl to be compiled statically.
 178
 179 =item * C<-Uusemymalloc>
 180
 181 By default Perl uses the C<malloc()> included with the Perl source.  If you
 182 want to force Perl to build with the system C<malloc()> undefine this symbol.
 183
 184 =item * C<-Uuseperlio>
 185
 186 Undefining this symbol disables the PerlIO abstraction.  PerlIO is now the
 187 default; it is not recommended to disable PerlIO.
 188
 189 =item * C<-Dusemultiplicity>
 190
 191 Multiplicity is required when embedding Perl in a C program and using
 192 more than one interpreter instance.  This works with the Cygwin port.
 193
 194 =item * C<-Duse64bitint>
 195
 196 By default Perl uses 32 bit integers.  If you want to use larger 64
 197 bit integers, define this symbol.
 198
 199 =item * C<-Duselongdouble>
 200
 201 I<gcc> supports long doubles (12 bytes).  However, several additional
 202 long double math functions are necessary to use them within Perl
 203 (I<{atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l,
 204 strtold>).
 205 These are B<not> yet available with Cygwin.
 206
 207 =item * C<-Dusethreads>
 208
 209 POSIX threads are implemented in Cygwin, define this symbol if you want
 210 a threaded perl.
 211
 212 =item * C<-Duselargefiles>
 213
 214 Cygwin uses 64-bit integers for internal size and position calculations,
 215 this will be correctly detected and defined by Configure.
 216
 217 =item * C<-Dmksymlinks>
 218
 219 Use this to build perl outside of the source tree.  This works with Cygwin.
 220 Details can be found in the F<INSTALL> document.  This is the recommended
 221 way to build perl from sources.
 222
 223 =back
 224
 225 =head2 Suspicious Warnings on Cygwin
 226
 227 You may see some messages during Configure that seem suspicious.
 228
 229 =over 4
 230
 231 =item * I<dlsym()>
 232
 233 I<ld2> is needed to build dynamic libraries, but it does not exist
 234 when C<dlsym()> checking occurs (it is not created until `C<make>' runs).
 235 You will see the following message:
 236
 237   Checking whether your C<dlsym()> needs a leading underscore ...
 238   ld2: not found
 239   I can't compile and run the test program.
 240   I'm guessing that dlsym doesn't need a leading underscore.
 241
 242 Since the guess is correct, this is not a problem.
 243
 244 =item * Win9x and C<d_eofnblk>
 245
 246 Win9x does not correctly report C<EOF> with a non-blocking read on a
 247 closed pipe.  You will see the following messages:
 248
 249   But it also returns -1 to signal EOF, so be careful!
 250   WARNING: you can't distinguish between EOF and no data!
 251
 252   *** WHOA THERE!!! ***
 253       The recommended value for $d_eofnblk on this machine was "define"!
 254       Keep the recommended value? [y]
 255
 256 At least for consistency with WinNT, you should keep the recommended
 257 value.
 258
 259 =item * Compiler/Preprocessor defines
 260
 261 The following error occurs because of the Cygwin C<#define> of
 262 C<_LONG_DOUBLE>:
 263
 264   Guessing which symbols your C compiler and preprocessor define...
 265   try.c:<line#>: missing binary operator
 266
 267 This failure does not seem to cause any problems.  With older gcc
 268 versions, "parse error" is reported instead of "missing binary
 269 operator".
 270
 271 =back
 272
 273 =head1 MAKE ON CYGWIN
 274
 275 Simply run I<make> and wait:
 276
 277   make 2>&1 | tee log.make
 278
 279 =head2 Errors on Cygwin
 280
 281 Errors like these are normal:
 282
 283   ...
 284   make: [extra.pods] Error 1 (ignored)
 285   ...
 286   make: [extras.make] Error 1 (ignored)
 287
 288 =head2 ld2 on Cygwin
 289
 290 During `C<make>', I<ld2> will be created and installed in your $installbin
 291 directory (where you said to put public executables).  It does not
 292 wait until the `C<make install>' process to install the I<ld2> script,
 293 this is because the remainder of the `C<make>' refers to I<ld2> without
 294 fully specifying its path and does this from multiple subdirectories.
 295 The assumption is that $installbin is in your current C<PATH>.  If this
 296 is not the case `C<make>' will fail at some point.  If this happens,
 297 just manually copy I<ld2> from the source directory to somewhere in
 298 your C<PATH>.
 299
 300 =head1 TEST ON CYGWIN
 301
 302 There are two steps to running the test suite:
 303
 304   make test 2>&1 | tee log.make-test
 305
 306   cd t;./perl harness 2>&1 | tee ../log.harness
 307
 308 The same tests are run both times, but more information is provided when
 309 running as `C<./perl harness>'.
 310
 311 Test results vary depending on your host system and your Cygwin
 312 configuration.  If a test can pass in some Cygwin setup, it is always
 313 attempted and explainable test failures are documented.  It is possible
 314 for Perl to pass all the tests, but it is more likely that some tests
 315 will fail for one of the reasons listed below.
 316
 317 =head2 File Permissions on Cygwin
 318
 319 UNIX file permissions are based on sets of mode bits for
 320 {read,write,execute} for each {user,group,other}.  By default Cygwin
 321 only tracks the Win32 read-only attribute represented as the UNIX file
 322 user write bit (files are always readable, files are executable if they
 323 have a F<.{com,bat,exe}> extension or begin with C<#!>, directories are
 324 always readable and executable).  On WinNT with the I<ntea> C<CYGWIN>
 325 setting, the additional mode bits are stored as extended file attributes.
 326 On WinNT with the I<ntsec> C<CYGWIN> setting, permissions use the standard
 327 WinNT security descriptors and access control lists.  Without one of
 328 these options, these tests will fail (listing not updated yet):
 329
 330   Failed Test           List of failed
 331   ------------------------------------
 332   io/fs.t               5, 7, 9-10
 333   lib/anydbm.t          2
 334   lib/db-btree.t        20
 335   lib/db-hash.t         16
 336   lib/db-recno.t        18
 337   lib/gdbm.t            2
 338   lib/ndbm.t            2
 339   lib/odbm.t            2
 340   lib/sdbm.t            2
 341   op/stat.t             9, 20 (.tmp not an executable extension)
 342
 343 =head2 NDBM_File and ODBM_File do not work on FAT filesystems
 344
 345 Do not use NDBM_File or ODBM_File on FAT filesystem.  They can be
 346 built on a FAT filesystem, but many tests will fail:
 347
 348  ../ext/NDBM_File/ndbm.t       13  3328    71   59  83.10%  1-2 4 16-71
 349  ../ext/ODBM_File/odbm.t      255 65280    ??   ??       %  ??
 350  ../lib/AnyDBM_File.t           2   512    12    2  16.67%  1 4
 351  ../lib/Memoize/t/errors.t      0   139    11    5  45.45%  7-11
 352  ../lib/Memoize/t/tie_ndbm.t   13  3328     4    4 100.00%  1-4
 353  run/fresh_perl.t                          97    1   1.03%  91
 354
 355 If you intend to run only on FAT (or if using AnyDBM_File on FAT),
 356 run Configure with the -Ui_ndbm and -Ui_dbm options to prevent
 357 NDBM_File and ODBM_File being built.
 358
 359 With NTFS (and CYGWIN=ntsec), there should be no problems even if
 360 perl was built on FAT.
 361
 362 =head2 C<fork()> failures in io_* tests
 363
 364 A C<fork()> failure may result in the following tests failing:
 365
 366   ext/IO/lib/IO/t/io_multihomed.t
 367   ext/IO/lib/IO/t/io_sock.t
 368   ext/IO/lib/IO/t/io_unix.t
 369
 370 See comment on fork in L<Miscellaneous> below.
 371
 372 =head2 Script Portability on Cygwin
 373
 374 Cygwin does an outstanding job of providing UNIX-like semantics on top of
 375 Win32 systems.  However, in addition to the items noted above, there are
 376 some differences that you should know about.  This is a very brief guide
 377 to portability, more information can be found in the Cygwin documentation.
 378
 379 =over 4
 380
 381 =item * Pathnames
 382
 383 Cygwin pathnames can be separated by forward (F</>) or backward (F<\\>)
 384 slashes.  They may also begin with drive letters (F<C:>) or Universal
 385 Naming Codes (F<//UNC>).  DOS device names (F<aux>, F<con>, F<prn>,
 386 F<com*>, F<lpt?>, F<nul>) are invalid as base filenames.  However, they
 387 can be used in extensions (e.g., F<hello.aux>).  Names may contain all
 388 printable characters except these:
 389
 390   : * ? " < > |
 391
 392 File names are case insensitive, but case preserving.  A pathname that
 393 contains a backslash or drive letter is a Win32 pathname (and not subject
 394 to the translations applied to POSIX style pathnames).
 395
 396 =item * Text/Binary
 397
 398 When a file is opened it is in either text or binary mode.  In text mode
 399 a file is subject to CR/LF/Ctrl-Z translations.  With Cygwin, the default
 400 mode for an C<open()> is determined by the mode of the mount that underlies
 401 the file.  Perl provides a C<binmode()> function to set binary mode on files
 402 that otherwise would be treated as text.  C<sysopen()> with the C<O_TEXT>
 403 flag sets text mode on files that otherwise would be treated as binary:
 404
 405     sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
 406
 407 C<lseek()>, C<tell()> and C<sysseek()> only work with files opened in binary
 408 mode.
 409
 410 The text/binary issue is covered at length in the Cygwin documentation.
 411
 412 =item * PerlIO
 413
 414 PerlIO overrides the default Cygwin Text/Binary behaviour.  A file will
 415 always treated as binary, regardless which mode of the mount it lives on,
 416 just like it is in UNIX.  So CR/LF translation needs to be requested in
 417 either the C<open()> call like this:
 418
 419   open(FH, ">:crlf", "out.txt");
 420
 421 which will do conversion from LF to CR/LF on the output, or in the
 422 environment settings (add this to your .bashrc):
 423
 424   export PERLIO=crlf
 425
 426 which will pull in the crlf PerlIO layer which does LF -> CRLF conversion
 427 on every output generated by perl.
 428
 429 =item * F<.exe>
 430
 431 The Cygwin C<stat()>, C<lstat()> and C<readlink()> functions make the F<.exe>
 432 extension transparent by looking for F<foo.exe> when you ask for F<foo>
 433 (unless a F<foo> also exists).  Cygwin does not require a F<.exe>
 434 extension, but I<gcc> adds it automatically when building a program.
 435 However, when accessing an executable as a normal file (e.g., I<cp>
 436 in a makefile) the F<.exe> is not transparent.  The I<install> included
 437 with Cygwin automatically appends a F<.exe> when necessary.
 438
 439 =item * C<chown()>
 440
 441 On WinNT C<chown()> can change a file's user and group IDs.  On Win9x C<chown()>
 442 is a no-op, although this is appropriate since there is no security model.
 443
 444 =item * Miscellaneous
 445
 446 File locking using the C<F_GETLK> command to C<fcntl()> is a stub that
 447 returns C<ENOSYS>.
 448
 449 Win9x can not C<rename()> an open file (although WinNT can).
 450
 451 The Cygwin C<chroot()> implementation has holes (it can not restrict file
 452 access by native Win32 programs).
 453
 454 Inplace editing C<perl -i> of files doesn't work without doing a backup
 455 of the file being edited C<perl -i.bak> because of windowish restrictions,
 456 therefore Perl adds the suffix C<.bak> automatically if you use C<perl -i>
 457 without specifying a backup extension.
 458
 459 Using C<fork()> after loading multiple dlls may fail with an internal cygwin
 460 error like the following:
 461
 462   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
 463
 464     200 [main] perl 377147 sync_with_child: child -395691(0xB8) died before initialization with status code 0x1
 465    1370 [main] perl 377147 sync_with_child: *** child state child loading dlls
 466
 467 Use the rebase utility to resolve the conflicting dll addresses.  The
 468 rebase package is included in the Cygwin netrelease.  Use setup.exe from
 469 F<http://www.cygwin.com/setup.exe> to install it and run rebaseall.
 470
 471 =back
 472
 473 =head1 INSTALL PERL ON CYGWIN
 474
 475 This will install Perl, including I<man> pages.
 476
 477   make install 2>&1 | tee log.make-install
 478
 479 NOTE: If C<STDERR> is redirected `C<make install>' will B<not> prompt
 480 you to install I<perl> into F</usr/bin>.
 481
 482 You may need to be I<Administrator> to run `C<make install>'.  If you
 483 are not, you must have write access to the directories in question.
 484
 485 Information on installing the Perl documentation in HTML format can be
 486 found in the F<INSTALL> document.
 487
 488 =head1 MANIFEST ON CYGWIN
 489
 490 These are the files in the Perl release that contain references to Cygwin.
 491 These very brief notes attempt to explain the reason for all conditional
 492 code.  Hopefully, keeping this up to date will allow the Cygwin port to
 493 be kept as clean as possible (listing not updated yet).
 494
 495 =over 4
 496
 497 =item Documentation
 498
 499   INSTALL README.cygwin README.win32 MANIFEST
 500   Changes Changes5.005 Changes5.004 Changes5.6
 501   pod/perl.pod pod/perlport.pod pod/perlfaq3.pod
 502   pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod
 503   pod/perlhist.pod pod/perlmodlib.pod perl/buildtoc pod/perltoc.pod
 504
 505 =item Build, Configure, Make, Install
 506
 507   cygwin/Makefile.SHs
 508   cygwin/ld2.in
 509   cygwin/perlld.in
 510   ext/IPC/SysV/hints/cygwin.pl
 511   ext/NDBM_File/hints/cygwin.pl
 512   ext/ODBM_File/hints/cygwin.pl
 513   hints/cygwin.sh
 514   Configure             - help finding hints from uname,
 515                           shared libperl required for dynamic loading
 516   Makefile.SH           - linklibperl
 517   Porting/patchls       - cygwin in port list
 518   installman            - man pages with :: translated to .
 519   installperl           - install dll/ld2/perlld, install to pods
 520   makedepend.SH         - uwinfix
 521
 522 =item Tests
 523
 524   t/io/tell.t           - binmode
 525   t/lib/b.t             - ignore Cwd from os_extras
 526   t/lib/glob-basic.t    - Win32 directory list access differs from read mode
 527   t/op/magic.t          - $^X/symlink WORKAROUND, s/.exe//
 528   t/op/stat.t           - no /dev, skip Win32 ftCreationTime quirk
 529                           (cache manager sometimes preserves ctime of file
 530                           previously created and deleted), no -u (setuid)
 531
 532 =item Compiled Perl Source
 533
 534   EXTERN.h              - __declspec(dllimport)
 535   XSUB.h                - __declspec(dllexport)
 536   cygwin/cygwin.c       - os_extras (getcwd, spawn)
 537   perl.c                - os_extras
 538   perl.h                - binmode
 539   doio.c                - win9x can not rename a file when it is open
 540   pp_sys.c              - do not define h_errno, pp_system with spawn
 541   util.c                - use setenv
 542
 543 =item Compiled Module Source
 544
 545   ext/POSIX/POSIX.xs    - tzname defined externally
 546   ext/SDBM_File/sdbm/pair.c
 547                         - EXTCONST needs to be redefined from EXTERN.h
 548   ext/SDBM_File/sdbm/sdbm.c
 549                         - binary open
 550
 551 =item Perl Modules/Scripts
 552
 553   lib/Cwd.pm            - hook to internal Cwd::cwd
 554   lib/ExtUtils/MakeMaker.pm
 555                         - require MM_Cygwin.pm
 556   lib/ExtUtils/MM_Cygwin.pm
 557                         - canonpath, cflags, manifypods, perl_archive
 558   lib/File/Find.pm      - on remote drives stat() always sets st_nlink to 1
 559   lib/File/Spec/Unix.pm - preserve //unc
 560   lib/File/Temp.pm      - no directory sticky bit
 561   lib/perl5db.pl        - use stdin not /dev/tty
 562   utils/perldoc.PL      - version comment
 563
 564 =back
 565
 566 =head1 BUGS ON CYGWIN
 567
 568 Support for swapping real and effective user and group IDs is incomplete.
 569 On WinNT Cygwin provides C<setuid()>, C<seteuid()>, C<setgid()> and C<setegid()>.
 570 However, additional Cygwin calls for manipulating WinNT access tokens
 571 and security contexts are required.
 572
 573 =head1 AUTHORS
 574
 575 Charles Wilson <cwilson@ece.gatech.edu>,
 576 Eric Fifer <egf7@columbia.edu>,
 577 alexander smishlajev <als@turnhere.com>,
 578 Steven Morlock <newspost@morlock.net>,
 579 Sebastien Barre <Sebastien.Barre@utc.fr>,
 580 Teun Burgers <burgers@ecn.nl>,
 581 Gerrit P. Haase <gp@familiehaase.de>.
 582
 583 =head1 HISTORY
 584
 585 Last updated: 2003-08-12