summaryrefslogtreecommitdiffstats
path: root/README
blob: 189f803e9ba4f250e1979ee1deffebbe75b9b028 (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
    __
 __/  \__
/  \__/  \__                       .
\__/  \__/  \    , _ , _     ___   │   '
/  \__   \__/    │' `│  `┒ .'   `  │   │
\__/  \__/  \    │   │   │ |────'  │   │
   \__/  \__/    │       / `.___, /\__ /
      \__/                       
			                              ,-.  
																    \_/   
        terminal mail user agent   {|||)<
                                    / \
                                    `-'  
config
======

# $XDG_CONFIG_HOME/meli/config

testing
=======

# cargo test -p {melib, ui, meli} (-- --nocapture) (--test test_name)

profiling:
==========

# perf record -g target/debug/bin
# perf script | stackcollapse-perf | rust-unmangle | flamegraph > perf.svg

--------------------------------------------------------------------------


NAME
      meli - Meli Mail User Agent. Meli is the Greek word for honey.

STARTING WITH meli
      When launched for the first time, meli will search for its configuration directory ($XDG_CONFIG_HOME/meli/). If it doesn't exist, you will be asked if you want to create one along with a sample configuration. The sample configuration ($XDG_CONFIG_HOME/meli/config) includes comments with the basic settings required for setting up accounts allowing you to copy and edit right away.

      At any time, you can press `?` to show a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.

      The main visual navigation tool is the left-side sidebar. The menu's visibility can be toggled (default shortcut _) and can be moved with the X setting. [SCROLLING and OPENING, ACCOUNT / FOLDER SETTINGS]

      The view into each folder has 3 modes: plain, threaded and compact. Plain views each mail indvidually, threaded shows their thread relationship visually, and compact includes one entry per thread of emails.

    
         ^^      .-=-=-=-.  ^^
     ^^        (`-=-=-=-=-`)         ^^
             (`-=-=-=-=-=-=-`)  ^^         ^^
       ^^   (`-=-=-=-=-=-=-=-`)   ^^
           ( `-=-=-=-(@)-=-=-` )      ^^
           (`-=-=-=-=-=-=-=-=-`)  ^^
           (`-=-=-=-=-=-=-=-=-`)          ^^
           (`-=-=-=-=-=-=-=-=-`)
    ^^     (`-=-=-=-=-=-=-=-=-`)  ^^
       ^^   (`-=-=-=-=-=-=-=-`)          ^^
             (`-=-=-=-=-=-=-`)  ^^
      ^^       (`-=-=-=-=-`)
                `-=-=-=-=-`          ^^

SYNOPSIS
      meli

DESCRIPTION


ENVIRONMENT

      EDITOR        Specifies the editor to use

      MELI_CONFIG   Override the configuration file

FILES

      meli uses the following parts of the XDG standard:

        XDG_CONFIG_HOME defaults to ~/.config/
        XDG_CACHE_HOME  defaults to ~/.cache/

      meli can also be used with xdg-email(1)

      $XDG_CONFIG_HOME/meli/
          User configuration directory.

      $XDG_CONFIG_HOME/meli/config
          User configuration file.

      $XDG_CONFIG_HOME/meli/hooks/*
          ************************

      $XDG_CONFIG_HOME/meli/plugins/*
          ************************

      $XDG_CACHE_HOME/meli/*
          Internal cached data used by meli. This requires the `cache` flag set application-wide or in any specific account and/or folder.

      /tmp/meli/*
          Temporary files generated by meli.

NO WARRANTIES
       This  program  is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

SEE ALSO
      meli.conf(5), mailcap(5), maildir(5), mbox(5).