Re: [PATCH v4 01/16] add util/search-path.{c, h} to test for executables in $PATH
[notmuch-archives.git] / 54 / 706c115302904e91c1ec8e99fbc711091b9076
1 Return-Path: <too@guru-group.fi>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5         by olra.theworths.org (Postfix) with ESMTP id B922D431FAF\r
6         for <notmuch@notmuchmail.org>; Thu,  3 Apr 2014 13:53:18 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: 0\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
12         autolearn=disabled\r
13 Received: from olra.theworths.org ([127.0.0.1])\r
14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
15         with ESMTP id r5la+mADjXiU for <notmuch@notmuchmail.org>;\r
16         Thu,  3 Apr 2014 13:53:14 -0700 (PDT)\r
17 Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
18         by olra.theworths.org (Postfix) with ESMTP id A5D2D431FAE\r
19         for <notmuch@notmuchmail.org>; Thu,  3 Apr 2014 13:53:13 -0700 (PDT)\r
20 Received: by guru.guru-group.fi (Postfix, from userid 501)\r
21         id 5AE06100063; Thu,  3 Apr 2014 23:53:06 +0300 (EEST)\r
22 From: Tomi Ollila <tomi.ollila@iki.fi>\r
23 To: notmuch@notmuchmail.org\r
24 Subject:\r
25  [PATCH 1/1] doc: added 'Init File' section to notmuch-emacs info source\r
26 Date: Thu,  3 Apr 2014 23:53:03 +0300\r
27 Message-Id: <1396558383-21277-1-git-send-email-tomi.ollila@iki.fi>\r
28 X-Mailer: git-send-email 1.8.0\r
29 MIME-Version: 1.0\r
30 Content-Type: text/plain; charset=UTF-8\r
31 Content-Transfer-Encoding: 8bit\r
32 Cc: tomi.ollila@iki.fi\r
33 X-BeenThere: notmuch@notmuchmail.org\r
34 X-Mailman-Version: 2.1.13\r
35 Precedence: list\r
36 List-Id: "Use and development of the notmuch mail system."\r
37         <notmuch.notmuchmail.org>\r
38 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
39         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
40 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
41 List-Post: <mailto:notmuch@notmuchmail.org>\r
42 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
43 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
44         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
45 X-List-Received-Date: Thu, 03 Apr 2014 20:53:18 -0000\r
46 \r
47 While adding that fixed (also other) typos noticed by aspell(1) run,\r
48 and capitalized Emacs and (most) Notmuch terms to match how emacs\r
49 Info documentation seems to look in general.\r
50 ---\r
51  doc/notmuch-emacs.rst | 34 +++++++++++++++++++++++-----------\r
52  1 file changed, 23 insertions(+), 11 deletions(-)\r
53 \r
54 diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst\r
55 index 28301b3..09579bf 100644\r
56 --- a/doc/notmuch-emacs.rst\r
57 +++ b/doc/notmuch-emacs.rst\r
58 @@ -5,18 +5,18 @@ notmuch-emacs\r
59  About this Manual\r
60  =================\r
61  \r
62 -This manual covers only the emacs interface to notmuch. For information\r
63 +This manual covers only the Emacs interface to Notmuch. For information\r
64  on the command line interface, see See section “Description” in Notmuch\r
65  Manual Pager. To save typing, we will sometimes use *notmuch* in this\r
66 -manual to refer to the Emacs interface to notmuch. If the distinction\r
67 -should every be important, we’ll refer to the Emacs inteface as\r
68 +manual to refer to the Emacs interface to Notmuch. If the distinction\r
69 +should every be important, we’ll refer to the Emacs interface as\r
70  *notmuch-emacs*.\r
71  \r
72  Notmuch-emacs is highly customizable via the the Emacs customization\r
73  framework (or just by setting the appropriate variables). We try to\r
74  point out relevant variables in this manual, but in order to avoid\r
75  duplication of information, but you can usually find the most detailed\r
76 -description in the varables docstring.\r
77 +description in the variables docstring.\r
78  \r
79  notmuch-hello\r
80  =============\r
81 @@ -25,7 +25,7 @@ notmuch-hello\r
82     single: notmuch-hello\r
83     single: notmuch\r
84  \r
85 -``notmuch-hello`` is the main entry point for notmuch. You can start it\r
86 +``notmuch-hello`` is the main entry point for Notmuch. You can start it\r
87  with ``M-x notmuch`` or ``M-x notmuch-hello``. The startup screen looks\r
88  something like the following. There are some hints at the bottom of the\r
89  screen. There are three main parts to the notmuch-hello screen,\r
90 @@ -48,7 +48,7 @@ a mouse or by positioning the cursor and pressing ``<return>``\r
91  |     ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit.\r
92  |                  **Customize** this page.\r
93  \r
94 -You can change the overall appearence of the notmuch-hello screen by\r
95 +You can change the overall appearance of the notmuch-hello screen by\r
96  customizing the variable :index:`notmuch-hello-sections`.\r
97  \r
98  \r
99 @@ -59,7 +59,7 @@ notmuch-hello key bindings\r
100  ``<tab>``\r
101      Move to the next widget (button or text entry field)\r
102  \r
103 -``<backtab>``\r
104 +``<backspace>``\r
105      Move to the previous widget.\r
106  \r
107  ``<return>``\r
108 @@ -91,12 +91,12 @@ Saved Searches\r
109  \r
110  Notmuch replaces the static assignment of messages with the more dynamic\r
111  notion of searching. Notmuch-hello presents the user with a customizable\r
112 -set of saved searchs. The initial defaults are ``tag:inbox`` and\r
113 +set of saved searches. The initial defaults are ``tag:inbox`` and\r
114  ``tag:unread``, but you can customize the following variables\r
115  \r
116  :index:`notmuch-saved-searches`\r
117      A list of cons pairs, the first being the name to display, the\r
118 -    second being a query string for notmuch. See section “Description”\r
119 +    second being a query string for Notmuch. See section “Description”\r
120      in Notmuch Query Syntax.\r
121  \r
122  :index:`notmuch-saved-searches-sort-function`\r
123 @@ -110,8 +110,8 @@ set of saved searchs. The initial defaults are ``tag:inbox`` and\r
124  Search Box\r
125  ----------\r
126  \r
127 -The search box lets the user enter an notmuch query. See section\r
128 -“Description” in Notmuch Query Syntax, for more info on notmuch query\r
129 +The search box lets the user enter a Notmuch query. See section\r
130 +“Description” in Notmuch Query Syntax, for more info on Notmuch query\r
131  syntax. A history of recent searches is also displayed by default. The\r
132  latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`.\r
133  \r
134 @@ -190,3 +190,15 @@ Importing Mail\r
135  :index:`notmuch-poll`\r
136  \r
137  :index:`notmuch-poll-script`\r
138 +\r
139 +Init File\r
140 +---------\r
141 +\r
142 +When Notmuch is loaded, it will read the ``notmuch-init-file``\r
143 +(``~/.emacs.d/notmuch-config`` by default) file. This is normal Emacs Lisp\r
144 +file and can be used to avoid cluttering your ``~/.emacs`` with Notmuch\r
145 +stuff. If the file with ``.elc``, ``.elc.gz``, ``.el`` or ``.el.gz``\r
146 +suffix exist it will be read instead (just one of these, chosen in this\r
147 +order). Most often users create ``~/.emacs.d/notmuch-config.el`` and just\r
148 +work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file``\r
149 +options, ``notmuch-init-file`` is not read.\r
150 -- \r
151 1.8.0\r
152 \r