skquery.8   [plain text]


.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
.\"See Also:
.\"man mdoc.samples for a complete listing of options
.\"man mdoc for the short list of editing options
.\"/usr/share/misc/mdoc.template
.Dd 2/15/13               \" DATE 
.Dt skquery 8      \" Program name and manual section number 
.Os Darwin
.Sh NAME                 \" Section Header - required - don't modify 
.Nm skquery
.Nd Query Dovecot SearchKit full-text-search indexes
.Sh SYNOPSIS             \" Section Header - required - don't modify
.Nm
.Op Fl f
.Op Fl q Ar query
skindex-path [...]                 \" Arguments
.Sh DESCRIPTION          \" Section Header - required - don't modify
.Nm
searches each named
.Ar dovecot.skindex
or
.Ar dovecot.skindex-\fIn\fR
file, or each such file in the named directory arguments,
using the specified query.  The output is a list of document
identifiers which match the query (not mail UIDs), and the
relevancy score of each match.
.Pp                      \" Inserts a space
This program is for use with the
.Ar fts_sk
plugin to dovecot.
.Pp
The following options are available:
.Bl -tag -compact
.It Fl f
Use a "fuzzy" search.
.El                      \" Ends the list
.Sh SEE ALSO
.Xr doveadm 1 ,
.Xr skview 8 ,
the SearchKit documentation at developer.apple.com.