Update notmuch documentation
This commit is contained in:
parent
d3eaad8f1c
commit
16393e3af1
1 changed files with 36 additions and 3 deletions
|
@ -19,6 +19,8 @@
|
|||
- [[#offlineimap][offlineimap]]
|
||||
- [[#mbsync][mbsync]]
|
||||
- [[#notmuch][notmuch]]
|
||||
- [[#customize-notmuch-hello-buffer][Customize =*notmuch-hello*= buffer]]
|
||||
- [[#changing-the-notmuch-landing-page][Changing the =notmuch= landing page]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
|
||||
* Description
|
||||
|
@ -35,13 +37,19 @@ This module makes Emacs an email client, using ~notmuch~.
|
|||
* Prerequisites
|
||||
This module requires:
|
||||
|
||||
+ Either ~gmailieer~ (default), ~mbsync~ or ~offlineimap~ (to sync mail with)
|
||||
+ ~notmuch~, to index and tag your downloaded messages.
|
||||
+ Either ~[[https://github.com/gauteh/lieer][gmailieer]]~ (default), ~mbsync~ or ~offlineimap~ (to sync mail with)
|
||||
+ ~[[https://notmuchmail.org/][notmuch]]~, to index and tag your downloaded messages.
|
||||
+ ~afew~, optionally to initially tag your downloaded messages.
|
||||
|
||||
** TODO MacOS
|
||||
|
||||
** TODO Arch Linux
|
||||
|
||||
See: [[https://wiki.archlinux.org/index.php/Notmuch][Arch Wiki - Notmuch]]
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
pacman -S notmuch
|
||||
#+END_SRC
|
||||
|
||||
** NixOS
|
||||
#+BEGIN_SRC nix
|
||||
environment.systemPackages = with pkgs; [
|
||||
|
@ -57,6 +65,7 @@ environment.systemPackages = with pkgs; [
|
|||
|
||||
** TODO openSUSE
|
||||
** TODO Debian/Ubuntu
|
||||
|
||||
* TODO Features
|
||||
|
||||
* Configuration
|
||||
|
@ -107,4 +116,28 @@ Before you can use =notmuch=, you need to index your email initially.
|
|||
notmuch new
|
||||
#+END_SRC
|
||||
|
||||
** Customize =*notmuch-hello*= buffer
|
||||
|
||||
It is possible to change the =*notmuch-hello*= buffer if you want to.
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(use-package! notmuch
|
||||
:config
|
||||
(setq notmuch-show-log nil
|
||||
notmuch-hello-sections `(notmuch-hello-insert-saved-searches
|
||||
notmuch-hello-insert-alltags)
|
||||
;; Maybe you don't like seeing email headers when you write email either.
|
||||
notmuch-message-headers-visible nil))
|
||||
#+END_SRC
|
||||
|
||||
** Changing the =notmuch= landing page
|
||||
|
||||
You may want to forego the =*notmuch-hello*= buffer by having ~M-x =notmuch~ or ~SPC o m~ take you straight to a search page.
|
||||
|
||||
When using ~SPC o m~ the =+notmuch-home-function= is called. By default it uses the =notmuch= function and so has the same familiar behavior of running a vanilla install of notmuch-emacs. But, by overwriting this function you can run a custom search as your landing page.
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(setq +notmuch-home-function (lambda () (notmuch-search "tag:inbox")))
|
||||
#+END_SRC
|
||||
|
||||
* Troubleshooting
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue