📄 lwp::useragent.3
字号:
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05).\".\" Standard preamble:.\" ========================================================================.de Sh \" Subsection heading.br.if t .Sp.ne 5.PP\fB\\$1\fR.PP...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 (.Sh), 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::UserAgent 3".TH LWP::UserAgent 3 "2006-06-05" "perl v5.10.0" "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::UserAgent \- Web user agent class.SH "SYNOPSIS".IX Header "SYNOPSIS".Vb 1\& require LWP::UserAgent;\& \& my $ua = LWP::UserAgent\->new;\& $ua\->timeout(10);\& $ua\->env_proxy;\& \& my $response = $ua\->get(\*(Aqhttp://search.cpan.org/\*(Aq);\& \& if ($response\->is_success) {\& print $response\->content; # or whatever\& }\& else {\& die $response\->status_line;\& }.Ve.SH "DESCRIPTION".IX Header "DESCRIPTION"The \f(CW\*(C`LWP::UserAgent\*(C'\fR is a class implementing a web user agent.\&\f(CW\*(C`LWP::UserAgent\*(C'\fR objects can be used to dispatch web requests..PPIn normal use the application creates an \f(CW\*(C`LWP::UserAgent\*(C'\fR object, andthen configures it with values for timeouts, proxies, name, etc. Itthen creates an instance of \f(CW\*(C`HTTP::Request\*(C'\fR for the request thatneeds to be performed. This request is then passed to one of therequest method the UserAgent, which dispatches it using the relevantprotocol, and returns a \f(CW\*(C`HTTP::Response\*(C'\fR object. There areconvenience methods for sending the most common request types: \fIget()\fR,\&\fIhead()\fR and \fIpost()\fR. When using these methods then the creation of therequest object is hidden as shown in the synopsis above..PPThe basic approach of the library is to use \s-1HTTP\s0 style communicationfor all protocol schemes. This means that you will construct\&\f(CW\*(C`HTTP::Request\*(C'\fR objects and receive \f(CW\*(C`HTTP::Response\*(C'\fR objects evenfor non-HTTP resources like \fIgopher\fR and \fIftp\fR. In order to achieveeven more similarity to \s-1HTTP\s0 style communications, gopher menus andfile directories are converted to \s-1HTML\s0 documents..SH "CONSTRUCTOR METHODS".IX Header "CONSTRUCTOR METHODS"The following constructor methods are available:.ie n .IP "$ua\fR = LWP::UserAgent\->new( \f(CW%options )" 4.el .IP "\f(CW$ua\fR = LWP::UserAgent\->new( \f(CW%options\fR )" 4.IX Item "$ua = LWP::UserAgent->new( %options )"This method constructs a new \f(CW\*(C`LWP::UserAgent\*(C'\fR object and returns it.Key/value pair arguments may be provided to set up the initial state.The following options correspond to attribute methods described below:.Sp.Vb 10\& KEY DEFAULT\& \-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\& agent "libwww\-perl/#.##"\& from undef\& conn_cache undef\& cookie_jar undef\& default_headers HTTP::Headers\->new\& max_size undef\& max_redirect 7\& parse_head 1\& protocols_allowed undef\& protocols_forbidden undef\& requests_redirectable [\*(AqGET\*(Aq, \*(AqHEAD\*(Aq]\& timeout 180.Ve.SpThe following additional options are also accepted: If the\&\f(CW\*(C`env_proxy\*(C'\fR option is passed in with a \s-1TRUE\s0 value, then proxysettings are read from environment variables (see \fIenv_proxy()\fR methodbelow). If the \f(CW\*(C`keep_alive\*(C'\fR option is passed in, then a\&\f(CW\*(C`LWP::ConnCache\*(C'\fR is set up (see \fIconn_cache()\fR method below). The\&\f(CW\*(C`keep_alive\*(C'\fR value is passed on as the \f(CW\*(C`total_capacity\*(C'\fR for theconnection cache..ie n .IP "$ua\->clone" 4.el .IP "\f(CW$ua\fR\->clone" 4.IX Item "$ua->clone"Returns a copy of the LWP::UserAgent object..SH "ATTRIBUTES".IX Header "ATTRIBUTES"The settings of the configuration attributes modify the behaviour of the\&\f(CW\*(C`LWP::UserAgent\*(C'\fR when it dispatches requests. Most of these can alsobe initialized by options passed to the constructor method..PPThe following attributes methods are provided. The attribute value isleft unchanged if no argument is given. The return value from eachmethod is the old attribute value..ie n .IP "$ua\->agent" 4.el .IP "\f(CW$ua\fR\->agent" 4.IX Item "$ua->agent".PD 0.ie n .IP "$ua\fR\->agent( \f(CW$product_id )" 4.el .IP "\f(CW$ua\fR\->agent( \f(CW$product_id\fR )" 4.IX Item "$ua->agent( $product_id )".PDGet/set the product token that is used to identify the user agent onthe network. The agent value is sent as the \*(L"User-Agent\*(R" header inthe requests. The default is the string returned by the \fI_agent()\fRmethod (see below)..SpIf the \f(CW$product_id\fR ends with space then the \fI_agent()\fR string isappended to it..SpThe user agent string should be one or more simple product identifierswith an optional version number separated by the \*(L"/\*(R" character.Examples are:.Sp.Vb 4\& $ua\->agent(\*(AqCheckbot/0.4 \*(Aq . $ua\->_agent);\& $ua\->agent(\*(AqCheckbot/0.4 \*(Aq); # same as above\& $ua\->agent(\*(AqMozilla/5.0\*(Aq);\& $ua\->agent(""); # don\*(Aqt identify.Ve.ie n .IP "$ua\->_agent" 4.el .IP "\f(CW$ua\fR\->_agent" 4.IX Item "$ua->_agent"
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -