Debian Codegraph @

upstream/debian-unstable/man3/File::Spec::Cygwin.3perl

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 "File::Spec::Cygwin 3perl"
58 .TH File::Spec::Cygwin 3perl 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 File::Spec::Cygwin \- methods for Cygwin file specs
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& require File::Spec::Cygwin; # Done internally by File::Spec if needed
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 See File::Spec and File::Spec::Unix. This package overrides the
73 implementation of these methods, not the semantics.
74 .PP
75 This module is still in beta. Cygwin-knowledgeable folks are invited
76 to offer patches and suggestions.
77 .IP canonpath 4
78 .IX Item "canonpath"
79 Any \f(CW\*(C`\e\*(C'\fR (backslashes) are converted to \f(CW\*(C`/\*(C'\fR (forward slashes),
80 and then File::Spec::Unix \fBcanonpath()\fR is called on the result.
81 .IP file_name_is_absolute 4
82 .IX Item "file_name_is_absolute"
83 True is returned if the file name begins with \f(CW\*(C`drive_letter:\*(C'\fR,
84 and if not, File::Spec::Unix \fBfile_name_is_absolute()\fR is called.
85 .IP "tmpdir (override)" 4
86 .IX Item "tmpdir (override)"
87 Returns a string representation of the first existing directory
88 from the following list:
89 .Sp
90 .Vb 5
91 \& $ENV{TMPDIR}
92 \& /tmp
93 \& $ENV{\*(AqTMP\*(Aq}
94 \& $ENV{\*(AqTEMP\*(Aq}
95 \& C:/temp
96 .Ve
97 .Sp
98 If running under taint mode, and if the environment
99 variables are tainted, they are not used.
100 .IP case_tolerant 4
101 .IX Item "case_tolerant"
102 Override Unix. Cygwin case-tolerance depends on managed mount settings and
103 as with MsWin32 on \fBGetVolumeInformation()\fR \f(CW$ouFsFlags\fR == FS_CASE_SENSITIVE,
104 indicating the case significance when comparing file specifications.
105 Default: 1
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright (c) 2004,2007 by the Perl 5 Porters. All rights reserved.
109 .PP
110 This program is free software; you can redistribute it and/or modify
111 it under the same terms as Perl itself.