.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "WWW::OpenSearch 3pm"
.TH WWW::OpenSearch 3pm "2022-07-02" "perl v5.34.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"
WWW::OpenSearch \- Search A9 OpenSearch compatible engines
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use WWW::OpenSearch;
\&    
\&    my $url = "http://bulkfeeds.net/opensearch.xml";
\&    my $engine = WWW::OpenSearch\->new($url);
\&    
\&    my $name = $engine\->description\->ShortName;
\&    my $tags = $engine\->description\->Tags;
\&    
\&    # Perform search for "iPod"
\&    my $response = $engine\->search("iPod");
\&    for my $item (@{$response\->feed\->items}) {
\&        print $item\->{description};
\&    }
\&    
\&    # Retrieve the next page of results
\&    my $next_page = $response\->next_page;
\&    for my $item (@{$next_page\->feed\->items}) {
\&        print $item\->{description};
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
WWW::OpenSearch is a module to search A9's OpenSearch compatible search
engines. See http://opensearch.a9.com/ for details.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "new( $url )"
.el .SS "new( \f(CW$url\fP )"
.IX Subsection "new( $url )"
Constructs a new instance of WWW::OpenSearch using the given
\&\s-1URL\s0 as the location of the engine's OpenSearch Description
document (retrievable via the description_url accessor).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "fetch_description( [ $url ] )"
.el .SS "fetch_description( [ \f(CW$url\fP ] )"
.IX Subsection "fetch_description( [ $url ] )"
Fetches the OpenSearch Descsription found either at the given \s-1URL\s0
or at the \s-1URL\s0 specified by the description_url accessor. Fetched
description may be accessed via the description accessor.
.ie n .SS "search( $query [, \e%params] )"
.el .SS "search( \f(CW$query\fP [, \e%params] )"
.IX Subsection "search( $query [, %params] )"
Searches the engine for the given query using the given 
search parameters. Valid search parameters include:
.IP "\(bu" 4
startPage
.IP "\(bu" 4
totalResults
.IP "\(bu" 4
startIndex
.IP "\(bu" 4
itemsPerPage
.PP
See http://opensearch.a9.com/spec/1.1/response/#elements for details.
.ie n .SS "do_search( $url [, $method] )"
.el .SS "do_search( \f(CW$url\fP [, \f(CW$method\fP] )"
.IX Subsection "do_search( $url [, $method] )"
Performs a request for the given \s-1URL\s0 and returns a
WWW::OpenSearch::Response object. Method defaults to '\s-1GET\s0'.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "description_url( [$description_url] )"
.IX Subsection "description_url( [$description_url] )"
.SS "agent( [$agent] )"
.IX Subsection "agent( [$agent] )"
.SS "description( [$description] )"
.IX Subsection "description( [$description] )"
.SH "AUTHOR"
.IX Header "AUTHOR"
Brian Cassidy <bricas@cpan.org>
.PP
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2005\-2013 by Tatsuhiko Miyagawa and Brian Cassidy
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.