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