\input texinfo   @c -*-texinfo-*-
@comment $Id@w{$}
@comment %**start of header
@setfilename notmuch-emacs.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})

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 Notmuch
@direntry
* notmuch-emacs: (notmuch-emacs).  Emacs interface to notmuch
@end direntry

@titlepage
@title Notmuch
@subtitle for version @value{VERSION}
@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}).
@end ifnottex

@menu
* About this Manual::
* notmuch-hello::
* notmuch-search::
* notmuch-show::
* notmuch-tree::
* 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
@xref{top,the notmuch man page,Description,notmuch,Notmuch Manual Pager}.
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
* notmuch-hello Key Bindings::
* Saved Searches::
* Search Box::
* Known Tags::
@end menu

@node notmuch-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{top,Notmuch Query
Syntax,Description,notmuch-search-terms,Notmuch Query Syntax}.

@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{top,Notmuch
Query Syntax,Description,notmuch-search-terms,Notmuch Query 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

@menu
* notmuch-search Key Bindings::
* notmuch-search Customization::
@end menu

@funindex notmuch-search-mode
@funindex notmuch-search

@command{notmuch-search-mode} is used to display the results from
executing a query via @command{notmuch-search}. The syntax for these
queries is the the same as for @xref{Saved Searches}, namely
@xref{top,Notmuch Query
Syntax,Description,notmuch-search-terms,Notmuch Query Syntax}.

By default the output approximates that of the command line
@xref{top,notmuch search command,Description,notmuch-search,notmuch search command}.

The main purpose of the @command{notmuch-search-mode} buffer is to act
as a menu of results that the user can explore further by pressing
@kbd{<return>} on the appropriate line.

@node notmuch-search Key Bindings
@table @kbd
@item n,C-n,<down>
      Move to next line
@item p,C-p,<up>
      Move to previous line
@item <return>
      Open thread on current line in @xref{notmuch-show}
@item ?
      Display full set of key bindings
@end table

@node notmuch-search Customization

@varindex notmuch-search-result-format
@varindex notmuch-search-oldest-first

The presentation of results can be controlled by the following variables.
@table @var
@item notmuch-search-result-format
      Control how each thread of messages is presented in the
      @command{notmuch-show-mode} buffer
@item notmuch-search-oldest-first
      Display the oldest threads at the top of the buffer
@end table

@node notmuch-show
@chapter notmuch-show

@node notmuch-tree
@chapter notmuch-tree

@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