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 6.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  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.
  53. .Pp
  54. At any time, you can press
  55. .Cm \&?
  56. to show a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
  57. .Pp
  58. The main visual navigation tool is the left-side sidebar. The menu's visibility can be toggled (default shortcut
  59. .Cm ` Ns
  60. ).
  61. .Pp
  62. 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.
  63. .Bd -literal
  64. ^^ .-=-=-=-. ^^
  65. ^^ (`-=-=-=-=-`) ^^
  66. (`-=-=-=-=-=-=-`) ^^ ^^
  67. ^^ (`-=-=-=-=-=-=-=-`) ^^
  68. ( `-=-=-=-(@)-=-=-` ) ^^
  69. (`-=-=-=-=-=-=-=-=-`) ^^
  70. (`-=-=-=-=-=-=-=-=-`) ^^
  71. (`-=-=-=-=-=-=-=-=-`)
  72. ^^ (`-=-=-=-=-=-=-=-=-`) ^^
  73. ^^ (`-=-=-=-=-=-=-=-`) ^^
  74. (`-=-=-=-=-=-=-`) ^^
  75. ^^ (`-=-=-=-=-`)
  76. `-=-=-=-=-` ^^
  77. .Ed
  78. .Sh EXECUTE mode
  79. Commands are issued in EXECUTE mode, by default started with the space character and exited with Escape key.
  80. .Bl -tag -width "Cm subsort Op Ar subject | date Op asc | desc"
  81. .It Cm set Ar plain | threaded | compact
  82. set the way mailboxes are displayed
  83. .Bl -tag -width "threaded" -compact
  84. .It Cm plain
  85. shows one row per mail, regardless of threading
  86. .It Cm threaded
  87. shows threads as a tree structure, with one row per thread entry
  88. .It Cm compact
  89. shows one row per thread
  90. .El
  91. .It Cm sort Ar subject | date \ Ar asc | desc
  92. sort mail listing
  93. .It Cm subsort Ar subject | date \ Ar asc | desc
  94. sorts only the first level of replies.
  95. .It Cm close
  96. closes closeable tabs
  97. .It Cm go Ar n
  98. where
  99. .Ar n
  100. is a mailbox prefixed with the
  101. .Ar n
  102. number in the side menu for the current account
  103. .It Cm toggle_thread_snooze
  104. don't issue notifications for thread under cursor in thread listing
  105. .It Cm filter Ar STRING
  106. filter mailbox with
  107. .Ar STRING
  108. key. Escape exits filter results
  109. .It Cm list-post
  110. post in list of currently viewed envelope
  111. .It Cm list-unsubscribe
  112. unsubscribe automatically from list of currently viewed envelope
  113. .It Cm list-archive
  114. open list archive with
  115. .Cm xdg-open
  116. .It Cm set read, set unread
  117. .It Cm setenv Ar KEY=VALUE
  118. set environment variable
  119. .Ar KEY
  120. to
  121. .Ar VALUE
  122. .It Cm printenv KEY
  123. print environment variable
  124. .Ar KEY
  125. .El
  126. .Sh SHORTCUTS
  127. Non-complete list of shortcuts and their default values.
  128. .Bl -tag -width "create_contact" -offset indent
  129. .It Cm open_thread
  130. \&'\\n'
  131. .It Cm exit_thread
  132. \&'i'
  133. .It Cm create_contact
  134. \&'c'
  135. .It Cm edit_contact
  136. \&'e'
  137. .It Cm prev_page
  138. PageUp,
  139. .It Cm next_page
  140. PageDown
  141. .It Cm prev_folder
  142. \&'K'
  143. .It Cm next_folder
  144. \&'J'
  145. .It Cm prev_account
  146. \&'l'
  147. .It Cm next_account
  148. \&'h'
  149. .It Cm new_mail
  150. \&'m'
  151. .It Cm scroll_up
  152. \&'k'
  153. .It Cm scroll_down
  154. \&'j'
  155. .It Cm page_up
  156. PageUp
  157. .It Cm page_down
  158. PageDown
  159. .El
  160. .Bl -tag -width "<n>a" -offset indent
  161. .It Cm `
  162. toggles hiding of sidebar in mail listings
  163. .It Cm \&?
  164. opens up a shortcut window that shows available actions in the current component you are using (eg mail listing, contact list, mail composing)
  165. .It Cm m
  166. starts a new mail composer
  167. .It Cm R
  168. replies to the currently viewed mail.
  169. .It Cm u
  170. displays numbers next to urls in the body text of an email and
  171. .Ar n Ns Cm g
  172. opens the
  173. .Ar n Ns
  174. th
  175. url with xdg-open
  176. .It Ar n Ns Cm a
  177. opens the
  178. .Ar n Ns
  179. th
  180. attachment.
  181. .El
  182. .Sh EXIT STATUS
  183. .Nm
  184. exits with 0 on a successful run. Other exit statuses are:
  185. .Bl -tag -width 2n
  186. .It 1
  187. catchall for general errors
  188. .El
  189. .Sh ENVIRONMENT
  190. .Bl -tag -width "Ev MELI_CONFIG" -offset indent
  191. .It Ev EDITOR
  192. Specifies the editor to use
  193. .It Ev MELI_CONFIG
  194. Override the configuration file
  195. .El
  196. .Sh FILES
  197. meli uses the following parts of the XDG standard:
  198. .Bl -tag -width "XDG_CONFIG_HOME" -offset indent
  199. .It Ev XDG_CONFIG_HOME
  200. defaults to
  201. .Pa ~/.config/
  202. .It Ev XDG_CACHE_HOME
  203. defaults to
  204. .Pa ~/.cache/
  205. .El
  206. .Pp
  207. and appropriates the following locations:
  208. .Bl -tag -width "$XDG_CONFIG_HOME/meli/plugins/*" -offset indent
  209. .It Pa $XDG_CONFIG_HOME/meli/
  210. User configuration directory.
  211. .It Pa $XDG_CONFIG_HOME/meli/config
  212. User configuration file.
  213. .It Pa $XDG_CONFIG_HOME/meli/hooks/*
  214. Reserved for event hooks.
  215. .It Pa $XDG_CONFIG_HOME/meli/plugins/*
  216. Reserved for plugin files.
  217. .It Pa $XDG_CACHE_HOME/meli/*
  218. Internal cached data used by meli.
  219. .It Pa /tmp/meli/*
  220. Temporary files generated by meli.
  221. .El
  222. .Sh SEE ALSO
  223. .Xr xdg-open 1
  224. .Sh CONFORMING TO
  225. XDG Standard
  226. .Aq https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html Ns
  227. , maildir
  228. .Aq https://cr.yp.to/proto/maildir.html
  229. .Sh AUTHORS
  230. Copyright 2017-2019
  231. .An Manos Pitsidianakis Aq epilys@nessuent.xyz
  232. Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYING for full copyright and warranty notices.)
  233. .Pp
  234. .Aq https://meli.delivery