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