Debian Codegraph @

upstream/debian-unstable/man1/perlcygwin.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PERLCYGWIN 1"
58 .TH PERLCYGWIN 1 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 perlcygwin \- Perl for Cygwin
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 This document will help you configure, make, test and install Perl
68 on Cygwin. This document also describes features of Cygwin that will
69 affect how Perl behaves at runtime.
70 .PP
71 \&\fBNOTE:\fR There are pre-built Perl packages available for Cygwin and a
72 version of Perl is provided in the normal Cygwin install. If you do
73 not need to customize the configuration, consider using one of those
74 packages.
75 .SH "PREREQUISITES FOR COMPILING PERL ON CYGWIN"
76 .IX Header "PREREQUISITES FOR COMPILING PERL ON CYGWIN"
77 .SS "Cygwin = GNU+Cygnus+Windows (Don't leave UNIX without it)"
78 .IX Subsection "Cygwin = GNU+Cygnus+Windows (Don't leave UNIX without it)"
79 The Cygwin tools are ports of the popular GNU development tools for Win32
80 platforms. They run thanks to the Cygwin library which provides the UNIX
81 system calls and environment these programs expect. More information
82 about this project can be found at:
83 .PP
84 <https://www.cygwin.com/>
85 .PP
86 A recent net or commercial release of Cygwin is required.
87 .PP
88 At the time this document was last updated, Cygwin 3.0.7 was current.
89 .SS "Cygwin Configuration"
90 .IX Subsection "Cygwin Configuration"
91 While building Perl some changes may be necessary to your Cygwin setup so
92 that Perl builds cleanly. These changes are \fBnot\fR required for normal
93 Perl usage.
94 .PP
95 \&\fBNOTE:\fR The binaries that are built will run on all Win32 versions.
96 They do not depend on your host system or your
97 Cygwin configuration (binary/text mounts, cygserver).
98 The only dependencies come from hard-coded pathnames like \fI/usr/local\fR.
99 However, your host system and Cygwin configuration will affect Perl's
100 runtime behavior (see "TEST").
101 .IP \(bu 4
102 \&\f(CW\*(C`PATH\*(C'\fR
103 .Sp
104 Set the \f(CW\*(C`PATH\*(C'\fR environment variable so that Configure finds the Cygwin
105 versions of programs. Any not-needed Windows directories should be removed or
106 moved to the end of your \f(CW\*(C`PATH\*(C'\fR.
107 .IP \(bu 4
108 \&\fInroff\fR
109 .Sp
110 If you do not have \fInroff\fR (which is part of the \fIgroff\fR package),
111 Configure will \fBnot\fR prompt you to install \fIman\fR pages.
112 .SH "CONFIGURE PERL ON CYGWIN"
113 .IX Header "CONFIGURE PERL ON CYGWIN"
114 The default options gathered by Configure with the assistance of
115 \&\fIhints/cygwin.sh\fR will build a Perl that supports dynamic loading
116 (which requires a shared \fIcygperl5_16.dll\fR).
117 .PP
118 This will run Configure and keep a record:
119 .PP
120 .Vb 1
121 \& ./Configure 2>&1 | tee log.configure
122 .Ve
123 .PP
124 If you are willing to accept all the defaults run Configure with \fB\-de\fR.
125 However, several useful customizations are available.
126 .SS "Stripping Perl Binaries on Cygwin"
127 .IX Subsection "Stripping Perl Binaries on Cygwin"
128 It is possible to strip the EXEs and DLLs created by the build process.
129 The resulting binaries will be significantly smaller. If you want the
130 binaries to be stripped, you can either add a \fB\-s\fR option when Configure
131 prompts you,
132 .PP
133 .Vb 5
134 \& Any additional ld flags (NOT including libraries)? [none] \-s
135 \& Any special flags to pass to g++ to create a dynamically loaded
136 \& library?
137 \& [none] \-s
138 \& Any special flags to pass to gcc to use dynamic linking? [none] \-s
139 .Ve
140 .PP
141 or you can edit \fIhints/cygwin.sh\fR and uncomment the relevant variables
142 near the end of the file.
143 .SS "Optional Libraries for Perl on Cygwin"
144 .IX Subsection "Optional Libraries for Perl on Cygwin"
145 Several Perl functions and modules depend on the existence of
146 some optional libraries. Configure will find them if they are
147 installed in one of the directories listed as being used for library
148 searches. Pre-built packages for most of these are available from
149 the Cygwin installer.
150 .IP \(bu 4
151 \&\f(CW\*(C`\-lcrypt\*(C'\fR
152 .Sp
153 The crypt package distributed with Cygwin is a Linux compatible 56\-bit
154 DES crypt port by Corinna Vinschen.
155 .Sp
156 Alternatively, the crypt libraries in GNU libc have been ported to Cygwin.
157 .Sp
158 As of libcrypt 1.3 (March 2016), you will need to install the
159 libcrypt-devel package for Configure to detect \fBcrypt()\fR.
160 .IP \(bu 4
161 \&\f(CW\*(C`\-lgdbm_compat\*(C'\fR (\f(CW\*(C`use GDBM_File\*(C'\fR)
162 .Sp
163 GDBM is available for Cygwin.
164 .Sp
165 NOTE: The GDBM library only works on NTFS partitions.
166 .IP \(bu 4
167 \&\f(CW\*(C`\-ldb\*(C'\fR (\f(CW\*(C`use DB_File\*(C'\fR)
168 .Sp
169 BerkeleyDB is available for Cygwin.
170 .Sp
171 NOTE: The BerkeleyDB library only completely works on NTFS partitions.
172 .IP \(bu 4
173 \&\f(CW\*(C`cygserver\*(C'\fR (\f(CW\*(C`use IPC::SysV\*(C'\fR)
174 .Sp
175 A port of SysV IPC is available for Cygwin.
176 .Sp
177 NOTE: This has \fBnot\fR been extensively tested. In particular,
178 \&\f(CW\*(C`d_semctl_semun\*(C'\fR is undefined because it fails a Configure test. It
179 also creates a compile time dependency because \fIperl.h\fR includes
180 \&\fI<sys/ipc.h\fR> and \fI<sys/sem.h\fR> (which will be required in the
181 future when compiling CPAN modules). CURRENTLY NOT SUPPORTED!
182 .IP \(bu 4
183 \&\f(CW\*(C`\-lutil\*(C'\fR
184 .Sp
185 Included with the standard Cygwin netrelease is the inetutils package
186 which includes libutil.a.
187 .SS "Configure-time Options for Perl on Cygwin"
188 .IX Subsection "Configure-time Options for Perl on Cygwin"
189 The \fIINSTALL\fR document describes several Configure-time options. Some of
190 these will work with Cygwin, others are not yet possible. Also, some of
191 these are experimental. You can either select an option when Configure
192 prompts you or you can define (undefine) symbols on the command line.
193 .IP \(bu 4
194 \&\f(CW\*(C`\-Uusedl\*(C'\fR
195 .Sp
196 Undefining this symbol forces Perl to be compiled statically.
197 .IP \(bu 4
198 \&\f(CW\*(C`\-Dusemymalloc\*(C'\fR
199 .Sp
200 By default Perl does not use the \f(CWmalloc()\fR included with the Perl source,
201 because it was slower and not entirely thread-safe. If you want to force
202 Perl to build with the old \-Dusemymalloc define this.
203 .IP \(bu 4
204 \&\f(CW\*(C`\-Uuseperlio\*(C'\fR
205 .Sp
206 Undefining this symbol disables the PerlIO abstraction. PerlIO is now the
207 default; it is not recommended to disable PerlIO.
208 .IP \(bu 4
209 \&\f(CW\*(C`\-Dusemultiplicity\*(C'\fR
210 .Sp
211 Multiplicity is required when embedding Perl in a C program and using
212 more than one interpreter instance. This is only required when you build
213 a not-threaded perl with \f(CW\*(C`\-Uuseithreads\*(C'\fR.
214 .IP \(bu 4
215 \&\f(CW\*(C`\-Uuse64bitint\*(C'\fR
216 .Sp
217 By default Perl uses 64 bit integers. If you want to use smaller 32 bit
218 integers, define this symbol.
219 .IP \(bu 4
220 \&\f(CW\*(C`\-Duselongdouble\*(C'\fR
221 .Sp
222 \&\fIgcc\fR supports long doubles (12 bytes). However, several additional
223 long double math functions are necessary to use them within Perl
224 (\fI{atan2, cos, exp, floor, fmod, frexp, isnan, log, modf, pow, sin, sqrt}l,
225 strtold\fR).
226 These are \fBnot\fR yet available with newlib, the Cygwin libc.
227 .IP \(bu 4
228 \&\f(CW\*(C`\-Uuseithreads\*(C'\fR
229 .Sp
230 Define this symbol if you want not-threaded faster perl.
231 .IP \(bu 4
232 \&\f(CW\*(C`\-Duselargefiles\*(C'\fR
233 .Sp
234 Cygwin uses 64\-bit integers for internal size and position calculations,
235 this will be correctly detected and defined by Configure.
236 .IP \(bu 4
237 \&\f(CW\*(C`\-Dmksymlinks\*(C'\fR
238 .Sp
239 Use this to build perl outside of the source tree. Details can be
240 found in the \fIINSTALL\fR document. This is the recommended way to
241 build perl from sources.
242 .SH "MAKE ON CYGWIN"
243 .IX Header "MAKE ON CYGWIN"
244 Simply run \fImake\fR and wait:
245 .PP
246 .Vb 1
247 \& make \-jn 2>&1 | tee log.make
248 .Ve
249 .PP
250 where \fIn\fR is the maximum number of simultaneous compilations you want;
251 omitting this parameter is the same as specifying \f(CW\*(C`\-j1\*(C'\fR.
252 .SH "TEST ON CYGWIN"
253 .IX Header "TEST ON CYGWIN"
254 There are two steps to running the test suite:
255 .PP
256 .Vb 1
257 \& make test 2>&1 | tee log.make\-test
258 \&
259 \& cd t; ./perl harness 2>&1 | tee ../log.harness
260 .Ve
261 .PP
262 The same tests are run both times, but more information is provided when
263 running as \f(CW\*(C`./perl harness\*(C'\fR, and you can run the tests in parallel by
264 instead specifying
265 .PP
266 .Vb 1
267 \& cd t; TEST_JOBS=n ./perl harness 2>&1 | tee ../log.harness
268 .Ve
269 .PP
270 where \fIn\fR is the maximum number of tests to run simulataneously.
271 .PP
272 Test results vary depending on your host system and your Cygwin
273 configuration. If a test can pass in some Cygwin setup, it is always
274 attempted and explainable test failures are documented. It is possible
275 for Perl to pass all the tests, but it is more likely that some tests
276 will fail for one of the reasons listed below.
277 .SS "File Permissions on Cygwin"
278 .IX Subsection "File Permissions on Cygwin"
279 UNIX file permissions are based on sets of mode bits for
280 {read,write,execute} for each {user,group,other}. By default Cygwin
281 only tracks the Win32 read-only attribute represented as the UNIX file
282 user write bit (files are always readable, files are executable if they
283 have a \fI.{com,bat,exe}\fR extension or begin with \f(CW\*(C`#!\*(C'\fR, directories are
284 always readable and executable). On WinNT with the \fIntea\fR \f(CW\*(C`CYGWIN\*(C'\fR
285 setting, the additional mode bits are stored as extended file attributes.
286 On WinNT with the default \fIntsec\fR \f(CW\*(C`CYGWIN\*(C'\fR setting, permissions use the
287 standard WinNT security descriptors and access control lists. Without one of
288 these options, these tests will fail (listing not updated yet):
289 .PP
290 .Vb 12
291 \& Failed Test List of failed
292 \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
293 \& io/fs.t 5, 7, 9\-10
294 \& lib/anydbm.t 2
295 \& lib/db\-btree.t 20
296 \& lib/db\-hash.t 16
297 \& lib/db\-recno.t 18
298 \& lib/gdbm.t 2
299 \& lib/ndbm.t 2
300 \& lib/odbm.t 2
301 \& lib/sdbm.t 2
302 \& op/stat.t 9, 20 (.tmp not an executable extension)
303 .Ve
304 .SS "NDBM_File and ODBM_File do not work on FAT filesystems"
305 .IX Subsection "NDBM_File and ODBM_File do not work on FAT filesystems"
306 Do not use NDBM_File or ODBM_File on FAT filesystem. They can be
307 built on a FAT filesystem, but many tests will fail:
308 .PP
309 .Vb 6
310 \& ../ext/NDBM_File/ndbm.t 13 3328 71 59 83.10% 1\-2 4 16\-71
311 \& ../ext/ODBM_File/odbm.t 255 65280 ?? ?? % ??
312 \& ../lib/AnyDBM_File.t 2 512 12 2 16.67% 1 4
313 \& ../lib/Memoize/t/errors.t 0 139 11 5 45.45% 7\-11
314 \& ../lib/Memoize/t/tie_ndbm.t 13 3328 4 4 100.00% 1\-4
315 \& run/fresh_perl.t 97 1 1.03% 91
316 .Ve
317 .PP
318 If you intend to run only on FAT (or if using AnyDBM_File on FAT),
319 run Configure with the \-Ui_ndbm and \-Ui_dbm options to prevent
320 NDBM_File and ODBM_File being built.
321 .PP
322 With NTFS (and no CYGWIN=nontsec), there should be no problems even if
323 perl was built on FAT.
324 .ie n .SS "fork() failures in io_* tests"
325 .el .SS "\f(CWfork()\fP failures in io_* tests"
326 .IX Subsection "fork() failures in io_* tests"
327 A \f(CWfork()\fR failure may result in the following tests failing:
328 .PP
329 .Vb 3
330 \& ext/IO/lib/IO/t/io_multihomed.t
331 \& ext/IO/lib/IO/t/io_sock.t
332 \& ext/IO/lib/IO/t/io_unix.t
333 .Ve
334 .PP
335 See comment on fork in "Miscellaneous" below.
336 .SH "Specific features of the Cygwin port"
337 .IX Header "Specific features of the Cygwin port"
338 .SS "Script Portability on Cygwin"
339 .IX Subsection "Script Portability on Cygwin"
340 Cygwin does an outstanding job of providing UNIX-like semantics on top of
341 Win32 systems. However, in addition to the items noted above, there are
342 some differences that you should know about. This is a very brief guide
343 to portability, more information can be found in the Cygwin documentation.
344 .IP \(bu 4
345 Pathnames
346 .Sp
347 Cygwin pathnames are separated by forward (\fI/\fR) slashes, Universal
348 Naming Codes (\fI//UNC\fR) are also supported. Since cygwin\-1.7 non-POSIX
349 pathnames should not be used. Names may contain all printable
350 characters.
351 .Sp
352 File names are case insensitive, but case preserving. A pathname that
353 contains a backslash or drive letter is a Win32 pathname, and not
354 subject to the translations applied to POSIX style pathnames, but
355 cygwin will warn you, so better convert them to POSIX.
356 .Sp
357 For conversion we have \f(CWCygwin::win_to_posix_path()\fR and
358 \&\f(CWCygwin::posix_to_win_path()\fR.
359 .Sp
360 Since cygwin\-1.7 pathnames are UTF\-8 encoded.
361 .IP \(bu 4
362 Text/Binary
363 .Sp
364 Since cygwin\-1.7 textmounts are deprecated and strongly discouraged.
365 .Sp
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 \f(CWopen()\fR is determined by the mode of the mount that underlies
369 the file. See "Cygwin::is_binmount"(). Perl provides a \f(CWbinmode()\fR function
370 to set binary mode on files that otherwise would be treated as text.
371 \&\f(CWsysopen()\fR with the \f(CW\*(C`O_TEXT\*(C'\fR flag sets text mode on files that otherwise
372 would be treated as binary:
373 .Sp
374 .Vb 1
375 \& sysopen(FOO, "bar", O_WRONLY|O_CREAT|O_TEXT)
376 .Ve
377 .Sp
378 \&\f(CWlseek()\fR, \f(CWtell()\fR and \f(CWsysseek()\fR only work with files opened in binary
379 mode.
380 .Sp
381 The text/binary issue is covered at length in the Cygwin documentation.
382 .IP \(bu 4
383 PerlIO
384 .Sp
385 PerlIO overrides the default Cygwin Text/Binary behaviour. A file will
386 always be treated as binary, regardless of the mode of the mount it lives
387 on, just like it is in UNIX. So CR/LF translation needs to be requested in
388 either the \f(CWopen()\fR call like this:
389 .Sp
390 .Vb 1
391 \& open(FH, ">:crlf", "out.txt");
392 .Ve
393 .Sp
394 which will do conversion from LF to CR/LF on the output, or in the
395 environment settings (add this to your .bashrc):
396 .Sp
397 .Vb 1
398 \& export PERLIO=crlf
399 .Ve
400 .Sp
401 which will pull in the crlf PerlIO layer which does LF \-> CRLF conversion
402 on every output generated by perl.
403 .IP \(bu 4
404 \&\fI.exe\fR
405 .Sp
406 The Cygwin \f(CWstat()\fR, \f(CWlstat()\fR and \f(CWreadlink()\fR functions make the \fI.exe\fR
407 extension transparent by looking for \fIfoo.exe\fR when you ask for \fIfoo\fR
408 (unless a \fIfoo\fR also exists). Cygwin does not require a \fI.exe\fR
409 extension, but \fIgcc\fR adds it automatically when building a program.
410 However, when accessing an executable as a normal file (e.g., \fIcp\fR
411 in a makefile) the \fI.exe\fR is not transparent. The \fIinstall\fR program
412 included with Cygwin automatically appends a \fI.exe\fR when necessary.
413 .IP \(bu 4
414 Cygwin vs. Windows process ids
415 .Sp
416 Cygwin processes have their own pid, which is different from the
417 underlying windows pid. Most posix compliant Proc functions expect
418 the cygwin pid, but several Win32::Process functions expect the
419 winpid. E.g. \f(CW$$\fR is the cygwin pid of \fI/usr/bin/perl\fR, which is not
420 the winpid. Use \f(CWCygwin::pid_to_winpid()\fR and \f(CWCygwin::winpid_to_pid()\fR
421 to translate between them.
422 .IP \(bu 4
423 Cygwin vs. Windows errors
424 .Sp
425 Under Cygwin, $^E is the same as $!. When using Win32 API Functions,
426 use \f(CWWin32::GetLastError()\fR to get the last Windows error.
427 .IP \(bu 4
428 rebase errors on fork or system
429 .Sp
430 Using \f(CWfork()\fR or \f(CWsystem()\fR out to another perl after loading multiple dlls
431 may result on a DLL baseaddress conflict. The internal cygwin error
432 looks like like the following:
433 .Sp
434 .Vb 2
435 \& 0 [main] perl 8916 child_info_fork::abort: data segment start:
436 \& parent (0xC1A000) != child(0xA6A000)
437 .Ve
438 .Sp
439 or:
440 .Sp
441 .Vb 4
442 \& 183 [main] perl 3588 C:\ecygwin\ebin\eperl.exe: *** fatal error \-
443 \& unable to remap C:\ecygwin\ebin\ecygsvn_subr\-1\-0.dll to same address
444 \& as parent(0x6FB30000) != 0x6FE60000 46 [main] perl 3488 fork: child
445 \& 3588 \- died waiting for dll loading, errno11
446 .Ve
447 .Sp
448 See <https://cygwin.com/faq/faq.html#faq.using.fixing\-fork\-failures>
449 It helps if not too many DLLs are loaded in memory so the available address space is larger,
450 e.g. stopping the MS Internet Explorer might help.
451 .Sp
452 +Use the rebase utilities to resolve the conflicting dll addresses.
453 The rebase package is included in the Cygwin setup. Use \fIsetup.exe\fR
454 from <https://cygwin.com/install.html> to install it.
455 .Sp
456 1. kill all perl processes and run
457 \f(CW\*(C`</bin/find <dir\*(C'\fR \-xdev \-name \e*.dll | /bin/rebase \-OT \->> or
458 .Sp
459 2. kill all cygwin processes and services, and run setup.exe.
460 .IP \(bu 4
461 Miscellaneous
462 .Sp
463 File locking using the \f(CW\*(C`F_GETLK\*(C'\fR command to \f(CWfcntl()\fR is a stub that
464 returns \f(CW\*(C`ENOSYS\*(C'\fR.
465 .Sp
466 The Cygwin \f(CWchroot()\fR implementation has holes (it can not restrict file
467 access by native Win32 programs).
468 .Sp
469 Inplace editing \f(CW\*(C`perl \-i\*(C'\fR of files doesn't work without doing a backup
470 of the file being edited \f(CW\*(C`perl \-i.bak\*(C'\fR because of windowish restrictions,
471 therefore Perl adds the suffix \f(CW\*(C`.bak\*(C'\fR automatically if you use \f(CW\*(C`perl \-i\*(C'\fR
472 without specifying a backup extension.
473 .SS "Prebuilt methods:"
474 .IX Subsection "Prebuilt methods:"
475 .ie n .IP """Cwd::cwd""" 4
476 .el .IP \f(CWCwd::cwd\fR 4
477 .IX Item "Cwd::cwd"
478 Returns the current working directory.
479 .ie n .IP """Cygwin::pid_to_winpid""" 4
480 .el .IP \f(CWCygwin::pid_to_winpid\fR 4
481 .IX Item "Cygwin::pid_to_winpid"
482 Translates a cygwin pid to the corresponding Windows pid (which may or
483 may not be the same).
484 .ie n .IP """Cygwin::winpid_to_pid""" 4
485 .el .IP \f(CWCygwin::winpid_to_pid\fR 4
486 .IX Item "Cygwin::winpid_to_pid"
487 Translates a Windows pid to the corresponding cygwin pid (if any).
488 .ie n .IP """Cygwin::win_to_posix_path""" 4
489 .el .IP \f(CWCygwin::win_to_posix_path\fR 4
490 .IX Item "Cygwin::win_to_posix_path"
491 Translates a Windows path to the corresponding cygwin path respecting
492 the current mount points. With a second non-null argument returns an
493 absolute path. Double-byte characters will not be translated.
494 .ie n .IP """Cygwin::posix_to_win_path""" 4
495 .el .IP \f(CWCygwin::posix_to_win_path\fR 4
496 .IX Item "Cygwin::posix_to_win_path"
497 Translates a cygwin path to the corresponding cygwin path respecting
498 the current mount points. With a second non-null argument returns an
499 absolute path. Double-byte characters will not be translated.
500 .ie n .IP Cygwin::mount_table() 4
501 .el .IP \f(CWCygwin::mount_table()\fR 4
502 .IX Item "Cygwin::mount_table()"
503 Returns an array of [mnt_dir, mnt_fsname, mnt_type, mnt_opts].
504 .Sp
505 .Vb 8
506 \& perl \-e \*(Aqfor $i (Cygwin::mount_table) {print join(" ",@$i),"\en";}\*(Aq
507 \& /bin c:\ecygwin\ebin system binmode,cygexec
508 \& /usr/bin c:\ecygwin\ebin system binmode
509 \& /usr/lib c:\ecygwin\elib system binmode
510 \& / c:\ecygwin system binmode
511 \& /cygdrive/c c: system binmode,noumount
512 \& /cygdrive/d d: system binmode,noumount
513 \& /cygdrive/e e: system binmode,noumount
514 .Ve
515 .ie n .IP """Cygwin::mount_flags""" 4
516 .el .IP \f(CWCygwin::mount_flags\fR 4
517 .IX Item "Cygwin::mount_flags"
518 Returns the mount type and flags for a specified mount point.
519 A comma-separated string of mntent\->mnt_type (always
520 "system" or "user"), then the mntent\->mnt_opts, where
521 the first is always "binmode" or "textmode".
522 .Sp
523 .Vb 2
524 \& system|user,binmode|textmode,exec,cygexec,cygdrive,mixed,
525 \& notexec,managed,nosuid,devfs,proc,noumount
526 .Ve
527 .Sp
528 If the argument is "/cygdrive", then just the volume mount settings,
529 and the cygdrive mount prefix are returned.
530 .Sp
531 User mounts override system mounts.
532 .Sp
533 .Vb 4
534 \& $ perl \-e \*(Aqprint Cygwin::mount_flags "/usr/bin"\*(Aq
535 \& system,binmode,cygexec
536 \& $ perl \-e \*(Aqprint Cygwin::mount_flags "/cygdrive"\*(Aq
537 \& binmode,cygdrive,/cygdrive
538 .Ve
539 .ie n .IP """Cygwin::is_binmount""" 4
540 .el .IP \f(CWCygwin::is_binmount\fR 4
541 .IX Item "Cygwin::is_binmount"
542 Returns true if the given cygwin path is binary mounted, false if the
543 path is mounted in textmode.
544 .ie n .IP """Cygwin::sync_winenv""" 4
545 .el .IP \f(CWCygwin::sync_winenv\fR 4
546 .IX Item "Cygwin::sync_winenv"
547 Cygwin does not initialize all original Win32 environment variables.
548 See the bottom of this page <https://cygwin.com/cygwin\-ug\-net/setup\-env.html>
549 for "Restricted Win32 environment".
550 .Sp
551 Certain Win32 programs called from cygwin programs might need some environment
552 variable, such as e.g. ADODB needs \f(CW%COMMONPROGRAMFILES\fR%.
553 Call \fBCygwin::sync_winenv()\fR to copy all Win32 environment variables to your
554 process and note that cygwin will warn on every encounter of non-POSIX paths.
555 .SH "INSTALL PERL ON CYGWIN"
556 .IX Header "INSTALL PERL ON CYGWIN"
557 This will install Perl, including \fIman\fR pages.
558 .PP
559 .Vb 1
560 \& make install 2>&1 | tee log.make\-install
561 .Ve
562 .PP
563 NOTE: If \f(CW\*(C`STDERR\*(C'\fR is redirected \f(CW\*(C`make install\*(C'\fR will \fBnot\fR prompt
564 you to install \fIperl\fR into \fI/usr/bin\fR.
565 .PP
566 You may need to be \fIAdministrator\fR to run \f(CW\*(C`make install\*(C'\fR. If you
567 are not, you must have write access to the directories in question.
568 .PP
569 Information on installing the Perl documentation in HTML format can be
570 found in the \fIINSTALL\fR document.
571 .SH "MANIFEST ON CYGWIN"
572 .IX Header "MANIFEST ON CYGWIN"
573 These are the files in the Perl release that contain references to Cygwin.
574 These very brief notes attempt to explain the reason for all conditional
575 code. Hopefully, keeping this up to date will allow the Cygwin port to
576 be kept as clean as possible.
577 .IP Documentation 4
578 .IX Item "Documentation"
579 .Vb 10
580 \& INSTALL README.cygwin README.win32 MANIFEST
581 \& pod/perl.pod pod/perlport.pod pod/perlfaq3.pod
582 \& pod/perldelta.pod pod/perl5004delta.pod pod/perl56delta.pod
583 \& pod/perl561delta.pod pod/perl570delta.pod pod/perl572delta.pod
584 \& pod/perl573delta.pod pod/perl58delta.pod pod/perl581delta.pod
585 \& pod/perl590delta.pod pod/perlhist.pod pod/perlmodlib.pod
586 \& pod/perltoc.pod Porting/Glossary pod/perlgit.pod
587 \& Porting/updateAUTHORS.pl
588 \& dist/Cwd/Changes ext/Compress\-Raw\-Zlib/Changes
589 \& dist/Time\-HiRes/Changes
590 \& ext/Compress\-Raw\-Zlib/README ext/Compress\-Zlib/Changes
591 \& ext/DB_File/Changes ext/Encode/Changes ext/Sys\-Syslog/Changes
592 \& ext/Win32API\-File/Changes
593 \& lib/ExtUtils/CBuilder/Changes lib/ExtUtils/Changes
594 \& lib/ExtUtils/NOTES lib/ExtUtils/PATCHING lib/ExtUtils/README
595 \& lib/Net/Ping/Changes lib/Test/Harness/Changes
596 \& lib/Term/ANSIColor/ChangeLog lib/Term/ANSIColor/README
597 .Ve
598 .IP "Build, Configure, Make, Install" 4
599 .IX Item "Build, Configure, Make, Install"
600 .Vb 10
601 \& cygwin/Makefile.SHs
602 \& ext/IPC/SysV/hints/cygwin.pl
603 \& ext/NDBM_File/hints/cygwin.pl
604 \& ext/ODBM_File/hints/cygwin.pl
605 \& hints/cygwin.sh
606 \& Configure \- help finding hints from uname,
607 \& shared libperl required for dynamic loading
608 \& Makefile.SH Cross/Makefile\-cross\-SH
609 \& \- linklibperl
610 \& Porting/patchls \- cygwin in port list
611 \& installman \- man pages with :: translated to .
612 \& installperl \- install dll, install to \*(Aqpods\*(Aq
613 \& makedepend.SH \- uwinfix
614 \& regen_lib.pl \- file permissions
615 \&
616 \& plan9/mkfile
617 \& vms/descrip_mms.template
618 \& win32/Makefile
619 .Ve
620 .IP Tests 4
621 .IX Item "Tests"
622 .Vb 10
623 \& t/io/fs.t \- no file mode checks if not ntsec
624 \& skip rename() check when not
625 \& check_case:relaxed
626 \& t/io/tell.t \- binmode
627 \& t/lib/cygwin.t \- builtin cygwin function tests
628 \& t/op/groups.t \- basegroup has ID = 0
629 \& t/op/magic.t \- $^X/symlink WORKAROUND, s/.exe//
630 \& t/op/stat.t \- no /dev, skip Win32 ftCreationTime quirk
631 \& (cache manager sometimes preserves ctime of
632 \& file previously created and deleted), no \-u
633 \& (setuid)
634 \& t/op/taint.t \- can\*(Aqt use empty path under Cygwin Perl
635 \& t/op/time.t \- no tzset()
636 .Ve
637 .IP "Compiled Perl Source" 4
638 .IX Item "Compiled Perl Source"
639 .Vb 10
640 \& EXTERN.h \- _\|_declspec(dllimport)
641 \& XSUB.h \- _\|_declspec(dllexport)
642 \& cygwin/cygwin.c \- os_extras (getcwd, spawn, and several
643 \& Cygwin:: functions)
644 \& perl.c \- os_extras, \-i.bak
645 \& perl.h \- binmode
646 \& doio.c \- win9x can not rename a file when it is open
647 \& pp_sys.c \- do not define h_errno, init
648 \& _pwent_struct.pw_comment
649 \& util.c \- use setenv
650 \& util.h \- PERL_FILE_IS_ABSOLUTE macro
651 \& pp.c \- Comment about Posix vs IEEE math under
652 \& Cygwin
653 \& perlio.c \- CR/LF mode
654 \& perliol.c \- Comment about EXTCONST under Cygwin
655 .Ve
656 .IP "Compiled Module Source" 4
657 .IX Item "Compiled Module Source"
658 .Vb 10
659 \& ext/Compress\-Raw\-Zlib/Makefile.PL
660 \& \- Can\*(Aqt install via CPAN shell under Cygwin
661 \& ext/Compress\-Raw\-Zlib/zlib\-src/zutil.h
662 \& \- Cygwin is Unix\-like and has vsnprintf
663 \& ext/Errno/Errno_pm.PL \- Special handling for Win32 Perl under
664 \& Cygwin
665 \& ext/POSIX/POSIX.xs \- tzname defined externally
666 \& ext/SDBM_File/sdbm/pair.c
667 \& \- EXTCONST needs to be redefined from
668 \& EXTERN.h
669 \& ext/SDBM_File/sdbm/sdbm.c
670 \& \- binary open
671 \& ext/Sys/Syslog/Syslog.xs
672 \& \- Cygwin has syslog.h
673 \& ext/Sys/Syslog/win32/compile.pl
674 \& \- Convert paths to Windows paths
675 \& ext/Time\-HiRes/HiRes.xs
676 \& \- Various timers not available
677 \& ext/Time\-HiRes/Makefile.PL
678 \& \- Find w32api/windows.h
679 \& ext/Win32/Makefile.PL \- Use various libraries under Cygwin
680 \& ext/Win32/Win32.xs \- Child dir and child env under Cygwin
681 \& ext/Win32API\-File/File.xs
682 \& \- _open_osfhandle not implemented under
683 \& Cygwin
684 \& ext/Win32CORE/Win32CORE.c
685 \& \- _\|_declspec(dllexport)
686 .Ve
687 .IP "Perl Modules/Scripts" 4
688 .IX Item "Perl Modules/Scripts"
689 .Vb 10
690 \& ext/B/t/OptreeCheck.pm \- Comment about stderr/stdout order under
691 \& Cygwin
692 \& ext/Digest\-SHA/bin/shasum
693 \& \- Use binary mode under Cygwin
694 \& ext/Sys/Syslog/win32/Win32.pm
695 \& \- Convert paths to Windows paths
696 \& ext/Time\-HiRes/HiRes.pm
697 \& \- Comment about various timers not available
698 \& ext/Win32API\-File/File.pm
699 \& \- _open_osfhandle not implemented under
700 \& Cygwin
701 \& ext/Win32CORE/Win32CORE.pm
702 \& \- History of Win32CORE under Cygwin
703 \& lib/Cwd.pm \- hook to internal Cwd::cwd
704 \& lib/ExtUtils/CBuilder/Platform/cygwin.pm
705 \& \- use gcc for ld, and link to libperl.dll.a
706 \& lib/ExtUtils/CBuilder.pm
707 \& \- Cygwin is Unix\-like
708 \& lib/ExtUtils/Install.pm \- Install and rename issues under Cygwin
709 \& lib/ExtUtils/MM.pm \- OS classifications
710 \& lib/ExtUtils/MM_Any.pm \- Example for Cygwin
711 \& lib/ExtUtils/MakeMaker.pm
712 \& \- require MM_Cygwin.pm
713 \& lib/ExtUtils/MM_Cygwin.pm
714 \& \- canonpath, cflags, manifypods, perl_archive
715 \& lib/File/Fetch.pm \- Comment about quotes using a Cygwin example
716 \& lib/File/Find.pm \- on remote drives stat() always sets
717 \& st_nlink to 1
718 \& lib/File/Spec/Cygwin.pm \- case_tolerant
719 \& lib/File/Spec/Unix.pm \- preserve //unc
720 \& lib/File/Spec/Win32.pm \- References a message on cygwin.com
721 \& lib/File/Spec.pm \- Pulls in lib/File/Spec/Cygwin.pm
722 \& lib/File/Temp.pm \- no directory sticky bit
723 \& lib/Module/CoreList.pm \- List of all module files and versions
724 \& lib/Net/Domain.pm \- No domainname command under Cygwin
725 \& lib/Net/Netrc.pm \- Bypass using stat() under Cygwin
726 \& lib/Net/Ping.pm \- ECONREFUSED is EAGAIN under Cygwin
727 \& lib/Pod/Find.pm \- Set \*(Aqpods\*(Aq dir
728 \& lib/Pod/Perldoc/ToMan.pm \- \*(Aq\-c\*(Aq switch for pod2man
729 \& lib/Pod/Perldoc.pm \- Use \*(Aqless\*(Aq pager, and use .exe extension
730 \& lib/Term/ANSIColor.pm \- Cygwin terminal info
731 \& lib/perl5db.pl \- use stdin not /dev/tty
732 \& utils/perlbug.PL \- Add CYGWIN environment variable to report
733 .Ve
734 .IP "Perl Module Tests" 4
735 .IX Item "Perl Module Tests"
736 .Vb 10
737 \& dist/Cwd/t/cwd.t
738 \& ext/Compress\-Zlib/t/14gzopen.t
739 \& ext/DB_File/t/db\-btree.t
740 \& ext/DB_File/t/db\-hash.t
741 \& ext/DB_File/t/db\-recno.t
742 \& ext/DynaLoader/t/DynaLoader.t
743 \& ext/File\-Glob/t/basic.t
744 \& ext/GDBM_File/t/gdbm.t
745 \& ext/POSIX/t/sysconf.t
746 \& ext/POSIX/t/time.t
747 \& ext/SDBM_File/t/sdbm.t
748 \& ext/Sys/Syslog/t/syslog.t
749 \& ext/Time\-HiRes/t/HiRes.t
750 \& ext/Win32/t/Unicode.t
751 \& ext/Win32API\-File/t/file.t
752 \& ext/Win32CORE/t/win32core.t
753 \& lib/AnyDBM_File.t
754 \& lib/Archive/Extract/t/01_Archive\-Extract.t
755 \& lib/Archive/Tar/t/02_methods.t
756 \& lib/ExtUtils/t/Embed.t
757 \& lib/ExtUtils/t/eu_command.t
758 \& lib/ExtUtils/t/MM_Cygwin.t
759 \& lib/ExtUtils/t/MM_Unix.t
760 \& lib/File/Compare.t
761 \& lib/File/Copy.t
762 \& lib/File/Find/t/find.t
763 \& lib/File/Path.t
764 \& lib/File/Spec/t/crossplatform.t
765 \& lib/File/Spec/t/Spec.t
766 \& lib/Net/hostent.t
767 \& lib/Net/Ping/t/110_icmp_inst.t
768 \& lib/Net/Ping/t/500_ping_icmp.t
769 \& lib/Net/t/netrc.t
770 \& lib/Pod/Simple/t/perlcyg.pod
771 \& lib/Pod/Simple/t/perlcygo.txt
772 \& lib/Pod/Simple/t/perlfaq.pod
773 \& lib/Pod/Simple/t/perlfaqo.txt
774 \& lib/User/grent.t
775 \& lib/User/pwent.t
776 .Ve
777 .SH "BUGS ON CYGWIN"
778 .IX Header "BUGS ON CYGWIN"
779 Support for swapping real and effective user and group IDs is incomplete.
780 On WinNT Cygwin provides \f(CWsetuid()\fR, \f(CWseteuid()\fR, \f(CWsetgid()\fR and \f(CWsetegid()\fR.
781 However, additional Cygwin calls for manipulating WinNT access tokens
782 and security contexts are required.
783 .SH AUTHORS
784 .IX Header "AUTHORS"
785 Charles Wilson <[email protected]>,
786 Eric Fifer <[email protected]>,
787 alexander smishlajev <[email protected]>,
788 Steven Morlock <[email protected]>,
789 Sebastien Barre <[email protected]>,
790 Teun Burgers <[email protected]>,
791 Gerrit P. Haase <[email protected]>,
792 Reini Urban <[email protected]>,
793 Jan Dubois <[email protected]>,
794 Jerry D. Hedden <[email protected]>.
795 .SH HISTORY
796 .IX Header "HISTORY"
797 Last updated: 2019\-11\-14