From 3230d1bf546a10be68498701fc859781f9262de2 Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Thu, 3 Apr 2014 23:53:03 +0300 Subject: [PATCH] [PATCH 1/1] doc: added 'Init File' section to notmuch-emacs info source --- 54/706c115302904e91c1ec8e99fbc711091b9076 | 152 ++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 54/706c115302904e91c1ec8e99fbc711091b9076 diff --git a/54/706c115302904e91c1ec8e99fbc711091b9076 b/54/706c115302904e91c1ec8e99fbc711091b9076 new file mode 100644 index 000000000..cda5e455e --- /dev/null +++ b/54/706c115302904e91c1ec8e99fbc711091b9076 @@ -0,0 +1,152 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id B922D431FAF + for ; Thu, 3 Apr 2014 13:53:18 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id r5la+mADjXiU for ; + Thu, 3 Apr 2014 13:53:14 -0700 (PDT) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by olra.theworths.org (Postfix) with ESMTP id A5D2D431FAE + for ; Thu, 3 Apr 2014 13:53:13 -0700 (PDT) +Received: by guru.guru-group.fi (Postfix, from userid 501) + id 5AE06100063; Thu, 3 Apr 2014 23:53:06 +0300 (EEST) +From: Tomi Ollila +To: notmuch@notmuchmail.org +Subject: + [PATCH 1/1] doc: added 'Init File' section to notmuch-emacs info source +Date: Thu, 3 Apr 2014 23:53:03 +0300 +Message-Id: <1396558383-21277-1-git-send-email-tomi.ollila@iki.fi> +X-Mailer: git-send-email 1.8.0 +MIME-Version: 1.0 +Content-Type: text/plain; charset=UTF-8 +Content-Transfer-Encoding: 8bit +Cc: tomi.ollila@iki.fi +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Thu, 03 Apr 2014 20:53:18 -0000 + +While adding that fixed (also other) typos noticed by aspell(1) run, +and capitalized Emacs and (most) Notmuch terms to match how emacs +Info documentation seems to look in general. +--- + doc/notmuch-emacs.rst | 34 +++++++++++++++++++++++----------- + 1 file changed, 23 insertions(+), 11 deletions(-) + +diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst +index 28301b3..09579bf 100644 +--- a/doc/notmuch-emacs.rst ++++ b/doc/notmuch-emacs.rst +@@ -5,18 +5,18 @@ notmuch-emacs + About this Manual + ================= + +-This manual covers only the emacs interface to notmuch. For information ++This manual covers only the Emacs interface to Notmuch. For information + on the command line interface, see See section “Description” in Notmuch + Manual Pager. To save typing, we will sometimes use *notmuch* in this +-manual to refer to the Emacs interface to notmuch. If the distinction +-should every be important, we’ll refer to the Emacs inteface as ++manual to refer to the Emacs interface to Notmuch. If the distinction ++should every be important, we’ll refer to the Emacs interface as + *notmuch-emacs*. + + Notmuch-emacs is highly customizable via the the Emacs customization + framework (or just by setting the appropriate variables). We try to + point out relevant variables in this manual, but in order to avoid + duplication of information, but you can usually find the most detailed +-description in the varables docstring. ++description in the variables docstring. + + notmuch-hello + ============= +@@ -25,7 +25,7 @@ notmuch-hello + single: notmuch-hello + single: notmuch + +-``notmuch-hello`` is the main entry point for notmuch. You can start it ++``notmuch-hello`` is the main entry point for Notmuch. You can start it + with ``M-x notmuch`` or ``M-x notmuch-hello``. The startup screen looks + something like the following. There are some hints at the bottom of the + screen. There are three main parts to the notmuch-hello screen, +@@ -48,7 +48,7 @@ a mouse or by positioning the cursor and pressing ```` + | ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit. + | **Customize** this page. + +-You can change the overall appearence of the notmuch-hello screen by ++You can change the overall appearance of the notmuch-hello screen by + customizing the variable :index:`notmuch-hello-sections`. + + +@@ -59,7 +59,7 @@ notmuch-hello key bindings + ```` + Move to the next widget (button or text entry field) + +-```` ++```` + Move to the previous widget. + + ```` +@@ -91,12 +91,12 @@ Saved Searches + + Notmuch replaces the static assignment of messages with the more dynamic + notion of searching. Notmuch-hello presents the user with a customizable +-set of saved searchs. The initial defaults are ``tag:inbox`` and ++set of saved searches. The initial defaults are ``tag:inbox`` and + ``tag:unread``, but you can customize the following variables + + :index:`notmuch-saved-searches` + A list of cons pairs, the first being the name to display, the +- second being a query string for notmuch. See section “Description” ++ second being a query string for Notmuch. See section “Description” + in Notmuch Query Syntax. + + :index:`notmuch-saved-searches-sort-function` +@@ -110,8 +110,8 @@ set of saved searchs. The initial defaults are ``tag:inbox`` and + Search Box + ---------- + +-The search box lets the user enter an notmuch query. See section +-“Description” in Notmuch Query Syntax, for more info on notmuch query ++The search box lets the user enter a Notmuch query. See section ++“Description” in Notmuch Query Syntax, for more info on Notmuch query + syntax. A history of recent searches is also displayed by default. The + latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`. + +@@ -190,3 +190,15 @@ Importing Mail + :index:`notmuch-poll` + + :index:`notmuch-poll-script` ++ ++Init File ++--------- ++ ++When Notmuch is loaded, it will read the ``notmuch-init-file`` ++(``~/.emacs.d/notmuch-config`` by default) file. This is normal Emacs Lisp ++file and can be used to avoid cluttering your ``~/.emacs`` with Notmuch ++stuff. If the file with ``.elc``, ``.elc.gz``, ``.el`` or ``.el.gz`` ++suffix exist it will be read instead (just one of these, chosen in this ++order). Most often users create ``~/.emacs.d/notmuch-config.el`` and just ++work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file`` ++options, ``notmuch-init-file`` is not read. +-- +1.8.0 + -- 2.26.2