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