home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _31e0d453a1f8f95472aace9c4bc785fc < prev    next >
Text File  |  2000-03-23  |  3KB  |  91 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::Slurp -- single call read & write file routines; read directories</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::Slurp -- single call read & write file routines; read directories</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="#author">AUTHOR</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <PRE>
  33.         File::Slurp -- single call read & write file routines; read directories</PRE>
  34. <P>
  35. <HR>
  36. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  37. <UL>
  38. <LI>Windows</LI>
  39. </UL>
  40. <HR>
  41. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  42. <PRE>
  43.         use File::Slurp;</PRE>
  44. <PRE>
  45.         $all_of_it = read_file($filename);
  46.         @all_lines = read_file($filename);</PRE>
  47. <PRE>
  48.         write_file($filename, @contents)</PRE>
  49. <PRE>
  50.         overwrite_file($filename, @new_contnts);</PRE>
  51. <PRE>
  52.         append_file($filename, @additional_contents);</PRE>
  53. <PRE>
  54.         @files = read_dir($directory);</PRE>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P>These are quickie routines that are meant to save a couple of lines of
  59. code over and over again.  They do not do anything fancy.
  60. </P>
  61. <PRE>
  62.  
  63. read_file() does what you would expect.  If you are using its output
  64. in array context, then it returns an array of lines.  If you are calling
  65. it from scalar context, then returns the entire file in a single string.</PRE>
  66. <P>It croaks()s if it can't open the file.</P>
  67. <P><CODE>write_file()</CODE> creates or overwrites files.</P>
  68. <P><CODE>append_file()</CODE> appends to a file.</P>
  69. <P><CODE>overwrite_file()</CODE> does an in-place update of an existing file or creates
  70. a new file if it didn't already exist.  Write_file will also replace a
  71. file.  The difference is that the first that that <CODE>write_file()</CODE> does is 
  72. to trucate the file whereas the last thing that <CODE>overwrite_file()</CODE> is to
  73. trucate the file.  <CODE>Overwrite_file()</CODE> should be used in situations where
  74. you have a file that always needs to have contents, even in the middle
  75. of an update.</P>
  76. <P><CODE>read_dir()</CODE> returns all of the entries in a directory except for ``.''
  77. and ``..''.  It croaks if it cannot open the directory.</P>
  78. <P>
  79. <HR>
  80. <H1><A NAME="author">AUTHOR</A></H1>
  81. <P>David Muir Sharnoff <<A HREF="mailto:muir@idiom.com">muir@idiom.com</A>></P>
  82. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  83. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  84. <STRONG><P CLASS=block> File::Slurp -- single call read & write file routines; read directories</P></STRONG>
  85. </TD></TR>
  86. </TABLE>
  87.  
  88. </BODY>
  89.  
  90. </HTML>
  91.