meli/README

104 lines
3.5 KiB
Plaintext

__
__/ \__
/ \__/ \__ .
\__/ \__/ \ , _ , _ ___ │ '
/ \__ \__/ │' `│ `┒ .' ` │ │
\__/ \__/ \ │ │ │ |────' │ │
\__/ \__/ │ / `.___, /\__ /
\__/
,-.
\_/
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).