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.

meli.conf.5 8.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. .\" meli - meli.1
  2. .\"
  3. .\" Copyright 2017-2019 Manos Pitsidianakis
  4. .\"
  5. .\" This file is part of meli.
  6. .\"
  7. .\" meli is free software: you can redistribute it and/or modify
  8. .\" it under the terms of the GNU General Public License as published by
  9. .\" the Free Software Foundation, either version 3 of the License, or
  10. .\" (at your option) any later version.
  11. .\"
  12. .\" meli is distributed in the hope that it will be useful,
  13. .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. .\" GNU General Public License for more details.
  16. .\"
  17. .\" You should have received a copy of the GNU General Public License
  18. .\" along with meli. If not, see <http://www.gnu.org/licenses/>.
  19. .\"
  20. .Dd September 16, 2019
  21. .Dt MELI.CONF 5
  22. .Os Linux
  23. .Sh NAME
  24. .Nm meli.conf
  25. .Nd configuration file for the Meli Mail User Agent
  26. .Sh SYNOPSIS
  27. .Pa $XDG_CONFIG_HOME/meli/config
  28. .Sh DESCRIPTION
  29. Configuration for meli is written in TOML. Few things to consider before writing TOML (quoting the spec):
  30. .Pp
  31. .Bl -bullet -compact
  32. .It
  33. TOML is case sensitive.
  34. .It
  35. A TOML file must be a valid UTF-8 encoded Unicode document.
  36. .It
  37. Whitespace means tab (0x09) or space (0x20).
  38. .It
  39. Newline means LF (0x0A) or CRLF (0x0D 0x0A).
  40. .El
  41. .Pp
  42. Refer to TOML documentation for valid TOML syntax.
  43. .Sh SECTIONS
  44. The top level sections of the config are accounts, shortcuts, notifications, pager, composing, pgp.
  45. .Pp
  46. .Sy example configuration
  47. .Bd -literal
  48. # Setting up a Maildir account
  49. [accounts.account-name]
  50. root_folder = "/path/to/root/folder"
  51. format = "Maildir"
  52. index_style = "Compact"
  53. identity="email@address.tld"
  54. subscribed_folders = ["folder", "folder/Sent"]
  55. display_name = "Name"
  56. # Set folder-specific settings
  57. [accounts.account-name.folders]
  58. "INBOX" = { rename="Inbox" } #inline table
  59. "drafts" = { rename="Drafts" } #inline table
  60. [accounts.account-name.folders."foobar-devel"] # or a regular table
  61. ignore = true # don't show notifications for this folder
  62. # Setting up an mbox account
  63. [accounts.mbox]
  64. root_folder = "/var/mail/username"
  65. format = "mbox"
  66. index_style = "Compact"
  67. identity="username@hostname.local"
  68. [pager]
  69. filter = "/usr/bin/pygmentize"
  70. [notifications]
  71. script = "notify-send"
  72. [composing]
  73. # required for sending e-mail
  74. mailer_cmd = 'msmtp --read-recipients --read-envelope-from'
  75. editor_cmd = 'vim +/^$'
  76. [shortcuts]
  77. scroll_up = 'k'
  78. scroll_down = 'j'
  79. page_up = PageUp
  80. page_down = PageDown
  81. .Ed
  82. .Pp
  83. available options are listed below.
  84. .Sy default values are shown in parentheses.
  85. .Sh ACCOUNTS
  86. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  87. .It Cm root_folder Ar String
  88. the backend-specific path of the root_folder, usually INBOX
  89. .It Cm format Ar String Op maildir mbox imap
  90. the format of the mail backend.
  91. .It Cm subscribed_folders Ar [String,]
  92. an array of folder paths to display in the UI. Paths are relative to the root folder (eg "INBOX/Sent", not "Sent")
  93. .It Cm identity Ar String
  94. your e-mail address that is inserted in the From: headers of outgoing mail
  95. .It Cm index_style Ar String
  96. set the way mailboxes are displayed
  97. .Bl -tag -width "conversations" -compact
  98. .It Cm plain
  99. shows one row per mail, regardless of threading
  100. .It Cm threaded
  101. shows threads as a tree structure, with one row per thread entry
  102. .It Cm conversations
  103. shows one entry per thread
  104. .It Cm compact
  105. shows one row per thread
  106. .El
  107. .It Cm display_name Ar String
  108. (optional) a name which can be combined with your address:
  109. "Name <email@address.tld>"
  110. .It Cm html_filter Ar String
  111. (optional) pipe html attachments through this filter before display
  112. .It Cm read_only Ar boolean
  113. attempt to not make any changes to this account.
  114. .Pq Em false
  115. .It Cm folders Ar folder_config
  116. (optional) configuration for each folder. Its format is described below in
  117. .Sx FOLDERS Ns
  118. \&.
  119. .El
  120. .Pp
  121. IMAP specific options are:
  122. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  123. .It Cm server_hostname Ar String
  124. example:
  125. .Qq mail.example.tld
  126. .It Cm server_username Ar String
  127. .It Cm server_password Ar String
  128. .It Cm danger_accept_invalid_certs Ar boolean
  129. (optional) do not validate TLS certificates.
  130. .\" default value
  131. .Pq Em false
  132. .El
  133. .Sh FOLDERS
  134. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  135. .It Cm rename Ar String
  136. (optional) show a different name for this folder in the UI
  137. .It Cm autoload Ar boolean
  138. (optional) load this folder on startup (not functional yet)
  139. .It Cm subscribe Ar boolean
  140. (optional) watch this folder for updates
  141. .\" default value
  142. .Pq Em true
  143. .It Cm ignore Ar boolean
  144. (optional) silently insert updates for this folder, if any
  145. .\" default value
  146. .Pq Em false
  147. .It Cm usage Ar boolean
  148. (optional) special usage of this folder. valid values are:
  149. .Bl -bullet -compact
  150. .It
  151. .Ar Normal
  152. .It
  153. .Ar Inbox
  154. .It
  155. .Ar Archive
  156. .It
  157. .Ar Drafts
  158. .It
  159. .Ar Flagged
  160. .It
  161. .Ar Junk
  162. .It
  163. .Ar Sent
  164. .It
  165. .Ar Trash
  166. .El
  167. otherwise usage is inferred from the folder title.
  168. .It Cm conf_override Ar boolean
  169. (optional) override global settings for this folder. available sections to override are
  170. .Em pager, notifications, shortcuts, composing
  171. and the account options
  172. .Em identity and index_style Ns
  173. \&. example:
  174. .Bd -literal
  175. [accounts."imap.domain.tld".folders."INBOX"]
  176. index_style = "plain"
  177. [accounts."imap.domain.tld".folders."INBOX".pager]
  178. filter = ""
  179. .Ed
  180. .El
  181. .Sh COMPOSING
  182. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  183. .It Cm mailer_cmd Ar String
  184. command to pipe new mail to, exit code must be 0 for success.
  185. .It Cm editor_cmd Ar String
  186. 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.
  187. .El
  188. .Sh SHORTCUTS
  189. Shortcuts can take the following values:
  190. .Qq Em Backspace
  191. .Qq Em Left
  192. .Qq Em Right
  193. .Qq Em Up
  194. .Qq Em Down
  195. .Qq Em Home
  196. .Qq Em End
  197. .Qq Em PageUp
  198. .Qq Em PageDown
  199. .Qq Em Delete
  200. .Qq Em Insert
  201. .Qq Em Esc
  202. and
  203. .Qq Em char Ns
  204. , where char is a single character string.
  205. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  206. .It Cm prev_page
  207. Go to previous page.
  208. .It Cm next_page
  209. Go to next page.
  210. .It Cm prev_folder
  211. Go to previous folder.
  212. .It Cm next_folder
  213. Go to next folder.
  214. .It Cm prev_account
  215. Go to previous account.
  216. .It Cm next_account
  217. Go to next account.
  218. .It Cm new_mail
  219. Start new mail draft in new tab
  220. .It Cm open_thread
  221. Open thread.
  222. .It Cm exit_thread
  223. Exit thread view
  224. .It Cm scroll_up
  225. Scroll up pager.
  226. .It Cm scroll_down
  227. Scroll down pager.
  228. .It Cm page_up
  229. Go to previous pager page
  230. .It Cm page_down
  231. Go to next pager pag
  232. .It Cm create_contact
  233. Create new contact.
  234. .It Cm edit_contact
  235. Edit contact under cursor
  236. .El
  237. .Sh NOTIFICATIONS
  238. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  239. .It Cm enable Ar boolean
  240. enable freedesktop-spec notifications. this is usually what you want
  241. .\" default value
  242. .Pq Em true
  243. .It Cm script Ar String
  244. (optional) script to pass notifications to, with title as 1st arg and body as 2nd
  245. .\" default value
  246. .Pq Em none
  247. .It Cm xbiff_file_path Ar String
  248. (optional) file that gets its size updated when new mail arrives
  249. .Pq Em none
  250. .\" default value
  251. .It Cm play_sound Ar boolean
  252. (optional) play theme sound in notifications if possible
  253. .Pq Em false
  254. .\" default value
  255. .It Cm sound_file Ar String
  256. (optional) play sound file in notifications if possible
  257. .\" default value
  258. .Pq Em none
  259. .El
  260. .Sh PAGER
  261. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  262. .It Cm pager_context Ar num
  263. (optional) number of context lines when going to next page.
  264. .\" default value
  265. .Pq Em 0
  266. .It Cm headers_sticky Ar boolean
  267. (optional) always show headers when scrolling.
  268. .\" default value
  269. .Pq Em false
  270. .It Cm filter Ar String
  271. (optional) a command to pipe mail output through for viewing in pager.
  272. .\" default value
  273. .Pq Em none
  274. .El
  275. .Sh PGP
  276. .Bl -tag -width "danger_accept_invalid_certs boolean" -offset -indent
  277. .It Cm auto_verify_signatures Ar boolean
  278. auto verify signed e-mail according to RFC3156
  279. .\" default value
  280. .Pq Em true
  281. .It Cm auto_sign Ar boolean
  282. (optional) always sign sent messages
  283. .\" default value
  284. .Pq Em false
  285. .It Cm key Ar String
  286. (optional) key to be used when signing/encrypting (not functional yet)
  287. .\" default value
  288. .Pq Em none
  289. .It Cm gpg_binary Ar String
  290. (optional) gpg binary name or file location to use
  291. .\" default value
  292. .Pq Em "gpg2"
  293. .El
  294. .Sh SEE ALSO
  295. .Xr meli 1
  296. .Sh CONFORMING TO
  297. TOML Standard v.0.5.0 https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md
  298. .Sh AUTHORS
  299. Copyright 2017-2019
  300. .An Manos Pitsidianakis Aq epilys@nessuent.xyz
  301. Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYING for full copyright and warranty notices.)
  302. .Pp
  303. .Aq https://meli.delivery