.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Perldoc::Search 3pm"
.TH Perldoc::Search 3pm "2021-01-05" "perl v5.32.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"
Perldoc::Search \- Index and Search local Perl Documentation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    #######################################
\&    # Command line utility:
\&    #######################################
\&        # This is permanent and needs to be performed only once
\&        # (or if new documentation gets installed).
\&    $ perldig \-u 
\&
\&        # Then, search:
\&    $ perldig log AND apache AND connect
\&     1) CGI/Carp.pm                    2) CGI/Prototype.pm              
\&     3) DBI/Changes.pm                 4) DBI/Changes.pm                
\&    Enter number of choice:
\&      
\&    #######################################
\&    # API
\&    #######################################
\&    use  Perldoc::Search;
\&
\&    my $searcher = Perldoc::Search\->new();
\&
\&        # This is permanent and needs to be performed only once
\&        # (or if new documentation gets installed).
\&    $searcher\->update();
\&
\&        # Then, search:
\&    for my $hit ($searcher\->search("log AND apache")) {
\&        print $hit\->path(), "\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Perldoc::Search\*(C'\fR uses the swish-e engine to index the local Perl
documentation. It provides both the command line utility \f(CW\*(C`perldig\*(C'\fR
and an \s-1API\s0 to perform searches on the index. It uses \f(CW\*(C`SWISH::API::Common\*(C'\fR 
as the indexing and search engine.
.PP
Most likely, you will want the command line utility \f(CW\*(C`perldig\*(C'\fR, please
check the documentation that comes with it by calling
.PP
.Vb 1
\&    perldoc perldig
.Ve
.PP
In case you're interested in the \s-1API,\s0 read on.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """my $searcher = Perldoc::Search\-$<gt""\fBnew()\fR>" 4
.el .IP "\f(CWmy $searcher = Perldoc::Search\-$<gt\fR\fBnew()\fR>" 4
.IX Item "my $searcher = Perldoc::Search-$<gtnew()>"
Instantiates a searcher object. Usually takes no parameters.
.Sp
If you like to modify the searched directories or want to pass
different options to \f(CW\*(C`SWISH::API::Common\*(C'\fR, go ahead:
.Sp
.Vb 1
\&    use Config;
\&
\&    my $searcher = Perldoc::Search\->new(
\&        dirs => [$Config{installsitearch},
\&                 $Config{installsitelib},
\&                 $Config{installarchlib},
\&                 $Config{installprivlib},
\&                ],
\&        swish_options => {
\&            swish_adm_dir => "$ENV{HOME}/.perldig",
\&        }
\&    );
.Ve
.ie n .IP """$searcher\-""\fBupdate()\fR>" 4
.el .IP "\f(CW$searcher\-\fR\fBupdate()\fR>" 4
.IX Item "$searcher-update()>"
Update the index. This operation might take a couple of minutes.
.ie n .IP """my @hits = $searcher\-""search(""log \s-1AND\s0 apache"")>" 4
.el .IP "\f(CWmy @hits = $searcher\-\fRsearch(``log \s-1AND\s0 apache'')>" 4
.IX Item "my @hits = $searcher-search(log AND apache)>"
Perform a search on the index with the given query. Returns a list of
result objects.
.Sp
.Vb 5
\&         # Search documents containing
\&         # both "foo" and "bar"
\&     for my $hit ($swish\->search("foo AND bar")) {
\&         print $hit\->path(), "\en";
\&     }
.Ve
.SH "LEGALESE"
.IX Header "LEGALESE"
Copyright 2005 by Mike Schilli, all rights reserved.
This program is free software, you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
2005, Mike Schilli <cpan@perlmeister.com>