2019-07-04 07:38:25 +03:00
. \" meli - meli.1
2019-07-29 20:23:22 +03:00
. \"
2019-07-04 07:38:25 +03:00
. \" Copyright 2017-2019 Manos Pitsidianakis
2019-07-29 20:23:22 +03:00
. \"
2019-07-04 07:38:25 +03:00
. \" This file is part of meli.
2019-07-29 20:23:22 +03:00
. \"
2019-07-04 07:38:25 +03:00
. \" meli is free software: you can redistribute it and/or modify
. \" it under the terms of the GNU General Public License as published by
. \" the Free Software Foundation, either version 3 of the License, or
. \" (at your option) any later version.
2019-07-29 20:23:22 +03:00
. \"
2019-07-04 07:38:25 +03:00
. \" meli 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.
2019-07-29 20:23:22 +03:00
. \"
2019-07-04 07:38:25 +03:00
. \" You should have received a copy of the GNU General Public License
. \" along with meli. If not, see <http://www.gnu.org/licenses/>.
2019-07-29 20:23:22 +03:00
. \"
2022-09-04 18:28:36 +03:00
.de Shortcut
.Sm
.Aq \\ $1
\
.Po
.Em shortcuts.\\$2\&. Ns
.Em \\ $3
.Pc
.Sm
. .
.de ShortcutPeriod
.Aq \\ $1
.Po
.Em shortcuts.\\$2\&. Ns
.Em \\ $3
.Pc Ns
. .
.de Command
.Bd -ragged
.Cm \\ $*
.Ed
.sp
. .
2019-07-29 20:23:22 +03:00
.Dd July 29 , 2019
2019-07-04 07:38:25 +03:00
.Dt MELI 1
2019-11-22 13:12:44 +02:00
.Os
2019-07-04 07:38:25 +03:00
.Sh NAME
2019-07-29 20:23:22 +03:00
.Nm meli
2019-11-22 13:12:44 +02:00
.Nd Meli Mail User Agent. meli is the Greek word for honey
2019-07-04 07:38:25 +03:00
.Sh SYNOPSIS
2019-11-11 22:20:16 +02:00
.Nm
2019-07-29 20:23:22 +03:00
.Op Fl -help | h
2019-08-01 12:44:30 +03:00
.Op Fl -version | v
2019-07-29 20:23:22 +03:00
.Op Fl -config Ar path
.Bl -tag -width flag -offset indent
2020-01-28 18:43:14 +02:00
.It Fl -help | h
2019-07-29 20:23:22 +03:00
Show help message and exit.
2020-01-28 18:43:14 +02:00
.It Fl -version | v
2019-08-01 12:44:30 +03:00
Show version and exit.
2020-06-07 18:02:20 +03:00
.It Fl -config Ar path
Start meli with given configuration file.
.It Cm create-config Op Ar path
2019-07-29 20:23:22 +03:00
Create configuration file in
.Pa path
if given, or at
2020-01-28 00:32:40 +02:00
.Pa $XDG_CONFIG_HOME/meli/config.toml
2020-06-07 18:02:20 +03:00
.It Cm test-config Op Ar path
2019-11-22 18:43:24 +02:00
Test a configuration file for syntax issues or missing options.
2020-06-07 18:02:20 +03:00
.It Cm man Op Ar page
2022-09-04 18:28:36 +03:00
Print documentation page and exit (Piping to a pager is recommended).
2020-06-07 18:02:20 +03:00
.It Cm print-default-theme
2020-01-28 00:32:40 +02:00
Print default theme keys and values in TOML syntax, to be used as a blueprint.
2020-06-07 18:02:20 +03:00
.It Cm print-loaded-themes
2020-01-28 00:32:40 +02:00
Print all loaded themes in TOML syntax.
2021-09-08 22:09:32 +03:00
.It Cm compiled-with
Print compile time feature flags of this binary.
2020-06-10 18:06:28 +03:00
.It Cm view
View mail from input file.
2019-07-29 20:23:22 +03:00
.El
2020-01-28 18:43:14 +02:00
.Sh DESCRIPTION
.Nm
is a terminal mail client aiming for extensive and user-frendly configurability.
.Bd -literal
2020-07-15 20:20:37 +03:00
^^ .-=-=-=-. ^^
^^ (`-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-`) ^^ ^^
^^ (`-=-=-=-=-=-=-=-`) ^^
( `-=-=-=-(@)-=-=-` ) ^^
(`-=-=-=-=-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-=-=-`)
^^ (`-=-=-=-=-=-=-=-=-`) ^^
^^ (`-=-=-=-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-`) ^^
^^ (`-=-=-=-=-`)
`-=-=-=-=-` ^^
2020-01-28 18:43:14 +02:00
.Ed
2019-07-04 07:38:25 +03:00
.Sh STARTING WITH meli
2019-11-22 13:12:44 +02:00
When launched for the first time,
2019-11-11 22:20:16 +02:00
.Nm
will search for its configuration directory,
2019-07-29 20:23:22 +03:00
.Pa $XDG_CONFIG_HOME/meli/ Ns
2020-01-28 18:43:14 +02:00
\& .
2020-07-15 20:20:37 +03:00
If it doesn't exist, you will be asked if you want to create one and presented with a sample configuration file
.Pq Pa $XDG_CONFIG_HOME/meli/config.toml
that includes the basic settings required for setting up accounts allowing you to copy and edit right away.
2020-01-28 18:43:14 +02:00
See
2019-09-16 14:07:38 +03:00
.Xr meli.conf 5
for the available configuration options.
2019-07-04 07:38:25 +03:00
.Pp
2019-11-22 13:12:44 +02:00
At any time, you may press
2022-09-04 18:28:36 +03:00
.Shortcut \& ? general toggle_help
2020-07-15 20:20:37 +03:00
for a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
2019-07-04 07:38:25 +03:00
.Pp
2020-07-15 20:20:37 +03:00
The main visual navigation tool, the left-side sidebar may be toggled with
2022-09-04 18:28:36 +03:00
.ShortcutPeriod ` listing toggle_menu_visibility
\& .
2019-07-04 07:38:25 +03:00
.Pp
2020-07-15 20:20:37 +03:00
Each mailbox may be viewed in 4 modes:
Plain views each mail individually, Threaded shows their thread relationship visually, Conversations collapses each thread of emails into a single entry, Compact shows one row per thread.
2019-10-06 10:58:47 +03:00
.Pp
2020-07-15 20:20:37 +03:00
If you're using a light color palette in your terminal, you should set
2019-10-06 10:58:47 +03:00
.Em theme = "light"
in the
.Em terminal
section of your configuration.
2020-01-28 18:43:14 +02:00
See
.Xr meli-themes 5
for complete documentation on user themes.
2022-09-04 18:28:36 +03:00
.Pp
See
.Xr meli 7
for a more detailed tutorial on using
.Nm Ns
\& .
2019-11-11 22:20:16 +02:00
.Sh VIEWING MAIL
Open attachments by typing their index in the attachments list and then
2022-09-04 18:28:36 +03:00
.ShortcutPeriod a envelope_view open_attachment
\& .
2019-11-11 22:20:16 +02:00
.Nm
2020-07-15 20:20:37 +03:00
will attempt to open text inside its pager, and other content via
2019-11-11 22:20:16 +02:00
.Cm xdg-open Ns
2020-01-28 18:43:14 +02:00
\& .
Press
2022-09-04 18:28:36 +03:00
.Shortcut m envelope_view open_mailcap
2020-01-28 18:43:14 +02:00
instead to use the mailcap entry for the MIME type of the attachment, if any.
See
2019-11-11 22:20:16 +02:00
.Sx FILES
2019-11-22 13:12:44 +02:00
for the location of the mailcap files and
2019-11-11 22:20:16 +02:00
.Xr mailcap 5
for their syntax.
2020-06-15 01:07:50 +03:00
You can save individual attachments with the
2022-09-04 18:28:36 +03:00
.Command save-attachment Ar INDEX Ar path-to-file
command.
2020-06-15 01:07:50 +03:00
.Ar INDEX
is the attachment's index in the listing.
2022-09-04 18:28:36 +03:00
If the path provided is a directory, the attachment is saved with its filename set to the filename in the attachment, if any.
If the 0th index is provided, the entire message is saved.
2020-06-15 01:07:50 +03:00
If the path provided is a directory, the message is saved as an eml file with its filename set to the messages message-id.
2019-11-27 17:40:00 +02:00
.Sh SEARCH
2020-07-15 20:20:37 +03:00
Each e-mail storage backend has a default search method assigned.
2019-11-27 17:40:00 +02:00
.Em IMAP
uses the SEARCH command,
.Em notmuch
uses libnotmuch and
.Em Maildir/mbox
2020-07-15 20:20:37 +03:00
performs a slow linear search.
2020-07-16 23:57:00 +03:00
It is advised to use a search backend on
2019-11-27 17:40:00 +02:00
.Em Maildir/mbox
accounts.
.Nm Ns
2020-07-15 20:20:37 +03:00
, if built with sqlite3, includes the ability to perform full text search on the following fields:
.Em From ,
.Em To ,
.Em Cc ,
.Em Bcc ,
.Em In-Reply-To ,
.Em References ,
.Em Subject
and
.Em Date .
2020-01-28 18:43:14 +02:00
The message body (in plain text human readable form) and the flags can also be queried.
To enable sqlite3 indexing for an account set
2020-07-16 23:57:00 +03:00
.Em search_backend
2019-11-27 17:40:00 +02:00
to
.Em sqlite3
2022-09-04 18:28:36 +03:00
in the configuration file and to create the sqlite3 index issue command:
.Command index Ar ACCOUNT_NAME Ns
2019-11-27 17:40:00 +02:00
To search in the message body type your keywords without any special formatting.
To search in specific fields, prepend your search keyword with "field:" like so:
.Pp
.D1 subject:helloooo or subject:\&"call for help\&" or \& "You remind me today of a small, Mexican chihuahua.\&"
.Pp
.D1 not ((from:unrealistic and (to:complex or not "query" )) or flags:seen,draft)
.Pp
2021-01-13 20:59:23 +02:00
.D1 alladdresses:mailing@example.com and cc:me@example.com
2019-11-27 17:40:00 +02:00
.Pp
Boolean operators are
.Em or Ns
,
.Em and
and
.Em not
.Po
alias:
.Em \& !
.Pc
2020-01-28 18:43:14 +02:00
String keywords with spaces must be quoted.
Quotes should always be escaped.
2019-11-27 17:40:00 +02:00
.sp
2019-12-13 00:13:54 +02:00
.Sy Important Notice about IMAP/JMAP
2019-11-27 17:40:00 +02:00
.sp
2019-12-13 00:13:54 +02:00
To prevent downloading all your messages from your IMAP/JMAP server, don't set
2020-07-16 23:57:00 +03:00
.Em search_backend
2019-11-27 17:40:00 +02:00
to
.Em sqlite3 Ns
\& .
.Nm
2020-01-28 18:43:14 +02:00
will relay your queries to the IMAP server.
Expect a delay between query and response.
Sqlite3 on the contrary at reasonable mailbox sizes should have a non noticable delay.
2020-07-15 20:20:37 +03:00
.Ss QUERY ABNF SYNTAX
.Bl -bullet
.It
.Li query = \& "(\&" query \& ")\&" | from | to | cc | bcc | alladdresses | subject | flags | has_attachments | query \& "or\&" query | query \& "and\&" query | not query
.It
.Li not = \& "not\&" | \& "!\&"
.It
.Li quoted = ALPHA / SP *(ALPHA / DIGIT / SP)
.It
.Li term = ALPHA *(ALPHA / DIGIT) | DQUOTE quoted DQUOTE
.It
.Li tagname = term
.It
.Li flagval = \& "passed\&" | \& "replied\&" | \& "seen\&" | \& "read\&" | \& "junk\&" | \& "trash\&" | \& "trashed\&" | \& "draft\&" | \& "flagged\&" | tagname
.It
.Li flagterm = flagval | flagval \& ",\&" flagterm
.It
.Li from = \& "from:\&" term
.It
.Li to = \& "to:\&" term
.It
.Li cc = \& "cc:\&" term
.It
.Li bcc = \& "bcc:\&" term
.It
.Li alladdresses = \& "alladdresses:\&" term
.It
.Li subject = \& "subject:\&" term
.It
.Li flags = \& "flags:\&" flag | \& "tags:\&" flag | \& "is:\&" flag
.El
2019-12-08 11:26:15 +02:00
.Sh TAGS
.Nm
2020-01-28 18:43:14 +02:00
supports tagging in notmuch and IMAP/JMAP backends.
Tags can be searched with the `tags:` or `flags:` prefix in a search query, and can be modified by
2022-09-04 18:28:36 +03:00
.Command tag add TAG
2019-12-08 11:26:15 +02:00
and
2022-09-04 18:28:36 +03:00
.Command tag remove TAG
2019-12-08 11:26:15 +02:00
(see
.Xr meli.conf 5 TAGS Ns
, settings
.Ic colors
and
.Ic ignore_tags
2022-09-06 21:41:26 +03:00
for how to set tag colors and tag visibility)
2019-09-27 12:48:48 +03:00
.Sh COMPOSING
2020-07-15 20:20:37 +03:00
.Ss Opening the message Composer tab
To create a new mail message, press
2022-09-04 18:28:36 +03:00
.Shortcut m listing new_mail
while viewing a mailbox.
2020-01-28 18:43:14 +02:00
To reply to a mail, press
2022-09-04 18:28:36 +03:00
.ShortcutPeriod R envelope_view reply
\& .
2020-07-15 20:20:37 +03:00
Both these actions open the mail composer view in a new tab.
.Ss Editing text
.Bl -bullet -compact
.It
Edit the header fields by selecting with the arrow keys and pressing
2022-09-04 18:28:36 +03:00
.Shortcut Enter general focus_in_text_field
2019-09-27 12:48:48 +03:00
to enter
2020-07-15 20:20:37 +03:00
.Em INSERT
mode and
.Cm Esc
key to exit.
.It
2020-01-28 18:43:14 +02:00
At any time you may press
2022-09-04 18:28:36 +03:00
.Shortcut e composing edit_mail Ns
to launch your editor (see
2019-11-27 01:43:03 +02:00
.Xr meli.conf 5 COMPOSING Ns
, setting
2020-07-08 12:09:37 +03:00
.Ic editor_command
2020-01-28 18:43:14 +02:00
for how to select which editor to launch).
2020-07-15 20:20:37 +03:00
.It
Your editor can be used in
.Nm Ns
\& 's embed terminal emulator by setting
.Ic embed
to
.Em true
2022-09-04 18:28:36 +03:00
in your composing settings
.Po
You can return to
.Nm
at any time by pressing
.Aq Ctrl-Z
.Pc
2020-07-15 20:20:37 +03:00
.It
When launched, your editor captures all input until it exits or stops.
.It
To stop your editor and return to
.Nm
2022-09-04 18:28:36 +03:00
press
.Aq Ctrl-z
and to resume editing press the
2020-07-15 20:20:37 +03:00
.Ic edit_mail
2022-09-04 18:28:36 +03:00
command again.
2020-07-15 20:20:37 +03:00
.El
.Ss Attachments
2020-01-28 18:43:14 +02:00
Attachments may be handled with the
2020-07-15 20:20:37 +03:00
.Cm add-attachment Ns
2019-09-27 12:48:48 +03:00
,
2020-07-15 20:20:37 +03:00
.Cm remove-attachment
2020-01-28 18:43:14 +02:00
commands (see below).
2020-07-15 20:20:37 +03:00
.Ss Sending
2020-01-28 18:43:14 +02:00
Finally, pressing
2022-09-04 18:28:36 +03:00
.Shortcut s composing send_mail
will send your message according to your settings
2020-07-15 15:19:27 +03:00
.Po
see
2019-11-22 13:12:44 +02:00
.Xr meli.conf 5 COMPOSING Ns
2022-09-04 18:28:36 +03:00
, setting name
2020-07-15 15:19:27 +03:00
.Ic send_mail
.Pc Ns
\& .
2020-02-26 10:54:10 +02:00
With no Draft or Sent mailbox,
2019-11-22 13:12:44 +02:00
.Nm
2020-02-26 10:54:10 +02:00
tries first saving mail in your INBOX and then at any other mailbox.
2020-01-28 18:43:14 +02:00
On complete failure to save your draft or sent message it will be saved in your
2019-09-27 12:48:48 +03:00
.Em tmp
directory instead and you will be notified of its location.
2020-07-15 20:20:37 +03:00
.Ss Drafts
To save your draft without sending it, issue
2020-07-25 13:08:36 +03:00
.Em COMMAND
2020-07-15 20:20:37 +03:00
.Cm close
and select 'save as draft'.
2020-01-28 18:43:14 +02:00
.sp
2020-07-15 20:20:37 +03:00
To open a draft for further editing, select your draft in the mail listing and press
.Ic edit_mail Ns
\& .
2019-11-27 17:40:00 +02:00
.Sh CONTACTS
.Nm
supports two kinds of contact backends:
2020-01-28 18:43:14 +02:00
.sp
2019-11-27 17:40:00 +02:00
.Bl -enum -compact -offset indent
.It
an internal format that gets saved under
.Pa $XDG_DATA_HOME/meli/account_name/addressbook Ns
2019-11-22 13:12:44 +02:00
\& .
2019-11-27 17:40:00 +02:00
.It
vCard files (v3, v4) through the
.Ic vcard_folder
2020-01-28 18:43:14 +02:00
option in the account section.
The path defined as
2019-11-27 17:40:00 +02:00
.Ic vcard_folder
2020-01-28 18:43:14 +02:00
can hold multiple vCards per file.
They are loaded read only.
2019-11-27 17:40:00 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
2019-11-27 17:40:00 +02:00
See
.Xr meli.conf 5 ACCOUNTS
for the complete account configuration values.
2020-07-15 20:20:37 +03:00
.Sh MODES
.Bl -tag -compact -width 8 n
.It NORMAL
is the default mode
2020-07-25 13:08:36 +03:00
.It COMMAND
2020-07-15 20:20:37 +03:00
commands are issued in
2020-07-25 13:08:36 +03:00
.Em COMMAND
2020-10-14 20:21:22 +03:00
mode, by default started with
2022-09-04 18:28:36 +03:00
.Shortcut \& : general enter_command_mode
2020-10-14 20:21:22 +03:00
and exited with
2022-09-04 18:28:36 +03:00
.Aq Esc
2020-07-15 20:20:37 +03:00
key.
.It EMBED
is the mode of the embed terminal emulator
.It INSERT
captures all input as text input, and is exited with
.Cm Esc
key.
.El
2020-07-25 13:08:36 +03:00
.Ss COMMAND Mode
2020-07-15 20:20:37 +03:00
.Ss Mail listing commands
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
.It Cm set Ar plain | threaded | compact | conversations
2019-07-29 20:23:22 +03:00
set the way mailboxes are displayed
2019-11-22 13:12:44 +02:00
.El
.TS
allbox tab(:);
lb l.
conversations:shows one entry per thread
compact:shows one row per thread
threaded:shows threads as a tree structure
plain:shows one row per mail, regardless of threading
.TE
.Bl -tag -width 36 n
.It Cm sort Ar subject | date \ Ar asc | desc
2019-07-29 20:23:22 +03:00
sort mail listing
2019-11-22 13:12:44 +02:00
.It Cm subsort Ar subject | date \ Ar asc | desc
2019-07-29 20:23:22 +03:00
sorts only the first level of replies.
2019-11-22 13:12:44 +02:00
.It Cm go Ar n
2019-07-29 20:23:22 +03:00
where
.Ar n
is a mailbox prefixed with the
.Ar n
number in the side menu for the current account
2020-10-14 13:17:54 +03:00
.It Cm toggle thread_snooze
2019-07-29 20:23:22 +03:00
don't issue notifications for thread under cursor in thread listing
2020-02-26 18:36:52 +02:00
.It Cm search Ar STRING
search mailbox with
2019-07-29 20:23:22 +03:00
.Ar STRING
2020-09-26 18:18:24 +03:00
query.
Escape exits search results.
.It Cm select Ar STRING
select threads matching
.Ar STRING
query.
.It Cm set seen, set unseen
Set seen status of message.
2020-10-09 11:56:50 +03:00
.It Cm import Ar FILEPATH Ar MAILBOX_PATH
Import mail from file into given mailbox.
2020-09-26 18:18:24 +03:00
.It Cm copyto, moveto Ar MAILBOX_PATH
Copy or move to other mailbox.
.It Cm copyto, moveto Ar ACCOUNT Ar MAILBOX_PATH
Copy or move to another account's mailbox.
.It Cm delete
Delete selected threads.
2021-01-09 22:34:50 +02:00
.It Cm export-mbox Ar FILEPATH
Export selected threads to mboxcl2 file.
2020-02-26 10:54:10 +02:00
.It Cm create-mailbox Ar ACCOUNT Ar MAILBOX_PATH
create mailbox with given path.
2020-01-28 18:43:14 +02:00
Be careful with backends and separator sensitivity (eg IMAP)
2020-02-26 10:54:10 +02:00
.It Cm subscribe-mailbox Ar ACCOUNT Ar MAILBOX_PATH
subscribe to mailbox with given path
.It Cm unsubscribe-mailbox Ar ACCOUNT Ar MAILBOX_PATH
unsubscribe to mailbox with given path
.It Cm rename-mailbox Ar ACCOUNT Ar MAILBOX_PATH_SRC Ar MAILBOX_PATH_DEST
rename mailbox
.It Cm delete-mailbox Ar ACCOUNT Ar MAILBOX_PATH
2020-07-15 20:20:37 +03:00
deletes mailbox in the mail backend.
This action is unreversible.
2019-09-16 14:07:38 +03:00
.El
2020-07-15 20:20:37 +03:00
.Ss Mail view commands
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2019-09-16 14:07:38 +03:00
.It Cm pipe Ar EXECUTABLE Ar ARGS
pipe pager contents to binary
2021-09-13 13:34:10 +03:00
.It Cm filter Ar EXECUTABLE Ar ARGS
filter and display pager contents through command
2019-07-29 20:23:22 +03:00
.It Cm list-post
2019-11-22 13:12:44 +02:00
post in list of viewed envelope
2019-07-29 20:23:22 +03:00
.It Cm list-unsubscribe
2019-11-22 13:12:44 +02:00
unsubscribe automatically from list of viewed envelope
2019-07-29 20:23:22 +03:00
.It Cm list-archive
open list archive with
.Cm xdg-open
2019-09-16 14:07:38 +03:00
.El
2020-07-15 20:20:37 +03:00
.Ss composing mail commands
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
.It Cm add-attachment Ar PATH
2019-09-16 14:07:38 +03:00
in composer, add
.Ar PATH
as an attachment
2020-03-01 17:45:55 +02:00
.It Cm add-attachment < Ar CMD Ar ARGS
in composer, pipe
.Ar CMD Ar ARGS
output into an attachment
2020-10-09 21:21:15 +03:00
.It Cm add-attachment-file-picker
Launch command defined in the configuration value
.Ic file_picker_command
in
.Xr meli.conf 5 TERMINAL
.It Cm add-attachment-file-picker < Ar CMD Ar ARGS
Launch command
.Ar CMD Ar ARGS Ns
\& .
The command should print file paths in stderr, separated by NULL bytes.
2019-11-22 13:12:44 +02:00
.It Cm remove-attachment Ar INDEX
2019-09-16 14:07:38 +03:00
remove attachment with given index
2019-11-22 13:12:44 +02:00
.It Cm toggle sign
2020-01-28 18:43:14 +02:00
toggle between signing and not signing this message.
If the gpg invocation fails then the mail won't be sent.
2020-07-15 20:20:37 +03:00
See
.Xr meli.conf 5 PGP
for PGP configuration.
2020-06-23 19:25:01 +03:00
.It Cm save-draft
saves a copy of the draft in the Draft folder
2019-09-16 14:07:38 +03:00
.El
2020-07-15 20:20:37 +03:00
.Ss generic commands
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2019-09-16 14:07:38 +03:00
.It Cm open-in-tab
opens envelope view in new tab
2019-11-22 13:12:44 +02:00
.It Cm close
2019-09-16 14:07:38 +03:00
closes closeable tabs
2019-07-29 20:23:22 +03:00
.It Cm setenv Ar KEY=VALUE
set environment variable
.Ar KEY
to
.Ar VALUE
2019-09-16 14:07:38 +03:00
.It Cm printenv Ar KEY
2019-07-29 20:23:22 +03:00
print environment variable
.Ar KEY
2020-12-02 20:47:48 +02:00
.It Cm quit
Quits
.Nm Ns
\& .
.It Cm reload-config
Reloads configuration but only if account configuration is unchanged.
Useful if you want to reload some settings without restarting
.Nm Ns
\& .
2019-07-04 07:38:25 +03:00
.El
.Sh SHORTCUTS
2020-07-15 20:20:37 +03:00
See
.Xr meli.conf 5 SHORTCUTS
for shortcuts and their default values.
2019-07-04 07:38:25 +03:00
.Sh EXIT STATUS
2019-07-29 20:23:22 +03:00
.Nm
2020-01-28 18:43:14 +02:00
exits with 0 on a successful run.
Other exit statuses are:
2020-07-15 20:20:37 +03:00
.Bl -tag -width 5 n
2019-07-29 20:23:22 +03:00
.It 1
catchall for general errors
2020-07-15 20:20:37 +03:00
.It 101
process panic
2019-07-29 20:23:22 +03:00
.El
2019-07-04 07:38:25 +03:00
.Sh ENVIRONMENT
2019-09-16 14:07:38 +03:00
.Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
2019-07-29 20:23:22 +03:00
.It Ev EDITOR
Specifies the editor to use
.It Ev MELI_CONFIG
Override the configuration file
2020-01-27 20:17:46 +02:00
.It Ev NO_COLOR
2020-01-28 18:43:14 +02:00
When present (regardless of its value), prevents the addition of ANSI color.
The configuration value
2020-01-27 20:17:46 +02:00
.Ic use_color
overrides this.
2019-07-04 07:38:25 +03:00
.El
.Sh FILES
2019-11-11 22:20:16 +02:00
.Nm
uses the following parts of the XDG standard:
2019-09-16 14:07:38 +03:00
.Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
2019-07-29 20:23:22 +03:00
.It Ev XDG_CONFIG_HOME
defaults to
.Pa ~/.config/
.It Ev XDG_CACHE_HOME
defaults to
.Pa ~/.cache/
2019-07-04 07:38:25 +03:00
.El
2019-07-29 20:23:22 +03:00
.Pp
and appropriates the following locations:
.Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
.It Pa $XDG_CONFIG_HOME/meli/
2020-07-15 20:20:37 +03:00
User configuration directory
2020-01-28 00:32:40 +02:00
.It Pa $XDG_CONFIG_HOME/meli/config.toml
2020-07-15 20:20:37 +03:00
User configuration file, see
2019-09-16 14:07:38 +03:00
.Xr meli.conf 5
for its syntax and values.
2019-07-29 20:23:22 +03:00
.It Pa $XDG_CONFIG_HOME/meli/hooks/*
Reserved for event hooks.
.It Pa $XDG_CONFIG_HOME/meli/plugins/*
Reserved for plugin files.
.It Pa $XDG_CACHE_HOME/meli/*
Internal cached data used by meli.
2019-09-16 14:07:38 +03:00
.It Pa $XDG_DATA_HOME/meli/*
Internal data used by meli.
.It Pa $XDG_DATA_HOME/meli/meli.log
Operation log.
2019-07-29 20:23:22 +03:00
.It Pa /tmp/meli/*
2019-11-11 22:20:16 +02:00
Temporary files generated by
.Nm Ns
\& .
.El
.Pp
Mailcap entries are searched for in the following files, in this order:
.Pp
.Bl -enum -compact -offset indent
2019-11-22 13:12:44 +02:00
.It
2019-11-11 22:20:16 +02:00
.Pa $XDG_CONFIG_HOME/meli/mailcap
.It
.Pa $XDG_CONFIG_HOME/.mailcap
.It
.Pa $HOME/.mailcap
.It
.Pa /etc/mailcap
.It
.Pa /usr/etc/mailcap
.It
.Pa /usr/local/etc/mailcap
2019-07-04 07:38:25 +03:00
.El
2019-07-29 20:23:22 +03:00
.Sh SEE ALSO
2019-11-11 22:20:16 +02:00
.Xr meli.conf 5 ,
2020-01-28 00:32:40 +02:00
.Xr meli-themes 5 ,
2022-09-04 18:28:36 +03:00
.Xr meli 7 ,
2019-09-16 14:07:38 +03:00
.Xr xdg-open 1 ,
2019-11-11 22:20:16 +02:00
.Xr mailcap 5
2019-07-29 20:23:22 +03:00
.Sh CONFORMING TO
XDG Standard
2022-09-04 18:28:36 +03:00
.Lk https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html Ns
2019-07-29 20:23:22 +03:00
, maildir
2022-09-04 18:28:36 +03:00
.Lk https://cr.yp.to/proto/maildir.html Ns
2019-12-13 00:13:54 +02:00
, IMAPv4rev1 RFC3501, The JSON Meta Application Protocol (JMAP) RFC8620, The JSON Meta Application Protocol (JMAP) for Mail RFC8621.
2019-07-04 07:38:25 +03:00
.Sh AUTHORS
2022-09-04 18:28:36 +03:00
Copyright 2017-2022
.An Manos Pitsidianakis Mt manos@pitsidianak.is
2020-01-28 18:43:14 +02:00
Released under the GPL, version 3 or greater.
2022-09-04 18:28:36 +03:00
This software carries no warranty of any kind (See COPYING for full copyright and warranty notices).
2019-07-04 07:38:25 +03:00
.Pp
2022-09-04 18:28:36 +03:00
.Lk https://meli.delivery