.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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" ''
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LWP::Simple 3"
.TH LWP::Simple 3 "2022-01-21" "perl v5.26.3" "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 LWP::UserAgent module.
.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
\&\f(CW\*(C`LWP::Simple/#.##\*(C'\fR
and will initialize its proxy defaults from the environment (by
calling \f(CW\*(C`$ua\->env_proxy\*(C'\fR).
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
The following functions are provided (and exported) by this module:
.SS "get"
.IX Subsection "get"
.Vb 1
\& my $res = get($url);
.Ve
.PP
The \fBget()\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.
.PP
You will not be able to examine the response code or response headers
(like \f(CW\*(C`Content\-Type\*(C'\fR) 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).
.SS "head"
.IX Subsection "head"
.Vb 1
\& my $res = head($url);
.Ve
.PP
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)
.PP
Returns an empty list if it fails. In scalar context returns \s-1TRUE\s0 if
successful.
.SS "getprint"
.IX Subsection "getprint"
.Vb 1
\& my $code = getprint($url);
.Ve
.PP
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.
.SS "getstore"
.IX Subsection "getstore"
.Vb 1
\& my $code = getstore($url, $file)
.Ve
.PP
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.
.SS "mirror"
.IX Subsection "mirror"
.Vb 1
\& my $code = mirror($url, $file);
.Ve
.PP
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.
.SH "STATUS CONSTANTS"
.IX Header "STATUS CONSTANTS"
This module also exports the HTTP::Status constants and procedures.
You can use them when you check the response code from \*(L"getprint\*(R" in LWP::Simple,
\&\*(L"getstore\*(R" in LWP::Simple or \*(L"mirror\*(R" in LWP::Simple. 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
.SH "CLASSIFICATION FUNCTIONS"
.IX Header "CLASSIFICATION FUNCTIONS"
The HTTP::Status classification functions are:
.SS "is_success"
.IX Subsection "is_success"
.Vb 1
\& my $bool = is_success($rc);
.Ve
.PP
True if response code indicated a successful request.
.SS "is_error"
.IX Subsection "is_error"
.Vb 1
\& my $bool = is_error($rc)
.Ve
.PP
True if response code indicated that an error occurred.
.SH "CAVEAT"
.IX Header "CAVEAT"
Note that if you are using both LWP::Simple and the very popular \s-1CGI\s0
module, you may be importing a \f(CW\*(C`head\*(C'\fR function from each module,
producing a warning like \f(CW\*(C`Prototype mismatch: sub main::head ($) vs none\*(C'\fR.
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