Debian Codegraph @

upstream/opensuse-tumbleweed/man3/File::Spec::Cygwin.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "File::Spec::Cygwin 3pm"
61 .TH File::Spec::Cygwin 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 File::Spec::Cygwin \- methods for Cygwin file specs
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& require File::Spec::Cygwin; # Done internally by File::Spec if needed
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 See File::Spec and File::Spec::Unix. This package overrides the
76 implementation of these methods, not the semantics.
77 .PP
78 This module is still in beta. Cygwin\-knowledgeable folks are invited
79 to offer patches and suggestions.
80 .IP canonpath 4
81 .IX Item "canonpath"
82 Any \f(CW\*(C`\e\*(C'\fR (backslashes) are converted to \f(CW\*(C`/\*(C'\fR (forward slashes),
83 and then File::Spec::Unix \fBcanonpath()\fR is called on the result.
84 .IP file_name_is_absolute 4
85 .IX Item "file_name_is_absolute"
86 True is returned if the file name begins with \f(CW\*(C`drive_letter:\*(C'\fR,
87 and if not, File::Spec::Unix \fBfile_name_is_absolute()\fR is called.
88 .IP "tmpdir (override)" 4
89 .IX Item "tmpdir (override)"
90 Returns a string representation of the first existing directory
91 from the following list:
92 .Sp
93 .Vb 5
94 \& $ENV{TMPDIR}
95 \& /tmp
96 \& $ENV{\*(AqTMP\*(Aq}
97 \& $ENV{\*(AqTEMP\*(Aq}
98 \& C:/temp
99 .Ve
100 .Sp
101 If running under taint mode, and if the environment
102 variables are tainted, they are not used.
103 .IP case_tolerant 4
104 .IX Item "case_tolerant"
105 Override Unix. Cygwin case\-tolerance depends on managed mount settings and
106 as with MsWin32 on \fBGetVolumeInformation()\fR \f(CW$ouFsFlags\fR == FS_CASE_SENSITIVE,
107 indicating the case significance when comparing file specifications.
108 Default: 1
109 .SH COPYRIGHT
110 .IX Header "COPYRIGHT"
111 Copyright (c) 2004,2007 by the Perl 5 Porters. All rights reserved.
112 .PP
113 This program is free software; you can redistribute it and/or modify
114 it under the same terms as Perl itself.