2. Usage

2.1. Commandline invocation

alot [-r] [-c CONFIGFILE] [-n NOTMUCHCONFIGFILE] [-C {1,16,256}] [-p DB_PATH]
     [-d {debug,info,warning,error}] [-l LOGFILE] [--version] [--help]
     [command]

Options

-r, --read-only
 open db in read only mode
-c, --config=FILENAME
 config file (default: ~/.config/alot/config)
-n, --notmuch-config=FILENAME
 notmuch config (default: $NOTMUCH_CONFIG or ~/.notmuch-config)
-C, --colour-mode=COLOUR
 terminal colour mode (default: 256). Must be 1, 16 or 256
-p, --mailindex-path=PATH
 path to notmuch index
-d, --debug-level=LEVEL
 debug log (default: info). Must be one of debug,info,warning or error
-l, --logfile=FILENAME
 logfile (default: /dev/null)
--version Display version string and exit
--help Display help and exit

Subommands

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 alot search –help.
compose
compose a new message See the output of alot compose –help for more info on parameters.

2.2. First Steps

The arrow keys, page-up/down, j, k and Space can be used to move the focus. Escape cancels prompts and Enter selects. Hit : at any time and type in commands to the prompt.

The interface shows one buffer at a time, you can use Tab and Shift-Tab to switch between them, close the current buffer with d and list them all with ;.

The buffer type or mode (displayed at the bottom left) determines which prompt commands are available. Usage information on any command can be listed by typing help YOURCOMMAND to the prompt; The key bindings for the current mode are listed upon pressing ?.

2.3. Commands

Alot interprets user input as command line strings given via its prompt or bound to keys in the config. Command lines are semi-colon separated command strings, each of which starts with a command name and possibly followed by arguments.

See the sections below for which commands are available in which (UI) mode. global commands are available independently of the mode.

Global Commands
globally available commands
Commands in search mode
commands available when showing thread search results
Commands in thread mode
commands available while displaying a thread
Commands in envelope mode
commands during message composition
Commands in bufferlist mode
commands while listing active buffers
Commands in taglist mode
commands while listing all tagstrings present in the notmuch database

Table Of Contents

Previous topic

1. Installation

Next topic

2.3.7.1. Global Commands

This Page