.\" Man page generated from reStructuredText.
.
.TH "ALOT" "1" "August 22, 2014" "0.3.6" "alot"
.SH NAME
alot \- mail user agent for the notmuch mail system
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
alot [\-r] [\-c CONFIGFILE] [\-n NOTMUCHCONFIGFILE] [\-C {1,16,256}] [\-p DB_PATH]
     [\-d {debug,info,warning,error}] [\-l LOGFILE] [\-\-version] [\-\-help]
     [command]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Options
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-r\fP,\fB  \-\-read\-only
open db in read only mode
.TP
.BI \-c\fP,\fB  \-\-config\fB= FILENAME
config file (default: ~/.config/alot/config)
.TP
.BI \-n\fP,\fB  \-\-notmuch\-config\fB= FILENAME
notmuch config (default: $NOTMUCH_CONFIG or ~/.notmuch\-config)
.TP
.BI \-C\fP,\fB  \-\-colour\-mode\fB= COLOUR
terminal colour mode (default: 256). Must be 1, 16 or 256
.TP
.BI \-p\fP,\fB  \-\-mailindex\-path\fB= PATH
path to notmuch index
.TP
.BI \-d\fP,\fB  \-\-debug\-level\fB= LEVEL
debug log (default: info). Must be one of debug,info,warning or error
.TP
.BI \-l\fP,\fB  \-\-logfile\fB= FILENAME
logfile (default: /dev/null)
.TP
.B \-\-version
Display version string and exit
.TP
.B \-\-help
Display  help and exit
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Subommands
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B search
start in a search buffer using the querystring provided as
parameter. See also the SEARCH SYNTAX section of notmuch(1)
and the output of \fIalot search \-\-help\fP\&.
.TP
.B compose
compose a new message
See the output of \fIalot compose \-\-help\fP for more info on parameters.
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Alot is a terminal\-based mail user agent for the notmuch mail system.
It features a modular and command prompt driven interface
to provide a full MUA experience as an alternative to the Emacs mode shipped
with notmuch.
.SH USAGE
.sp
The arrow keys, \fIpage\-up/down\fP, \fIj\fP, \fIk\fP and \fISpace\fP can be used to move the focus.
\fIEscape\fP cancels prompts and \fIEnter\fP selects. Hit \fI:\fP at any time and type in commands
to the prompt.
.sp
The interface shows one buffer at a time, you can use \fITab\fP and \fIShift\-Tab\fP to switch
between them, close the current buffer with \fId\fP and list them all with \fI;\fP\&.
.sp
The buffer type or \fImode\fP (displayed at the bottom left) determines which prompt commands
are available. Usage information on any command can be listed by typing \fIhelp YOURCOMMAND\fP
to the prompt; The key bindings for the current mode are listed upon pressing \fI?\fP\&.
.SH SEE ALSO
.sp
\fInotmuch(1)\fP
.SH AUTHOR
Patrick Totzke
.SH COPYRIGHT
2014, Patrick Totzke
.\" Generated by docutils manpage writer.
.