home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _6c2dd604ba1074e1e7c87f9959d0b056 < prev    next >
Text File  |  2000-03-23  |  4KB  |  119 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::Path - create or remove directory trees</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> File::Path - create or remove directory trees</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#authors">AUTHORS</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <P>File::Path - create or remove directory trees</P>
  33. <P>
  34. <HR>
  35. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  36. <UL>
  37. <LI>Linux</LI>
  38. <LI>Solaris</LI>
  39. <LI>Windows</LI>
  40. </UL>
  41. <HR>
  42. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  43. <PRE>
  44.     use File::Path;</PRE>
  45. <PRE>
  46.     mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);
  47.     rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);</PRE>
  48. <P>
  49. <HR>
  50. <H1><A NAME="description">DESCRIPTION</A></H1>
  51. <P>The <CODE>mkpath</CODE> function provides a convenient way to create directories, even
  52. if your <A HREF="../../lib/Pod/perlfunc.html#item_mkdir"><CODE>mkdir</CODE></A> kernel call won't create more than one level of directory at
  53. a time.  <CODE>mkpath</CODE> takes three arguments:</P>
  54. <UL>
  55. <LI>
  56. the name of the path to create, or a reference
  57. to a list of paths to create,
  58. <P></P>
  59. <LI>
  60. a boolean value, which if TRUE will cause <CODE>mkpath</CODE>
  61. to print the name of each directory as it is created
  62. (defaults to FALSE), and
  63. <P></P>
  64. <LI>
  65. the numeric mode to use when creating the directories
  66. (defaults to 0777)
  67. <P></P></UL>
  68. <P>It returns a list of all directories (including intermediates, determined
  69. using the Unix '/' separator) created.</P>
  70. <P>Similarly, the <CODE>rmtree</CODE> function provides a convenient way to delete a
  71. subtree from the directory structure, much like the Unix command <CODE>rm -r</CODE>.
  72. <CODE>rmtree</CODE> takes three arguments:</P>
  73. <UL>
  74. <LI>
  75. the root of the subtree to delete, or a reference to
  76. a list of roots.  All of the files and directories
  77. below each root, as well as the roots themselves,
  78. will be deleted.
  79. <P></P>
  80. <LI>
  81. a boolean value, which if TRUE will cause <CODE>rmtree</CODE> to
  82. print a message each time it examines a file, giving the
  83. name of the file, and indicating whether it's using <A HREF="../../lib/Pod/perlfunc.html#item_rmdir"><CODE>rmdir</CODE></A>
  84. or <A HREF="../../lib/Pod/perlfunc.html#item_unlink"><CODE>unlink</CODE></A> to remove it, or that it's skipping it.
  85. (defaults to FALSE)
  86. <P></P>
  87. <LI>
  88. a boolean value, which if TRUE will cause <CODE>rmtree</CODE> to
  89. skip any files to which you do not have delete access
  90. (if running under VMS) or write access (if running
  91. under another OS).  This will change in the future when
  92. a criterion for 'delete permission' under OSs other
  93. than VMS is settled.  (defaults to FALSE)
  94. <P></P></UL>
  95. <P>It returns the number of files successfully deleted.  Symlinks are
  96. simply deleted and not followed.</P>
  97. <P><STRONG>NOTE:</STRONG> If the third parameter is not TRUE, <CODE>rmtree</CODE> is <STRONG>unsecure</STRONG>
  98. in the face of failure or interruption.  Files and directories which
  99. were not deleted may be left with permissions reset to allow world
  100. read and write access.  Note also that the occurrence of errors in
  101. rmtree can be determined <EM>only</EM> by trapping diagnostic messages
  102. using <CODE>$SIG{__WARN__}</CODE>; it is not apparent from the return value.
  103. Therefore, you must be extremely careful about using <CODE>rmtree($foo,$bar,0</CODE>
  104. in situations where security is an issue.</P>
  105. <P>
  106. <HR>
  107. <H1><A NAME="authors">AUTHORS</A></H1>
  108. <P>Tim Bunce <<EM><A HREF="mailto:Tim.Bunce@ig.co.uk">Tim.Bunce@ig.co.uk</A></EM>> and
  109. Charles Bailey <<EM><A HREF="mailto:bailey@newman.upenn.edu">bailey@newman.upenn.edu</A></EM>></P>
  110. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  111. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  112. <STRONG><P CLASS=block> File::Path - create or remove directory trees</P></STRONG>
  113. </TD></TR>
  114. </TABLE>
  115.  
  116. </BODY>
  117.  
  118. </HTML>
  119.