projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / File::Path.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
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 "File::Path 3"
132.TH File::Path 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133.SH "NAME"
134File::Path \- create or remove directory trees
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& use File::Path;
139.Ve
140.PP
141.Vb 2
142\& mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);
143\& rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);
144.Ve
145.SH "DESCRIPTION"
146.IX Header "DESCRIPTION"
147The \f(CW\*(C`mkpath\*(C'\fR function provides a convenient way to create directories, even
148if your \f(CW\*(C`mkdir\*(C'\fR kernel call won't create more than one level of directory at
149a time. \f(CW\*(C`mkpath\*(C'\fR takes three arguments:
150.IP "\(bu" 4
151the name of the path to create, or a reference
152to a list of paths to create,
153.IP "\(bu" 4
154a boolean value, which if \s-1TRUE\s0 will cause \f(CW\*(C`mkpath\*(C'\fR
155to print the name of each directory as it is created
156(defaults to \s-1FALSE\s0), and
157.IP "\(bu" 4
158the numeric mode to use when creating the directories
159(defaults to 0777)
160.PP
161It returns a list of all directories (including intermediates, determined
162using the Unix '/' separator) created.
163.PP
164If a system error prevents a directory from being created, then the
165\&\f(CW\*(C`mkpath\*(C'\fR function throws a fatal error with \f(CW\*(C`Carp::croak\*(C'\fR. This error
166can be trapped with an \f(CW\*(C`eval\*(C'\fR block:
167.PP
168.Vb 4
169\& eval { mkpath($dir) };
170\& if ($@) {
171\& print "Couldn't create $dir: $@";
172\& }
173.Ve
174.PP
175Similarly, the \f(CW\*(C`rmtree\*(C'\fR function provides a convenient way to delete a
176subtree from the directory structure, much like the Unix command \f(CW\*(C`rm \-r\*(C'\fR.
177\&\f(CW\*(C`rmtree\*(C'\fR takes three arguments:
178.IP "\(bu" 4
179the root of the subtree to delete, or a reference to
180a list of roots. All of the files and directories
181below each root, as well as the roots themselves,
182will be deleted.
183.IP "\(bu" 4
184a boolean value, which if \s-1TRUE\s0 will cause \f(CW\*(C`rmtree\*(C'\fR to
185print a message each time it examines a file, giving the
186name of the file, and indicating whether it's using \f(CW\*(C`rmdir\*(C'\fR
187or \f(CW\*(C`unlink\*(C'\fR to remove it, or that it's skipping it.
188(defaults to \s-1FALSE\s0)
189.IP "\(bu" 4
190a boolean value, which if \s-1TRUE\s0 will cause \f(CW\*(C`rmtree\*(C'\fR to
191skip any files to which you do not have delete access
192(if running under \s-1VMS\s0) or write access (if running
193under another \s-1OS\s0). This will change in the future when
194a criterion for 'delete permission' under OSs other
195than \s-1VMS\s0 is settled. (defaults to \s-1FALSE\s0)
196.PP
197It returns the number of files successfully deleted. Symlinks are
198simply deleted and not followed.
199.PP
200\&\fB\s-1NOTE:\s0\fR If the third parameter is not \s-1TRUE\s0, \f(CW\*(C`rmtree\*(C'\fR is \fBunsecure\fR
201in the face of failure or interruption. Files and directories which
202were not deleted may be left with permissions reset to allow world
203read and write access. Note also that the occurrence of errors in
204rmtree can be determined \fIonly\fR by trapping diagnostic messages
205using \f(CW$SIG{_\|_WARN_\|_}\fR; it is not apparent from the return value.
206Therefore, you must be extremely careful about using \f(CW\*(C`rmtree($foo,$bar,0\*(C'\fR
207in situations where security is an issue.
208.SH "AUTHORS"
209.IX Header "AUTHORS"
210Tim Bunce <\fITim.Bunce@ig.co.uk\fR> and
211Charles Bailey <\fIbailey@newman.upenn.edu\fR>
Full OpenSPARC design & verification tarball including full HDL.