.\" Man page generated from reStructuredText.
.
.TH "ALOT" "1" "July 10, 2020" "0.9.1" "alot"
.SH NAME
alot \- Terminal MUA using notmuch mail
.
.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
.sp
alot [options …] [subcommand]
.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 OPTIONS
.INDENT 0.0
.TP
.B \-r\fP,\fB  \-\-read\-only
open notmuch database in read\-only mode
.TP
.BI \-c \ FILENAME\fR,\fB \ \-\-config\fB= FILENAME
configuration file (default: ~/.config/alot/config)
.TP
.BI \-n \ FILENAME\fR,\fB \ \-\-notmuch\-config\fB= FILENAME
notmuch configuration file (default: $NOTMUCH_CONFIG
or ~/.notmuch\-config)
.TP
.BI \-C \ COLOURS\fR,\fB \ \-\-colour\-mode\fB= COLOURS
number of colours to use on the terminal; must be 1, 16 or 256
(default: configuration option \fIcolourmode\fP or 256)
.TP
.BI \-p \ PATH\fR,\fB \ \-\-mailindex\-path\fB= PATH
path to notmuch index
.TP
.BI \-d \ LEVEL\fR,\fB \ \-\-debug\-level\fB= LEVEL
debug level; must be one of debug, info, warning or error
(default: info)
.TP
.BI \-l \ FILENAME\fR,\fB \ \-\-logfile\fB= FILENAME
log file (default: /dev/null)
.TP
.B \-h\fP,\fB  \-\-help
display help and exit
.TP
.B \-v\fP,\fB  \-\-version
output version information and exit
.UNINDENT
.SH COMMANDS
.INDENT 0.0
.TP
.B search
start in a search buffer using the query string provided as
parameter (see \fBnotmuch\-search\-terms(7)\fP)
.TP
.B compose
compose a new message
.TP
.B bufferlist
start with only a bufferlist buffer open
.TP
.B taglist
start with only a taglist buffer open
.TP
.B namedqueries
start with list of named queries
.TP
.B pyshell
start the interactive python shell inside alot
.UNINDENT
.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 keybindings for the current mode are listed upon pressing \fI?\fP\&.
.SH UNIX SIGNALS
.INDENT 0.0
.TP
.B SIGUSR1
Refreshes the current buffer.
.TP
.B SIGINT
Shuts down the user interface.
.UNINDENT
.SH SEE ALSO
.sp
\fBnotmuch(1)\fP
.SH AUTHOR
Patrick Totzke
.SH COPYRIGHT
Copyright (C) 2012-20 Patrick Totzke
.\" Generated by docutils manpage writer.
.