.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Lucy::Simple 3pm"
.TH Lucy::Simple 3pm "2017-08-02" "perl v5.26.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"
Lucy::Simple \- Basic search engine.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
First, build an index of your documents.
.PP
.Vb 4
\&    my $index = Lucy::Simple\->new(
\&        path     => \*(Aq/path/to/index/\*(Aq
\&        language => \*(Aqen\*(Aq,
\&    );
\&
\&    while ( my ( $title, $content ) = each %source_docs ) {
\&        $index\->add_doc({
\&            title    => $title,
\&            content  => $content,
\&        });
\&    }
.Ve
.PP
Later, search the index.
.PP
.Vb 5
\&    my $total_hits = $index\->search( 
\&        query      => $query_string,
\&        offset     => 0,
\&        num_wanted => 10,
\&    );
\&
\&    print "Total hits: $total_hits\en";
\&    while ( my $hit = $index\->next ) {
\&        print "$hit\->{title}\en",
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lucy::Simple is a stripped-down interface for the Apache Lucy search
engine library.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 4
\&    my $lucy = Lucy::Simple\->new(
\&        path     => \*(Aq/path/to/index/\*(Aq,
\&        language => \*(Aqen\*(Aq,
\&    );
.Ve
.PP
Create a Lucy::Simple object, which can be used for both indexing and
searching.  Two hash-style parameters are required.
.IP "\(bu" 4
\&\fBpath\fR \- Where the index directory should be located.  If no index is found
at the specified location, one will be created.
.IP "\(bu" 4
\&\fBlanguage\fR \- The language of the documents in your collection, indicated 
by a two-letter \s-1ISO\s0 code.  12 languages are supported:
.Sp
.Vb 10
\&    |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
\&    | Language   | ISO code |
\&    |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
\&    | Danish     | da       |
\&    | Dutch      | nl       |
\&    | English    | en       |
\&    | Finnish    | fi       |
\&    | French     | fr       |
\&    | German     | de       |
\&    | Italian    | it       |
\&    | Norwegian  | no       |
\&    | Portuguese | pt       |
\&    | Spanish    | es       |
\&    | Swedish    | sv       |
\&    | Russian    | ru       |
\&    |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
.Ve
.SS "add_doc"
.IX Subsection "add_doc"
.Vb 5
\&    $lucy\->add_doc({
\&        location => $url,
\&        title    => $title,
\&        content  => $content,
\&    });
.Ve
.PP
Add a document to the index.  The document must be supplied as a hashref, with
field names as keys and content as values.
.SS "search"
.IX Subsection "search"
.Vb 5
\&    my $total_hits = $lucy\->search( 
\&        query      => $query_string,    # required
\&        offset     => 40,               # default 0
\&        num_wanted => 20,               # default 10
\&    );
.Ve
.PP
Search the index.  Returns the total number of documents which match the
query.  (This number is unlikely to match \f(CW\*(C`num_wanted\*(C'\fR.)
.IP "\(bu" 4
\&\fBquery\fR \- A search query string.
.IP "\(bu" 4
\&\fBoffset\fR \- The number of most-relevant hits to discard, typically used when
\&\*(L"paging\*(R" through hits N at a time.  Setting offset to 20 and num_wanted to 10
retrieves hits 21\-30, assuming that 30 hits can be found.
.IP "\(bu" 4
\&\fBnum_wanted\fR \- The number of hits you would like to see after \f(CW\*(C`offset\*(C'\fR is
taken into account.
.SH "BUGS"
.IX Header "BUGS"
Not thread-safe.