| 1 | .\" meli - meli.7 |
| 2 | .\" |
| 3 | .\" Copyright 2017-2022 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 | .\".de Hr |
| 21 | .\".Bd -literal -offset center |
| 22 | .\"╌╍─────────────────────────────────────────────────────────╍╌ |
| 23 | .\".Ed |
| 24 | .\".. |
| 25 | .de Shortcut |
| 26 | .Sm |
| 27 | .Aq \\$1 |
| 28 | \ |
| 29 | .Po |
| 30 | .Em shortcuts.\\$2\&. Ns |
| 31 | .Em \\$3 |
| 32 | .Pc |
| 33 | .Sm |
| 34 | .. |
| 35 | .de ShortcutPeriod |
| 36 | .Aq \\$1 |
| 37 | .Po |
| 38 | .Em shortcuts.\\$2\&. Ns |
| 39 | .Em \\$3 |
| 40 | .Pc Ns |
| 41 | .. |
| 42 | .de Command |
| 43 | .Bd -ragged -offset 1n |
| 44 | .Cm \\$* |
| 45 | .Ed |
| 46 | .. |
| 47 | .\".Dd November 11, 2022 |
| 48 | .Dd March 10, 2024 |
| 49 | .Dt MELI 7 |
| 50 | .Os |
| 51 | .Sh NAME |
| 52 | .Nm meli |
| 53 | .Nd Tutorial for the meli terminal e\-mail client |
| 54 | .Sh SYNOPSIS |
| 55 | .Nm |
| 56 | .Op ... |
| 57 | .Sh DESCRIPTION |
| 58 | .Nm |
| 59 | is a terminal mail client aiming for extensive and user\-friendly configurability. |
| 60 | .Bd -literal -offset center |
| 61 | ^^ .-=-=-=-. ^^ |
| 62 | ^^ (`-=-=-=-=-`) ^^ |
| 63 | (`-=-=-=-=-=-=-`) ^^ ^^ |
| 64 | ^^ (`-=-=-=-=-=-=-=-`) ^^ |
| 65 | ( `-=-=-=-(@)-=-=-` ) ^^ |
| 66 | (`-=-=-=-=-=-=-=-=-`) ^^ |
| 67 | (`-=-=-=-=-=-=-=-=-`) ^^ |
| 68 | (`-=-=-=-=-=-=-=-=-`) |
| 69 | ^^ (`-=-=-=-=-=-=-=-=-`) ^^ |
| 70 | ^^ (`-=-=-=-=-=-=-=-`) ^^ |
| 71 | (`-=-=-=-=-=-=-`) ^^ |
| 72 | ^^ (`-=-=-=-=-`) |
| 73 | `-=-=-=-=-` ^^ |
| 74 | .Ed |
| 75 | .Sh INTRODUCTION |
| 76 | To quit |
| 77 | .Nm |
| 78 | press |
| 79 | .Shortcut q general quit |
| 80 | at any time. |
| 81 | When launched for the first time, |
| 82 | .Nm |
| 83 | will search for its configuration directory, |
| 84 | .Pa $XDG_CONFIG_HOME/meli/ Ns |
| 85 | \&. |
| 86 | If it doesn't exist, you will be asked if you want to create one and presented with a sample configuration file |
| 87 | .Pq Pa $XDG_CONFIG_HOME/meli/config.toml |
| 88 | that includes the basic settings required for setting up accounts allowing you to copy and edit right away. |
| 89 | See |
| 90 | .Xr meli.conf 5 |
| 91 | for the available configuration options. |
| 92 | .Pp |
| 93 | At any time, you may press |
| 94 | .Shortcut \&? general toggle_help |
| 95 | for a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports. |
| 96 | .Pp |
| 97 | Each time a shortcut is mentioned in this document, you will find a parenthesis next to it with the name of the shortcut setting along with its section in the configuration settings so that you can modify it if you wish. |
| 98 | .Pp |
| 99 | For example, to set the |
| 100 | .Em toggle_help |
| 101 | shortcut mentioned in the previous paragraph, add the following to your configuration: |
| 102 | .Bd -literal -offset center |
| 103 | [shortcuts] |
| 104 | general.toggle_help = 'F1' |
| 105 | .Ed |
| 106 | .sp |
| 107 | Or alternatively: |
| 108 | .Bd -literal -offset center |
| 109 | [shortcuts.general] |
| 110 | toggle_help = 'F1' |
| 111 | .Ed |
| 112 | .Pp |
| 113 | To go to the next tab on the right, press |
| 114 | .ShortcutPeriod T general next_tab |
| 115 | \&. |
| 116 | .Sh INTERACTING WITH Nm |
| 117 | You will be interacting with |
| 118 | .Nm |
| 119 | in four primary ways: |
| 120 | .Bl -column |
| 121 | .It 1. |
| 122 | keyboard shortcuts in |
| 123 | .Sy NORMAL |
| 124 | mode. |
| 125 | .It 2. |
| 126 | commands with arguments in |
| 127 | .Sy COMMAND |
| 128 | mode. |
| 129 | .It 3. |
| 130 | regular text input in text input widgets in |
| 131 | .Sy INSERT |
| 132 | mode. |
| 133 | .It 4. |
| 134 | any kind of input that gets passed directly into an embedded terminal in |
| 135 | .Sy EMBED |
| 136 | mode. |
| 137 | .El |
| 138 | .Sh MODES |
| 139 | .Nm |
| 140 | is a modal application, just like |
| 141 | .Xr vi 1 Ns |
| 142 | \&. |
| 143 | This means that pressing the same keys in different modes would yield different results. |
| 144 | This allows you to separate how the input is interpreted without the need to focus your input with a mouse. |
| 145 | .Bl -tag -width 8n |
| 146 | .It NORMAL |
| 147 | This is the default mode of |
| 148 | .Nm Ns |
| 149 | \&. |
| 150 | All keyboard shortcuts work in this mode. |
| 151 | .It COMMAND |
| 152 | Commands are issued in |
| 153 | .Sy COMMAND |
| 154 | mode, by default started with |
| 155 | .Shortcut \&: general enter_command_mode |
| 156 | and exited with |
| 157 | .Aq Esc |
| 158 | key. |
| 159 | .It EMBED |
| 160 | This is the mode of the embed terminal emulator. |
| 161 | To exit an embedded application, issue |
| 162 | .Aq Ctrl\-C |
| 163 | to kill it or |
| 164 | .Aq Ctrl\-Z |
| 165 | to stop the program and follow the instructions on |
| 166 | .Nm |
| 167 | to exit. |
| 168 | .It INSERT |
| 169 | This mode is entered when pressing |
| 170 | .Aq Enter |
| 171 | on a cursor selected text input field, and it captures all input as text input. |
| 172 | It is exited with the |
| 173 | .Aq Esc |
| 174 | key. |
| 175 | .El |
| 176 | .Sh ACTIVE SHORTCUTS POPUP |
| 177 | By pressing |
| 178 | .Shortcut \&? general toggle_help |
| 179 | at any time, the shortcuts popup display status gets toggled. |
| 180 | You can find all valid shortcuts for the current UI state you are in. |
| 181 | .Bd -literal -offset center |
| 182 | ┌─shortcuts──Press ? to close────────────────────────────────┐ |
| 183 | │ ▀│ |
| 184 | │ use COMMAND "search" to find shortcuts █│ |
| 185 | │ Use Up, Down, Left, Right to scroll. █│ |
| 186 | │ █│ |
| 187 | │ pager █│ |
| 188 | │ █│ |
| 189 | │ PageDown page_down █│ |
| 190 | │ PageUp page_up │ |
| 191 | │ j scroll_down │ |
| 192 | │ k scroll_up │ |
| 193 | │ │ |
| 194 | │ view mail │ |
| 195 | │ │ |
| 196 | │ c add_addresses_to_contacts │ |
| 197 | │ e edit │ |
| 198 | │ u toggle_url_mode │ |
| 199 | │ a open_attachment │ |
| 200 | │ m open_mailcap │ |
| 201 | │ R reply │ |
| 202 | │ C-r reply_to_author │ |
| 203 | │ C-g reply_to_all │ |
| 204 | │ C-f forward │ |
| 205 | │ M-r view_raw_source │ |
| 206 | │ h toggle_expand_headers ▄│ |
| 207 | └────────────────────────────────────────────────────────────┘ |
| 208 | .Ed |
| 209 | .Bd -ragged -offset 3n |
| 210 | .Em Shows\ active\ shortcuts\ in\ order\ of\ the\ widget\ hierarchy\&. |
| 211 | .Ed |
| 212 | .Sh MAIN VIEW |
| 213 | .Bd -literal -offset center |
| 214 | ┌───────────────────────┐ |
| 215 | ├────┼──────────────────┤ |
| 216 | │___ │ ___________ │ |
| 217 | │ _ │ _______________ │ |
| 218 | │ _ │__________________│ |
| 219 | │ _ │ ___________ │ |
| 220 | │ │ _____ │ |
| 221 | │ │ │ |
| 222 | └────┴──────────────────┘ |
| 223 | .Ed |
| 224 | .Bd -ragged -offset 3n |
| 225 | .Em The\ main\ view's\ layout\&. |
| 226 | .Ed |
| 227 | .sp |
| 228 | This is the view you will spend more time with in |
| 229 | .Nm Ns |
| 230 | \&. |
| 231 | .Pp |
| 232 | Press |
| 233 | .Shortcut \(ga listing toggle_menu_visibility |
| 234 | to toggle the sidebars visibility. |
| 235 | .Pp |
| 236 | Press |
| 237 | .Shortcut Left listing focus_right |
| 238 | to switch focus on the sidebar menu. |
| 239 | Press |
| 240 | .Shortcut Right listing focus_left |
| 241 | to switch focus on the e\-mail list. |
| 242 | .Pp |
| 243 | On the e\-mail list, press |
| 244 | .Shortcut k listing scroll_up |
| 245 | to scroll up, and |
| 246 | .Shortcut j listing scroll_down |
| 247 | to scroll down. |
| 248 | Press |
| 249 | .Shortcut Enter listing open_entry |
| 250 | to open an e\-mail entry and |
| 251 | .Shortcut i listing exit_entry |
| 252 | to exit it. |
| 253 | .Bd -ragged |
| 254 | .Sy The sidebar\&. |
| 255 | .Ed |
| 256 | .Bd -literal -offset center |
| 257 | ┌─────────────┉┉┉┉┉✂ |
| 258 | │ mail▐ contact li✂ |
| 259 | │personal account ✂ |
| 260 | │ 0 INBOX ✂ |
| 261 | │ 1 ┣━Sent ✂ |
| 262 | │ 2 ┣━Lists ✂ |
| 263 | │ 3 ┃ ┣━meli-dev ✂ |
| 264 | │ 4 ┃ ┗━meli ✂ |
| 265 | │ 5 ┣━Drafts ✂ |
| 266 | │ 6 ┣━Trash ✂ |
| 267 | │ 7 ┗━foobar ✂ |
| 268 | ┇ 8 Trash ✂ |
| 269 | ✂ ✂ ✂ ✂ ✂ ✂ ✂ ✂ ✂ ✂ |
| 270 | .Ed |
| 271 | .sp |
| 272 | Press |
| 273 | .Shortcut k listing scroll_up |
| 274 | to scroll up, and |
| 275 | .Shortcut j listing scroll_down |
| 276 | to scroll down. |
| 277 | .Pp |
| 278 | Press |
| 279 | .Shortcut Enter listing open_mailbox |
| 280 | to open an entry (either a mailbox or an account name). |
| 281 | Entering an account name will show you a page with details about the account and its network connection, depending on the backend. |
| 282 | .Pp |
| 283 | While focused in the sidebar, you can |
| 284 | .Dq collapse |
| 285 | a mailbox tree, if it has children, and you can open it with |
| 286 | .ShortcutPeriod Space listing toggle_mailbox_collapse |
| 287 | \&. |
| 288 | You can have mailbox trees collapsed on startup by default by setting a mailbox's |
| 289 | .Ic collapsed |
| 290 | setting to |
| 291 | .Em true Ns |
| 292 | \&. |
| 293 | See |
| 294 | .Xr meli.conf 5 section MAILBOXES |
| 295 | for details. |
| 296 | .Pp |
| 297 | You can increase the sidebar's width with |
| 298 | .Shortcut Ctrl\-p listing increase_sidebar |
| 299 | and decrease with |
| 300 | .ShortcutPeriod Ctrl\-o listing decrease_sidebar |
| 301 | \&. |
| 302 | .Bd -ragged |
| 303 | .Sy The status bar. |
| 304 | .Ed |
| 305 | .Bd -literal -offset center |
| 306 | ┌────────────────────────────────────────────────────┈┈ |
| 307 | │NORMAL | Mailbox: Inbox, Messages: 25772, New: 3006 |
| 308 | └────────────────────────────────────────────────────┈┈ |
| 309 | .Ed |
| 310 | .Pp |
| 311 | The status bar shows which mode you are, and the status message of the current view. |
| 312 | In the pictured example, it shows the status of a mailbox called |
| 313 | .Dq Inbox |
| 314 | with lots of e\-mails. |
| 315 | .Bd -ragged |
| 316 | .Sy The number modifier buffer. |
| 317 | .Ed |
| 318 | .Bd -literal -offset center |
| 319 | ┈┈────────────┐ |
| 320 | 12 │ |
| 321 | ┈┈────────────┘ |
| 322 | .Ed |
| 323 | .Pp |
| 324 | Some commands may accept a number modifier. |
| 325 | .Tg number-modifier |
| 326 | For example, scroll down commands can receive a multiplier |
| 327 | .Em n |
| 328 | to scroll down |
| 329 | .Em n |
| 330 | entries. |
| 331 | Another use of the number buffer is opening URLs inside the pager. |
| 332 | See |
| 333 | .Sx PAGER |
| 334 | for an explanation of interacting with URLs in e\-mails. |
| 335 | .Pp |
| 336 | Pressing numbers in |
| 337 | .Sy NORMAL |
| 338 | mode will populate this buffer. |
| 339 | To erase it, press the |
| 340 | .Aq Esc |
| 341 | key. |
| 342 | .Sh MAIL LIST |
| 343 | There are four different list styles: |
| 344 | .Bl -hyphen -compact |
| 345 | .It |
| 346 | .Qq plain |
| 347 | which shows one line per e\-mail. |
| 348 | .It |
| 349 | .Qq threaded |
| 350 | which shows a threaded view with drawn tree structure. |
| 351 | .It |
| 352 | .Qq compact |
| 353 | which shows one line per thread which can include multiple e\-mails. |
| 354 | .It |
| 355 | .Qq conversations |
| 356 | which shows more than one line per thread which can include multiple e\-mails with more details about the thread. |
| 357 | .El |
| 358 | .Bd -ragged |
| 359 | .Sy Plain view\&. |
| 360 | .Ed |
| 361 | .Bd -literal -offset center |
| 362 | │42 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH 3/8] │ |
| 363 | │43 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH 2/8] │ |
| 364 | │44 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH 1/8] │ |
| 365 | |45 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH 0/8] | |
| 366 | │46 Fri, 02 Sep 2022 18:18 xxxxxxxx <xxxxx Re: [PATCH 3│ |
| 367 | .Ed |
| 368 | .Bd -ragged |
| 369 | .Sy Threaded view\&. |
| 370 | .Ed |
| 371 | .Bd -literal -offset center |
| 372 | │12 9 hours ago xxxxxxxxxxxxxxx [PATCH v3 0│ |
| 373 | │13 9 hours ago xxxxxxxxxxxxxxx ├─>[PATCH │ |
| 374 | │14 9 hours ago xxxxxxxxxxxxxxx ├─>[PATCH │ |
| 375 | |15 9 hours ago xxxxxxxxxxxxxxx ├─>[PATCH | |
| 376 | │16 9 hours ago xxxxxxxxxxxxxxx ├─>[PATCH │ |
| 377 | │17 9 hours ago xxxxxxxxxxxxxxx └─>[PATCH │ |
| 378 | │18 2022-08-23 01:23:51 xxxxxxxxxxxxxxx [RFC v4 00/│ |
| 379 | │19 2022-08-23 01:23:52 xxxxxxxxxxxxxxx ├─>[RFC v4│ |
| 380 | |20 2022-08-30 10:30:16 xxxxxxxxxxxxxxx │ └─> | |
| 381 | │21 6 days ago xxxxxxxxxxxxxxx │ └─> │ |
| 382 | │22 2022-08-23 01:23:53 xxxxxxxxxxxxxxx ├─>[RFC v4│ |
| 383 | .Ed |
| 384 | .Bd -ragged |
| 385 | .Sy Compact view\&. |
| 386 | .Ed |
| 387 | .Bd -literal -offset center |
| 388 | │18 2022-…:38 xxxxxxxxxxxxxxx [PATCH v3 3/3] u…_l() (2) │ |
| 389 | |19 2022-…:49 xxxxxxxxxxxxxxx [PATCH v8 0/7] A…e (3) | |
| 390 | │20 2022-…:10 xxxxxxxxxxxxxxx [PATCH v8 2/7] f…s (2) │ |
| 391 | │21 2022-…:38 xxxxxxxxxxxxxxx [PATCH v8 3/7] b…s (2) │ |
| 392 | │22 2022-…:53 xxxxxxxxxxxxxxx [PATCH v6 00/10] p…g (31) │ |
| 393 | .Ed |
| 394 | .Bd -ragged |
| 395 | .Sy Conversations view\&. |
| 396 | .Ed |
| 397 | .Bd -literal -offset center |
| 398 | │[PATCH v2] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (5) │ |
| 399 | |1 day ago▁▁▁▁xxxxxxxxxxxxx <xxxxxxxxxxxxx@xxxxxxxxxx>, xxxxx│ |
| 400 | │ | |
| 401 | │[PATCH v2 0/8] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx│ |
| 402 | │1 day ago▁▁▁▁xxxxxxxxxxxxxxx <xxxxxxxxxx@xxxxxxxxxxxxxx>, xx│ |
| 403 | | │ |
| 404 | │[PATCH 0/2] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (4) | |
| 405 | │2 days ago▁▁▁▁xxxxxxxxxxxxxxxx <xxxxxxxx@xxxxxxxxxxx>, xxxxx│ |
| 406 | │ │ |
| 407 | │[PATCH 0/8] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (12) │ |
| 408 | │2 days ago▁▁▁▁xxxxxxxxxxxxx <xxxxxxxx@xxxxxxxxxx>, xxxxxxxxx│ |
| 409 | .Ed |
| 410 | .sp |
| 411 | .sp |
| 412 | .Sy Performing actions on entries and/or selections\&. |
| 413 | .Pp |
| 414 | Press |
| 415 | .Shortcut v listing select_entry |
| 416 | to toggle the selection of a single entry. |
| 417 | .Qq select_entry |
| 418 | can be prefixed by a number modifier and affixed by a scrolling motion (up or down) to select multiple entries. |
| 419 | .Tg number-modifier |
| 420 | Simple set operations can be performed on a selection with these shortcut modifiers: |
| 421 | .sp |
| 422 | .Bl -hyphen -compact |
| 423 | .It |
| 424 | Union modifier: |
| 425 | .Shortcut Ctrl\-u listing union_modifier |
| 426 | .It |
| 427 | Difference modifier: |
| 428 | .Shortcut Ctrl\-d listing diff_modifier |
| 429 | .It |
| 430 | Intersection modifier: |
| 431 | .Shortcut Ctrl\-i listing intersection_modifier |
| 432 | .El |
| 433 | .Pp |
| 434 | To set an entry as |
| 435 | .Qq read |
| 436 | \&, use the |
| 437 | .Shortcut n listing set_seen |
| 438 | shortcut. |
| 439 | To set an entry as |
| 440 | .Qq unread |
| 441 | \&, use the command |
| 442 | .Command set unseen |
| 443 | .sp |
| 444 | which also has its complement |
| 445 | .Command set seen |
| 446 | .sp |
| 447 | action. |
| 448 | .Pp |
| 449 | For e\-mail backends that support flags you can use the following commands on entries and selections to modify them: |
| 450 | .Command flag set FLAG |
| 451 | .Command flag unset FLAG |
| 452 | .Pp |
| 453 | For e\-mail backends that support tags |
| 454 | .Po |
| 455 | like |
| 456 | .Qq IMAP |
| 457 | or |
| 458 | .Qq notmuch Ns |
| 459 | .Pc |
| 460 | you can use the following commands on entries and selections to modify them: |
| 461 | .Command tag add TAG |
| 462 | .Command tag remove TAG |
| 463 | .sp |
| 464 | (see |
| 465 | .Xr meli.conf 5 TAGS Ns |
| 466 | , settings |
| 467 | .Ic colors |
| 468 | and |
| 469 | .Ic ignore_tags |
| 470 | for how to set tag colors and tag visibility) |
| 471 | You can clear the selection with the |
| 472 | .Aq Esc |
| 473 | key. |
| 474 | .Sh PAGER |
| 475 | You can open an e\-mail entry by pressing |
| 476 | .ShortcutPeriod Enter listing open_entry |
| 477 | \&. This brings up the e\-mail view with the e\-mail content inside a pager. |
| 478 | .Bd -literal -offset center |
| 479 | ┌────────────────────────────────────────────────────────────┐ |
| 480 | │Date: Sat, 21 May 2022 16:16:11 +0300 ▀│ |
| 481 | │From: Narrator <narrator@example.com> █│ |
| 482 | │To: Stanley <427@example.com> █│ |
| 483 | │Subject: The e-mail ending █│ |
| 484 | │Message-ID: <gambheerata@example.com> █│ |
| 485 | │ █│ |
| 486 | │The story, and the choices, or what have you, and therefore█│ |
| 487 | │by becoming it is! So on and so forth, until inevitably, we │ |
| 488 | │all until the end of time. At which time, everything all at │ |
| 489 | │once, so now you see? Blah, blah, blah, rah, rah, rah... │ |
| 490 | │We've eaten too much and it can't be just yet. No, no! │ |
| 491 | │Until two-hundred and forty-five! But the logic of │ |
| 492 | │elimination, working backwards, the deduction therefore │ |
| 493 | │becomes impossible to manufacture. It went on for nearly │ |
| 494 | │ten thousand years, until just yesterday. Here and there, │ |
| 495 | │forward and back, and never a moment before lunchtime. It │ |
| 496 | │can't be! It's the only thing there is! How many billions │ |
| 497 | │left until so much more than forever ago! Which is why I │ |
| 498 | │say: │ |
| 499 | │ │ |
| 500 | │The story, and the choices, or what have you, and therefore │ |
| 501 | │by becoming it is! So on and so forth, until inevitably, we▄│ |
| 502 | └────────────────────────────────────────────────────────────┘ |
| 503 | .Ed |
| 504 | .Bd -ragged -offset 3n |
| 505 | .Em The\ pager\ displaying\ an\ e\-mail\&. |
| 506 | .Ed |
| 507 | .Pp |
| 508 | The pager is simple to use. |
| 509 | Scroll with the following: |
| 510 | .Bl -hang -width 27n |
| 511 | .It Go to next pager page |
| 512 | .Shortcut PageDown pager page_down |
| 513 | .It Go to previous pager page |
| 514 | .Shortcut PageUp pager page_up |
| 515 | .It Scroll down pager. |
| 516 | .Shortcut j pager scroll_down |
| 517 | .It Scroll up pager. |
| 518 | .Shortcut k pager scroll_up |
| 519 | .El |
| 520 | .sp |
| 521 | All scrolling shortcuts can be prefixed with a number modifier |
| 522 | .Tg number-modifier |
| 523 | which will act as a multiplier. |
| 524 | .Pp |
| 525 | The pager can enter a special |
| 526 | .Em url |
| 527 | mode which will prefix all detected hyperlinks and e\-mail addresses with a number inside square brackets |
| 528 | .ShortcutPeriod u pager toggle_url_mode |
| 529 | \&. |
| 530 | Writing down a chosen number as a number modifier |
| 531 | .Tg number-modifier |
| 532 | and pressing |
| 533 | .Shortcut g envelope_view go_to_url |
| 534 | will attempt to open the link with the system's default open command |
| 535 | .Po |
| 536 | .Xr xdg-open 1 |
| 537 | in supported OSes, |
| 538 | and |
| 539 | .Xr open 1 |
| 540 | on MacOS |
| 541 | .Pc Ns |
| 542 | \&. |
| 543 | To override with a custom launcher, see |
| 544 | .Qo |
| 545 | .Li pager |
| 546 | .Qc |
| 547 | configuration setting |
| 548 | .Qo |
| 549 | .Li url_launcher |
| 550 | .Qc |
| 551 | .Po |
| 552 | see |
| 553 | .Xr meli.conf 5 PAGER |
| 554 | for more details |
| 555 | .Pc Ns |
| 556 | \&. |
| 557 | .Sh MAIL VIEW |
| 558 | Other things you can do when viewing e\-mail: |
| 559 | .Bl -dash -compact |
| 560 | .It |
| 561 | Most importantly, you can exit the mail view with: |
| 562 | .Shortcut i listing exit_entry |
| 563 | .It |
| 564 | Add addresses from the e\-mail headers to contacts: |
| 565 | .Shortcut c envelope_view add_addresses_to_contacts |
| 566 | .It |
| 567 | Open an attachment by entering its index as a number modifier and pressing: |
| 568 | .Tg number-modifier |
| 569 | .Shortcut a envelope_view open_attachment |
| 570 | .It |
| 571 | Open an attachment by its |
| 572 | .Xr mailcap 4 |
| 573 | entry by entering its index as a number modifier and pressing: |
| 574 | .Shortcut m envelope_view open_mailcap |
| 575 | .It |
| 576 | Reply to envelope: |
| 577 | .Shortcut R envelope_view reply |
| 578 | .It |
| 579 | Reply to author: |
| 580 | .Shortcut Ctrl\-r envelope_view reply_to_author |
| 581 | .It |
| 582 | Reply to all/Reply to list/Follow up: |
| 583 | .Shortcut Ctrl\-g envelope_view reply_to_all |
| 584 | .It |
| 585 | Forward e\-mail: |
| 586 | .Shortcut Ctrl\-f envelope_view forward |
| 587 | .It |
| 588 | Expand extra headers: (References and others) |
| 589 | .Shortcut h envelope_view toggle_expand_headers |
| 590 | .It |
| 591 | View envelope source in a pager: (toggles between raw and decoded source) |
| 592 | .Shortcut M\-r envelope_view view_raw_source |
| 593 | .It |
| 594 | Return to envelope_view if viewing raw source or attachment: |
| 595 | .Shortcut r envelope_view return_to_normal_view |
| 596 | .El |
| 597 | .Sh COMPOSING |
| 598 | To compose an e\-mail, you can either start with an empty draft by pressing |
| 599 | .Shortcut m listing new_mail |
| 600 | which opens a composer view in a new tab. |
| 601 | To reply to a specific e\-mail, when in envelope view you can select the specific action you want to take: |
| 602 | .sp |
| 603 | .Bl -dash -compact |
| 604 | .It |
| 605 | Reply to envelope. |
| 606 | .Shortcut R envelope_view reply |
| 607 | .It |
| 608 | Reply to author. |
| 609 | .Shortcut Ctrl\-r envelope_view reply_to_author |
| 610 | .It |
| 611 | Reply to all. |
| 612 | .Shortcut Ctrl\-g envelope_view reply_to_all |
| 613 | .El |
| 614 | .sp |
| 615 | To launch your editor, press |
| 616 | .ShortcutPeriod e composing edit |
| 617 | \&. |
| 618 | To send your draft, press |
| 619 | .ShortcutPeriod s composing send_mail |
| 620 | \&. |
| 621 | To save the draft without submission, enter the command |
| 622 | .Command close |
| 623 | .sp |
| 624 | and select |
| 625 | .Qq save as draft Ns |
| 626 | \&. |
| 627 | You can return to the draft by going to your |
| 628 | .Qq Drafts |
| 629 | mailbox and selecting |
| 630 | .ShortcutPeriod e envelope_view edit |
| 631 | \&. |
| 632 | .Bd -literal -offset center |
| 633 | ┌────────────────────────────────────────────────────────────┐ |
| 634 | │ mail▐ contact list ▐ composing ▍███████████████████████│ |
| 635 | │ COMPOSING MESSAGE │ |
| 636 | │ Date Mon, 05 Sep 2022 17:49:19 +0300 │ |
| 637 | │ From myself <myself@example.com>░░░░ │ |
| 638 | │ To friend <myfriend@example.com>░░ │ |
| 639 | │ Cc ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ |
| 640 | │ Bcc ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ |
| 641 | │ Subject This is my subject!░░░░░░░░░░░░ │ |
| 642 | │ │ |
| 643 | │ Hello friend!░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ |
| 644 | │ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ |
| 645 | │ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ |
| 646 | │ │ |
| 647 | │ ☐ don't sign │ |
| 648 | │ ☐ don't encrypt │ |
| 649 | │ no attachments │ |
| 650 | │ │ |
| 651 | │NORMAL | Mailbox: Inbox, Messages: 25772, New: 3006 │ |
| 652 | └────────────────────────────────────────────────────────────┘ |
| 653 | .Ed |
| 654 | .Bd -ragged -offset 3n |
| 655 | .Em The\ lightly\ highlighted\ cells\ represent\ text\ input\ fields\&. |
| 656 | .Ed |
| 657 | .sp |
| 658 | If you enable the embed terminal option, you can launch your terminal editor of choice when you press |
| 659 | .Ic edit Ns |
| 660 | \&. |
| 661 | .Bd -literal -offset center |
| 662 | ┌────────────────────────────────────────────────────────────┐ |
| 663 | │ mail▐ contact list ▐ composing ▍███████████████████████│ |
| 664 | │ ╓COMPOSING MESSAGE┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╖ │ |
| 665 | │ ║ p/v/f/h/5/T/m/07f56b6e-ec09-49d9-b8d8-f0c5a81e7826 ║ │ |
| 666 | │ ║ 7 Date: Mon, 05 Sep 2022 18:43:10 +0300 ║ │ |
| 667 | │ ║ 6 From: Mister Cardholder <mrholder@example.com> ║ │ |
| 668 | │ ║ 5 To: ║ │ |
| 669 | │ ║ 4 Cc: ║ │ |
| 670 | │ ║ 3 Bcc: ║ │ |
| 671 | │ ║ 2 Subject: ║ │ |
| 672 | │ ║ 1 User-Agent: meli 0.7.2 ║ │ |
| 673 | │ ║8 █ ║ │ |
| 674 | │ ║~ ║ │ |
| 675 | │ ║~ ║ │ |
| 676 | │ ║~ ║ │ |
| 677 | │ ║~ ║ │ |
| 678 | │ ║ N… <6e-ec09-49d9-b8d8-f0c5a81e7826 100% ㏑:8 ℅:1║ │ |
| 679 | │ ╚════════════════════════════════════════════════════╝ │ |
| 680 | │ │ |
| 681 | │ │ |
| 682 | │ ☐ don't sign │ |
| 683 | │ ☐ don't encrypt │ |
| 684 | │ no attachments │ |
| 685 | │ │ |
| 686 | │EMBED | Mailbox: Inbox, Messages: 25772, New: 3006 │ |
| 687 | └────────────────────────────────────────────────────────────┘ |
| 688 | .Ed |
| 689 | .Bd -ragged -offset 3n |
| 690 | .Bf -emphasis |
| 691 | .Xr nvim 1 Ns |
| 692 | \ running\ inside\ the\ composing\ tab\&. |
| 693 | .Ef |
| 694 | The\ double\ line\ border\ annotates\ the\ area\ of\ the\ embedded\ terminal, |
| 695 | the\ actual\ embedding\ is\ seamless\&. |
| 696 | .Ed |
| 697 | .Ss composing mail commands |
| 698 | .Bl -tag -width 36n |
| 699 | .It Cm add\-attachment Ar PATH |
| 700 | in composer, add |
| 701 | .Ar PATH |
| 702 | as an attachment |
| 703 | .It Cm add\-attachment < Ar CMD Ar ARGS |
| 704 | in composer, pipe |
| 705 | .Ar CMD Ar ARGS |
| 706 | output into an attachment |
| 707 | .It Cm add\-attachment\-file\-picker |
| 708 | Launch command defined in the configuration value |
| 709 | .Ic file_picker_command |
| 710 | in |
| 711 | .Xr meli.conf 5 TERMINAL |
| 712 | .It Cm add\-attachment\-file\-picker < Ar CMD Ar ARGS |
| 713 | Launch command |
| 714 | .Ar CMD Ar ARGS Ns |
| 715 | \&. |
| 716 | The command should print file paths in stderr, separated by NULL bytes. |
| 717 | .It Cm remove\-attachment Ar INDEX |
| 718 | remove attachment with given index |
| 719 | .It Cm toggle sign |
| 720 | toggle between signing and not signing this message. |
| 721 | If the gpg invocation fails then the mail won't be sent. |
| 722 | See |
| 723 | .Xr meli.conf 5 PGP |
| 724 | for PGP configuration. |
| 725 | .It Cm save\-draft |
| 726 | saves a copy of the draft in the Draft folder |
| 727 | .El |
| 728 | .\" [ref:TODO]: add contacts section |
| 729 | .Sh THEMES |
| 730 | See |
| 731 | .Xr meli-themes 5 |
| 732 | for documentation on how to theme |
| 733 | .Nm Ns |
| 734 | \&. |
| 735 | .Sh SEE ALSO |
| 736 | .Xr meli 1 , |
| 737 | .Xr meli.conf 5 , |
| 738 | .Xr meli-themes 5 , |
| 739 | .Xr xdg-open 1 , |
| 740 | .Xr mailcap 5 |
| 741 | .Sh AUTHORS |
| 742 | Copyright 2017\(en2024 |
| 743 | .An Manos Pitsidianakis Aq Mt manos@pitsidianak.is |
| 744 | .Pp |
| 745 | Released under the GPL, version 3 or greater. |
| 746 | This software carries no warranty of any kind. |
| 747 | .Po |
| 748 | See |
| 749 | .Pa COPYING |
| 750 | for full copyright and warranty notices. |
| 751 | .Pc |
| 752 | .Ss Links |
| 753 | .Bl -item -compact |
| 754 | .It |
| 755 | .Lk https://meli\-email.org "Website" |
| 756 | .It |
| 757 | .Lk https://git.meli\-email.org/meli/meli "Main\ git\ repository\ and\ issue\ tracker" |
| 758 | .It |
| 759 | .Lk https://codeberg.org/meli/meli "Official\ read-only\ git\ mirror\ on\ codeberg.org" |
| 760 | .It |
| 761 | .Lk https://github.com/meli/meli "Official\ read-only\ git\ mirror\ on\ github.com" |
| 762 | .It |
| 763 | .Lk https://crates.io/crates/meli "meli\ crate\ on\ crates.io" |
| 764 | .El |