.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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" '' '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 (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "SWISH::API::Common 3pm" .TH SWISH::API::Common 3pm "2008-07-08" "perl v5.10.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" SWISH::API::Common \- SWISH Document Indexing Made Easy .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use SWISH::API::Common; \& \& my $swish = SWISH::API::Common\->new(); \& \& # Index all files in a directory and its subdirectories \& $swish\->index("/usr/local/share/doc"); \& \& # After indexing once (it\*(Aqs persistent), fire up as many \& # queries as you like: \& \& # Search documents containing both "swish" and "install" \& for my $hit ($swish\->search("swish AND install")) { \& print $hit\->path(), "\en"; \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`SWISH::API::Common\*(C'\fR offers an easy interface to the Swish index engine. While \s-1SWISH::API\s0 offers a complete \s-1API\s0, \f(CW\*(C`SWISH::API::Common\*(C'\fR focusses on ease of use. .PP \&\s-1THIS\s0 \s-1MODULE\s0 \s-1IS\s0 \s-1CURRENTLY\s0 \s-1UNDER\s0 \s-1DEVELOPMENT\s0. \s-1THE\s0 \s-1API\s0 \s-1MIGHT\s0 \s-1CHANGE\s0 \s-1AT\s0 \s-1ANY\s0 \&\s-1TIME\s0. .PP Currently, \f(CW\*(C`SWISH::API::Common\*(C'\fR just allows for indexing documents in a single directory and any of its subdirectories. Also, don't run \&\fIindex()\fR and \fIsearch()\fR in parallel yet. .SH "INSTALLATION" .IX Header "INSTALLATION" \&\f(CW\*(C`SWISH::API::Common\*(C'\fR requires \f(CW\*(C`SWISH::API\*(C'\fR and the swish engine to be installed. Please download the latest release from .PP .Vb 1 \& http://swish\-e.org/distribution/swish\-e\-2.4.3.tar.gz .Ve .PP and untar it, type .PP .Vb 3 \& ./configure \& make \& make install .Ve .PP and then install \s-1SWISH::API\s0 which is contained in the distribution: .PP .Vb 4 \& cd perl \& perl Makefile.PL \& make \& make install .Ve .Sh "\s-1METHODS\s0" .IX Subsection "METHODS" .ie n .IP "$sw\fR = SWISH::API::Common\->\fInew()" 4 .el .IP "\f(CW$sw\fR = SWISH::API::Common\->\fInew()\fR" 4 .IX Item "$sw = SWISH::API::Common->new()" Constructor. Takes many options, but the defaults are usually fine. .Sp Available options and their defaults: .Sp .Vb 2 \& # Where SWISH::API::Common stores index files etc. \& swish_adm_dir "$ENV{HOME}/.swish\-common" \& \& # The path to swish\-e, relative is OK \& swish_exe "swish\-e" \& \& # Swish index file \& swish_idx_file "$self\->{swish_adm_dir}/default.idx" \& \& # Swish configuration file \& swish_cnf_file "$self\->{swish_adm_dir}/default.cnf" \& \& # SWISH Stemming \& swish_fuzzy_indexing_mode => "Stemming_en" \& \& # Maximum amount of data (in bytes) extracted \& # from a single file \& file_len_max 100_000 \& \& # Preserve every indexed file\*(Aqs atime \& atime_preserve .Ve .ie n .IP "$sw\->index($dir, ...)" 4 .el .IP "\f(CW$sw\fR\->index($dir, ...)" 4 .IX Item "$sw->index($dir, ...)" Generate a new index of all text documents under directory \f(CW$dir\fR. One or more directories can be specified. .ie n .IP "$sw\->search(""foo \s-1AND\s0 bar"");" 4 .el .IP "\f(CW$sw\fR\->search(``foo \s-1AND\s0 bar'');" 4 .IX Item "$sw->search(foo AND bar);" Searches the index, using the given search expression. Returns a list hits, which can be asked for their path: .Sp .Vb 5 \& # Search documents containing \& # both "foo" and "bar" \& for my $hit ($swish\->search("foo AND bar")) { \& print $hit\->path(), "\en"; \& } .Ve .IP "index_remove" 4 .IX Item "index_remove" Permanently delete the current index. .SH "TODO List" .IX Header "TODO List" .Vb 3 \& * More than one index directory \& * Remove documents from index \& * Iterator for search hits .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