Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man3 / WWW::Mechanize::Cookbook.3pm
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "WWW::Mechanize::Cookbook 3"
127 .TH WWW::Mechanize::Cookbook 3 "2007-08-27" "perl v5.8.7" "User Contributed Perl Documentation"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 WWW::Mechanize::Cookbook \- Recipes for using WWW::Mechanize
134 .SH "INTRODUCTION"
135 .IX Header "INTRODUCTION"
136 First, please note that many of these are possible just using
137 LWP::UserAgent.  Since \f(CW\*(C`WWW::Mechanize\*(C'\fR is a subclass of
138 LWP::UserAgent, whatever works on \f(CW\*(C`LWP::UserAgent\*(C'\fR should work
139 on \f(CW\*(C`WWW::Mechanize\*(C'\fR.  See the lwpcook man page included with
140 the libwww-perl distribution.
141 .SH "BASICS"
142 .IX Header "BASICS"
143 .SS "Launch the WWW::Mechanize browser"
144 .IX Subsection "Launch the WWW::Mechanize browser"
145 .Vb 1
146 \&    use WWW::Mechanize;
147 \&
148 \&    my $mech = WWW::Mechanize\->new( autocheck => 1 );
149 .Ve
150 .PP
151 The \f(CW\*(C`autocheck => 1\*(C'\fR tells Mechanize to die if any \s-1IO\s0 fails,
152 so you don't have to manually check.  It's easier that way.  If you
153 want to do your own error checking, leave it out.
154 .SS "Fetch a page"
155 .IX Subsection "Fetch a page"
156 .Vb 2
157 \&    $mech\->get( "http://search.cpan.org" );
158 \&    print $mech\->content;
159 .Ve
160 .PP
161 \&\f(CW\*(C`$mech\->content\*(C'\fR contains the raw \s-1HTML\s0 from the web page.  It
162 is not parsed or handled in any way, at least through the \f(CW\*(C`content\*(C'\fR
163 method.
164 .SS "Fetch a page into a file"
165 .IX Subsection "Fetch a page into a file"
166 Sometimes you want to dump your results directly into a file.  For
167 example, there's no reason to read a \s-1JPEG\s0 into memory if you're
168 only going to write it out immediately.  This can also help with
169 memory issues on large files.
170 .PP
171 .Vb 2
172 \&    $mech\->get( "http://www.cpan.org/src/stable.tar.gz",
173 \&                ":content_file" => "stable.tar.gz" );
174 .Ve
175 .SS "Fetch a password-protected page"
176 .IX Subsection "Fetch a password-protected page"
177 Generally, just call \f(CW\*(C`credentials\*(C'\fR before fetching the page.
178 .PP
179 .Vb 3
180 \&    $mech\->credentials( \*(Aqadmin\*(Aq => \*(Aqpassword\*(Aq );
181 \&    $mech\->get( \*(Aqhttp://10.11.12.13/password.html\*(Aq );
182 \&    print $mech\->content();
183 .Ve
184 .SH "LINKS"
185 .IX Header "LINKS"
186 .SS "Find all image links"
187 .IX Subsection "Find all image links"
188 Find all links that point to a \s-1JPEG\s0, \s-1GIF\s0 or \s-1PNG\s0.
189 .PP
190 .Vb 2
191 \&    my @links = $mech\->find_all_links(
192 \&        tag => "a", url_regex => qr/\e.(jpe?g|gif|png)$/i );
193 .Ve
194 .SS "Find all download links"
195 .IX Subsection "Find all download links"
196 Find all links that have the word \*(L"download\*(R" in them.
197 .PP
198 .Vb 2
199 \&    my @links = $mech\->find_all_links(
200 \&        tag => "a", text_regex => qr/\ebdownload\eb/i );
201 .Ve
202 .SH "APPLICATIONS"
203 .IX Header "APPLICATIONS"
204 .SS "Check all pages on a web site"
205 .IX Subsection "Check all pages on a web site"
206 Use Abe Timmerman's WWW::CheckSite
207 <http://search.cpan.org/dist/WWW\-CheckSite/>
208 .SH "AUTHORS"
209 .IX Header "AUTHORS"
210 Copyright 2005 Andy Lester \f(CW\*(C`<andy@petdance.com>\*(C'\fR
211 .PP
212 Later contributions by Peter Scott, Mark Stosberg and others.