.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .\" ======================================================================== .\" .IX Title "LEI 1" .TH LEI 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 \- local email interface .SH SYNOPSIS .IX Header "SYNOPSIS" lei [OPTIONS] COMMAND .SH DESCRIPTION .IX Header "DESCRIPTION" lei is a command-line tool for importing and searching email, regardless of whether it is from a personal mailbox or a public-inbox. lei supports a local, writable store built on top of \&\fBpublic\-inbox\-v2\-format\fR\|(5) and \fBpublic\-inbox\-extindex\fR\|(1). \&\fBlei\-q\fR\|(1) provides an interface for querying messages across the lei store and read-only local and remote "externals" (inboxes and external indices). .PP Warning: lei is still in its early stages and may destroy mail. Be sure to have backups of destinations lei writes to. .PP Available in public-inbox 1.7.0+. .SH OPTIONS .IX Header "OPTIONS" .IP "\-c NAME=VALUE" 4 .IX Item "-c NAME=VALUE" Override configuration \f(CW\*(C`NAME\*(C'\fR to \f(CW\*(C`VALUE\*(C'\fR. .IP "\-C DIR" 4 .IX Item "-C DIR" Change current working directory to the specified directory before running the command. This option can be given before or after \&\f(CW\*(C`COMMAND\*(C'\fR and is accepted by all lei subcommands except \&\fBlei\-daemon\-kill\fR\|(1). .SH COMMANDS .IX Header "COMMANDS" Subcommands for initializing and managing local, writable storage: .IP \(bu 4 \&\fBlei\-init\fR\|(1) .IP \(bu 4 \&\fBlei\-import\fR\|(1) .IP \(bu 4 \&\fBlei\-tag\fR\|(1) .PP The following subcommands can be used to manage and inspect external locations: .IP \(bu 4 \&\fBlei\-add\-external\fR\|(1) .IP \(bu 4 \&\fBlei\-forget\-external\fR\|(1) .IP \(bu 4 \&\fBlei\-ls\-external\fR\|(1) .PP Subcommands related to searching and inspecting messages from the lei store and configured externals are .IP \(bu 4 \&\fBlei\-blob\fR\|(1) .IP \(bu 4 \&\fBlei\-config\fR\|(1) .IP \(bu 4 \&\fBlei\-edit\-search\fR\|(1) .IP \(bu 4 \&\fBlei\-forget\-search\fR\|(1) .IP \(bu 4 \&\fBlei\-lcat\fR\|(1) .IP \(bu 4 \&\fBlei\-ls\-search\fR\|(1) .IP \(bu 4 \&\fBlei\-p2q\fR\|(1) .IP \(bu 4 \&\fBlei\-q\fR\|(1) .IP \(bu 4 \&\fBlei\-rediff\fR\|(1) .IP \(bu 4 \&\fBlei\-up\fR\|(1) .PP Other subcommands include .IP \(bu 4 \&\fBlei\-add\-watch\fR\|(1) .IP \(bu 4 \&\fBlei\-config\fR\|(1) .IP \(bu 4 \&\fBlei\-convert\fR\|(1) .IP \(bu 4 \&\fBlei\-daemon\-kill\fR\|(1) .IP \(bu 4 \&\fBlei\-daemon\-pid\fR\|(1) .IP \(bu 4 \&\fBlei\-forget\-mail\-sync\fR\|(1) .IP \(bu 4 \&\fBlei\-mail\-diff\fR\|(1) .IP \(bu 4 \&\fBlei\-inspect\fR\|(1) .IP \(bu 4 \&\fBlei\-ls\-label\fR\|(1) .IP \(bu 4 \&\fBlei\-ls\-mail\-source\fR\|(1) .IP \(bu 4 \&\fBlei\-ls\-mail\-sync\fR\|(1) .IP \(bu 4 \&\fBlei\-ls\-watch\fR\|(1) .IP \(bu 4 \&\fBlei\-rm\-watch\fR\|(1) .SH FILES .IX Header "FILES" By default storage is located at \f(CW\*(C`$XDG_DATA_HOME/lei/store\*(C'\fR. The configuration for lei resides at \f(CW\*(C`$XDG_CONFIG_HOME/lei/config\*(C'\fR. .SH ERRORS .IX Header "ERRORS" Errors and dianostics for interactive commands are reported to stderr. Some errors for background tasks are emitted via \&\fBsyslog\fR\|(3) as \fBlei\-daemon\fR\|(8) for the top-level daemon, and \f(CW\*(C`lei/store\*(C'\fR for the \fBlei\-store\-format\fR\|(5) worker. .SH CONTACT .IX Header "CONTACT" Feedback welcome via plain-text mail to .PP The mail archives are hosted at and .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright all contributors .PP License: AGPL\-3.0+ .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBlei\-overview\fR\|(7), \fBlei\-daemon\fR\|(8)