--- /dev/null
+Return-Path: <bremner@tethera.net>\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 D941A431FAE\r
+ for <notmuch@notmuchmail.org>; Sat, 9 Mar 2013 18:22:51 -0800 (PST)\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 zHaDnvLIHj29 for <notmuch@notmuchmail.org>;\r
+ Sat, 9 Mar 2013 18:22:48 -0800 (PST)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+ (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id 12797431FAF\r
+ for <notmuch@notmuchmail.org>; Sat, 9 Mar 2013 18:22:48 -0800 (PST)\r
+Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+ ([156.34.82.78] helo=zancas.localnet)\r
+ by tesseract.cs.unb.ca with esmtpsa\r
+ (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1UEVuN-0007lr-LL; Sat, 09 Mar 2013 22:22:47 -0400\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1UEVuI-0003yZ-2J; Sat, 09 Mar 2013 22:22:38 -0400\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [RFC patch] emacs: skeleton of texinfo manual for emacs interface.\r
+Date: Sat, 9 Mar 2013 22:22:31 -0400\r
+Message-Id: <1362882151-14030-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.2.rc1\r
+X-Spam_bar: -\r
+Cc: David Bremner <bremner@debian.org>\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: Sun, 10 Mar 2013 02:22:52 -0000\r
+\r
+From: David Bremner <bremner@debian.org>\r
+\r
+Currently this only attempts to document the notmuch-hello interface.\r
+---\r
+\r
+I have thought for a long time that we should have some unified\r
+documentation for the emacs interface. This is some sketch of a\r
+beginning. Building such a document turns out to be a fair amount of\r
+work, but I guess it should be possible to have something better than\r
+what we have now (i.e. nothing). I did try to avoid duplication with\r
+both the docstrings and the man pages. Eventually perhaps we should\r
+have some common format to generate the man pages and info pages from,\r
+but I didn't want to hold up the whole effort waiting for that.\r
+\r
+One thing that would make this effort more bearable is being able to\r
+re-use material from the wiki. Currently there is no license\r
+information at all on that material; I'm not sure exactly how to\r
+proceed.\r
+\r
+To build this, use "makeinfo notmuch.texi"\r
+You can then (perversely) view it without emacs with "info -f notmuch.info"\r
+or in emacs with C-u C-h i notmuch.info.\r
+\r
+\r
+ emacs/notmuch.texi | 274 +++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+ emacs/version.texi | 2 +\r
+ 2 files changed, 276 insertions(+)\r
+ create mode 100644 emacs/notmuch.texi\r
+ create mode 100644 emacs/version.texi\r
+\r
+diff --git a/emacs/notmuch.texi b/emacs/notmuch.texi\r
+new file mode 100644\r
+index 0000000..d4f7296\r
+--- /dev/null\r
++++ b/emacs/notmuch.texi\r
+@@ -0,0 +1,274 @@\r
++\input texinfo @c -*-texinfo-*-\r
++@comment $Id@w{$}\r
++@comment %**start of header\r
++@setfilename notmuch.info\r
++@include version.texi\r
++@settitle Notmuch @value{VERSION}\r
++@comment %**end of header\r
++\r
++@macro keyindex {NAME}\r
++@kindex \NAME\\r
++@cindex \NAME\\r
++@end macro\r
++\r
++@macro funindex {NAME}\r
++@findex \NAME\\r
++@cindex \NAME\\r
++@end macro\r
++\r
++@macro varindex {NAME}\r
++@vindex \NAME\\r
++@cindex \NAME\\r
++@end macro\r
++\r
++\r
++@copying\r
++This manual is for Notmuch (version @value{VERSION}, @value{UPDATED})\r
++\r
++Copyright @copyright{} 2013 David Bremner\r
++\r
++This manual is distributed under the same terms as notmuch, which are as follows.\r
++@quotation\r
++ This program is free software: you can redistribute it and/or modify\r
++ it under the terms of the GNU General Public License as published by\r
++ the Free Software Foundation, either version 3 of the License, or\r
++ (at your option) any later version.\r
++\r
++ This program is distributed in the hope that it will be useful,\r
++ but WITHOUT ANY WARRANTY; without even the implied warranty of\r
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
++ GNU General Public License for more details.\r
++\r
++ You should have received a copy of the GNU General Public License\r
++ along with this program. If not, see http://www.gnu.org/licenses/ .\r
++\r
++@end quotation\r
++@end copying\r
++\r
++@dircategory Texinfo documentation system\r
++@direntry\r
++* notmuch: (notmuch)Emacs interface to notmuch\r
++@end direntry\r
++\r
++@titlepage\r
++@title Notmuch\r
++@subtitle for version @value{VERSION}, @value{UPDATED}\r
++@author David Bremner (@email{david@@tethera.net})\r
++@page\r
++@vskip 0pt plus 1filll\r
++@insertcopying\r
++@end titlepage\r
++\r
++@contents\r
++\r
++@ifnottex\r
++@node Top\r
++@top Notmuch\r
++\r
++This manual is for Notmuch (version @value{VERSION}, @value{UPDATED}).\r
++@end ifnottex\r
++\r
++@menu\r
++* About this Manual::\r
++* notmuch-hello::\r
++* notmuch-search::\r
++* Search Syntax::\r
++* Configuration::\r
++* Function Index::\r
++* Variable Index::\r
++* Index::\r
++@end menu\r
++\r
++\r
++@node About this Manual\r
++@unnumbered About this Manual\r
++\r
++This manual covers only the emacs interface to notmuch. For\r
++information on the command line interface, see\r
++@url{http://notmuchmail.org/manpages/notmuch-1,the notmuch man page}.\r
++To save\r
++typing, we will sometimes use @emph{notmuch} in this manual to refer\r
++to the Emacs interface to notmuch. If the distinction should every be\r
++important, we'll refer to the Emacs inteface as @emph{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
++\r
++@node notmuch-hello\r
++@chapter notmuch-hello\r
++\r
++@funindex notmuch-hello\r
++@funindex notmuch\r
++\r
++@command{notmuch-hello} is the main entry point for notmuch. You can\r
++start it with @kbd{M-x notmuch} or @kbd{M-x notmuch-hello}. The\r
++startup screen looks something like the following. There are some\r
++hints at the bottom of the screen. There are three main parts to the\r
++notmuch-hello screen, discussed below. The @strong{bold} text\r
++indicates buttons you can click with a mouse or by positioning the\r
++cursor and pressing @kbd{<return>}\r
++\r
++@example\r
++@group\r
++----------------------------------------------------------------------------\r
++\r
++ Welcome to @strong{notmuch}. You have 52 messages.\r
++\r
++Saved searches: @strong{[edit]}\r
++\r
++ 52 @strong{inbox} 52 @strong{unread}\r
++\r
++Search: .\r
++\r
++All tags: @strong{[show]}\r
++\r
++ Type a search query and hit RET to view matching threads.\r
++ Edit saved searches with the `edit' button.\r
++ Hit RET or click on a saved search or tag name to view matching threads.\r
++ `=' to refresh this screen. `s' to search messages. `q' to quit.\r
++ @strong{Customize} this page.\r
++\r
++----------------------------------------------------------------------------\r
++@end group\r
++@end example\r
++\r
++You can change the overall appearence of the notmuch-hello screen by\r
++customizing the variable @var{notmuch-hello-sections}.\r
++@varindex{notmuch-hellow-sections}\r
++\r
++@menu\r
++* notemuch-hello Key Bindings::\r
++* Saved Searches::\r
++* Search Box::\r
++* Known Tags::\r
++@end menu\r
++\r
++@node notemuch-hello Key Bindings\r
++@section notmuch-hello key bindings\r
++\r
++@table @kbd\r
++\r
++@item <tab>\r
++ Move to the next widget (button or text entry field)\r
++@item <backtab>\r
++ Move to the previous widget.\r
++@item <return>\r
++ Activate the current widget.\r
++@item =\r
++Refresh the buffer; mainly update the counts of messages for various\r
++saved searches.\r
++@item G\r
++ Import mail, @xref{Importing Mail}.\r
++@item m\r
++ Compose a message\r
++@item s\r
++Search the notmuch database, @xref{notmuch-search}.\r
++@item v\r
++ Print notmuch version\r
++@item q\r
++Quit\r
++@end table\r
++\r
++\r
++@node Saved Searches\r
++@section Saved Searches\r
++@cindex Saved Searches\r
++\r
++@varindex notmuch-saved-searches\r
++@varindex notmuch-saved-search-sort-function\r
++@varindex notmuch-column-control\r
++\r
++Notmuch replaces the static assignment of messages with the more\r
++dynamic notion of searching.\r
++Notmuch-hello presents the user with a customizable set of saved\r
++searchs. The initial defaults are @code{tag:inbox} and\r
++@code{tag:unread}, but you can customize the following variables\r
++\r
++\r
++@table @var\r
++@item notmuch-saved-searches\r
++A list of cons pairs, the first being the name to display, the second being a query string\r
++for notmuch. @xref{Search Syntax}, for more info.\r
++@item notmuch-saved-searches-sort-function\r
++ This variable controls how saved searches should be sorted. A value\r
++ of @code{nil} displays the saved searches in the order they are\r
++ stored in `notmuch-saved-searches'.\r
++@item notmuch-column-control\r
++ Controls the number of columns for displaying saved-searches/tags\r
++@end table\r
++\r
++@node Search Box\r
++@section Search Box\r
++@cindex Search Box\r
++\r
++@varindex notmuch-hello-recent-searches-max\r
++The search box lets the user enter an notmuch query. @xref{Search\r
++Syntax}, for more info on notmuch query syntax. A history of recent\r
++searches is also displayed by default. The latter is controlled by\r
++the variable @var{notmuch-hello-recent-searches-max}.\r
++\r
++@node Known Tags\r
++@section Know Tags\r
++@cindex Known Tags\r
++@varindex notmuch-hello-tag-list-make-query\r
++@varindex notmuch-hello-hide-tags\r
++@varindex notmuch-column-control\r
++\r
++One special kind of saved search provided by default is for each\r
++individual tag defined in the database. This can be controlled via the\r
++following variables.\r
++\r
++@table @var\r
++@item notmuch-hello-tag-list-make-query\r
++ Control how to construct a search (``virtual folder'') from a given tag.\r
++@item notmuch-hello-hide-tags\r
++ Which tags not to display at all.\r
++@item notmuch-column-control\r
++ Controls the number of columns for displaying saved-searches/tags\r
++@end table\r
++\r
++\r
++@node notmuch-search\r
++@chapter notmuch-search\r
++\r
++\r
++@node Search Syntax\r
++@chapter Search Syntax\r
++\r
++The canonical reference for notmuch search syntax is\r
++@url{http://notmuchmail.org/manpages/notmuch-search-terms-7,notmuch-search-terms(7)}\r
++\r
++@node Configuration\r
++@chapter Configuration\r
++\r
++\r
++@menu\r
++* Importing Mail::\r
++@end menu\r
++\r
++@node Importing Mail\r
++@section Importing Mail\r
++\r
++@funindex notmuch-poll\r
++@vindex notmuch-poll-script\r
++\r
++@node Function Index\r
++@unnumbered Function Index\r
++\r
++@printindex fn\r
++\r
++@node Variable Index\r
++@unnumbered Variable Index\r
++\r
++@printindex vr\r
++\r
++@node Index\r
++@unnumbered Index\r
++\r
++@printindex cp\r
++\r
++\r
++@bye\r
+diff --git a/emacs/version.texi b/emacs/version.texi\r
+new file mode 100644\r
+index 0000000..4de9b21\r
+--- /dev/null\r
++++ b/emacs/version.texi\r
+@@ -0,0 +1,2 @@\r
++@set VERSION 0.15.2\r
++@set UPDATED April 01, 1970\r
+-- \r
+1.8.2.rc1\r
+\r
projects / notmuch-archives.git / commitdiff