home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _21355770cfa3aed8771757173c97a96f < prev    next >
Text File  |  2000-03-23  |  6KB  |  173 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Net::Netrc - OO interface to users netrc file</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> Net::Netrc - OO interface to users netrc file</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="#the .netrc file">THE .netrc FILE</A></LI>
  26.     <LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
  27.     <LI><A HREF="#methods">METHODS</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  30.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  31. </UL>
  32. <!-- INDEX END -->
  33.  
  34. <HR>
  35. <P>
  36. <H1><A NAME="name">NAME</A></H1>
  37. <P>Net::Netrc - OO interface to users netrc file</P>
  38. <P>
  39. <HR>
  40. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  41. <UL>
  42. <LI>Linux</LI>
  43. <LI>Solaris</LI>
  44. <LI>Windows</LI>
  45. </UL>
  46. <HR>
  47. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  48. <PRE>
  49.     use Net::Netrc;
  50. </PRE>
  51. <PRE>
  52.  
  53.     $mach = Net::Netrc->lookup('some.machine');
  54.     $login = $mach->login;
  55.     ($login, $password, $account) = $mach->lpa;</PRE>
  56. <P>
  57. <HR>
  58. <H1><A NAME="description">DESCRIPTION</A></H1>
  59. <P><CODE>Net::Netrc</CODE> is a class implementing a simple interface to the .netrc file
  60. used as by the ftp program.</P>
  61. <P><CODE>Net::Netrc</CODE> also implements security checks just like the ftp program,
  62. these checks are, first that the .netrc file must be owned by the user and 
  63. second the ownership permissions should be such that only the owner has
  64. read and write access. If these conditions are not met then a warning is
  65. output and the .netrc file is not read.</P>
  66. <P>
  67. <HR>
  68. <H1><A NAME="the .netrc file">THE .netrc FILE</A></H1>
  69. <P>The .netrc file contains login and initialization information used by the
  70. auto-login process.  It resides in the user's home directory.  The following
  71. tokens are recognized; they may be separated by spaces, tabs, or new-lines:</P>
  72. <DL>
  73. <DT><STRONG><A NAME="item_machine_name">machine name</A></STRONG><BR>
  74. <DD>
  75. Identify a remote machine name. The auto-login process searches
  76. the .netrc file for a machine token that matches the remote machine
  77. specified.  Once a match is made, the subsequent .netrc tokens
  78. are processed, stopping when the end of file is reached or an-
  79. other machine or a default token is encountered.
  80. <P></P>
  81. <DT><STRONG><A NAME="item_default">default</A></STRONG><BR>
  82. <DD>
  83. This is the same as machine name except that default matches
  84. any name.  There can be only one default token, and it must be
  85. after all machine tokens.  This is normally used as:
  86. <PRE>
  87.     default login anonymous password user@site</PRE>
  88. <P>thereby giving the user automatic anonymous login to machines
  89. not specified in .netrc.</P>
  90. <P></P>
  91. <DT><STRONG><A NAME="item_login_name">login name</A></STRONG><BR>
  92. <DD>
  93. Identify a user on the remote machine.  If this token is present,
  94. the auto-login process will initiate a login using the
  95. specified name.
  96. <P></P>
  97. <DT><STRONG><A NAME="item_password_string">password string</A></STRONG><BR>
  98. <DD>
  99. Supply a password.  If this token is present, the auto-login
  100. process will supply the specified string if the remote server
  101. requires a password as part of the login process.
  102. <P></P>
  103. <DT><STRONG><A NAME="item_account_string">account string</A></STRONG><BR>
  104. <DD>
  105. Supply an additional account password.  If this token is present,
  106. the auto-login process will supply the specified string
  107. if the remote server requires an additional account password.
  108. <P></P>
  109. <DT><STRONG><A NAME="item_macdef_name">macdef name</A></STRONG><BR>
  110. <DD>
  111. Define a macro. <CODE>Net::Netrc</CODE> only parses this field to be compatible
  112. with <EM>ftp</EM>.
  113. <P></P></DL>
  114. <P>
  115. <HR>
  116. <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
  117. <P>The constructor for a <CODE>Net::Netrc</CODE> object is not called new as it does not
  118. really create a new object. But instead is called <A HREF="#item_lookup"><CODE>lookup</CODE></A> as this is
  119. essentially what it does.</P>
  120. <DL>
  121. <DT><STRONG><A NAME="item_lookup">lookup ( MACHINE [, LOGIN ])</A></STRONG><BR>
  122. <DD>
  123. Lookup and return a reference to the entry for <CODE>MACHINE</CODE>. If <CODE>LOGIN</CODE> is given
  124. then the entry returned will have the given login. If <CODE>LOGIN</CODE> is not given then
  125. the first entry in the .netrc file for <CODE>MACHINE</CODE> will be returned.
  126. <P>If a matching entry cannot be found, and a default entry exists, then a
  127. reference to the default entry is returned.</P>
  128. <P></P></DL>
  129. <P>
  130. <HR>
  131. <H1><A NAME="methods">METHODS</A></H1>
  132. <DL>
  133. <DT><STRONG><A NAME="item_login">login ()</A></STRONG><BR>
  134. <DD>
  135. Return the login id for the netrc entry
  136. <P></P>
  137. <DT><STRONG><A NAME="item_password">password ()</A></STRONG><BR>
  138. <DD>
  139. Return the password for the netrc entry
  140. <P></P>
  141. <DT><STRONG><A NAME="item_account">account ()</A></STRONG><BR>
  142. <DD>
  143. Return the account information for the netrc entry
  144. <P></P>
  145. <DT><STRONG><A NAME="item_lpa">lpa ()</A></STRONG><BR>
  146. <DD>
  147. Return a list of login, password and account information fir the netrc entry
  148. <P></P></DL>
  149. <P>
  150. <HR>
  151. <H1><A NAME="author">AUTHOR</A></H1>
  152. <P>Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>></P>
  153. <P>
  154. <HR>
  155. <H1><A NAME="see also">SEE ALSO</A></H1>
  156. <P><A HREF="../../../site/lib/Net/Netrc.html">the Net::Netrc manpage</A>
  157. <A HREF="../../../site/lib/Net/Cmd.html">the Net::Cmd manpage</A></P>
  158. <P>
  159. <HR>
  160. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  161. <P>Copyright (c) 1995-1998 Graham Barr. All rights reserved.
  162. This program is free software; you can redistribute it and/or modify
  163. it under the same terms as Perl itself.</P>
  164. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  165. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  166. <STRONG><P CLASS=block> Net::Netrc - OO interface to users netrc file</P></STRONG>
  167. </TD></TR>
  168. </TABLE>
  169.  
  170. </BODY>
  171.  
  172. </HTML>
  173.