home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _6e63fc41d12e240c57abb1e2f56d746d < prev    next >
Encoding:
Text File  |  2000-03-23  |  6.1 KB  |  171 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>mirror - Procedural LWP interface</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> mirror - Procedural LWP interface</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="#see also">SEE ALSO</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <P>get, head, getprint, getstore, mirror - Procedural LWP interface</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.  perl -MLWP::Simple -e 'getprint "<A HREF="http://www.sn.no"">http://www.sn.no"</A>;'</PRE>
  45. <PRE>
  46.  use LWP::Simple;
  47.  $content = get("<A HREF="http://www.sn.no/"">http://www.sn.no/"</A>;)
  48.  if (mirror("<A HREF="http://www.sn.no/"">http://www.sn.no/"</A>;, "foo") == RC_NOT_MODIFIED) {
  49.      ...
  50.  }</PRE>
  51. <PRE>
  52.  if (is_success(getprint("<A HREF="http://www.sn.no/"">http://www.sn.no/"</A>;))) {
  53.      ...
  54.  }</PRE>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P>This interface is intended for those who want a simplified view of the
  59. libwww-perl library.  It should also be suitable for one-liners.  If
  60. you need more control or access to the header fields in the requests
  61. sent and responses received you should use the full object oriented
  62. interface provided by the <CODE>LWP::UserAgent</CODE> module.</P>
  63. <P>The following functions are provided (and exported) by this module:</P>
  64. <DL>
  65. <DT><STRONG><A NAME="item_get"><CODE>get($url)</CODE></A></STRONG><BR>
  66. <DD>
  67. The <A HREF="#item_get"><CODE>get()</CODE></A> function will fetch the document identified by the given URL
  68. and return it.  It returns <A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if it fails.  The $url argument can
  69. be either a simple string or a reference to a URI object.
  70. <P>You will not be able to examine the response code or response headers
  71. (like 'Content-Type') when you are accessing the web using this
  72. function.  If you need that information you should use the full OO
  73. interface (see <A HREF="../../../site/lib/LWP/UserAgent.html">the LWP::UserAgent manpage</A>).</P>
  74. <P></P>
  75. <DT><STRONG><A NAME="item_head"><CODE>head($url)</CODE></A></STRONG><BR>
  76. <DD>
  77. Get document headers. Returns the following 5 values if successful:
  78. ($content_type, $document_length, $modified_time, $expires, $server)
  79. <P>Returns an empty list if it fails.  In scalar context returns TRUE if
  80. successful.</P>
  81. <P></P>
  82. <DT><STRONG><A NAME="item_getprint"><CODE>getprint($url)</CODE></A></STRONG><BR>
  83. <DD>
  84. Get and print a document identified by a URL. The document is printed
  85. to STDOUT as data is received from the network.  If the request fails,
  86. then the status code and message are printed on STDERR.  The return
  87. value is the HTTP response code.
  88. <P></P>
  89. <DT><STRONG><A NAME="item_getstore">getstore($url, $file)</A></STRONG><BR>
  90. <DD>
  91. Gets a document identified by a URL and stores it in the file. The
  92. return value is the HTTP response code.
  93. <P></P>
  94. <DT><STRONG><A NAME="item_mirror">mirror($url, $file)</A></STRONG><BR>
  95. <DD>
  96. Get and store a document identified by a URL, using
  97. <EM>If-modified-since</EM>, and checking the <EM>Content-Length</EM>.  Returns
  98. the HTTP response code.
  99. <P></P></DL>
  100. <P>This module also exports the HTTP::Status constants and procedures.
  101. These can be used when you check the response code from getprint(),
  102. <A HREF="#item_getstore"><CODE>getstore()</CODE></A> and mirror().  The constants are:</P>
  103. <PRE>
  104.    RC_CONTINUE
  105.    RC_SWITCHING_PROTOCOLS
  106.    RC_OK
  107.    RC_CREATED
  108.    RC_ACCEPTED
  109.    RC_NON_AUTHORITATIVE_INFORMATION
  110.    RC_NO_CONTENT
  111.    RC_RESET_CONTENT
  112.    RC_PARTIAL_CONTENT
  113.    RC_MULTIPLE_CHOICES
  114.    RC_MOVED_PERMANENTLY
  115.    RC_MOVED_TEMPORARILY
  116.    RC_SEE_OTHER
  117.    RC_NOT_MODIFIED
  118.    RC_USE_PROXY
  119.    RC_BAD_REQUEST
  120.    RC_UNAUTHORIZED
  121.    RC_PAYMENT_REQUIRED
  122.    RC_FORBIDDEN
  123.    RC_NOT_FOUND
  124.    RC_METHOD_NOT_ALLOWED
  125.    RC_NOT_ACCEPTABLE
  126.    RC_PROXY_AUTHENTICATION_REQUIRED
  127.    RC_REQUEST_TIMEOUT
  128.    RC_CONFLICT
  129.    RC_GONE
  130.    RC_LENGTH_REQUIRED
  131.    RC_PRECONDITION_FAILED
  132.    RC_REQUEST_ENTITY_TOO_LARGE
  133.    RC_REQUEST_URI_TOO_LARGE
  134.    RC_UNSUPPORTED_MEDIA_TYPE
  135.    RC_INTERNAL_SERVER_ERROR
  136.    RC_NOT_IMPLEMENTED
  137.    RC_BAD_GATEWAY
  138.    RC_SERVICE_UNAVAILABLE
  139.    RC_GATEWAY_TIMEOUT
  140.    RC_HTTP_VERSION_NOT_SUPPORTED</PRE>
  141. <P>The HTTP::Status classification functions are:</P>
  142. <DL>
  143. <DT><STRONG><A NAME="item_is_success"><CODE>is_success($rc)</CODE></A></STRONG><BR>
  144. <DD>
  145. True if response code indicated a successful request.
  146. <P></P>
  147. <DT><STRONG><A NAME="item_is_error"><CODE>is_error($rc)</CODE></A></STRONG><BR>
  148. <DD>
  149. True if response code indicated that an error occured.
  150. <P></P></DL>
  151. <P>The module will also export the LWP::UserAgent object as <CODE>$ua</CODE> if you
  152. ask for it explicitly.</P>
  153. <P>The user agent created by this module will identify itself as
  154. ``LWP::Simple/#.##'' (where ``#.##'' is the libwww-perl version number)
  155. and will initialize its proxy defaults from the environment (by
  156. calling $ua->env_proxy).</P>
  157. <P>
  158. <HR>
  159. <H1><A NAME="see also">SEE ALSO</A></H1>
  160. <P><A HREF="../../../site/lib/LWP.html">the LWP manpage</A>, <A HREF="../../../site/lib/LWP/UserAgent.html">the LWP::UserAgent manpage</A>, <A HREF="../../../site/lib/HTTP/Status.html">the HTTP::Status manpage</A>, <EM>lwp-request</EM>,
  161. <EM>lwp-mirror</EM></P>
  162. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  163. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  164. <STRONG><P CLASS=block> mirror - Procedural LWP interface</P></STRONG>
  165. </TD></TR>
  166. </TABLE>
  167.  
  168. </BODY>
  169.  
  170. </HTML>
  171.