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