.\"
.TH NMZMAIL 1 "March 2006"
.SH NAME
nmzmail \- a tool to use the namazu2 search engine from within mutt
.SH SYNOPSIS
.B nmzmail
[\fI -b \fR] [\fI -r \fR] \fI-i \fR ...
.P
-or-
.P
.B nmzmail
[\fI -b \fR] [\fI -r \fR] [\fI -n \fR]
.br
.SH DESCRIPTION
.PP
\fBnmzmail\fP is a program that uses the namazu2 search engine
(http://www.namazu.org) from within the mail client mutt to search and index mail stored
in maildir folders. Based on the result of the namazu query, nmzmail
generates a maildir folder containing symbolic links to the mail matching the
query. A simple mutt macro makes it very easy to use nmzmail from within
mutt, and a simple crontab entry always keeps your mail indexed by
namazu.
.PP
Add the following macro to your muttrc file:
.PP
.nf
macro generic S "nmzmailc~/.nmzmail/result" "Search via nmzmail"
.fi
.PP
Run mutt and hit "S" and enter your query when prompted.
.PP
.PP
You can manually update your index periodically or via a cronjob with:
.PP
\fInmzmail -i \fR ...
.SH OPTIONS
.PP
.TP
.B \-i
This tells nmzmail to index your email.
.TP
.BI \-b " FILE"
Base. Where nmzmail builds its index. By default it is in $HOME/.nmzmail.
.TP
.BI \-r " FILE"
Result. Similar to -b, this lets you specify where the results are to be built. By
default it is within $HOME/.nmzmail.
.TP
.BI \-n " NUM"
Limit. When making a query, nmzmail can be used directly from the command line
instead of from within mutt. When the -n option is invoked, the
number of results returned from your query will be limited to whatever integer
you specify for NUM.
.SH SEE ALSO
.BR namazu (1), mutt (1)
.br
.SH AUTHOR
nmzmail was written by Johannes Hofmann
.PP
This manual page was written by Kevin Coyner ,
for the Debian project (but may be used by others).