Correct mdoc lint warnings
parent
dbc0fd81af
commit
60457725a4
|
@ -30,20 +30,21 @@ mail client
|
|||
comes with two themes,
|
||||
.Ic dark
|
||||
(the default) and
|
||||
.Ic light.
|
||||
The application theme is defined in the configuration as follows:
|
||||
.Bd
|
||||
[terminal]
|
||||
theme = "dark"
|
||||
.Ed
|
||||
.Ic light .
|
||||
.sp
|
||||
Custom themes can be defined as lists of key-values in the configuration files:
|
||||
|
||||
.Bl -compact
|
||||
.Bl -bullet -compact
|
||||
.It
|
||||
.Pa $XDG_CONFIG_HOME/meli/config.toml
|
||||
.It
|
||||
.Pa $XDG_CONFIG_HOME/meli/themes/*.toml
|
||||
.El
|
||||
.sp
|
||||
The application theme is defined in the configuration as follows:
|
||||
.Bd -literal
|
||||
[terminal]
|
||||
theme = "dark"
|
||||
.Ed
|
||||
.Sh DESCRIPTION
|
||||
Themes for
|
||||
.Nm meli
|
||||
|
@ -51,26 +52,32 @@ are described in the configuration language TOML.
|
|||
They are key-value tables defined in the TERMINAL section of the configuration file.
|
||||
Each key defines the semantic location of the theme attribute within the application.
|
||||
For example, "mail.listing.compact.* keys are settings for the `compact` mail listing style.
|
||||
A setting contains three fields: fg for foreground color, bg for background color, and attrs for attribute.
|
||||
Each field contains a value, and each value can be either a color/attribute, or a key name.
|
||||
A setting contains three fields: fg for foreground color, bg for background color, and attrs for text attribute.
|
||||
.sp
|
||||
.Dl \&"widget.key.label\&" = { fg = \&"Default\&", bg = \&"Default\&", attrs = \&"Default\&" }
|
||||
.sp
|
||||
Each field contains a value, and each value can either be a color/attribute, or a key name.
|
||||
In the latter case the setting's real value depends on the value of the key.
|
||||
This allows for defaults within a group of associated values.
|
||||
Cycles in a theme's links results in an error.
|
||||
Cyclic references in a theme results in an error:
|
||||
.sp
|
||||
.Dl spooky theme contains a cycle: fg: mail.listing.compact.even -> mail.listing.compact.highlighted -> mail.listing.compact.odd -> mail.listing.compact.even
|
||||
.Pp
|
||||
Two themes are included by default, `light` and `dark`.
|
||||
.Sh EXAMPLES
|
||||
Specific settings from already defined themes can be overwritten:
|
||||
.Bd -literal
|
||||
[terminal]
|
||||
theme = "dark"
|
||||
|
||||
.sp
|
||||
[terminal.themes.dark]
|
||||
"mail.sidebar_highlighted_account" = { bg = "#ff4529" }
|
||||
"mail.listing.attachment_flag" = { fg = "#ff4529" }
|
||||
"mail.view.headers" = { fg = "30" }
|
||||
"mail.view.body" = {fg = "HotPink3", bg = "LightSalmon1"}
|
||||
# Linked value keys can be whatever:
|
||||
# Linked value keys can be whatever key:
|
||||
"mail.listing.compact.unseen" = { bg = "mail.sidebar_highlighted_account" }
|
||||
|
||||
.sp
|
||||
# define new theme. Undefined settings will inherit from the default "dark" theme.
|
||||
[terminal.themes."hunter2"]
|
||||
"mail.view.headers" = { fg = "White", bg = "Black" }
|
||||
|
@ -78,16 +85,16 @@ theme = "dark"
|
|||
.Sh CUSTOM THEMES
|
||||
Custom themes can be included in your configuration files or be saved independently in your
|
||||
.Pa $XDG_CONFIG_HOME/meli/themes/
|
||||
directory as TOML files. To start creating a theme right away, you can begin by editing the default theme keys and values:
|
||||
.Bd -literal
|
||||
meli --print-default-theme > ~/.config/meli/themes/new_theme.toml
|
||||
.Ed
|
||||
|
||||
directory as TOML files.
|
||||
To start creating a theme right away, you can begin by editing the default theme keys and values:
|
||||
.sp
|
||||
.Dl meli --print-default-theme > ~/.config/meli/themes/new_theme.toml
|
||||
.sp
|
||||
.Pa new_theme.toml
|
||||
will now include all keys and values of the "dark" theme.
|
||||
|
||||
.Fl -print-loaded-themes
|
||||
.Ed
|
||||
.sp
|
||||
.Dl meli --print-loaded-themes
|
||||
.sp
|
||||
will print all loaded themes with the links resolved.
|
||||
.Sh VALID ATTRIBUTE VALUES
|
||||
Case-sensitive.
|
||||
|
@ -113,7 +120,7 @@ Case-sensitive.
|
|||
Color values are of type String with the following valid contents:
|
||||
.Bl -bullet -compact
|
||||
.It
|
||||
"Default" Terminal default.
|
||||
"Default" is the terminal default. (Case-sensitive)
|
||||
.It
|
||||
Hex triplet eg #FFFFFF for RGB colors
|
||||
(three letter shorthand also valid, eg #09c → #0099cc) (Case-insensitive)
|
||||
|
@ -129,22 +136,21 @@ To completely disable ANSI colors, there are two options:
|
|||
.It
|
||||
Set the
|
||||
.Ic use_color
|
||||
option (section
|
||||
option (section
|
||||
.Ic terminal Ns
|
||||
.Ns )
|
||||
to false, which is true by default.
|
||||
) to false, which is true by default.
|
||||
.It
|
||||
The
|
||||
.Ev NO_COLOR
|
||||
environmental variable, when present (regardless of its value), prevents the addition of ANSI color. When the configuration value
|
||||
environmental variable, when present (regardless of its value), prevents the addition of ANSI color.
|
||||
When the configuration value
|
||||
.Ic use_color
|
||||
is explicitly set to true by the user,
|
||||
.Ev NO_COLOR
|
||||
is ignored.
|
||||
.El
|
||||
|
||||
.sp
|
||||
In this mode, cursor locations (i.e. currently selected entries/items) will use the "reverse video" ANSI attribute to inverse the terminal's default foreground/background colors.
|
||||
|
||||
.Sh VALID KEYS
|
||||
.TS
|
||||
allbox tab(:);
|
||||
|
@ -462,6 +468,8 @@ Yellow6:148:_:Grey93:255
|
|||
.Xr meli.conf 5
|
||||
.Sh CONFORMING TO
|
||||
TOML Standard v.0.5.0 https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md
|
||||
.sp
|
||||
https://no-color.org/
|
||||
.Sh AUTHORS
|
||||
Copyright 2017-2019
|
||||
.An Manos Pitsidianakis Aq epilys@nessuent.xyz
|
||||
|
|
156
meli.1
156
meli.1
|
@ -32,12 +32,10 @@
|
|||
.Op Fl -config Ar path
|
||||
.Op Fl -print-default-theme
|
||||
.Op Fl -print-loaded-themes
|
||||
.Sh DESCRIPTION
|
||||
Experimental terminal mail client
|
||||
.Bl -tag -width flag -offset indent
|
||||
.It Fl -help, h
|
||||
.It Fl -help | h
|
||||
Show help message and exit.
|
||||
.It Fl -version, v
|
||||
.It Fl -version | v
|
||||
Show version and exit.
|
||||
.It Fl -create-config Op Ar path
|
||||
Create configuration file in
|
||||
|
@ -53,34 +51,9 @@ Print default theme keys and values in TOML syntax, to be used as a blueprint.
|
|||
.It Fl -print-loaded-themes
|
||||
Print all loaded themes in TOML syntax.
|
||||
.El
|
||||
.Sh STARTING WITH meli
|
||||
When launched for the first time,
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
will search for its configuration directory,
|
||||
.Pa $XDG_CONFIG_HOME/meli/ Ns
|
||||
\&. If it doesn't exist, you will be asked if you want to create one along with a sample configuration. The sample configuration
|
||||
.Pa $XDG_CONFIG_HOME/meli/config.toml
|
||||
includes comments with the basic settings required for setting up accounts allowing you to copy and edit right away. See
|
||||
.Xr meli.conf 5
|
||||
for the available configuration options.
|
||||
.Pp
|
||||
At any time, you may press
|
||||
.Cm \&?
|
||||
to show a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
|
||||
.Pp
|
||||
The main visual navigation tool is the left-side sidebar. The menu's visibility may be toggled with
|
||||
.Cm `
|
||||
(shortcuts.listing:
|
||||
.Ic toggle_menu_visibility Ns
|
||||
).
|
||||
.Pp
|
||||
The view into each folder has 4 modes: plain, threaded, conversations and compact. Plain views each mail indvidually, threaded shows their thread relationship visually, and conversations includes one entry per thread of emails (compact is one row per thread).
|
||||
.Pp
|
||||
If you're using a light color palette in your terminal, you may set
|
||||
.Em theme = "light"
|
||||
in the
|
||||
.Em terminal
|
||||
section of your configuration.
|
||||
is a terminal mail client aiming for extensive and user-frendly configurability.
|
||||
.Bd -literal
|
||||
^^ .-=-=-=-. ^^
|
||||
^^ (`-=-=-=-=-`) ^^
|
||||
|
@ -96,17 +69,54 @@ section of your configuration.
|
|||
^^ (`-=-=-=-=-`)
|
||||
`-=-=-=-=-` ^^
|
||||
.Ed
|
||||
.Sh STARTING WITH meli
|
||||
When launched for the first time,
|
||||
.Nm
|
||||
will search for its configuration directory,
|
||||
.Pa $XDG_CONFIG_HOME/meli/ Ns
|
||||
\&.
|
||||
If it doesn't exist, you will be asked if you want to create one along with a sample configuration.
|
||||
The sample configuration
|
||||
.Pa $XDG_CONFIG_HOME/meli/config.toml
|
||||
includes comments with the basic settings required for setting up accounts allowing you to copy and edit right away.
|
||||
See
|
||||
.Xr meli.conf 5
|
||||
for the available configuration options.
|
||||
.Pp
|
||||
At any time, you may press
|
||||
.Cm \&?
|
||||
to show a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
|
||||
.Pp
|
||||
The main visual navigation tool is the left-side sidebar.
|
||||
The menu's visibility may be toggled with
|
||||
.Cm `
|
||||
(shortcuts.listing:
|
||||
.Ic toggle_menu_visibility Ns
|
||||
).
|
||||
.Pp
|
||||
The view into each folder has 4 modes: plain, threaded, conversations and compact.
|
||||
Plain views each mail indvidually, threaded shows their thread relationship visually, and conversations includes one entry per thread of emails (compact is one row per thread).
|
||||
.Pp
|
||||
If you're using a light color palette in your terminal, you may set
|
||||
.Em theme = "light"
|
||||
in the
|
||||
.Em terminal
|
||||
section of your configuration.
|
||||
See
|
||||
.Xr meli-themes 5
|
||||
for complete documentation on user themes.
|
||||
.Sh VIEWING MAIL
|
||||
Open attachments by typing their index in the attachments list and then
|
||||
.Cm a Ns
|
||||
\&.
|
||||
.Ns
|
||||
.Nm
|
||||
will attempt to open text inside its pager and other content via
|
||||
.Cm xdg-open Ns
|
||||
\&. Press
|
||||
\&.
|
||||
Press
|
||||
.Cm m
|
||||
instead to use the mailcap entry for the MIME type of the attachment, if any. See
|
||||
instead to use the mailcap entry for the MIME type of the attachment, if any.
|
||||
See
|
||||
.Sx FILES
|
||||
for the location of the mailcap files and
|
||||
.Xr mailcap 5
|
||||
|
@ -118,17 +128,20 @@ uses the SEARCH command,
|
|||
.Em notmuch
|
||||
uses libnotmuch and
|
||||
.Em Maildir/mbox
|
||||
have to do a slow linear search. Thus it is advised to use a cache on
|
||||
have to do a slow linear search.
|
||||
Thus it is advised to use a cache on
|
||||
.Em Maildir/mbox
|
||||
accounts.
|
||||
.Nm Ns
|
||||
, if built with sqlite3, includes the ability to perform full text search on the following fields: From, To, Cc, Bcc, In-Reply-To, References, Subject and Date. The message body (in plain text human readable form) and the flags can also be queried. To enable sqlite3 indexing for an account set
|
||||
, if built with sqlite3, includes the ability to perform full text search on the following fields: From, To, Cc, Bcc, In-Reply-To, References, Subject and Date.
|
||||
The message body (in plain text human readable form) and the flags can also be queried.
|
||||
To enable sqlite3 indexing for an account set
|
||||
.Em cache_type
|
||||
to
|
||||
.Em sqlite3
|
||||
in the configuration file and to create the sqlite3 index issue command
|
||||
.Cm index Ar ACCOUNT_NAME Ns \&.
|
||||
|
||||
.sp
|
||||
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
|
||||
|
@ -148,7 +161,8 @@ and
|
|||
alias:
|
||||
.Em \&!
|
||||
.Pc
|
||||
String keywords with spaces must be quoted. Quotes should always be escaped.
|
||||
String keywords with spaces must be quoted.
|
||||
Quotes should always be escaped.
|
||||
.sp
|
||||
.Sy Important Notice about IMAP/JMAP
|
||||
.sp
|
||||
|
@ -158,10 +172,13 @@ to
|
|||
.Em sqlite3 Ns
|
||||
\&.
|
||||
.Nm
|
||||
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.
|
||||
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.
|
||||
.Sh TAGS
|
||||
.Nm
|
||||
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
|
||||
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
|
||||
.Cm tag add TAG
|
||||
and
|
||||
.Cm tag remove TAG
|
||||
|
@ -175,49 +192,58 @@ for how to set tag colors and tag visiblity)
|
|||
.Sh COMPOSING
|
||||
To send mail, press
|
||||
.Cm m
|
||||
while viewing the appropriate account to open a new composing tab. To reply to a mail, press
|
||||
while viewing the appropriate account to open a new composing tab.
|
||||
To reply to a mail, press
|
||||
.Cm R Ns
|
||||
\&. You may edit some of the header fields from within the view, by selecting with the arrow keys and pressing
|
||||
\&.
|
||||
You may edit some of the header fields from within the view, by selecting with the arrow keys and pressing
|
||||
.Cm enter
|
||||
to enter
|
||||
.Ar INSERT
|
||||
mode. At any time you may press
|
||||
mode.
|
||||
At any time you may press
|
||||
.Cm e
|
||||
to launch your editor (see
|
||||
.Xr meli.conf 5 COMPOSING Ns
|
||||
, setting
|
||||
.Ic editor_cmd
|
||||
for how to select which editor to launch). Attachments may be handled with the
|
||||
for how to select which editor to launch).
|
||||
Attachments may be handled with the
|
||||
.Em add-attachment Ns
|
||||
,
|
||||
.Em remove-attachment
|
||||
commands (see below). Finally, pressing
|
||||
commands (see below).
|
||||
Finally, pressing
|
||||
.Cm s
|
||||
will send your message by piping it into a binary of your choosing (see
|
||||
.Xr meli.conf 5 COMPOSING Ns
|
||||
, setting
|
||||
.Ic mailer_cmd Ns
|
||||
). To save your draft without sending it, issue command
|
||||
).
|
||||
To save your draft without sending it, issue command
|
||||
.Cm close
|
||||
and select 'save as draft'.
|
||||
.Pp
|
||||
With no Draft or Sent folder,
|
||||
.Nm
|
||||
tries first saving mail in your INBOX and then at any other folder. On complete failure to save your draft or sent message it will be saved in your
|
||||
tries first saving mail in your INBOX and then at any other folder.
|
||||
On complete failure to save your draft or sent message it will be saved in your
|
||||
.Em tmp
|
||||
directory instead and you will be notified of its location.
|
||||
.Pp
|
||||
To open a draft for editing later, select your draft in the mail listing and press
|
||||
.Cm e Ns
|
||||
\&.
|
||||
|
||||
.sp
|
||||
Your editor can be used in
|
||||
.Nm Ns
|
||||
\&'s embed terminal emulator by setting
|
||||
.Ic embed
|
||||
to
|
||||
.Em true
|
||||
in your composing settings. When launched, your editor captures all input until it exits or stops. To stop your editor and return to
|
||||
in your composing settings.
|
||||
When launched, your editor captures all input until it exits or stops.
|
||||
To stop your editor and return to
|
||||
.Nm
|
||||
issue Ctrl-z and to resume editing press the
|
||||
.Ic edit_mail
|
||||
|
@ -227,7 +253,7 @@ command again (default
|
|||
.Sh CONTACTS
|
||||
.Nm
|
||||
supports two kinds of contact backends:
|
||||
|
||||
.sp
|
||||
.Bl -enum -compact -offset indent
|
||||
.It
|
||||
an internal format that gets saved under
|
||||
|
@ -236,11 +262,13 @@ an internal format that gets saved under
|
|||
.It
|
||||
vCard files (v3, v4) through the
|
||||
.Ic vcard_folder
|
||||
option in the account section. The path defined as
|
||||
option in the account section.
|
||||
The path defined as
|
||||
.Ic vcard_folder
|
||||
can hold multiple vCards per file. They are loaded read only.
|
||||
can hold multiple vCards per file.
|
||||
They are loaded read only.
|
||||
.El
|
||||
|
||||
.sp
|
||||
See
|
||||
.Xr meli.conf 5 ACCOUNTS
|
||||
for the complete account configuration values.
|
||||
|
@ -276,10 +304,12 @@ don't issue notifications for thread under cursor in thread listing
|
|||
.It Cm filter Ar STRING
|
||||
filter mailbox with
|
||||
.Ar STRING
|
||||
key. Escape exits filter results
|
||||
key.
|
||||
Escape exits filter results
|
||||
.It Cm set read, set unread
|
||||
.It Cm create-folder Ar ACCOUNT Ar FOLDER_PATH
|
||||
create folder with given path. be careful with backends and separator sensitivity (eg IMAP)
|
||||
create folder with given path.
|
||||
Be careful with backends and separator sensitivity (eg IMAP)
|
||||
.It Cm subscribe-folder Ar ACCOUNT Ar FOLDER_PATH
|
||||
subscribe to folder with given path
|
||||
.It Cm unsubscribe-folder Ar ACCOUNT Ar FOLDER_PATH
|
||||
|
@ -312,7 +342,8 @@ as an attachment
|
|||
.It Cm remove-attachment Ar INDEX
|
||||
remove attachment with given index
|
||||
.It Cm toggle sign
|
||||
toggle between signing and not signing this message. If the gpg invocation fails then the mail won't be sent.
|
||||
toggle between signing and not signing this message.
|
||||
If the gpg invocation fails then the mail won't be sent.
|
||||
.El
|
||||
.Pp
|
||||
generic commands:
|
||||
|
@ -397,7 +428,8 @@ attachment according to its mailcap entry.
|
|||
.El
|
||||
.Sh EXIT STATUS
|
||||
.Nm
|
||||
exits with 0 on a successful run. Other exit statuses are:
|
||||
exits with 0 on a successful run.
|
||||
Other exit statuses are:
|
||||
.Bl -tag -width 2n
|
||||
.It 1
|
||||
catchall for general errors
|
||||
|
@ -409,7 +441,8 @@ Specifies the editor to use
|
|||
.It Ev MELI_CONFIG
|
||||
Override the configuration file
|
||||
.It Ev NO_COLOR
|
||||
When present (regardless of its value), prevents the addition of ANSI color. The configuration value
|
||||
When present (regardless of its value), prevents the addition of ANSI color.
|
||||
The configuration value
|
||||
.Ic use_color
|
||||
overrides this.
|
||||
.El
|
||||
|
@ -430,7 +463,8 @@ and appropriates the following locations:
|
|||
.It Pa $XDG_CONFIG_HOME/meli/
|
||||
User configuration directory.
|
||||
.It Pa $XDG_CONFIG_HOME/meli/config.toml
|
||||
User configuration file. See
|
||||
User configuration file.
|
||||
See
|
||||
.Xr meli.conf 5
|
||||
for its syntax and values.
|
||||
.It Pa $XDG_CONFIG_HOME/meli/hooks/*
|
||||
|
@ -479,6 +513,8 @@ XDG Standard
|
|||
.Sh AUTHORS
|
||||
Copyright 2017-2019
|
||||
.An Manos Pitsidianakis Aq epilys@nessuent.xyz
|
||||
Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYING for full copyright and warranty notices.)
|
||||
Released under the GPL, version 3 or greater.
|
||||
This software carries no warranty of any kind.
|
||||
(See COPYING for full copyright and warranty notices.)
|
||||
.Pp
|
||||
.Aq https://meli.delivery
|
||||
|
|
126
meli.conf.5
126
meli.conf.5
|
@ -26,7 +26,8 @@
|
|||
.Sh SYNOPSIS
|
||||
.Pa $XDG_CONFIG_HOME/meli/config.toml
|
||||
.Sh DESCRIPTION
|
||||
Configuration for meli is written in TOML. Few things to consider before writing TOML (quoting the spec):
|
||||
Configuration for meli is written in TOML.
|
||||
Few things to consider before writing TOML (quoting the spec):
|
||||
.Pp
|
||||
.Bl -bullet -compact
|
||||
.It
|
||||
|
@ -40,23 +41,21 @@ Newline means LF (0x0A) or CRLF (0x0D 0x0A).
|
|||
.El
|
||||
.Pp
|
||||
Refer to TOML documentation for valid TOML syntax.
|
||||
|
||||
.sp
|
||||
Thought not part of TOML syntax,
|
||||
.Nm
|
||||
can have nested configuration files by using the following include directive, which though starting with
|
||||
.Em \&#
|
||||
is not a comment:
|
||||
.Bd -literal
|
||||
#include "/path/to/file"
|
||||
.Ed
|
||||
|
||||
.Dl #include \&"/path/to/file\&"
|
||||
.sp
|
||||
The accepted regular expression is
|
||||
.Li ^\es*include\es*\&\\&\e"(\e\e.|[^\e"])+\e"\es*$
|
||||
.Sh SECTIONS
|
||||
The top level sections of the config are accounts, shortcuts, notifications, pager, listing, composing, pgp, terminal.
|
||||
.Pp
|
||||
.Sy example configuration
|
||||
|
||||
.Sh EXAMPLES
|
||||
example configuration
|
||||
.sp
|
||||
.Bd -literal
|
||||
# Setting up a Maildir account
|
||||
[accounts.account-name]
|
||||
|
@ -114,7 +113,8 @@ the backend-specific path of the root_folder, usually INBOX.
|
|||
.It Ic format Ar String Op maildir mbox imap notmuch jmap
|
||||
the format of the mail backend.
|
||||
.It Ic subscribed_folders Ar [String,]
|
||||
an array of folder paths to display in the UI. Paths are relative to the root folder (eg "INBOX/Sent", not "Sent").
|
||||
an array of folder paths to display in the UI.
|
||||
Paths are relative to the root folder (eg "INBOX/Sent", not "Sent").
|
||||
The glob wildcard
|
||||
.Em \&*
|
||||
can be used to match every folder name and path.
|
||||
|
@ -145,12 +145,15 @@ attempt to not make any changes to this account.
|
|||
(optional) command to execute when manually refreshing (shortcut listing.refresh)
|
||||
.Pq Em None
|
||||
.It Ic cache_type Ar String
|
||||
(optional) choose which cache backend to use. Available options are 'none' and 'sqlite3'
|
||||
(optional) choose which cache backend to use.
|
||||
Available options are 'none' and 'sqlite3'
|
||||
.Pq Em "sqlite3"
|
||||
.It Ic vcard_folder Ar String
|
||||
(optional) Folder that contains .vcf files. They are parsed and imported read-only.
|
||||
(optional) Folder that contains .vcf files.
|
||||
They are parsed and imported read-only.
|
||||
.It Ic folders Ar folder_config
|
||||
(optional) configuration for each folder. Its format is described below in
|
||||
(optional) configuration for each folder.
|
||||
Its format is described below in
|
||||
.Sx FOLDERS Ns
|
||||
\&.
|
||||
.El
|
||||
|
@ -158,11 +161,14 @@ attempt to not make any changes to this account.
|
|||
.Ic root_folder
|
||||
points to the directory which contains the
|
||||
.Pa .notmuch/
|
||||
subdirectory. notmuch folders are virtual, since they are defined by user-given notmuch queries. Thus you have to explicitly state the folders you want in the
|
||||
subdirectory.
|
||||
notmuch folders are virtual, since they are defined by user-given notmuch queries.
|
||||
Thus you have to explicitly state the folders you want in the
|
||||
.Ic folders
|
||||
field and set the
|
||||
.Ar query
|
||||
property to each of them. Example:
|
||||
property to each of them.
|
||||
Example:
|
||||
.Bd -literal
|
||||
[accounts.notmuch]
|
||||
format = "notmuch"
|
||||
|
@ -225,7 +231,8 @@ example:
|
|||
.\" default value
|
||||
.Pq Em false
|
||||
.It Ic usage Ar boolean
|
||||
(optional) special usage of this folder. valid values are:
|
||||
(optional) special usage of this folder.
|
||||
Valid values are:
|
||||
.Bl -bullet -compact
|
||||
.It
|
||||
.Ar Normal
|
||||
|
@ -246,11 +253,13 @@ example:
|
|||
.El
|
||||
otherwise usage is inferred from the folder title.
|
||||
.It Ic conf_override Ar boolean
|
||||
(optional) override global settings for this folder. available sections to override are
|
||||
(optional) override global settings for this folder.
|
||||
Available sections to override are
|
||||
.Em pager, notifications, shortcuts, composing
|
||||
and the account options
|
||||
.Em identity and index_style Ns
|
||||
\&. example:
|
||||
\&.
|
||||
Example:
|
||||
.Bd -literal
|
||||
[accounts."imap.domain.tld".folders."INBOX"]
|
||||
index_style = "plain"
|
||||
|
@ -263,7 +272,10 @@ and the account options
|
|||
.It Ic mailer_cmd Ar String
|
||||
command to pipe new mail to, exit code must be 0 for success.
|
||||
.It Ic editor_cmd Ar String
|
||||
command to launch editor. Can have arguments. Draft filename is given as the last argument. If it's missing, the environment variable $EDITOR is looked up.
|
||||
command to launch editor.
|
||||
Can have arguments.
|
||||
Draft filename is given as the last argument.
|
||||
If it's missing, the environment variable $EDITOR is looked up.
|
||||
.It Ic embed Ar boolean
|
||||
(optional) embed editor within meli
|
||||
.\" default value
|
||||
|
@ -295,15 +307,16 @@ Shortcuts can take the following values:
|
|||
and
|
||||
.Qq Em char Ns
|
||||
, where char is a single character string.
|
||||
|
||||
The headings before each list indicate the map key of the shortcut list. For example for the first list titled
|
||||
.sp
|
||||
The headings before each list indicate the map key of the shortcut list.
|
||||
For example for the first list titled
|
||||
.Em general
|
||||
the configuration is typed as follows:
|
||||
.Bd -literal
|
||||
[shortcuts.general]
|
||||
next_tab = 'T'
|
||||
.Ed
|
||||
|
||||
.sp
|
||||
and for
|
||||
.Em compact-listing Ns
|
||||
:
|
||||
|
@ -311,23 +324,23 @@ and for
|
|||
[shortcuts.compact-listing]
|
||||
open_thread = "Enter"
|
||||
exit_thread = 'i'
|
||||
.Bd
|
||||
|
||||
.Ed
|
||||
.sp
|
||||
.Pp
|
||||
.Sy Em general
|
||||
.Em general
|
||||
.Bl -tag -width 36n
|
||||
.It Ic next_tab
|
||||
Go to next tab.
|
||||
.\" default value
|
||||
.Pq Em T
|
||||
.It Ic go_to_tab
|
||||
Go to the
|
||||
Go to the
|
||||
.Em n Ns
|
||||
th tab
|
||||
.Pq Em cannot be redefined
|
||||
.El
|
||||
|
||||
.Sy Em listing
|
||||
.sp
|
||||
.Em listing
|
||||
.Bl -tag -width 36n
|
||||
.It Ic prev_page
|
||||
Go to previous page.
|
||||
|
@ -374,8 +387,8 @@ Toggle visibility of side menu in mail list.
|
|||
.\" default value
|
||||
.Pq Em `
|
||||
.El
|
||||
|
||||
.Sy Em compact-listing
|
||||
.sp
|
||||
.Em compact-listing
|
||||
.Bl -tag -width 36n
|
||||
.It Ic exit_thread
|
||||
Exit thread view
|
||||
|
@ -390,8 +403,8 @@ Select thread entry.
|
|||
.\" default value
|
||||
.Pq Em v
|
||||
.El
|
||||
|
||||
.Sy Em pager
|
||||
.sp
|
||||
.Em pager
|
||||
.Bl -tag -width 36n
|
||||
.It Ic scroll_up
|
||||
Scroll up pager.
|
||||
|
@ -410,8 +423,8 @@ Go to next pager pag
|
|||
.\" default value
|
||||
.Pq Em PageDown
|
||||
.El
|
||||
|
||||
.Sy Em contact-list
|
||||
.sp
|
||||
.Em contact-list
|
||||
.Bl -tag -width 36n
|
||||
.It Ic create_contact
|
||||
Create new contact.
|
||||
|
@ -430,9 +443,9 @@ Toggle visibility of side menu in mail list.
|
|||
.\" default value
|
||||
.Pq Em `
|
||||
.El
|
||||
|
||||
|
||||
.Sy Em composing
|
||||
.sp
|
||||
.sp
|
||||
.Em composing
|
||||
.Bl -tag -width 36n
|
||||
.It Ic send_mail
|
||||
Deliver draft to mailer
|
||||
|
@ -443,8 +456,8 @@ Edit mail.
|
|||
.\" default value
|
||||
.Pq Em e
|
||||
.El
|
||||
|
||||
.Sy Em envelope-view
|
||||
.sp
|
||||
.Em envelope-view
|
||||
.Pp
|
||||
To "select" an attachment, type its index (you will see the typed result in the command buffer on your bottom right of the status line) and then issue the corresponding command.
|
||||
.Bl -tag -width 36n
|
||||
|
@ -469,12 +482,13 @@ Return to envelope if viewing raw source or attachment.
|
|||
.\" default value
|
||||
.Pq Em r
|
||||
.It Ic open_attachment
|
||||
Opens selected attachment with
|
||||
Opens selected attachment with
|
||||
.Cm xdg-open
|
||||
.\" default value
|
||||
.Pq Em a
|
||||
.It Ic open_mailcap
|
||||
Opens selected attachment according to its mailcap entry. See
|
||||
Opens selected attachment according to its mailcap entry.
|
||||
See
|
||||
.Xr meli.1 FILES
|
||||
for the mailcap file locations.
|
||||
.\" default value
|
||||
|
@ -484,7 +498,8 @@ Go to url of given index
|
|||
.\" default value
|
||||
.Pq Em g
|
||||
.It Ic toggle_url_mode
|
||||
Toggles url open mode. When active, it prepends an index next to each url that you can select by typing and open by issuing
|
||||
Toggles url open mode.
|
||||
When active, it prepends an index next to each url that you can select by typing and open by issuing
|
||||
.Ic go_to_url
|
||||
.\" default value
|
||||
.Pq Em u
|
||||
|
@ -493,8 +508,8 @@ Expand extra headers (References and others)
|
|||
.\" default value
|
||||
.Pq Em h
|
||||
.El
|
||||
|
||||
.Sy Em thread-view
|
||||
.sp
|
||||
.Em thread-view
|
||||
.Bl -tag -width 36n
|
||||
.It Ic reverse_thread_order
|
||||
Reverse thread order.
|
||||
|
@ -521,12 +536,12 @@ Go to next page.
|
|||
.\" default value
|
||||
.Pq Em PageDown
|
||||
.El
|
||||
|
||||
.Bl -tag -width 36n
|
||||
.sp
|
||||
.Sh NOTIFICATIONS
|
||||
.Bl -tag -width 36n
|
||||
.It Ic enable Ar boolean
|
||||
enable freedesktop-spec notifications. this is usually what you want
|
||||
enable freedesktop-spec notifications.
|
||||
this is usually what you want
|
||||
.\" default value
|
||||
.Pq Em true
|
||||
.It Ic script Ar String
|
||||
|
@ -549,7 +564,8 @@ enable freedesktop-spec notifications. this is usually what you want
|
|||
.Sh PAGER
|
||||
.Bl -tag -width 36n
|
||||
.It Ic pager_context Ar num
|
||||
(optional) number of context lines when going to next page. (Unimplemented)
|
||||
(optional) number of context lines when going to next page.
|
||||
(Unimplemented)
|
||||
.\" default value
|
||||
.Pq Em 0
|
||||
.It Ic headers_sticky Ar boolean
|
||||
|
@ -580,7 +596,8 @@ enable freedesktop-spec notifications. this is usually what you want
|
|||
.Sh LISTING
|
||||
.Bl -tag -width 36n
|
||||
.It Ic context_lines Ar num
|
||||
(optional) number of context lines when going to next page. (Unimplemented)
|
||||
(optional) number of context lines when going to next page.
|
||||
(Unimplemented)
|
||||
.\" default value
|
||||
.Pq Em 0
|
||||
.It Ic datetime_fmt Ar String
|
||||
|
@ -599,9 +616,9 @@ enable freedesktop-spec notifications. this is usually what you want
|
|||
.It Ic ignore_tags Ar Array String
|
||||
(optional) hide tags (not the tagged messages themselves)
|
||||
.El
|
||||
|
||||
.sp
|
||||
example configuration:
|
||||
|
||||
.sp
|
||||
.Bd -literal
|
||||
[tags]
|
||||
# valid inputs: #HHHHHH, #ABC -> #AABBCC, XTERM_NAME, 0-255 byte
|
||||
|
@ -650,7 +667,8 @@ auto verify signed e-mail according to RFC3156
|
|||
.\" default value
|
||||
.Pq Em "meli"
|
||||
.It Ic themes Ar hash table String[String[Attribute]]
|
||||
define UI themes. See
|
||||
define UI themes.
|
||||
See
|
||||
.Xr meli-themes 5
|
||||
for details.
|
||||
.Bd -literal
|
||||
|
@ -675,6 +693,8 @@ TOML Standard v.0.5.0 https://github.com/toml-lang/toml/blob/master/versions/en/
|
|||
.Sh AUTHORS
|
||||
Copyright 2017-2019
|
||||
.An Manos Pitsidianakis Aq epilys@nessuent.xyz
|
||||
Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYING for full copyright and warranty notices.)
|
||||
Released under the GPL, version 3 or greater.
|
||||
This software carries no warranty of any kind.
|
||||
(See COPYING for full copyright and warranty notices.)
|
||||
.Pp
|
||||
.Aq https://meli.delivery
|
||||
|
|
Loading…
Reference in New Issue