home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _8a0b3f26dd687581fd04a5474541349a < prev    next >
Text File  |  2000-03-23  |  8KB  |  209 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::Spec::Unix - methods used by File::Spec</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::Spec::Unix - methods used by File::Spec</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="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27. </UL>
  28. <!-- INDEX END -->
  29.  
  30. <HR>
  31. <P>
  32. <H1><A NAME="name">NAME</A></H1>
  33. <P>File::Spec::Unix - methods used by File::Spec</P>
  34. <P>
  35. <HR>
  36. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  37. <UL>
  38. <LI>Linux</LI>
  39. <LI>Solaris</LI>
  40. <LI>Windows</LI>
  41. </UL>
  42. <HR>
  43. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  44. <PRE>
  45.  require File::Spec::Unix; # Done automatically by File::Spec</PRE>
  46. <P>
  47. <HR>
  48. <H1><A NAME="description">DESCRIPTION</A></H1>
  49. <P>Methods for manipulating file specifications.</P>
  50. <P>
  51. <HR>
  52. <H1><A NAME="methods">METHODS</A></H1>
  53. <DL>
  54. <DT><STRONG><A NAME="item_canonpath">canonpath</A></STRONG><BR>
  55. <DD>
  56. No physical check on the filesystem, but a logical cleanup of a
  57. path. On UNIX eliminated successive slashes and successive ``/.''.
  58. <PRE>
  59.     $cpath = File::Spec->canonpath( $path ) ;</PRE>
  60. <P></P>
  61. <DT><STRONG><A NAME="item_catdir">catdir</A></STRONG><BR>
  62. <DD>
  63. Concatenate two or more directory names to form a complete path ending
  64. with a directory. But remove the trailing slash from the resulting
  65. string, because it doesn't look good, isn't necessary and confuses
  66. OS2. Of course, if this is the root directory, don't cut off the
  67. trailing slash :-)
  68. <P></P>
  69. <DT><STRONG><A NAME="item_catfile">catfile</A></STRONG><BR>
  70. <DD>
  71. Concatenate one or more directory names and a filename to form a
  72. complete path ending with a filename
  73. <P></P>
  74. <DT><STRONG><A NAME="item_curdir">curdir</A></STRONG><BR>
  75. <DD>
  76. Returns a string representation of the current directory.  ``.'' on UNIX.
  77. <P></P>
  78. <DT><STRONG><A NAME="item_devnull">devnull</A></STRONG><BR>
  79. <DD>
  80. Returns a string representation of the null device. ``/dev/null'' on UNIX.
  81. <P></P>
  82. <DT><STRONG><A NAME="item_rootdir">rootdir</A></STRONG><BR>
  83. <DD>
  84. Returns a string representation of the root directory.  ``/'' on UNIX.
  85. <P></P>
  86. <DT><STRONG><A NAME="item_tmpdir">tmpdir</A></STRONG><BR>
  87. <DD>
  88. Returns a string representation of the first writable directory
  89. from the following list or ``'' if none are writable:
  90. <PRE>
  91.     $ENV{TMPDIR}
  92.     /tmp</PRE>
  93. <P></P>
  94. <DT><STRONG><A NAME="item_updir">updir</A></STRONG><BR>
  95. <DD>
  96. Returns a string representation of the parent directory.  ``..'' on UNIX.
  97. <P></P>
  98. <DT><STRONG><A NAME="item_no_upwards">no_upwards</A></STRONG><BR>
  99. <DD>
  100. Given a list of file names, strip out those that refer to a parent
  101. directory. (Does not strip symlinks, only '.', '..', and equivalents.)
  102. <P></P>
  103. <DT><STRONG><A NAME="item_case_tolerant">case_tolerant</A></STRONG><BR>
  104. <DD>
  105. Returns a true or false value indicating, respectively, that alphabetic
  106. is not or is significant when comparing file specifications.
  107. <P></P>
  108. <DT><STRONG><A NAME="item_file_name_is_absolute">file_name_is_absolute</A></STRONG><BR>
  109. <DD>
  110. Takes as argument a path and returns true, if it is an absolute path.
  111. <P></P>
  112. <DT><STRONG><A NAME="item_path">path</A></STRONG><BR>
  113. <DD>
  114. Takes no argument, returns the environment variable PATH as an array.
  115. <P></P>
  116. <DT><STRONG><A NAME="item_join">join</A></STRONG><BR>
  117. <DD>
  118. join is the same as catfile.
  119. <P></P>
  120. <DT><STRONG><A NAME="item_splitpath">splitpath</A></STRONG><BR>
  121. <DD>
  122. <PRE>
  123.     ($volume,$directories,$file) = File::Spec->splitpath( $path );
  124.     ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );</PRE>
  125. <P>Splits a path in to volume, directory, and filename portions. On systems
  126. with no concept of volume, returns undef for volume.</P>
  127. <P>For systems with no syntax differentiating filenames from directories, 
  128. assumes that the last file is a path unless $no_file is true or a 
  129. trailing separator or /. or /.. is present. On Unix this means that $no_file
  130. true makes this return ( '', $path, '' ).</P>
  131. <P>The directory portion may or may not be returned with a trailing '/'.</P>
  132. <P>The results can be passed to <A HREF="#catpath()">catpath()</A> to get back a path equivalent to
  133. (usually identical to) the original path.</P>
  134. <DT><STRONG><A NAME="item_splitdir">splitdir</A></STRONG><BR>
  135. <DD>
  136. The opposite of <A HREF="#catdir()">catdir()</A>.
  137. <PRE>
  138.     @dirs = File::Spec->splitdir( $directories );</PRE>
  139. <P>$directories must be only the directory portion of the path on systems 
  140. that have the concept of a volume or that have path syntax that differentiates
  141. files from directories.</P>
  142. <P>Unlike just splitting the directories on the separator, empty
  143. directory names (<CODE>''</CODE>) can be returned, because these are significant
  144. on some OSs (e.g. MacOS).</P>
  145. <P>On Unix,</P>
  146. <PRE>
  147.     File::Spec->splitdir( "/a/b//c/" );</PRE>
  148. <P>Yields:</P>
  149. <PRE>
  150.     ( '', 'a', 'b', '', 'c', '' )</PRE>
  151. <P></P>
  152. <DT><STRONG><A NAME="item_catpath">catpath</A></STRONG><BR>
  153. <DD>
  154. Takes volume, directory and file portions and returns an entire path. Under
  155. Unix, $volume is ignored, and directory and file are catenated.  A '/' is
  156. inserted if need be.  On other OSs, $volume is significant.
  157. <P></P>
  158. <DT><STRONG><A NAME="item_abs2rel">abs2rel</A></STRONG><BR>
  159. <DD>
  160. Takes a destination path and an optional base path returns a relative path
  161. from the base path to the destination path:
  162. <PRE>
  163.     $rel_path = File::Spec->abs2rel( $destination ) ;
  164.     $rel_path = File::Spec->abs2rel( $destination, $base ) ;</PRE>
  165. <P>If $base is not present or '', then <EM>cwd()</EM> is used. If $base is relative, 
  166. then it is converted to absolute form using <A HREF="#rel2abs()">rel2abs()</A>. This means that it
  167. is taken to be relative to <EM>cwd()</EM>.</P>
  168. <P>On systems with the concept of a volume, this assumes that both paths 
  169. are on the $destination volume, and ignores the $base volume.</P>
  170. <P>On systems that have a grammar that indicates filenames, this ignores the 
  171. $base filename as well. Otherwise all path components are assumed to be
  172. directories.</P>
  173. <P>If $path is relative, it is converted to absolute form using <A HREF="#rel2abs()">rel2abs()</A>.
  174. This means that it is taken to be relative to <EM>cwd()</EM>.</P>
  175. <P>Based on code written by Shigio Yamaguchi.</P>
  176. <P>No checks against the filesystem are made.</P>
  177. <P></P>
  178. <DT><STRONG><A NAME="item_rel2abs">rel2abs</A></STRONG><BR>
  179. <DD>
  180. Converts a relative path to an absolute path.
  181. <PRE>
  182.     $abs_path = File::Spec->rel2abs( $destination ) ;
  183.     $abs_path = File::Spec->rel2abs( $destination, $base ) ;</PRE>
  184. <P>If $base is not present or '', then <EM>cwd()</EM> is used. If $base is relative, 
  185. then it is converted to absolute form using <A HREF="#rel2abs()">rel2abs()</A>. This means that it
  186. is taken to be relative to <EM>cwd()</EM>.</P>
  187. <P>On systems with the concept of a volume, this assumes that both paths 
  188. are on the $base volume, and ignores the $destination volume.</P>
  189. <P>On systems that have a grammar that indicates filenames, this ignores the 
  190. $base filename as well. Otherwise all path components are assumed to be
  191. directories.</P>
  192. <P>If $path is absolute, it is cleaned up and returned using <A HREF="#canonpath()">canonpath()</A>.</P>
  193. <P>Based on code written by Shigio Yamaguchi.</P>
  194. <P>No checks against the filesystem are made.</P>
  195. <P></P></DL>
  196. <P>
  197. <HR>
  198. <H1><A NAME="see also">SEE ALSO</A></H1>
  199. <P><A HREF="../../../lib/File/Spec.html">the File::Spec manpage</A></P>
  200. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  201. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  202. <STRONG><P CLASS=block> File::Spec::Unix - methods used by File::Spec</P></STRONG>
  203. </TD></TR>
  204. </TABLE>
  205.  
  206. </BODY>
  207.  
  208. </HTML>
  209.