From 2559132a1bb9a51f178dfb0f276764a5aa397acf Mon Sep 17 00:00:00 2001 From: Jai Flack Date: Wed, 16 Sep 2020 17:52:05 +1000 Subject: [PATCH] add more commentary --- nnir-mu.el | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/nnir-mu.el b/nnir-mu.el index f89c872..c99d864 100644 --- a/nnir-mu.el +++ b/nnir-mu.el @@ -25,11 +25,20 @@ ;;; Commentary -;; This package provides an `mu' backend for Gnus' nnir as an alternative to notmuch or any other -;; backends. It relies on the `mu' executable and thus can only search local mail and requires `mu' -;; to be configured for your mail setup. Tested with an nnmaildir backend synced with mbsync. +;; This package provides an `mu' backend for Gnus' nnir as an +;; alternative to notmuch or any other backends. It relies on the `mu' +;; executable and thus can only search local mail and requires `mu' to +;; be configured for your mail setup. Tested with an nnmaildir backend +;; synced with mbsync. -;; TODO: configuration +;;; Configuration: + +;; Generally the defaults will work find but first mu must be +;; installed and configured, see mu(1) and mu-init(1). + +;; Available options: +;; - `nnir-mu-program' +;; - `nnir-mu-remove-prefix' ;;; Code: