.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "LEI-INDEX 1"
.TH LEI-INDEX 1 1993-10-02 public-inbox.git "public-inbox user manual"
.\" 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
lei\-index \- index messages without importing them into lei/store
.SH SYNOPSIS
.IX Header "SYNOPSIS"
lei index [OPTIONS] FOLDER
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Similar to \fBlei\-import\fR\|(1), but does not store a copy of
messages into \f(CW\*(C`lei/store\*(C'\fR.
.PP
This command only makes sense for messages stored in Maildir
folders.  Other folder types may be supported in the future
(they can all be indexed, but the message isn\*(Aqt automatically
retrieved by \fBlei\-q\fR\|(1) or \fBlei\-lcat\fR\|(1)).
.PP
Combined with \fBlei\-q\fR\|(1), \f(CW\*(C`lei index\*(C'\fR allows Maildir users to
have similar functionality to \fBmairix\fR\|(1) by not duplicating
messages into \f(CW\*(C`lei/store\*(C'\fR.
.PP
Occasional invocations of \f(CW\*(C`lei\-refresh\-mail\-sync \-\-all=local\*(C'\fR
are recommended to keep indexed messages retrievable.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\-F MAIL_FORMAT" 4
.IX Item "-F MAIL_FORMAT"
.PD 0
.IP \-\-in\-format=MAIL_FORMAT 4
.IX Item "--in-format=MAIL_FORMAT"
.PD
There is currently no need for this option.  It will support \f(CW\*(C`mh\*(C'\fR,
eventually.  For now, the default (and only supported) format is
\&\f(CW\*(C`maildir\*(C'\fR.  When IMAP and NNTP support are fleshed out, those
formats will be inferred from their URLs.
.Sp
Default: \f(CW\*(C`maildir\*(C'\fR
.IP \-q 4
.IX Item "-q"
.PD 0
.IP \-\-quiet 4
.IX Item "--quiet"
.PD
Suppress feedback messages.
.SH CONTACT
.IX Header "CONTACT"
Feedback welcome via plain\-text mail to <mailto:meta@public\-inbox.org>
.PP
The mail archives are hosted at <https://public\-inbox.org/meta/> and
<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright all contributors <mailto:meta@public\-inbox.org>
.PP
License: AGPL\-3.0+ <https://www.gnu.org/licenses/agpl\-3.0.txt>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlei\-refresh\-mail\-sync\fR\|(1), \fBlei\-store\-format\fR\|(5), \fBlei\-import\fR\|(1)