home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _32369e69c59ff1e0e57cf2a5ad65ac75 < prev    next >
Text File  |  2000-03-23  |  4KB  |  115 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>lib - manipulate @INC at compile time</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> lib - manipulate @INC at compile time</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.     <UL>
  26.  
  27.         <LI><A HREF="#adding directories to @inc">Adding directories to @INC</A></LI>
  28.         <LI><A HREF="#deleting directories from @inc">Deleting directories from @INC</A></LI>
  29.         <LI><A HREF="#restoring original @inc">Restoring original @INC</A></LI>
  30.     </UL>
  31.  
  32.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  33.     <LI><A HREF="#author">AUTHOR</A></LI>
  34. </UL>
  35. <!-- INDEX END -->
  36.  
  37. <HR>
  38. <P>
  39. <H1><A NAME="name">NAME</A></H1>
  40. <P>lib - manipulate @INC at compile time</P>
  41. <P>
  42. <HR>
  43. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  44. <UL>
  45. <LI>Linux</LI>
  46. <LI>Solaris</LI>
  47. <LI>Windows</LI>
  48. </UL>
  49. <HR>
  50. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  51. <PRE>
  52.     use lib LIST;</PRE>
  53. <PRE>
  54.     no lib LIST;</PRE>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P>This is a small simple module which simplifies the manipulation of @INC
  59. at compile time.</P>
  60. <P>It is typically used to add extra directories to perl's search path so
  61. that later <A HREF="../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A> or <A HREF="../lib/Pod/perlfunc.html#item_require"><CODE>require</CODE></A> statements will find modules which are
  62. not located on perl's default search path.</P>
  63. <P>
  64. <H2><A NAME="adding directories to @inc">Adding directories to @INC</A></H2>
  65. <P>The parameters to <CODE>use lib</CODE> are added to the start of the perl search
  66. path. Saying</P>
  67. <PRE>
  68.     use lib LIST;</PRE>
  69. <P>is <EM>almost</EM> the same as saying</P>
  70. <PRE>
  71.     BEGIN { unshift(@INC, LIST) }</PRE>
  72. <P>For each directory in LIST (called $dir here) the lib module also
  73. checks to see if a directory called $dir/$archname/auto exists.
  74. If so the $dir/$archname directory is assumed to be a corresponding
  75. architecture specific directory and is added to @INC in front of $dir.</P>
  76. <P>To avoid memory leaks, all trailing duplicate entries in @INC are
  77. removed.</P>
  78. <P>
  79. <H2><A NAME="deleting directories from @inc">Deleting directories from @INC</A></H2>
  80. <P>You should normally only add directories to @INC.  If you need to
  81. delete directories from @INC take care to only delete those which you
  82. added yourself or which you are certain are not needed by other modules
  83. in your script.  Other modules may have added directories which they
  84. need for correct operation.</P>
  85. <P>The <CODE>no lib</CODE> statement deletes all instances of each named directory
  86. from @INC.</P>
  87. <P>For each directory in LIST (called $dir here) the lib module also
  88. checks to see if a directory called $dir/$archname/auto exists.
  89. If so the $dir/$archname directory is assumed to be a corresponding
  90. architecture specific directory and is also deleted from @INC.</P>
  91. <P>
  92. <H2><A NAME="restoring original @inc">Restoring original @INC</A></H2>
  93. <P>When the lib module is first loaded it records the current value of @INC
  94. in an array <CODE>@lib::ORIG_INC</CODE>. To restore @INC to that value you
  95. can say</P>
  96. <PRE>
  97.     @INC = @lib::ORIG_INC;</PRE>
  98. <P>
  99. <HR>
  100. <H1><A NAME="see also">SEE ALSO</A></H1>
  101. <P>FindBin - optional module which deals with paths relative to the source file.</P>
  102. <P>
  103. <HR>
  104. <H1><A NAME="author">AUTHOR</A></H1>
  105. <P>Tim Bunce, 2nd June 1995.</P>
  106. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  107. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  108. <STRONG><P CLASS=block> lib - manipulate @INC at compile time</P></STRONG>
  109. </TD></TR>
  110. </TABLE>
  111.  
  112. </BODY>
  113.  
  114. </HTML>
  115.