.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 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.
.\"
.\" 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 "Pod::Index::Search 3pm"
.TH Pod::Index::Search 3pm "2016-09-18" "perl v5.22.2" "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"
Pod::Index::Search \- Search for keywords in an indexed pod
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Pod::Index::Search;
\&
\&    my $q = Pod::Index::Search\->new;
\&
\&    my @results = $q\->search(\*(Aqgetprotobyname\*(Aq);
\&
\&    for my $r (@results) {
\&        printf "%s\et%s\en", $r\->podname, $r\->line;
\&        print $r\->pod;
\&    }
\&
\&    my @subtopics = $q\->subtopics(\*(Aqoperator\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module searches an index created by Pod::Index::Builder. Search results
are returned as Pod::Index::Entry objects.
.PP
It is also possible to search for subtopics for a keyword. For example, a
search for \*(L"operator\*(R" might return things like
.PP
.Vb 5
\&    operator, conditional
\&    operator, filetest
\&    operator, logical
\&    operator, precedence
\&    operator, relational
.Ve
.PP
The subtopics returned are simple strings.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
.Vb 1
\&    my $q = Pod::Index::Search\->new(%args);
.Ve
.Sp
Create a new search object. Possible arguments are:
.RS 4
.ie n .IP """fh""" 4
.el .IP "\f(CWfh\fR" 4
.IX Item "fh"
The filehandle of the index to use. If omitted, \f(CW\*(C`perlindex::DATA\*(C'\fR is used.
.ie n .IP """filename""" 4
.el .IP "\f(CWfilename\fR" 4
.IX Item "filename"
The filename of the index to use. Note that you can specify either \f(CW\*(C`fh\*(C'\fR or
filename, but not both.
.ie n .IP """filemap""" 4
.el .IP "\f(CWfilemap\fR" 4
.IX Item "filemap"
A subroutine reference that takes a podname and returns a filename. A simple
example might be:
.Sp
.Vb 4
\&    sub {
\&        my $podname = shift;
\&        return "/usr/lib/perl5/5.8.7/pod/$podname.pod";
\&    }
.Ve
.Sp
The podname is in colon-delimited Perl package syntax.
.Sp
The default \f(CW\*(C`filemap\*(C'\fR returns the first file in \f(CW@INC\fR that seems to have the 
proper documentation (either a .pod or .pm file).
.ie n .IP """nocase""" 4
.el .IP "\f(CWnocase\fR" 4
.IX Item "nocase"
If true, the search will be case-insensitive.
.RE
.RS 4
.RE
.IP "search($keyword)" 4
.IX Item "search($keyword)"
Do the actual search in the index.  Returns a list of search results, as
Pod::Index::Entry objects.
.ie n .IP "subtopics($keyword, %options)" 4
.el .IP "subtopics($keyword, \f(CW%options\fR)" 4
.IX Item "subtopics($keyword, %options)"
.Vb 2
\&    my @topics = $q\->subtopics(\*(Aqoperator\*(Aq);
\&    my @topics = $q\->subtopics(\*(Aqoperator\*(Aq, deep => 1);
.Ve
.Sp
Lists the subtopics for a given keyword. If \f(CW\*(C`deep\*(C'\fR is given, it includes
all subtopics; otherwise, only the first level of subtopics is included.
.SH "VERSION"
.IX Header "VERSION"
0.14
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Index::Entry, Pod::Index::Builder
.SH "AUTHOR"
.IX Header "AUTHOR"
Ivan Tubert-Brohman <itub@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same terms as
Perl itself.