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.1 9.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  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 July 29, 2019
  21. .Dt MELI 1
  22. .Os Linux
  23. .Sh NAME
  24. .Nm meli
  25. .Nd Meli Mail User Agent. meli is the Greek word for honey.
  26. .Sh SYNOPSIS
  27. .Nm meli
  28. .Op Fl -help | h
  29. .Op Fl -version | v
  30. .Op Fl -create-config Op Ar path
  31. .Op Fl -config Ar path
  32. .Sh DESCRIPTION
  33. Experimental terminal mail client
  34. .Bl -tag -width flag -offset indent
  35. .It Fl -help, h
  36. Show help message and exit.
  37. .It Fl -version, v
  38. Show version and exit.
  39. .It Fl -create-config Op Ar path
  40. Create configuration file in
  41. .Pa path
  42. if given, or at
  43. .Pa $XDG_CONFIG_HOME/meli/config
  44. .It Fl -config Ar path
  45. Start meli with given configuration file.
  46. .El
  47. .Sh STARTING WITH meli
  48. When launched for the first time, meli will search for its configuration directory,
  49. .Pa $XDG_CONFIG_HOME/meli/ Ns
  50. \&. If it doesn't exist, you will be asked if you want to create one along with a sample configuration. The sample configuration
  51. .Pa $XDG_CONFIG_HOME/meli/config
  52. includes comments with the basic settings required for setting up accounts allowing you to copy and edit right away. See
  53. .Xr meli.conf 5
  54. for the available configuration options.
  55. .Pp
  56. At any time, you can press
  57. .Cm \&?
  58. to show a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
  59. .Pp
  60. The main visual navigation tool is the left-side sidebar. The menu's visibility can be toggled (default shortcut
  61. .Cm ` Ns
  62. ).
  63. .Pp
  64. 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).
  65. .Bd -literal
  66. ^^ .-=-=-=-. ^^
  67. ^^ (`-=-=-=-=-`) ^^
  68. (`-=-=-=-=-=-=-`) ^^ ^^
  69. ^^ (`-=-=-=-=-=-=-=-`) ^^
  70. ( `-=-=-=-(@)-=-=-` ) ^^
  71. (`-=-=-=-=-=-=-=-=-`) ^^
  72. (`-=-=-=-=-=-=-=-=-`) ^^
  73. (`-=-=-=-=-=-=-=-=-`)
  74. ^^ (`-=-=-=-=-=-=-=-=-`) ^^
  75. ^^ (`-=-=-=-=-=-=-=-`) ^^
  76. (`-=-=-=-=-=-=-`) ^^
  77. ^^ (`-=-=-=-=-`)
  78. `-=-=-=-=-` ^^
  79. .Ed
  80. .Sh COMPOSING
  81. To send mail, press
  82. .Cm m
  83. while viewing the appropriate account to open a new composing tab. To reply to a mail, press
  84. .Cm R Ns
  85. \&. You can edit some of the header fields from within the view, by selecting with the arrow keys and pressing
  86. .Cm enter
  87. to enter
  88. .Ar INSERT
  89. mode. At any time you can press
  90. .Cm e
  91. to launch your editor (see
  92. .Xr meli.conf 5
  93. .Em COMPOSING
  94. for how to select which editor to launch). Attachments can be handled with the
  95. .Em add-attachment Ns
  96. ,
  97. .Em remove-attachment
  98. commands (see below). Finally, pressing
  99. .Ar s
  100. will send your message by piping it into a binary of your choosing (see
  101. .Xr meli.conf 5
  102. .Em COMPOSING Ns
  103. , setting
  104. .Em mailer_cmd Ns
  105. ). To save your draft without sending it, issue command
  106. .Cm close
  107. and select 'save as draft'.
  108. .Pp
  109. If there is no Draft or Sent folder, meli 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
  110. .Em tmp
  111. directory instead and you will be notified of its location.
  112. .Pp
  113. To open a draft for editing later, select your draft in the mail listing and press
  114. .Cm e Ns
  115. \&.
  116. .Sh EXECUTE mode
  117. Commands are issued in EXECUTE mode, by default started with the space character and exited with Escape key.
  118. .Pp
  119. the following commands are valid in the mail listing context:
  120. .Bl -tag -width "rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST"
  121. .It Ic set Ar plain | threaded | compact | conversations
  122. set the way mailboxes are displayed
  123. .Bl -tag -width "conversations" -compact
  124. .It Cm plain
  125. shows one row per mail, regardless of threading
  126. .It Cm threaded
  127. shows threads as a tree structure, with one row per thread entry
  128. .It Cm conversations
  129. shows one entry per thread
  130. .It Cm compact
  131. shows one row per thread
  132. .El
  133. .It Ic sort Ar subject | date \ Ar asc | desc
  134. sort mail listing
  135. .It Ic subsort Ar subject | date \ Ar asc | desc
  136. sorts only the first level of replies.
  137. .It Ic go Ar n
  138. where
  139. .Ar n
  140. is a mailbox prefixed with the
  141. .Ar n
  142. number in the side menu for the current account
  143. .It Ic toggle_thread_snooze
  144. don't issue notifications for thread under cursor in thread listing
  145. .It Ic filter Ar STRING
  146. filter mailbox with
  147. .Ar STRING
  148. key. Escape exits filter results
  149. .It Ic set read, set unread
  150. .It Ic create-folder Ar ACCOUNT Ar FOLDER_PATH
  151. create folder with given path. be careful with backends and separator sensitivity (eg IMAP)
  152. .It Ic subscribe-folder Ar ACCOUNT Ar FOLDER_PATH
  153. subscribe to folder with given path
  154. .It Ic unsubscribe-folder Ar ACCOUNT Ar FOLDER_PATH
  155. unsubscribe to folder with given path
  156. .It Ic rename-folder Ar ACCOUNT Ar FOLDER_PATH_SRC Ar FOLDER_PATH_DEST
  157. rename folder
  158. .It Ic delete-folder Ar ACCOUNT Ar FOLDER_PATH
  159. delete folder
  160. .El
  161. .Pp
  162. envelope view commands:
  163. .Bl -tag -width "rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST" -offset indent
  164. .It Cm pipe Ar EXECUTABLE Ar ARGS
  165. pipe pager contents to binary
  166. .It Cm list-post
  167. post in list of currently viewed envelope
  168. .It Cm list-unsubscribe
  169. unsubscribe automatically from list of currently viewed envelope
  170. .It Cm list-archive
  171. open list archive with
  172. .Cm xdg-open
  173. .El
  174. .Pp
  175. composing mail commands:
  176. .Bl -tag -width "rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST" -offset indent
  177. .It Ic add-attachment Ar PATH
  178. in composer, add
  179. .Ar PATH
  180. as an attachment
  181. .It Ic remove-attachment Ar INDEX
  182. remove attachment with given index
  183. .It Ic toggle sign
  184. toggle between signing and not signing this message. If the gpg invocation fails then the mail won't be sent.
  185. .El
  186. .Pp
  187. generic commands:
  188. .Bl -tag -width "rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST" -offset indent
  189. .It Cm open-in-tab
  190. opens envelope view in new tab
  191. .It Ic close
  192. closes closeable tabs
  193. .It Cm setenv Ar KEY=VALUE
  194. set environment variable
  195. .Ar KEY
  196. to
  197. .Ar VALUE
  198. .It Cm printenv Ar KEY
  199. print environment variable
  200. .Ar KEY
  201. .El
  202. .Sh SHORTCUTS
  203. Non-complete list of shortcuts and their default values.
  204. .Bl -tag -width "rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST" -offset indent
  205. .It Cm open_thread
  206. \&'\\n'
  207. .It Cm exit_thread
  208. \&'i'
  209. .It Cm create_contact
  210. \&'c'
  211. .It Cm edit_contact
  212. \&'e'
  213. .It Cm prev_page
  214. PageUp,
  215. .It Cm next_page
  216. PageDown
  217. .It Cm prev_folder
  218. \&'K'
  219. .It Cm next_folder
  220. \&'J'
  221. .It Cm prev_account
  222. \&'l'
  223. .It Cm next_account
  224. \&'h'
  225. .It Cm new_mail
  226. \&'m'
  227. .It Cm scroll_up
  228. \&'k'
  229. .It Cm scroll_down
  230. \&'j'
  231. .It Cm page_up
  232. PageUp
  233. .It Cm page_down
  234. PageDown
  235. .It Cm toggle-menu-visibility
  236. \&'`'
  237. .It Cm select
  238. \&'v'
  239. .El
  240. .Bl -tag -width "rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST" -offset indent
  241. .It Cm `
  242. toggles hiding of sidebar in mail listings
  243. .It Cm \&?
  244. opens up a shortcut window that shows available actions in the current component you are using (eg mail listing, contact list, mail composing)
  245. .It Cm m
  246. starts a new mail composer
  247. .It Cm R
  248. replies to the currently viewed mail.
  249. .It Cm u
  250. displays numbers next to urls in the body text of an email and
  251. .Ar n Ns Cm g
  252. opens the
  253. .Ar n Ns
  254. th
  255. url with xdg-open
  256. .It Ar n Ns Cm a
  257. opens the
  258. .Ar n Ns
  259. th
  260. attachment.
  261. .It Cm v
  262. (un)selects mail entries in mail listings
  263. .El
  264. .Sh EXIT STATUS
  265. .Nm
  266. exits with 0 on a successful run. Other exit statuses are:
  267. .Bl -tag -width 2n
  268. .It 1
  269. catchall for general errors
  270. .El
  271. .Sh ENVIRONMENT
  272. .Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
  273. .It Ev EDITOR
  274. Specifies the editor to use
  275. .It Ev MELI_CONFIG
  276. Override the configuration file
  277. .El
  278. .Sh FILES
  279. meli uses the following parts of the XDG standard:
  280. .Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
  281. .It Ev XDG_CONFIG_HOME
  282. defaults to
  283. .Pa ~/.config/
  284. .It Ev XDG_CACHE_HOME
  285. defaults to
  286. .Pa ~/.cache/
  287. .El
  288. .Pp
  289. and appropriates the following locations:
  290. .Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
  291. .It Pa $XDG_CONFIG_HOME/meli/
  292. User configuration directory.
  293. .It Pa $XDG_CONFIG_HOME/meli/config
  294. User configuration file. See
  295. .Xr meli.conf 5
  296. for its syntax and values.
  297. .It Pa $XDG_CONFIG_HOME/meli/hooks/*
  298. Reserved for event hooks.
  299. .It Pa $XDG_CONFIG_HOME/meli/plugins/*
  300. Reserved for plugin files.
  301. .It Pa $XDG_CACHE_HOME/meli/*
  302. Internal cached data used by meli.
  303. .It Pa $XDG_DATA_HOME/meli/*
  304. Internal data used by meli.
  305. .It Pa $XDG_DATA_HOME/meli/meli.log
  306. Operation log.
  307. .It Pa /tmp/meli/*
  308. Temporary files generated by meli.
  309. .El
  310. .Sh SEE ALSO
  311. .Xr xdg-open 1 ,
  312. .Xr meli.conf 5
  313. .Sh CONFORMING TO
  314. XDG Standard
  315. .Aq https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html Ns
  316. , maildir
  317. .Aq https://cr.yp.to/proto/maildir.html
  318. .Sh AUTHORS
  319. Copyright 2017-2019
  320. .An Manos Pitsidianakis Aq epilys@nessuent.xyz
  321. Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYING for full copyright and warranty notices.)
  322. .Pp
  323. .Aq https://meli.delivery