[RFC patch] emacs: skeleton of texinfo manual for emacs interface.

* [RFC patch] emacs: skeleton of texinfo manual for emacs interface.
@ 2013-03-10  2:22 david
  2013-04-25  1:19 ` Second draft of info manual david
  0 siblings, 1 reply; 27+ messages in thread
From: david @ 2013-03-10  2:22 UTC (permalink / raw)
  To: notmuch; +Cc: David Bremner

From: David Bremner <bremner@debian.org>

Currently this only attempts to document the notmuch-hello interface.
---

I have thought for a long time that we should have some unified
documentation for the emacs interface. This is some sketch of a
beginning.  Building such a document turns out to be a fair amount of
work, but I guess it should be possible to have something better than
what we have now (i.e. nothing). I did try to avoid duplication with
both the docstrings and the man pages. Eventually perhaps we should
have some common format to generate the man pages and info pages from,
but I didn't want to hold up the whole effort waiting for that.

One thing that would make this effort more bearable is being able to
re-use material from the wiki. Currently there is no license
information at all on that material; I'm not sure exactly how to
proceed.

To build this, use "makeinfo notmuch.texi"
You can then (perversely) view it without emacs with "info -f notmuch.info"
or in emacs with C-u C-h i notmuch.info.


 emacs/notmuch.texi | 274 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 emacs/version.texi |   2 +
 2 files changed, 276 insertions(+)
 create mode 100644 emacs/notmuch.texi
 create mode 100644 emacs/version.texi

diff --git a/emacs/notmuch.texi b/emacs/notmuch.texi
new file mode 100644
index 0000000..d4f7296
--- /dev/null
+++ b/emacs/notmuch.texi
@@ -0,0 +1,274 @@
+\input texinfo   @c -*-texinfo-*-
+@comment $Id@w{$}
+@comment %**start of header
+@setfilename notmuch.info
+@include version.texi
+@settitle Notmuch @value{VERSION}
+@comment %**end of header
+
+@macro keyindex {NAME}
+@kindex \NAME\
+@cindex \NAME\
+@end macro
+
+@macro funindex {NAME}
+@findex \NAME\
+@cindex \NAME\
+@end macro
+
+@macro varindex {NAME}
+@vindex \NAME\
+@cindex \NAME\
+@end macro
+
+
+@copying
+This manual is for Notmuch (version @value{VERSION}, @value{UPDATED})
+
+Copyright @copyright{} 2013 David Bremner
+
+This manual is distributed under the same terms as notmuch, which are as follows.
+@quotation
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see http://www.gnu.org/licenses/ .
+
+@end quotation
+@end copying
+
+@dircategory Texinfo documentation system
+@direntry
+* notmuch: (notmuch)Emacs interface to notmuch
+@end direntry
+
+@titlepage
+@title Notmuch
+@subtitle for version @value{VERSION}, @value{UPDATED}
+@author David Bremner (@email{david@@tethera.net})
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top
+@top Notmuch
+
+This manual is for Notmuch (version @value{VERSION}, @value{UPDATED}).
+@end ifnottex
+
+@menu
+* About this Manual::
+* notmuch-hello::
+* notmuch-search::
+* Search Syntax::
+* Configuration::
+* Function Index::
+* Variable Index::
+* Index::
+@end menu
+
+
+@node About this Manual
+@unnumbered About this Manual
+
+This manual covers only the emacs interface to notmuch. For
+information on the command line interface, see
+@url{http://notmuchmail.org/manpages/notmuch-1,the notmuch man page}.
+To save
+typing, we will sometimes use @emph{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 inteface as @emph{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 varables docstring.
+
+@node notmuch-hello
+@chapter notmuch-hello
+
+@funindex notmuch-hello
+@funindex notmuch
+
+@command{notmuch-hello} is the main entry point for notmuch. You can
+start it with @kbd{M-x notmuch} or @kbd{M-x notmuch-hello}. The
+startup screen looks something like the following. There are some
+hints at the bottom of the screen.  There are three main parts to the
+notmuch-hello screen, discussed below. The @strong{bold} text
+indicates buttons you can click with a mouse or by positioning the
+cursor and pressing @kbd{<return>}
+
+@example
+@group
+----------------------------------------------------------------------------
+
+   Welcome to @strong{notmuch}. You have 52 messages.
+
+Saved searches: @strong{[edit]}
+
+	  52 @strong{inbox}           52 @strong{unread}
+
+Search:                                                                     .
+
+All tags: @strong{[show]}
+
+	 Type a search query and hit RET to view matching threads.
+		Edit saved searches with the `edit' button.
+  Hit RET or click on a saved search or tag name to view matching threads.
+      `=' to refresh this screen. `s' to search messages. `q' to quit.
+		    @strong{Customize} this page.
+
+----------------------------------------------------------------------------
+@end group
+@end example
+
+You can change the overall appearence of the notmuch-hello screen by
+customizing the variable @var{notmuch-hello-sections}.
+@varindex{notmuch-hellow-sections}
+
+@menu
+* notemuch-hello Key Bindings::
+* Saved Searches::
+* Search Box::
+* Known Tags::
+@end menu
+
+@node notemuch-hello Key Bindings
+@section notmuch-hello key bindings
+
+@table @kbd
+
+@item <tab>
+      Move to the next widget (button or text entry field)
+@item <backtab>
+      Move to the previous widget.
+@item <return>
+      Activate the current widget.
+@item =
+Refresh the buffer; mainly update the counts of messages for various
+saved searches.
+@item G
+      Import mail, @xref{Importing Mail}.
+@item m
+      Compose a message
+@item s
+Search the notmuch database, @xref{notmuch-search}.
+@item v
+      Print notmuch version
+@item q
+Quit
+@end table
+
+
+@node Saved Searches
+@section Saved Searches
+@cindex Saved Searches
+
+@varindex notmuch-saved-searches
+@varindex notmuch-saved-search-sort-function
+@varindex notmuch-column-control
+
+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
+searchs. The initial defaults are @code{tag:inbox} and
+@code{tag:unread}, but you can customize the following variables
+
+
+@table @var
+@item notmuch-saved-searches
+A list of cons pairs, the first being the name to display, the second being a query string
+for notmuch. @xref{Search Syntax}, for more info.
+@item notmuch-saved-searches-sort-function
+   This variable controls how saved searches should be sorted. A value
+   of @code{nil} displays the saved searches in the order they are
+   stored in `notmuch-saved-searches'.
+@item notmuch-column-control
+      Controls the number of columns for displaying saved-searches/tags
+@end table
+
+@node Search Box
+@section Search Box
+@cindex Search Box
+
+@varindex notmuch-hello-recent-searches-max
+The search box lets the user enter an notmuch query.  @xref{Search
+Syntax}, for more info on notmuch query syntax. A history of recent
+searches is also displayed by default.  The latter is controlled by
+the variable @var{notmuch-hello-recent-searches-max}.
+
+@node Known Tags
+@section Know Tags
+@cindex Known Tags
+@varindex notmuch-hello-tag-list-make-query
+@varindex notmuch-hello-hide-tags
+@varindex notmuch-column-control
+
+One special kind of saved search provided by default is for each
+individual tag defined in the database. This can be controlled via the
+following variables.
+
+@table @var
+@item notmuch-hello-tag-list-make-query
+      Control how to construct a search (``virtual folder'') from a given tag.
+@item notmuch-hello-hide-tags
+      Which tags not to display at all.
+@item notmuch-column-control
+      Controls the number of columns for displaying saved-searches/tags
+@end table
+
+
+@node notmuch-search
+@chapter notmuch-search
+
+
+@node Search Syntax
+@chapter Search Syntax
+
+The canonical reference for notmuch search syntax is
+@url{http://notmuchmail.org/manpages/notmuch-search-terms-7,notmuch-search-terms(7)}
+
+@node Configuration
+@chapter Configuration
+
+
+@menu
+* Importing Mail::
+@end menu
+
+@node Importing Mail
+@section Importing Mail
+
+@funindex notmuch-poll
+@vindex notmuch-poll-script
+
+@node Function Index
+@unnumbered Function Index
+
+@printindex fn
+
+@node Variable Index
+@unnumbered Variable Index
+
+@printindex vr
+
+@node Index
+@unnumbered Index
+
+@printindex cp
+
+
+@bye
diff --git a/emacs/version.texi b/emacs/version.texi
new file mode 100644
index 0000000..4de9b21
--- /dev/null
+++ b/emacs/version.texi
@@ -0,0 +1,2 @@
+@set VERSION 0.15.2
+@set UPDATED April 01, 1970
-- 
1.8.2.rc1

^ permalink raw reply related	[flat|nested] 27+ messages in thread