.\" 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 "Pod::Search_db 3pm"
.TH Pod::Search_db 3pm "2022-06-28" "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"
Tk::Pod::Search_db \- dirty OO wrapper for "perlindex"'s search functionality
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    ** THIS IS ALPHA SOFTWARE everything may and should change **
\&    **   stuff here is more a scratch pad than docomentation!  **
\&
\&    use Tk::Pod::Search_db;
\&    ...
\&    $idx = Tk::Pod::Search_db\->new?(INDEXDIR)?;
\&    ...
\&    @hits = $idx\->searchWords(WORD1,...); # @hits is a list of
\&                                             # relpath1,score1,...  where
\&                                             # score is increasing
\&    $prefix = $idx\->prefix();
\&
\&    @word = Tk::Pod::Search_db::normalize(STRING1,...);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Module to search Pod documentation.  Before you can use
the module one should create the indices with \f(CW\*(C`perlindex \-index\*(C'\fR.
.SH "MISSING"
.IX Header "MISSING"
Enable options like \-maxhits (currently = 15).  Solve \s-1PREFIX\s0
dependency.  Interface for \f(CW@stop\fR and \f(CW@unknown\fR also as methods
return lists for last searchWords call?
.PP
Lots more ...
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$idx = Tk::Pod::Search_db\->new(\s-1INDEXDIR\s0)" 4
.el .IP "\f(CW$idx\fR = Tk::Pod::Search_db\->new(\s-1INDEXDIR\s0)" 4
.IX Item "$idx = Tk::Pod::Search_db->new(INDEXDIR)"
Interface may change to support options like \-maxhits
.ie n .IP "$idx\->seachWords(\s-1WORD1\s0?,...?)" 4
.el .IP "\f(CW$idx\fR\->seachWords(\s-1WORD1\s0?,...?)" 4
.IX Item "$idx->seachWords(WORD1?,...?)"
search for \s-1WORD\s0(s). Return a list of
.Sp
.Vb 1
\&  relpath1, score1, relpath2, score2, ...
.Ve
.Sp
or empty list if no match is found.
.ie n .IP "$pathprefix = $idx\->\fBpathprefix()\fR" 4
.el .IP "\f(CW$pathprefix\fR = \f(CW$idx\fR\->\fBpathprefix()\fR" 4
.IX Item "$pathprefix = $idx->pathprefix()"
The return path prefix and \f(CW$relpath\fR give together the full path
name of the Pod documentation.
.Sp
.Vb 1
\&        $fullpath = $patchprefix . \*(Aq/\*(Aq . $relpath
.Ve
.Sp
\&\fBNote:\fR Should make it easy to use Tk::Pod::Search with perlindex but
index specific prefix handling is a mess up to know.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
tkpod, perlindex, perlpod, Tk::Pod::Search
.SH "AUTHORS"
.IX Header "AUTHORS"
Achim Bohnet  <\fIach@mpe.mpg.de\fR>
.PP
Most of the code here is borrowed from perlindex written by
Ulrich Pfeifer <\fIUlrich.Pfeifer@de.uu.net\fR>.
.PP
Current maintainer is Slaven Rezić <\fIslaven@rezic.de\fR>.
.PP
Copyright (c) 1997\-1998 Achim Bohnet. All rights reserved.  This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.