Edit File: LWP::Simple.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "LWP::Simple 3" .TH LWP::Simple 3 "2015-02-14" "perl v5.10.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" LWP::Simple \- simple procedural interface to LWP .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& perl \-MLWP::Simple \-e \*(Aqgetprint "http://www.sn.no"\*(Aq \& \& use LWP::Simple; \& $content = get("http://www.sn.no/"); \& die "Couldn\*(Aqt get it!" unless defined $content; \& \& if (mirror("http://www.sn.no/", "foo") == RC_NOT_MODIFIED) { \& ... \& } \& \& if (is_success(getprint("http://www.sn.no/"))) { \& ... \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is meant for people who want a simplified view of the libwww-perl library. It should also be suitable for one-liners. If you need more control or access to the header fields in the requests sent and responses received, then you should use the full object-oriented interface provided by the \f(CW\*(C`LWP::UserAgent\*(C'\fR module. .PP The following functions are provided (and exported) by this module: .IP "get($url)" 3 .IX Item "get($url)" The \fIget()\fR function will fetch the document identified by the given \s-1URL\s0 and return it. It returns \f(CW\*(C`undef\*(C'\fR if it fails. The \f(CW$url\fR argument can be either a string or a reference to a \s-1URI\s0 object. .Sp You will not be able to examine the response code or response headers (like 'Content\-Type') when you are accessing the web using this function. If you need that information you should use the full \s-1OO\s0 interface (see LWP::UserAgent). .IP "head($url)" 3 .IX Item "head($url)" Get document headers. Returns the following 5 values if successful: ($content_type, \f(CW$document_length\fR, \f(CW$modified_time\fR, \f(CW$expires\fR, \f(CW$server\fR) .Sp Returns an empty list if it fails. In scalar context returns \s-1TRUE\s0 if successful. .IP "getprint($url)" 3 .IX Item "getprint($url)" Get and print a document identified by a \s-1URL\s0. The document is printed to the selected default filehandle for output (normally \s-1STDOUT\s0) as data is received from the network. If the request fails, then the status code and message are printed on \s-1STDERR\s0. The return value is the \s-1HTTP\s0 response code. .ie n .IP "getstore($url, $file)" 3 .el .IP "getstore($url, \f(CW$file\fR)" 3 .IX Item "getstore($url, $file)" Gets a document identified by a \s-1URL\s0 and stores it in the file. The return value is the \s-1HTTP\s0 response code. .ie n .IP "mirror($url, $file)" 3 .el .IP "mirror($url, \f(CW$file\fR)" 3 .IX Item "mirror($url, $file)" Get and store a document identified by a \s-1URL\s0, using \&\fIIf-modified-since\fR, and checking the \fIContent-Length\fR. Returns the \s-1HTTP\s0 response code. .PP This module also exports the HTTP::Status constants and procedures. You can use them when you check the response code from \fIgetprint()\fR, \&\fIgetstore()\fR or \fImirror()\fR. The constants are: .PP .Vb 10 \& RC_CONTINUE \& RC_SWITCHING_PROTOCOLS \& RC_OK \& RC_CREATED \& RC_ACCEPTED \& RC_NON_AUTHORITATIVE_INFORMATION \& RC_NO_CONTENT \& RC_RESET_CONTENT \& RC_PARTIAL_CONTENT \& RC_MULTIPLE_CHOICES \& RC_MOVED_PERMANENTLY \& RC_MOVED_TEMPORARILY \& RC_SEE_OTHER \& RC_NOT_MODIFIED \& RC_USE_PROXY \& RC_BAD_REQUEST \& RC_UNAUTHORIZED \& RC_PAYMENT_REQUIRED \& RC_FORBIDDEN \& RC_NOT_FOUND \& RC_METHOD_NOT_ALLOWED \& RC_NOT_ACCEPTABLE \& RC_PROXY_AUTHENTICATION_REQUIRED \& RC_REQUEST_TIMEOUT \& RC_CONFLICT \& RC_GONE \& RC_LENGTH_REQUIRED \& RC_PRECONDITION_FAILED \& RC_REQUEST_ENTITY_TOO_LARGE \& RC_REQUEST_URI_TOO_LARGE \& RC_UNSUPPORTED_MEDIA_TYPE \& RC_INTERNAL_SERVER_ERROR \& RC_NOT_IMPLEMENTED \& RC_BAD_GATEWAY \& RC_SERVICE_UNAVAILABLE \& RC_GATEWAY_TIMEOUT \& RC_HTTP_VERSION_NOT_SUPPORTED .Ve .PP The HTTP::Status classification functions are: .IP "is_success($rc)" 3 .IX Item "is_success($rc)" True if response code indicated a successful request. .IP "is_error($rc)" 3 .IX Item "is_error($rc)" True if response code indicated that an error occurred. .PP The module will also export the LWP::UserAgent object as \f(CW$ua\fR if you ask for it explicitly. .PP The user agent created by this module will identify itself as \&\*(L"LWP::Simple/#.##\*(R" and will initialize its proxy defaults from the environment (by calling \f(CW$ua\fR\->env_proxy). .SH "CAVEAT" .IX Header "CAVEAT" Note that if you are using both LWP::Simple and the very popular \s-1CGI\s0.pm module, you may be importing a \f(CW\*(C`head\*(C'\fR function from each module, producing a warning like \*(L"Prototype mismatch: sub main::head ($) vs none\*(R". Get around this problem by just not importing LWP::Simple's \&\f(CW\*(C`head\*(C'\fR function, like so: .PP .Vb 2 \& use LWP::Simple qw(!head); \& use CGI qw(:standard); # then only CGI.pm defines a head() .Ve .PP Then if you do need LWP::Simple's \f(CW\*(C`head\*(C'\fR function, you can just call it as \f(CW\*(C`LWP::Simple::head($url)\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1LWP\s0, lwpcook, LWP::UserAgent, HTTP::Status, lwp-request, lwp-mirror
Back to File Manager