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.3.10 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 =item * C<-ldb> (C<use DB_File>)
 141
 142 BerkeleyDB is available for Cygwin.  Some details can be found in
 143 F<ext/DB_File/DB_File.pm>.
 144
 145 NOTE: The BerkeleyDB library only completely works on NTFS partitions.
 146
 147 =item * C<-lcygipc> (C<use IPC::SysV>)
 148
 149 A port of SysV IPC is available for Cygwin.
 150
 151 NOTE: This has B<not> been extensively tested.  In particular,
 152 C<d_semctl_semun> is undefined because it fails a Configure test
 153 and on Win9x the I<shm*()> functions seem to hang.  It also creates
 154 a compile time dependency because F<perl.h> includes F<<sys/ipc.h>>
 155 and F<<sys/sem.h>> (which will be required in the future when compiling
 156 CPAN modules).  NO LONGER SUPPORTED!
 157
 158 =item * C<-lutil>
 159
 160 Included with the standard Cygwin netrelease is the inetutils package
 161 which includes libutil.a.
 162
 163 =back
 164
 165 =head2 Configure-time Options for Perl on Cygwin
 166
 167 The F<INSTALL> document describes several Configure-time options.  Some of
 168 these will work with Cygwin, others are not yet possible.  Also, some of
 169 these are experimental.  You can either select an option when Configure
 170 prompts you or you can define (undefine) symbols on the command line.
 171
 172 =over 4
 173
 174 =item * C<-Uusedl>
 175
 176 Undefining this symbol forces Perl to be compiled statically.
 177
 178 =item * C<-Uusemymalloc>
 179
 180 By default Perl uses the malloc() included with the Perl source.  If you
 181 want to force Perl to build with the system malloc() undefine this symbol.
 182
 183 =item * C<-Uuseperlio>
 184
 185 Undefining this symbol disables the PerlIO abstraction, which is now the
 186 default.
 187
 188 =item * C<-Dusemultiplicity>
 189
 190 Multiplicity is required when embedding Perl in a C program and using
 191 more than one interpreter instance.  This works with the Cygwin port.
 192
 193 =item * C<-Duse64bitint>
 194
 195 By default Perl uses 32 bit integers.  If you want to use larger 64
 196 bit integers, define this symbol.  If there is trouble, check that
 197 your Cygwin installation is up to date.
 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 B<not> yet implemented in Cygwin completely.
 210
 211 =item * C<-Duselargefiles>
 212
 213 Although Win32 supports large files, Cygwin currently uses 32-bit integers
 214 for internal size and position calculations.
 215
 216 =item * C<-Dmksymlinks>
 217
 218 Use this to build perl outside of the source tree.  This works with Cygwin.
 219 Details can be found in the F<INSTALL> document.
 220
 221 =back
 222
 223 =head2 Suspicious Warnings on Cygwin
 224
 225 You may see some messages during Configure that seem suspicious.
 226
 227 =over 4
 228
 229 =item * I<dlsym()>
 230
 231 I<ld2> is needed to build dynamic libraries, but it does not exist
 232 when dlsym() checking occurs (it is not created until `C<make>' runs).
 233 You will see the following message:
 234
 235   Checking whether your dlsym() needs a leading underscore ...
 236   ld2: not found
 237   I can't compile and run the test program.
 238   I'm guessing that dlsym doesn't need a leading underscore.
 239
 240 Since the guess is correct, this is not a problem.
 241
 242 =item * Win9x and C<d_eofnblk>
 243
 244 Win9x does not correctly report C<EOF> with a non-blocking read on a
 245 closed pipe.  You will see the following messages:
 246
 247   But it also returns -1 to signal EOF, so be careful!
 248   WARNING: you can't distinguish between EOF and no data!
 249
 250   *** WHOA THERE!!! ***
 251       The recommended value for $d_eofnblk on this machine was "define"!
 252       Keep the recommended value? [y]
 253
 254 At least for consistency with WinNT, you should keep the recommended
 255 value.
 256
 257 =item * Compiler/Preprocessor defines
 258
 259 The following error occurs because of the Cygwin C<#define> of
 260 C<_LONG_DOUBLE>:
 261
 262   Guessing which symbols your C compiler and preprocessor define...
 263   try.c:<line#>: parse error
 264
 265 This failure does not seem to cause any problems.
 266
 267 =back
 268
 269 =head1 MAKE ON CYGWIN
 270
 271 Simply run I<make> and wait:
 272
 273   make 2>&1 | tee log.make
 274
 275 =head2 Warnings on Cygwin
 276
 277 Warnings like these are normal:
 278
 279   warning: overriding commands for target <file>
 280   warning: ignoring old commands for target <file>
 281
 282   dllwrap: no export definition file provided
 283   dllwrap: creating one, but that may not be what you want
 284
 285 =head2 ld2 on Cygwin
 286
 287 During `C<make>', I<ld2> will be created and installed in your $installbin
 288 directory (where you said to put public executables).  It does not
 289 wait until the `C<make install>' process to install the I<ld2> script,
 290 this is because the remainder of the `C<make>' refers to I<ld2> without
 291 fully specifying its path and does this from multiple subdirectories.
 292 The assumption is that $installbin is in your current C<PATH>.  If this
 293 is not the case `C<make>' will fail at some point.  If this happens,
 294 just manually copy I<ld2> from the source directory to somewhere in
 295 your C<PATH>.
 296
 297 =head1 TEST ON CYGWIN
 298
 299 There are two steps to running the test suite:
 300
 301   make test 2>&1 | tee log.make-test
 302
 303   cd t;./perl harness 2>&1 | tee ../log.harness
 304
 305 The same tests are run both times, but more information is provided when
 306 running as `C<./perl harness>'.
 307
 308 Test results vary depending on your host system and your Cygwin
 309 configuration.  If a test can pass in some Cygwin setup, it is always
 310 attempted and explainable test failures are documented.  It is possible
 311 for Perl to pass all the tests, but it is more likely that some tests
 312 will fail for one of the reasons listed below.
 313
 314 =head2 File Permissions on Cygwin
 315
 316 UNIX file permissions are based on sets of mode bits for
 317 {read,write,execute} for each {user,group,other}.  By default Cygwin
 318 only tracks the Win32 read-only attribute represented as the UNIX file
 319 user write bit (files are always readable, files are executable if they
 320 have a F<.{com,bat,exe}> extension or begin with C<#!>, directories are
 321 always readable and executable).  On WinNT with the I<ntea> C<CYGWIN>
 322 setting, the additional mode bits are stored as extended file attributes.
 323 On WinNT with the I<ntsec> C<CYGWIN> setting, permissions use the standard
 324 WinNT security descriptors and access control lists.  Without one of
 325 these options, these tests will fail (listing not updated yet):
 326
 327   Failed Test           List of failed
 328   ------------------------------------
 329   io/fs.t               5, 7, 9-10
 330   lib/anydbm.t          2
 331   lib/db-btree.t        20
 332   lib/db-hash.t         16
 333   lib/db-recno.t        18
 334   lib/gdbm.t            2
 335   lib/ndbm.t            2
 336   lib/odbm.t            2
 337   lib/sdbm.t            2
 338   op/stat.t             9, 20 (.tmp not an executable extension)
 339
 340 =head2 Script Portability on Cygwin
 341
 342 Cygwin does an outstanding job of providing UNIX-like semantics on top of
 343 Win32 systems.  However, in addition to the items noted above, there are
 344 some differences that you should know about.  This is a very brief guide
 345 to portability, more information can be found in the Cygwin documentation.
 346
 347 =over 4
 348
 349 =item * Pathnames
 350
 351 Cygwin pathnames can be separated by forward (F</>) or backward (F<\\>)
 352 slashes.  They may also begin with drive letters (F<C:>) or Universal
 353 Naming Codes (F<//UNC>).  DOS device names (F<aux>, F<con>, F<prn>,
 354 F<com*>, F<lpt?>, F<nul>) are invalid as base filenames.  However, they
 355 can be used in extensions (e.g., F<hello.aux>).  Names may contain all
 356 printable characters except these:
 357
 358   : * ? " < > |
 359
 360 File names are case insensitive, but case preserving.  A pathname that
 361 contains a backslash or drive letter is a Win32 pathname (and not subject
 362 to the translations applied to POSIX style pathnames).
 363
 364 =item * Text/Binary
 365
 366 When a file is opened it is in either text or binary mode.  In text mode
 367 a file is subject to CR/LF/Ctrl-Z translations.  With Cygwin, the default
 368 mode for an open() is determined by the mode of the mount that underlies
 369 the file.  Perl provides a binmode() function to set binary mode on files
 370 that otherwise would be treated as text.  sysopen() with the C<O_TEXT>
 371 flag sets text mode on files that otherwise would be treated as binary:
 372
 373     sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
 374
 375 lseek(), tell() and sysseek() only work with files opened in binary mode.
 376
 377 The text/binary issue is covered at length in the Cygwin documentation.
 378
 379 =item * F<.exe>
 380
 381 The Cygwin stat(), lstat() and readlink() functions make the F<.exe>
 382 extension transparent by looking for F<foo.exe> when you ask for F<foo>
 383 (unless a F<foo> also exists).  Cygwin does not require a F<.exe>
 384 extension, but I<gcc> adds it automatically when building a program.
 385 However, when accessing an executable as a normal file (e.g., I<cp>
 386 in a makefile) the F<.exe> is not transparent.  The I<install> included
 387 with Cygwin automatically appends a F<.exe> when necessary.
 388
 389 =item * chown()
 390
 391 On WinNT chown() can change a file's user and group IDs.  On Win9x chown()
 392 is a no-op, although this is appropriate since there is no security model.
 393
 394 =item * Miscellaneous
 395
 396 File locking using the C<F_GETLK> command to fcntl() is a stub that
 397 returns C<ENOSYS>.
 398
 399 Win9x can not rename() an open file (although WinNT can).
 400
 401 The Cygwin chroot() implementation has holes (it can not restrict file
 402 access by native Win32 programs).
 403
 404 Inplace editing C<perl -i> of files doesn't work without doing a backup
 405 of the file being edited C<perl -i.bak> because of windowish restrictions,
 406 so Perl adds the C<.bak> automatically if you just use C<perl -i>.
 407
 408 =back
 409
 410 =head1 INSTALL PERL ON CYGWIN
 411
 412 This will install Perl, including I<man> pages.
 413
 414   make install 2>&1 | tee log.make-install
 415
 416 NOTE: If C<STDERR> is redirected `C<make install>' will B<not> prompt
 417 you to install I<perl> into F</usr/bin>.
 418
 419 You may need to be I<Administrator> to run `C<make install>'.  If you
 420 are not, you must have write access to the directories in question.
 421
 422 Information on installing the Perl documentation in HTML format can be
 423 found in the F<INSTALL> document.
 424
 425 =head1 MANIFEST ON CYGWIN
 426
 427 These are the files in the Perl release that contain references to Cygwin.
 428 These very brief notes attempt to explain the reason for all conditional
 429 code.  Hopefully, keeping this up to date will allow the Cygwin port to
 430 be kept as clean as possible (listing not updated yet).
 431
 432 =over 4
 433
 434 =item Documentation
 435
 436   INSTALL README.cygwin README.win32 MANIFEST
 437   Changes Changes5.005 Changes5.004 Changes5.6
 438   pod/perl.pod pod/perlport.pod pod/perlfaq3.pod
 439   pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod
 440   pod/perlhist.pod pod/perlmodlib.pod pod/buildtoc.PL pod/perltoc.pod
 441
 442 =item Build, Configure, Make, Install
 443
 444   cygwin/Makefile.SHs
 445   cygwin/ld2.in
 446   cygwin/perlld.in
 447   ext/IPC/SysV/hints/cygwin.pl
 448   ext/NDBM_File/hints/cygwin.pl
 449   ext/ODBM_File/hints/cygwin.pl
 450   hints/cygwin.sh
 451   Configure             - help finding hints from uname,
 452                           shared libperl required for dynamic loading
 453   Makefile.SH           - linklibperl
 454   Porting/patchls       - cygwin in port list
 455   installman            - man pages with :: translated to .
 456   installperl           - install dll/ld2/perlld, install to pods
 457   makedepend.SH         - uwinfix
 458
 459 =item Tests
 460
 461   t/io/tell.t           - binmode
 462   t/lib/b.t             - ignore Cwd from os_extras
 463   t/lib/glob-basic.t    - Win32 directory list access differs from read mode
 464   t/op/magic.t          - $^X/symlink WORKAROUND, s/.exe//
 465   t/op/stat.t           - no /dev, skip Win32 ftCreationTime quirk
 466                           (cache manager sometimes preserves ctime of file
 467                           previously created and deleted), no -u (setuid)
 468
 469 =item Compiled Perl Source
 470
 471   EXTERN.h              - __declspec(dllimport)
 472   XSUB.h                - __declspec(dllexport)
 473   cygwin/cygwin.c       - os_extras (getcwd, spawn)
 474   perl.c                - os_extras
 475   perl.h                - binmode
 476   doio.c                - win9x can not rename a file when it is open
 477   pp_sys.c              - do not define h_errno, pp_system with spawn
 478   util.c                - use setenv
 479
 480 =item Compiled Module Source
 481
 482   ext/POSIX/POSIX.xs    - tzname defined externally
 483   ext/SDBM_File/sdbm/pair.c
 484                         - EXTCONST needs to be redefined from EXTERN.h
 485   ext/SDBM_File/sdbm/sdbm.c
 486                         - binary open
 487
 488 =item Perl Modules/Scripts
 489
 490   lib/Cwd.pm            - hook to internal Cwd::cwd
 491   lib/ExtUtils/MakeMaker.pm
 492                         - require MM_Cygwin.pm
 493   lib/ExtUtils/MM_Cygwin.pm
 494                         - canonpath, cflags, manifypods, perl_archive
 495   lib/File/Find.pm      - on remote drives stat() always sets st_nlink to 1
 496   lib/File/Spec/Unix.pm - preserve //unc
 497   lib/File/Temp.pm      - no directory sticky bit
 498   lib/perl5db.pl        - use stdin not /dev/tty
 499   utils/perldoc.PL      - version comment
 500
 501 =back
 502
 503 =head1 BUGS ON CYGWIN
 504
 505 Support for swapping real and effective user and group IDs is incomplete.
 506 On WinNT Cygwin provides setuid(), seteuid(), setgid() and setegid().
 507 However, additional Cygwin calls for manipulating WinNT access tokens
 508 and security contexts are required.
 509
 510 =head1 AUTHORS
 511
 512 Charles Wilson <cwilson@ece.gatech.edu>,
 513 Eric Fifer <egf7@columbia.edu>,
 514 alexander smishlajev <als@turnhere.com>,
 515 Steven Morlock <newspost@morlock.net>,
 516 Sebastien Barre <Sebastien.Barre@utc.fr>,
 517 Teun Burgers <burgers@ecn.nl>,
 518 Gerrit Haase <gh@familiehaase.de>.
 519
 520 =head1 HISTORY
 521
 522 Last updated: 2002-02-27