summaryrefslogtreecommitdiff
path: root/docs/source/usage/synopsis
blob: 5bfb8e88937186a9aa96540c98f3cd09b3e06f3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
.. code-block:: none

    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


Commands

    search
        start in a search buffer using the querystring provided as
        parameter. See the SEARCH SYNTAX section of notmuch(1).
    compose
        compose a new message