[PATCH 1/1] doc: added 'Init File' section to notmuch-emacs info source

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