You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Manos Pitsidianakis 7463248da8
melib: change BackendOp::set_flag() signature
4 months ago
benches melib: remove BackendOpGenerator 8 months ago
debug_printer Fix warnings, lints, and 2018 errors 9 months ago
melib melib: change BackendOp::set_flag() signature 4 months ago
scripts scripts: remove auto-rustfmt from pre-commit hook 9 months ago
src Add embed pty support 4 months ago
testing Remove unused imports from testing/src/ 6 months ago
text_processing text_processing: add line_break method 4 months ago
ui melib: change BackendOp::set_flag() signature 4 months ago
.gdbinit add experimental gdb debug lib 9 months ago
.gitignore Revert "Show manuals with command line arguments" 5 months ago
COPYING mailbox: add threads 9 months ago
Cargo.lock add sqlite3 feature WIP 4 months ago
Cargo.toml Revert "Show manuals with command line arguments" 5 months ago
Makefile add Makefile for installation 6 months ago
README Add information about building on debian systems 5 months ago fixup manual 5 months ago
meli.1 ui: add mailcap support 4 months ago
meli.conf.5 Add search documentation 4 months ago
rustfmt.toml Run rustfmt 9 months ago
sample-config conf: add a light theme option 5 months ago


__/ \__
/ \__/ \__ .
\__/ \__/ \ , _ , _ ___ │ '
/ \__ \__/ │' `│ `┒ .' ` │ │
\__/ \__/ \ │ │ │ |────' │ │
\__/ \__/ │ / `.___, /\__ /
terminal mail user agent {|||)<
/ \

After installing meli, see meli(1) and meli.conf(5) for documentation.


meli requires rust 1.34 and rust's package manager, Cargo. Information on how
to get it on your system can be found here:

With Cargo available, the project can be built with

# make

The resulting binary will then be found under target/release/meli


# make install

to install the binary and man pages. This requires root, so I suggest you override the default paths and install it in your $HOME:

# make PREFIX=$HOME/.local install

See meli(1) and meli.conf(5) for documentation.

You can build and run meli with one command:

# cargo run --release

While the project is in early development, meli will only be developed for the
linux kernel and respected linux distributions. Support for more UNIX-like OSes
is on the roadmap.


Building with Debian's packaged cargo might require the installation of these
two packages: librust-openssl-sys-dev and librust-libdbus-sys-dev


Development builds can be built and/or run with

# cargo build
# cargo run

There is a debug/tracing log feature that can be enabled by using the flag
`--feature debug-tracing` after uncommenting the features in `Cargo.toml`. The logs
are printed in stderr, thus you can run meli with a redirection (i.e `2> log`)

Code style follows the default rustfmt profile.


meli by default looks for a configuration file in this location:
# $XDG_CONFIG_HOME/meli/config

You can run meli with arbitrary configuration files by setting the MELI_CONFIG
environment variable to their locations, ie:

# MELI_CONFIG=./test_config cargo run


How to run specific tests:

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


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