diff options
| author | Manos Pitsidianakis <el13635@mail.ntua.gr> | 2019-07-04 07:38:25 +0300 |
|---|---|---|
| committer | Manos Pitsidianakis <el13635@mail.ntua.gr> | 2019-07-06 00:18:55 +0300 |
| commit | b920834117c971eca805efa7202cd638d37dd97f (patch) | |
| tree | 01a8f42d0ee176cd97fb0ebb368fcc79d9e316ad /README | |
| parent | 34054d46ea7a3d5543e3cceeb7b77d175e7ebbcc (diff) | |
Add manpage and strip README
Diffstat (limited to 'README')
| -rw-r--r-- | README | 83 |
1 files changed, 6 insertions, 77 deletions
@@ -6,11 +6,15 @@ \__/ \__/ \ │ │ │ |────' │ │ \__/ \__/ │ / `.___, /\__ / \__/ - ,-. - \_/ + ,-. + \_/ terminal mail user agent {|||)< / \ `-' + + +builds with debug print logs on stderr + config ====== @@ -26,78 +30,3 @@ 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). |