--- /dev/null
+Return-Path: <aclements@csail.mit.edu>\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 26C3A431FDB\r
+ for <notmuch@notmuchmail.org>; Fri, 3 Oct 2014 07:28:05 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+ tests=[RCVD_IN_DNSWL_MED=-2.3] 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 CGPG17bAP0Vg for <notmuch@notmuchmail.org>;\r
+ Fri, 3 Oct 2014 07:27:59 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu\r
+ [18.7.68.35])\r
+ (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id D2CBF431FD6\r
+ for <notmuch@notmuchmail.org>; Fri, 3 Oct 2014 07:27:58 -0700 (PDT)\r
+X-AuditID: 12074423-f799d6d00000337c-7f-542eb26657a7\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+ (using TLS with cipher AES256-SHA (256/256 bits))\r
+ (Client did not present a certificate)\r
+ by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP\r
+ id 60.57.13180.E62BE245; Fri, 3 Oct 2014 10:27:58 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+ by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id s93ERctg021448; \r
+ Fri, 3 Oct 2014 10:27:38 -0400\r
+Received: from drake.dyndns.org\r
+ (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+ [216.15.114.40]) (authenticated bits=0)\r
+ (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+ by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s93ERZtN026440\r
+ (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NOT);\r
+ Fri, 3 Oct 2014 10:27:37 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.84)\r
+ (envelope-from <aclements@csail.mit.edu>)\r
+ id 1Xa3pP-0002YK-HL; Fri, 03 Oct 2014 10:27:27 -0400\r
+From: Austin Clements <aclements@csail.mit.edu>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] doc: Emacs manual improvements and expansions\r
+Date: Fri, 3 Oct 2014 10:27:26 -0400\r
+Message-Id: <1412346446-9701-1-git-send-email-aclements@csail.mit.edu>\r
+X-Mailer: git-send-email 2.1.0\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=UTF-8\r
+Content-Transfer-Encoding: 8bit\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFnrIIsWRmVeSWpSXmKPExsUixG6nrpu3SS/EYM5fIYvrN2cyOzB6PFt1\r
+ izmAMYrLJiU1J7MstUjfLoErY+On+ewFR+Qq/h1YwdTAOFmyi5GTQ0LARGLP9HYWCFtM4sK9\r
+ 9WxdjFwcQgKzmSQm3PnNAuFsYJT4/es6O4Rzm0li//xJUGVLGCVurXzFDNLPJqAvsWLtJFYQ\r
+ W0RAWmLn3dlANgcHs4CuRHO7MkhYWMBO4smumWDlLAKqEh1tr9hBbF4BN4kjByawQZwhJ7Fh\r
+ 939GiLigxMmZT1ggxqhLrJ8nBBJmFpCXaN46m3kCo8AsJFWzEKpmIalawMi8ilE2JbdKNzcx\r
+ M6c4NVm3ODkxLy+1SNdMLzezRC81pXQTIzgkXZR3MP45qHSIUYCDUYmH98MN3RAh1sSy4src\r
+ Q4ySHExKoryVi/VChPiS8lMqMxKLM+KLSnNSiw8xSnAwK4nwLlgJlONNSaysSi3Kh0lJc7Ao\r
+ ifNu+sEXIiSQnliSmp2aWpBaBJOV4eBQkuCt2QjUKFiUmp5akZaZU4KQZuLgBBnOAzR8KUgN\r
+ b3FBYm5xZjpE/hSjopQ471qQhABIIqM0D64XljJeMYoDvSLMuwqkigeYbuC6XwENZgIa/M5e\r
+ F2RwSSJCSqqB0ZBrstbiA7NkZgsb6koxz2dTM6rtbXtQUK88OWLnS/ZlaS/kSgxlMozCThXp\r
+ bLI5ftKy13nrvY2s0VlrH17atmLp3H8hTpc+Gkfve7xjr/Haf+sXHd1SXu34XFzn/R09ndC3\r
+ NRpJ0Rs+rP8jVlFhETcl8a/FXPGtlWZLTVS//TsxJ+TwmxbHvUosxRmJhlrMRcWJADkxg3n0 AgAA\r
+Cc: Austin Clements <aclements@csail.mit.edu>\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: Fri, 03 Oct 2014 14:28:05 -0000\r
+\r
+Fix several typos, improve general wording and flow, and add some\r
+information on notmuch-jump.\r
+---\r
+\r
+Sorry I didn't tease these changes apart. I went through it linearly\r
+and it didn't seem worth the trouble of separating them after the fact.\r
+\r
+ doc/notmuch-emacs.rst | 50 +++++++++++++++++++++++++++++++++++++-------------\r
+ 1 file changed, 37 insertions(+), 13 deletions(-)\r
+\r
+diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst\r
+index 09579bf..6f2f61e 100644\r
+--- a/doc/notmuch-emacs.rst\r
++++ b/doc/notmuch-emacs.rst\r
+@@ -6,17 +6,17 @@ About this Manual\r
+ =================\r
+ \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 interface as\r
++on the command line interface, see section “Description” in the Notmuch\r
++Manual Pages. To save typing, we will sometimes use *notmuch* in this\r
++manual to refer to the Emacs interface to Notmuch. When this distinction\r
++is 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 variables docstring.\r
++duplication of information, you can usually find the most detailed\r
++description in the variables' docstring.\r
+ \r
+ notmuch-hello\r
+ =============\r
+@@ -89,15 +89,19 @@ notmuch-hello key bindings\r
+ Saved Searches\r
+ --------------\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 searches. The initial defaults are ``tag:inbox`` and\r
+-``tag:unread``, but you can customize the following variables\r
++Since notmuch is entirely search-based, it's often useful to organize\r
++mail around common searches. To facilitate this, the first section of\r
++notmuch-hello presents a customizable set of saved searches. Saved\r
++searches can also be accessed from anywhere in notmuch by pressing\r
++``j`` to access :ref:`notmuch-jump`.\r
++\r
++The saved searches default to various common searches such as\r
++``tag:inbox`` to access the inbox and ``tag:unread`` to access all\r
++unread mail, but there are several options for customization:\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
+- in Notmuch Query Syntax.\r
++ The list of saved searches, including names, queries, and\r
++ additional per-query options.\r
+ \r
+ :index:`notmuch-saved-searches-sort-function`\r
+ This variable controls how saved searches should be sorted. A value\r
+@@ -179,6 +183,26 @@ notmuch-show\r
+ notmuch-tree\r
+ ============\r
+ \r
++Global key bindings\r
++===================\r
++\r
++Several features are accessible from anywhere in notmuch through the\r
++following key bindings:\r
++\r
++``j``\r
++ Jump to saved searches using :ref:`notmuch-jump`.\r
++\r
++notmuch-jump\r
++------------\r
++\r
++Saved searches configured through :ref:`notmuch-saved-searches` can\r
++include a "shortcut key" that's accessible through notmuch-jump.\r
++Pressing ``j`` anywhere in notmuch followed by the configured shortcut\r
++key of a saved search will immediately jump to that saved search. For\r
++example, in the default configuration ``j i`` jumps immediately to the\r
++inbox search. When you press ``j``, notmuch-jump shows the saved\r
++searches and their shortcut keys in the mini-buffer.\r
++\r
+ Configuration\r
+ =============\r
+ \r
+-- \r
+2.1.0\r
+\r
projects / notmuch-archives.git / commitdiff