Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "Cwd 3" | |
132 | .TH Cwd 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | Cwd \- get pathname of current working directory | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 2 | |
138 | \& use Cwd; | |
139 | \& my $dir = getcwd; | |
140 | .Ve | |
141 | .PP | |
142 | .Vb 2 | |
143 | \& use Cwd 'abs_path'; | |
144 | \& my $abs_path = abs_path($file); | |
145 | .Ve | |
146 | .SH "DESCRIPTION" | |
147 | .IX Header "DESCRIPTION" | |
148 | This module provides functions for determining the pathname of the | |
149 | current working directory. It is recommended that getcwd (or another | |
150 | *\fIcwd()\fR function) be used in \fIall\fR code to ensure portability. | |
151 | .PP | |
152 | By default, it exports the functions \fIcwd()\fR, \fIgetcwd()\fR, \fIfastcwd()\fR, and | |
153 | \&\fIfastgetcwd()\fR (and, on Win32, \fIgetdcwd()\fR) into the caller's namespace. | |
154 | .Sh "getcwd and friends" | |
155 | .IX Subsection "getcwd and friends" | |
156 | Each of these functions are called without arguments and return the | |
157 | absolute path of the current working directory. | |
158 | .IP "getcwd" 4 | |
159 | .IX Item "getcwd" | |
160 | .Vb 1 | |
161 | \& my $cwd = getcwd(); | |
162 | .Ve | |
163 | .Sp | |
164 | Returns the current working directory. | |
165 | .Sp | |
166 | Re-implements the \fIgetcwd\fR\|(3) (or \fIgetwd\fR\|(3)) functions in Perl. | |
167 | .IP "cwd" 4 | |
168 | .IX Item "cwd" | |
169 | .Vb 1 | |
170 | \& my $cwd = cwd(); | |
171 | .Ve | |
172 | .Sp | |
173 | The \fIcwd()\fR is the most natural form for the current architecture. For | |
174 | most systems it is identical to `pwd` (but without the trailing line | |
175 | terminator). | |
176 | .IP "fastcwd" 4 | |
177 | .IX Item "fastcwd" | |
178 | .Vb 1 | |
179 | \& my $cwd = fastcwd(); | |
180 | .Ve | |
181 | .Sp | |
182 | A more dangerous version of \fIgetcwd()\fR, but potentially faster. | |
183 | .Sp | |
184 | It might conceivably \fIchdir()\fR you out of a directory that it can't | |
185 | \&\fIchdir()\fR you back into. If fastcwd encounters a problem it will return | |
186 | undef but will probably leave you in a different directory. For a | |
187 | measure of extra security, if everything appears to have worked, the | |
188 | \&\fIfastcwd()\fR function will check that it leaves you in the same directory | |
189 | that it started in. If it has changed it will \f(CW\*(C`die\*(C'\fR with the message | |
190 | \&\*(L"Unstable directory path, current directory changed | |
191 | unexpectedly\*(R". That should never happen. | |
192 | .IP "fastgetcwd" 4 | |
193 | .IX Item "fastgetcwd" | |
194 | .Vb 1 | |
195 | \& my $cwd = fastgetcwd(); | |
196 | .Ve | |
197 | .Sp | |
198 | The \fIfastgetcwd()\fR function is provided as a synonym for \fIcwd()\fR. | |
199 | .IP "getdcwd" 4 | |
200 | .IX Item "getdcwd" | |
201 | .Vb 2 | |
202 | \& my $cwd = getdcwd(); | |
203 | \& my $cwd = getdcwd('C:'); | |
204 | .Ve | |
205 | .Sp | |
206 | The \fIgetdcwd()\fR function is also provided on Win32 to get the current working | |
207 | directory on the specified drive, since Windows maintains a separate current | |
208 | working directory for each drive. If no drive is specified then the current | |
209 | drive is assumed. | |
210 | .Sp | |
211 | This function simply calls the Microsoft C library \fI_getdcwd()\fR function. | |
212 | .Sh "abs_path and friends" | |
213 | .IX Subsection "abs_path and friends" | |
214 | These functions are exported only on request. They each take a single | |
215 | argument and return the absolute pathname for it. If no argument is | |
216 | given they'll use the current working directory. | |
217 | .IP "abs_path" 4 | |
218 | .IX Item "abs_path" | |
219 | .Vb 1 | |
220 | \& my $abs_path = abs_path($file); | |
221 | .Ve | |
222 | .Sp | |
223 | Uses the same algorithm as \fIgetcwd()\fR. Symbolic links and relative-path | |
224 | components (\*(L".\*(R" and \*(L"..\*(R") are resolved to return the canonical | |
225 | pathname, just like \fIrealpath\fR\|(3). | |
226 | .IP "realpath" 4 | |
227 | .IX Item "realpath" | |
228 | .Vb 1 | |
229 | \& my $abs_path = realpath($file); | |
230 | .Ve | |
231 | .Sp | |
232 | A synonym for \fIabs_path()\fR. | |
233 | .IP "fast_abs_path" 4 | |
234 | .IX Item "fast_abs_path" | |
235 | .Vb 1 | |
236 | \& my $abs_path = fast_abs_path($file); | |
237 | .Ve | |
238 | .Sp | |
239 | A more dangerous, but potentially faster version of abs_path. | |
240 | .Sh "$ENV{\s-1PWD\s0}" | |
241 | .IX Subsection "$ENV{PWD}" | |
242 | If you ask to override your \fIchdir()\fR built-in function, | |
243 | .PP | |
244 | .Vb 1 | |
245 | \& use Cwd qw(chdir); | |
246 | .Ve | |
247 | .PP | |
248 | then your \s-1PWD\s0 environment variable will be kept up to date. Note that | |
249 | it will only be kept up to date if all packages which use chdir import | |
250 | it from Cwd. | |
251 | .SH "NOTES" | |
252 | .IX Header "NOTES" | |
253 | .IP "\(bu" 4 | |
254 | Since the path seperators are different on some operating systems ('/' | |
255 | on Unix, ':' on MacPerl, etc...) we recommend you use the File::Spec | |
256 | modules wherever portability is a concern. | |
257 | .IP "\(bu" 4 | |
258 | Actually, on Mac \s-1OS\s0, the \f(CW\*(C`getcwd()\*(C'\fR, \f(CW\*(C`fastgetcwd()\*(C'\fR and \f(CW\*(C`fastcwd()\*(C'\fR | |
259 | functions are all aliases for the \f(CW\*(C`cwd()\*(C'\fR function, which, on Mac \s-1OS\s0, | |
260 | calls `pwd`. Likewise, the \f(CW\*(C`abs_path()\*(C'\fR function is an alias for | |
261 | \&\f(CW\*(C`fast_abs_path()\*(C'\fR. | |
262 | .SH "AUTHOR" | |
263 | .IX Header "AUTHOR" | |
264 | Originally by the perl5\-porters. | |
265 | .PP | |
266 | Maintained by Ken Williams <KWILLIAMS@cpan.org> | |
267 | .SH "COPYRIGHT" | |
268 | .IX Header "COPYRIGHT" | |
269 | Copyright (c) 2004 by the Perl 5 Porters. All rights reserved. | |
270 | .PP | |
271 | This program is free software; you can redistribute it and/or modify | |
272 | it under the same terms as Perl itself. | |
273 | .PP | |
274 | Portions of the C code in this library are copyright (c) 1994 by the | |
275 | Regents of the University of California. All rights reserved. The | |
276 | license on this code is compatible with the licensing of the rest of | |
277 | the distribution \- please see the source code in \fICwd.xs\fR for the | |
278 | details. | |
279 | .SH "SEE ALSO" | |
280 | .IX Header "SEE ALSO" | |
281 | File::chdir |