Re:

Re:

[Thomas Schwinge]

[-- Attachment #1: Type: text/plain, Size: 2038 bytes --]

Hi!

On Mon, 10 Oct 2011 10:49:15 -0300, david@tethera.net wrote:
> OK, here is my proposal to add search terms to notmuch dump.

Having worked in the same area ;-), I felt competent to review this.  And
I definitely do like David's approach.  The patches look good, with the
following comments:

What's missing is adding (roughly) the same text to the notmuch manpage,
``notmuch help dump'', NEWS file.  These should be added to the
respective patches, for enhance functionality and deprecation of output
filename.

> 2b7781d test: all dump-restore tests should be working now
> 7a203d6 notmuch-dump: treat any remaining arguments after the filename as search t

I would suggest to combine these two into one patch: enhance
implementation (7a203d6) and update the tests (2b7781d) is one unit.

> d6715d7 test: add tests for command line arguments to notmuch-dump

Specifically:

On Mon, 10 Oct 2011 10:49:17 -0300, david@tethera.net wrote:
> The plan is to add the possibility of search terms after the file name,
> and the use of -- to stop looking for an output file name.
> ---
>  test/dump-restore |   28 ++++++++++++++++++++++++++++
>  1 files changed, 28 insertions(+), 0 deletions(-)
> 
> diff --git a/test/dump-restore b/test/dump-restore
> index 96c4f19..699337c 100755
> --- a/test/dump-restore
> +++ b/test/dump-restore
> @@ -8,6 +8,34 @@ test_expect_success "Dumping all tags" "generate_message &&
>  notmuch new &&
>  notmuch dump > dump.expected"
>  
> +test_begin_subtest "dump outfile"
> +notmuch dump dump-outfile.actual
> +test_expect_equal_file dump.expected dump-outfile.actual
> +
> +test_begin_subtest "dump outfile --"
> +notmuch dump dump-1-arg-dash.actual
> +test_expect_equal_file dump.expected dump-1-arg-dash.actual
> 
> [...]

I don't understand the purpose of the second test above.  Was this meant
to be ``notmuch dump dump-1-arg-dash.actual --'' (as suggested by the
description), or ``notmuch dump -- > dump-1-arg-dash.actual''?


Grüße,
 Thomas

[-- Attachment #2: Type: application/pgp-signature, Size: 489 bytes --]

Re:

[David Bremner]

On Sun, 16 Oct 2011 22:34:29 +0200, Thomas Schwinge <thomas@schwinge.name> wrote:

> Having worked in the same area ;-), I felt competent to review this.  And
> I definitely do like David's approach.  The patches look good, with the
> following comments:

Thanks for the review.  I pushed a modified version of the series which
I think fixed all of the things you noticed.

d

Re:

[David Bremner]

On Tue, 24 Jan 2012 16:06:15 -0800, Jameson Graef Rollins <jrollins@finestructure.net> wrote:
> Final v3 rework of this patch series:
> 

pushed.

d

Re:

[Pieter Praet]

On Thu,  2 Feb 2012 00:01:31 -0400, David Bremner <david@tethera.net> wrote:
> I rebased these against branch release (and copied a comment from
> aaron's email), but the test fails there, as does the reply within emacs test.
> 

Same issue here.


That mark was introduced in commit 03146f20, so isn't available in the
release branch yet.  Let's just use `point-max' instead, merge 'release'
into 'master', and change it back to `mark' there.  It's better to break
MML tags in the user's sig for a little while than leave this security
hole wide open.


Same issue wrt commit 66ecd906;  the citation line should still be:
  On Tue, 05 Jan 2001 15:43:57 -0000, Notmuch Test Suite <test_suite@notmuchmail.org> wrote:
instead of:
  On Fri, 05 Jan 2001 15:43:57 +0000, Notmuch Test Suite <test_suite@notmuchmail.org> wrote:


Fixed patches follow, including a post-merge fix.


> FAIL   Reply within emacs
> 	--- emacs.24.expected	2012-02-02 03:55:14.000000000 +0000
> 	+++ emacs.24.output	2012-02-02 03:55:14.000000000 +0000
> 	@@ -1,8 +1,4 @@
> 	 From: Notmuch Test Suite <test_suite@notmuchmail.org>
> 	-To: user@example.com
> 	-Subject: Re: Testing message sent via SMTP
> 	-In-Reply-To: <XXX>
> 	-Fcc: /home/bremner/software/upstream/notmuch/test/tmp.emacs/mail/sent
> 	+To: 
> 	+Subject: 
> 	 --text follows this line--
> 	-On 01 Jan 2000 12:00:00 -0000, Notmuch Test Suite <test_suite@notmuchmail.org> wrote:
> 	-> This is a test that messages are sent via SMTP
> *ERROR*: Wrong type argument: integer-or-marker-p, nil
>  FAIL   Quote MML tags in reply
> 	--- emacs.25.expected	2012-02-02 03:55:15.000000000 +0000
> 	+++ emacs.25.output	2012-02-02 03:55:15.000000000 +0000
> 	@@ -1,7 +1,4 @@
> 	 From: Notmuch Test Suite <test_suite@notmuchmail.org>
> 	 To: 
> 	-Subject: Re: Quote MML tags in reply
> 	-In-Reply-To: <test-emacs-mml-quoting@message.id>
> 	+Subject: 
> 	 --text follows this line--
> 	-On Fri, 05 Jan 2001 15:43:57 +0000, Notmuch Test Suite <test_suite@notmuchmail.org> wrote:
> 	-> <#!part disposition=inline>
> *ERROR*: Wrong type argument: integer-or-marker-p, nil
> 
> 
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch


Peace

-- 
Pieter

Re:

[Mark Walters]

[-- Attachment #1: Type: text/plain, Size: 863 bytes --]


Hi

This is looking good: I have two comments the second of which is significant.

The first is do you want to sort (alphabetically) the headerline tags?
As it stands they are in the order they appear in the thread which is
probably not what is wanted.

The second is that there is a notmuch-show-tag-all functions to tag all
messages in the thread. Your patch is quadratic for the update (as it
calculates the list of thread tags once for each message). The attached
patch would avoid this and doesn't look too bad. (Note I retained
no-headerline-update as an optional argument in case there are out of
tree callers, eg users' .emacs files)

[Note this is not purely of academic interest: on my test large thread
(178 messages) updating the display after tagging all messages took some
seconds without my patch and almost no time with it.]

Best wishes 

Mark


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-mjw-tweak.patch --]
[-- Type: text/x-diff, Size: 2186 bytes --]

From ab15a4bdb50bcf6b2851806195bbe8bea3b099dc Mon Sep 17 00:00:00 2001
From: Mark Walters <markwalters1009@gmail.com>
Date: Thu, 13 Dec 2012 11:23:09 +0000
Subject: [PATCH] Avoid quadratic update

---
 emacs/notmuch-show.el |   12 +++++++-----
 1 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 93bce07..8dd6010 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -356,7 +356,7 @@ operation on the contents of the current buffer."
   "Return a string comprised of `n' spaces."
   (make-string n ? ))
 
-(defun notmuch-show-update-tags (tags)
+(defun notmuch-show-update-tags (tags &optional no-headerline-update)
   "Update the displayed tags of the current message."
   (save-excursion
     (goto-char (notmuch-show-message-top))
@@ -364,7 +364,8 @@ operation on the contents of the current buffer."
 	(let ((inhibit-read-only t))
 	  (replace-match (propertize (notmuch-tagger-format-tags tags)
 				     'face 'notmuch-tag-face)))))
-  (notmuch-show-update-header-line))
+  (unless no-headerline-update
+    (notmuch-show-update-header-line)))
 
 (defun notmuch-clean-address (address)
   "Try to clean a single email ADDRESS for display. Return a cons
@@ -1461,10 +1462,10 @@ current thread."
 (defun notmuch-show-get-depth ()
   (notmuch-show-get-prop :depth))
 
-(defun notmuch-show-set-tags (tags)
+(defun notmuch-show-set-tags (tags &optional no-headerline-update)
   "Set the tags of the current message."
   (notmuch-show-set-prop :tags tags)
-  (notmuch-show-update-tags tags))
+  (notmuch-show-update-tags tags no-headerline-update))
 
 (defun notmuch-show-get-tags ()
   "Return the tags of the current message."
@@ -1778,7 +1779,8 @@ See `notmuch-tag' for information on the format of TAG-CHANGES."
      (let* ((current-tags (notmuch-show-get-tags))
 	    (new-tags (notmuch-update-tags current-tags tag-changes)))
        (unless (equal current-tags new-tags)
-	 (notmuch-show-set-tags new-tags))))))
+	 (notmuch-show-set-tags new-tags t)))))
+  (notmuch-show-update-header-line))
 
 (defun notmuch-show-add-tag ()
   "Same as `notmuch-show-tag' but sets initial input to '+'."
-- 
1.7.9.1


[-- Attachment #3: Type: text/plain, Size: 1489 bytes --]




On Tue, 11 Dec 2012, Damien Cassou <damien.cassou@gmail.com> wrote:
> From: Damien Cassou <damien.cassou@gmail.com>
> Subject: [PATCH v4] emacs: display tags in notmuch-show with links
> In-Reply-To: 
>
> This patch obsoletes:
> id:1355149964-27905-1-git-send-email-damien.cassou@gmail.com
>
> [PATCH 1/4] emacs: Add a thread's tags to notmuch-show header-line
> [PATCH 2/4] emacs: Make tags in notmuch-show header-line clickable
> [PATCH 3/4] emacs: Make all tags in `notmuch-show' clickable
> [PATCH 4/4] emacs: Add unit-tests for clickable tags
>
> These patches make clickable all tags that appear in notmuch-show
> buffers. Each tag is a link to open a new notmuch-search buffer for
> this tag. Additionally, the buffer's header-line now shows the
> thread's tags (clickable only if the `header-button' library is loaded
> or loadable).
>
> These patches are the first of an upcoming series whose goal is to
> integrate notmuch-labeler into notmuch. See the following for more
> details: https://github.com/DamienCassou/notmuch-labeler
>
> With respect to v3, I took care of the comments you made:
> - the header-line now updates when tags are changed
> - the tags in the body stays clickable when tags are changed
>
> Additionally, I added two unit tests to cover the above two comments
> and fixed some others unit tests of mine.
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re:

[David Bremner]

david@tethera.net writes:

> Hi Gang;
>
> Here are some proposed changes to the debian packaging for 0.15.
>
> Most will probably be boring to people not familiar with debian
> packaging, with the excepotion of 4/5, which has a shell pipeline with
> two xargs in it, and almost can certainly be improved by several
> readers of this list.

As Tomi suggested, I left this alone and pushed as is for now.

d

Re:

[David Bremner]

Martin Owens <doctormo@gmail.com> writes:

> Looking at trunk it looks like this code was rewritten completely.
> Should the packages be ignored and should trunk be used instead?

Hi Martin;

Probably somebody needs to poke the folks at Ubuntu to sync from Debian
experimental again; the packages in experimental are very close to that
in git.

d

[RFC Patch] start of sphinx based docs

[David Bremner]

---

here is quick and dirty start a sphinx based docs.
This has the advantage that everything is in rst, no mixed formats.

things you might try, after installing sphinx (only tested with 1.2)

% make -C doc man

% make -C doc info

% man -l doc/_build/man/notmuch-search.1

% info -f doc/_build/texinfo/notmuch-emacs.info

 doc/Makefile                 | 177 ++++++++++++++++++++++++++++
 doc/conf.py                  | 272 +++++++++++++++++++++++++++++++++++++++++++
 doc/index.rst                |  24 ++++
 doc/notmuch-emacs.rst        | 188 ++++++++++++++++++++++++++++++
 doc/notmuch-search-terms.rst | 255 ++++++++++++++++++++++++++++++++++++++++
 doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++
 doc/notmuch.rst              | 173 +++++++++++++++++++++++++++
 7 files changed, 1292 insertions(+)
 create mode 100644 doc/Makefile
 create mode 100644 doc/conf.py
 create mode 100644 doc/index.rst
 create mode 100644 doc/notmuch-emacs.rst
 create mode 100644 doc/notmuch-search-terms.rst
 create mode 100644 doc/notmuch-search.rst
 create mode 100644 doc/notmuch.rst

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..906268c
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/notmuch.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/notmuch.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/notmuch"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/notmuch"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..d9f7b22
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,272 @@
+# -*- coding: utf-8 -*-
+#
+# notmuch documentation build configuration file, created by
+# sphinx-quickstart on Fri Jan 17 22:34:14 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'notmuch'
+copyright = u'2014, Carl Worth and many others'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.17'
+# The full version, including alpha/beta/rc tags.
+release = '0.17'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'notmuchdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'notmuch.tex', u'notmuch Documentation',
+   u'Carl Worth and many others', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('notmuch', 'notmuch', u'thread-based email index, search, and tagging',
+     [u'Carl Worth and many others'], 1),
+    ('notmuch-search', 'notmuch-search', u'search the notmuch mail index',
+     [u'Carl Worth and many others'], 1),
+    ('notmuch-search-terms', 'notmuch-search-terms', u'query format for notmuch',
+     [u'Carl Worth and many others'], 7),
+
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('notmuch', 'notmuch', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch', 'thread-based email index, search and tagging',
+   'Miscellaneous'),
+  ('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-emacs', 'emacs based front-end for notmuch',
+   'Miscellaneous'),
+  ('notmuch-search', 'notmuch-search', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-search', 'search the notmuch mail index.',
+   'Miscellaneous'),
+  ('notmuch-search-terms', 'notmuch-search-terms', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-search-terms', 'query syntax for notmuch.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+texinfo_no_detailmenu = True
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..c05c855
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,24 @@
+.. notmuch documentation master file, created by
+   sphinx-quickstart on Fri Jan 17 22:34:14 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to notmuch's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   notmuch
+   notmuch-emacs
+   notmuch-search
+   notmuch-search-terms
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
new file mode 100644
index 0000000..283bf69
--- /dev/null
+++ b/doc/notmuch-emacs.rst
@@ -0,0 +1,188 @@
+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 inteface 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 varables docstring.
+
+notmuch-hello
+=============
+
+.. index::
+   single: notmuch-hello
+   single: notmuch
+
+``notmuch-hello`` is the main entry point for notmuch. You can start it
+with ``M-x notmuch`` or ``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 **bold** text indicates buttons you can click with
+a mouse or by positioning the cursor and pressing ``<return>``
+
+|   Welcome to **notmuch** You have 52 messages.
+|
+| Saved searches: **[edit]**
+|
+|	  52 **inbox**           52 **unread**
+|
+| Search: ____________________________________
+|
+| All tags: **[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.
+|		    **Customize** this page.
+
+You can change the overall appearence of the notmuch-hello screen by
+customizing the variable :index:`notmuch-hello-sections`.
+
+
+
+notmuch-hello key bindings
+--------------------------
+
+``<tab>``
+    Move to the next widget (button or text entry field)
+
+``<backtab>``
+    Move to the previous widget.
+
+``<return>``
+    Activate the current widget.
+
+``=``
+    Refresh the buffer; mainly update the counts of messages for various
+    saved searches.
+
+``G``
+    Import mail, See :ref:`importing`
+
+``m``
+    Compose a message
+
+``s``
+    Search the notmuch database using :ref:`notmuch-search`
+
+``v``
+    Print notmuch version
+
+``q``
+    Quit
+
+.. _saved-searches:
+
+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 searchs. The initial defaults are ``tag:inbox`` and
+``tag:unread``, but you can customize the following variables
+
+: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.
+
+:index:`notmuch-saved-searches-sort-function`
+    This variable controls how saved searches should be sorted. A value
+    of ``nil`` displays the saved searches in the order they are stored
+    in ‘notmuch-saved-searches’.
+
+:index:`notmuch-column-control`
+    Controls the number of columns for displaying saved-searches/tags
+
+Search Box
+----------
+
+The search box lets the user enter an notmuch query. See section
+“Description” in 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 :index:`notmuch-hello-recent-searches-max`.
+
+Known Tags
+----------
+
+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.
+
+:index:`notmuch-hello-tag-list-make-query`
+    Control how to construct a search (“virtual folder”) from a given
+    tag.
+
+:index:`notmuch-hello-hide-tags`
+    Which tags not to display at all.
+
+:index:`notmuch-column-control`
+    Controls the number of columns for displaying saved-searches/tags
+
+.. _notmuch-search:
+
+notmuch-search
+==============
+
+``notmuch-search-mode`` is used to display the results from executing
+a query via ``notmuch-search``. The syntax for these queries is the
+the same as :ref:`saved-searches`. For details of this syntax see
+info:notmuch-search-terms
+
+By default the output approximates that of the command line See section
+“Description” in notmuch search command.
+
+The main purpose of the ``notmuch-search-mode`` buffer is to act as a
+menu of results that the user can explore further by pressing
+``<return>`` on the appropriate line.
+
+``n,C-n,<down>``
+    Move to next line
+
+``p,C-p,<up>``
+    Move to previous line
+
+``<return>``
+    Open thread on current line in :ref:`notmuch-show` mode
+
+``?``
+    Display full set of key bindings
+
+The presentation of results can be controlled by the following
+variables.
+
+:index:`notmuch-search-result-format`
+    Control how each thread of messages is presented in the
+    ``notmuch-show-mode`` buffer
+
+:index:`notmuch-search-oldest-first`
+    Display the oldest threads at the top of the buffer
+
+.. _notmuch-show:
+
+notmuch-show
+============
+
+notmuch-tree
+============
+
+Configuration
+=============
+
+.. _importing:
+
+Importing Mail
+--------------
+
+:index:`notmuch-poll`
+
+:index:`notmuch-poll-script`
diff --git a/doc/notmuch-search-terms.rst b/doc/notmuch-search-terms.rst
new file mode 100644
index 0000000..7885c6a
--- /dev/null
+++ b/doc/notmuch-search-terms.rst
@@ -0,0 +1,255 @@
+====================
+notmuch-search-terms
+====================
+
+********
+Synopsis
+********
+
+
+\ **notmuch**\  \ **count**\  [\ *options...*\ ] <\ *search-term*\ >...
+
+\ **notmuch**\  \ **dump**\  [ <\ *filename*\ > ] [--] [ <\ *search-term*\ >...]
+
+\ **notmuch**\  \ **search**\  [\ *options*\ ...] <\ *search-term*\ >...
+
+\ **notmuch**\  \ **show**\  [\ *options*\ ...] <\ *search-term*\ >...
+
+\ **notmuch**\  \ **tag**\  +<\ *tag*\ >|-<\ *tag*\ > [...] [--] <\ *search-term*\ >...
+
+
+***********
+Description
+***********
+
+
+Several notmuch commands accept a common syntax for search terms.
+
+The search terms can consist of free-form text (and quoted phrases)
+which will match all messages that contain all of the given
+terms/phrases in the body, the subject, or any of the sender or
+recipient headers.
+
+As a special case, a search string consisting of exactly a single
+asterisk ("\*") will match all messages.
+
+In addition to free text, the following prefixes can be used to force
+terms to match against specific portions of an email, (where <brackets>
+indicate user-supplied values):
+
+from:<name-or-address>
+
+to:<name-or-address>
+
+subject:<word-or-quoted-phrase>
+
+attachment:<word>
+
+tag:<tag> (or is:<tag>)
+
+id:<message-id>
+
+thread:<thread-id>
+
+folder:<directory-path>
+
+date:<since>..<until>
+
+The \ **from:**\  prefix is used to match the name or address of the sender of
+an email message.
+
+The \ **to:**\  prefix is used to match the names or addresses of any recipient
+of an email message, (whether To, Cc, or Bcc).
+
+Any term prefixed with \ **subject:**\  will match only text from the subject
+of an email. Searching for a phrase in the subject is supported by
+including quotation marks around the phrase, immediately following
+\ **subject:**\ .
+
+The \ **attachment:**\  prefix can be used to search for specific filenames (or
+extensions) of attachments to email messages.
+
+For \ **tag:**\  and \ **is:**\  valid tag values include \ **inbox**\  and \ **unread**\  by default
+for new messages added by \ **notmuch**\  \ **new**\  as well as any other tag values
+added manually with \ **notmuch**\  \ **tag**\ .
+
+For \ **id:**\ , message ID values are the literal contents of the Message-ID:
+header of email messages, but without the \`<', \`>' delimiters.
+
+The \ **thread:**\  prefix can be used with the thread ID values that are
+generated internally by notmuch (and do not appear in email messages).
+These thread ID values can be seen in the first column of output from
+\ **notmuch**\  \ **search**\
+
+The \ **folder:**\  prefix can be used to search for email message files that
+are contained within particular directories within the mail store. If
+the same email message has multiple message files associated with it,
+it's sufficient for a match that at least one of the files is contained
+within a matching directory. Only the directory components below the
+top-level mail database path are available to be searched.
+
+The \ **date:**\  prefix can be used to restrict the results to only messages
+within a particular time range (based on the Date: header) with a range
+syntax of:
+
+date:<since>..<until>
+
+See \ **DATE**\  \ **AND**\  \ **TIME**\  \ **SEARCH**\  below for details on the range expression, and
+supported syntax for <since> and <until> date and time expressions.
+
+The time range can also be specified using timestamps with a syntax of:
+
+<initial-timestamp>..<final-timestamp>
+
+Each timestamp is a number representing the number of seconds since
+1970-01-01 00:00:00 UTC.
+
+In addition to individual terms, multiple terms can be combined with
+Boolean operators ( \ **and**\ , \ **or**\ , \ **not**\  , etc.). Each term in the query will
+be implicitly connected by a logical AND if no explicit operator is
+provided, (except that terms with a common prefix will be implicitly
+combined with OR until we get Xapian defect #402 fixed).
+
+Parentheses can also be used to control the combination of the Boolean
+operators, but will have to be protected from interpretation by the
+shell, (such as by putting quotation marks around any parenthesized
+expression).
+
+
+********************
+Date and Time Search
+********************
+
+
+notmuch understands a variety of standard and natural ways of
+expressing dates and times, both in absolute terms ("2012-10-24") and
+in relative terms ("yesterday"). Any number of relative terms can be
+combined ("1 hour 25 minutes") and an absolute date/time can be
+combined with relative terms to further adjust it. A non-exhaustive
+description of the syntax supported for absolute and relative terms is
+given below.
+
+\ **The**\  \ **range**\  \ **expression**\
+
+date:<since>..<until>
+
+The above expression restricts the results to only messages
+from <since> to <until>, based on the Date: header.
+
+<since> and <until> can describe imprecise times, such as
+"yesterday". In this case, <since> is taken as the earliest
+time it could describe (the beginning of yesterday) and <until>
+is taken as the latest time it could describe (the end of
+yesterday). Similarly, date:january..february matches from the
+beginning of January to the end of February.
+
+Currently, we do not support spaces in range expressions. You
+can replace the spaces with \`_', or (in most cases) \`-', or (in
+some cases) leave the spaces out altogether. Examples in this
+man page use spaces for clarity.
+
+Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's
+possible to specify date:..<until> or date:<since>.. to not
+limit the start or end time, respectively. Pre-1.2.1 Xapian
+does not report an error on open ended ranges, but it does not
+work as expected either.
+
+Entering date:expr without ".." (for example date:yesterday)
+won't work, as it's not interpreted as a range expression at
+all. You can achieve the expected result by duplicating the
+expr both sides of ".." (for example
+date:yesterday..yesterday).
+
+\ **Relative**\  \ **date**\  \ **and**\  \ **time**\
+[N|number]
+(years|months|weeks|days|hours|hrs|minutes|mins|seconds|secs)
+[...]
+
+All refer to past, can be repeated and will be accumulated.
+
+Units can be abbreviated to any length, with the otherwise
+ambiguous single m being m for minutes and M for months.
+
+Number can also be written out one, two, ..., ten, dozen,
+hundred. Additionally, the unit may be preceded by "last" or
+"this" (e.g., "last week" or "this month").
+
+When combined with absolute date and time, the relative date
+and time specification will be relative from the specified
+absolute date and time.
+
+Examples: 5M2d, two weeks
+
+\ **Supported**\  \ **absolute**\  \ **time**\  \ **formats**\
+H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
+
+H[H] (am|a.m.|pm|p.m.)
+
+
+HHMMSS
+
+
+
+now
+
+noon
+
+midnight
+
+Examples: 17:05, 5pm
+
+\ **Supported**\  \ **absolute**\  \ **date**\  \ **formats**\
+YYYY-MM[-DD]
+
+
+DD-MM[-[YY]YY]
+
+
+
+MM-YYYY
+
+
+
+M[M]/D[D][/[YY]YY]
+
+
+
+M[M]/YYYY
+
+
+
+D[D].M[M][.[YY]YY]
+
+
+
+D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
+
+Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
+
+Wee[kday]
+
+Month names can be abbreviated at three or more characters.
+
+Weekday names can be abbreviated at three or more characters.
+
+Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
+
+\ **Time**\  \ **zones**\
+(+|-)HH:MM
+
+
+(+|-)HH[MM]
+
+
+
+Some time zone codes, e.g. UTC, EET.
+
+
+********
+See Also
+********
+
+
+notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),
+notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1),
+notmuch-restore(1), notmuch-search(1), notmuch-show(1), notmuch-tag(1)
diff --git a/doc/notmuch-search.rst b/doc/notmuch-search.rst
new file mode 100644
index 0000000..deb7e8b
--- /dev/null
+++ b/doc/notmuch-search.rst
@@ -0,0 +1,203 @@
+==============
+notmuch-search
+==============
+
+
+********
+Synopsis
+********
+
+
+\ **notmuch**\  \ **search**\  [\ *options*\ ...] <\ *search-term*\ >...
+
+
+***********
+Description
+***********
+
+
+Search for messages matching the given search terms, and display as
+results the threads containing the matched messages.
+
+The output consists of one line per thread, giving a thread ID, the
+date of the newest (or oldest, depending on the sort option) matched
+message in the thread, the number of matched messages and total
+messages in the thread, the names of all participants in the thread,
+and the subject of the newest (or oldest) message.
+
+See notmuch-search-terms(7) for details of the supported syntax for
+<search-terms>.
+
+Supported options for \ **search**\  include
+
+
+  **--format=** ( **json** | **sexp** | **text** |  **text0** )
+
+
+
+Presents the results in either JSON, S-Expressions, newline
+character separated plain-text (default), or null character
+separated plain-text (compatible with xargs(1) -0 option where
+available).
+
+
+\ **--format-version=N**\
+
+
+
+Use the specified structured output format version. This is
+intended for programs that invoke notmuch(1) internally. If
+omitted, the latest supported version will be used.
+
+
+\ **--output=(summary|threads|messages|files|tags)**\
+
+
+
+\ **summary**\
+
+Output a summary of each thread with any message matching
+the search terms. The summary includes the thread ID, date,
+the number of messages in the thread (both the number
+matched and the total number), the authors of the thread
+and the subject.
+
+\ **threads**\
+
+Output the thread IDs of all threads with any message
+matching the search terms, either one per line
+(--format=text), separated by null characters
+(--format=text0), as a JSON array (--format=json), or an S-
+Expression list (--format=sexp).
+
+\ **messages**\
+
+Output the message IDs of all messages matching the search
+terms, either one per line (--format=text), separated by
+null characters (--format=text0), as a JSON array
+(--format=json), or as an S-Expression list
+(--format=sexp).
+
+\ **files**\
+
+Output the filenames of all messages matching the search
+terms, either one per line (--format=text), separated by
+null characters (--format=text0), as a JSON array
+(--format=json), or as an S-Expression list
+(--format=sexp).
+
+Note that each message may have multiple filenames
+associated with it. All of them are included in the
+output, unless limited with the --duplicate=N option.
+
+\ **tags**\
+
+Output all tags that appear on any message matching the
+search terms, either one per line (--format=text),
+separated by null characters (--format=text0), as a JSON
+array (--format=json), or as an S-Expression list
+(--format=sexp).
+
+
+\ **--sort=** (\ **newest-first** | **oldest-first** )
+
+
+
+This option can be used to present results in either
+chronological order (\ **oldest-first**\ ) or reverse chronological
+order (\ **newest-first**\ ).
+
+Note: The thread order will be distinct between these two
+options (beyond being simply reversed). When sorting by
+\ **oldest-first**\  the threads will be sorted by the oldest message
+in each thread, but when sorting by \ **newest-first**\  the threads
+will be sorted by the newest message in each thread.
+
+By default, results will be displayed in reverse chronological
+order, (that is, the newest results will be displayed first).
+
+
+\ **--offset=[-]N**\
+
+
+
+Skip displaying the first N results. With the leading \`-',
+start at the Nth result from the end.
+
+
+\ **--limit=N**\
+
+
+
+Limit the number of displayed results to N.
+
+
+\ **--exclude=(true|false|all|flag)**\
+
+
+
+A message is called "excluded" if it matches at least one tag
+in search.tag_exclude that does not appear explicitly in the
+search terms. This option specifies whether to omit excluded
+messages in the search process.
+
+The default value, \ **true**\ , prevents excluded messages from
+matching the search terms.
+
+\ **all**\  additionally prevents excluded messages from appearing in
+displayed results, in effect behaving as though the excluded
+messages do not exist.
+
+\ **false**\  allows excluded messages to match search terms and appear
+in displayed results. Excluded messages are still marked in the
+relevant outputs.
+
+\ **flag**\  only has an effect when \ **--output=summary**\ . The output is
+almost identical to \ **false**\ , but the "match count" is the number
+of matching non-excluded messages in the thread, rather than
+the number of matching messages.
+
+
+\ **--duplicate=N**\
+
+
+
+Effective with \ **--output=files**\ , output the Nth filename
+associated with each message matching the query (N is 1-based).
+If N is greater than the number of files associated with the
+message, don't print anything.
+
+Note that this option is orthogonal with the \ **folder:**\  search
+prefix. The prefix matches messages based on filenames. This
+option filters filenames of the matching messages.
+
+
+***********
+Exit Status
+***********
+
+
+This command supports the following special exit status codes
+
+
+\ **20**\
+
+   The requested format version is too old.
+
+
+\ **21**\
+
+   The requested format version is too new.
+
+
+
+
+
+********
+See Also
+********
+
+
+notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),
+notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1),
+notmuch-restore(1), notmuch-search-terms(7), notmuch-show(1), notmuchtag(1)
diff --git a/doc/notmuch.rst b/doc/notmuch.rst
new file mode 100644
index 0000000..9d9a35c
--- /dev/null
+++ b/doc/notmuch.rst
@@ -0,0 +1,173 @@
+========
+notmuch
+========
+
+Synopsis
+========
+
+
+\ **notmuch**\  [\ *option*\  ...] \ *command*\  [\ *arg*\  ...]
+
+
+Description
+===========
+
+
+Notmuch is a command-line based program for indexing, searching,
+reading, and tagging large collections of email messages.
+
+This page describes how to get started using notmuch from the command
+line, and gives a brief overview of the commands available. For more
+information on e.g. \ **notmuch**\  \ **show**\  consult the notmuch-show(1) man page,
+also accessible via \ **notmuch**\  \ **help**\  \ **show**\
+
+The quickest way to get started with Notmuch is to simply invoke the
+\ **notmuch**\  command with no arguments, which will interactively guide you
+through the process of indexing your mail.
+
+Note
+====
+
+
+While the command-line program \ **notmuch**\  provides powerful functionality,
+it does not provide the most convenient interface for that
+functionality. More sophisticated interfaces are expected to be built
+on top of either the command-line interface, or more likely, on top of
+the notmuch library interface. See http://notmuchmail.org for more
+about alternate interfaces to notmuch. The emacs-based interface to
+notmuch (available under \ **emacs/**\  in the Notmuch source distribution) is
+probably the most widely used at this time.
+
+Options
+========
+
+
+Supported global options for \ **notmuch**\  include
+
+
+\ **--help**\
+
+
+
+Print a synopsis of available commands and exit.
+
+
+\ **--version**\
+
+
+
+Print the installed version of notmuch, and exit.
+
+
+\ **--config=FILE**\
+
+
+
+Specify the configuration file to use. This overrides any
+configuration file specified by ${NOTMUCH_CONFIG}.
+
+Commands
+========
+
+
+\ **SETUP**\
+The \ **notmuch**\  \ **setup**\  command is used to configure Notmuch for first use,
+(or to reconfigure it later).
+
+The setup command will prompt for your full name, your primary email
+address, any alternate email addresses you use, and the directory
+containing your email archives. Your answers will be written to a
+configuration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-
+config . This configuration file will be created with descriptive
+comments, making it easy to edit by hand later to change the
+configuration. Or you can run \ **notmuch**\  \ **setup**\  again to change the
+configuration.
+
+The mail directory you specify can contain any number of sub-
+directories and should primarily contain only files with individual
+email messages (eg. maildir or mh archives are perfect). If there are
+other, non-email files (such as indexes maintained by other email
+programs) then notmuch will do its best to detect those and ignore
+them.
+
+Mail storage that uses mbox format, (where one mbox file contains many
+messages), will not work with notmuch. If that's how your mail is
+currently stored, it is recommended you first convert it to maildir
+format with a utility such as mb2md before running \ **notmuch**\  \ **setup**\  \ **.**\
+
+Invoking \ **notmuch**\  with no command argument will run \ **setup**\  if the setup
+command has not previously been completed.
+
+\ **OTHER**\  \ **COMMANDS**\
+Several of the notmuch commands accept search terms with a common
+syntax. See notmuch-search-terms(7) for more details on the supported
+syntax.
+
+The \ **search**\ , \ **show**\  and \ **count**\  commands are used to query the email
+database.
+
+The \ **reply**\  command is useful for preparing a template for an email
+reply.
+
+The \ **tag**\  command is the only command available for manipulating database
+contents.
+
+The \ **dump**\  and \ **restore**\  commands can be used to create a textual dump of
+email tags for backup purposes, and to restore from that dump.
+
+The \ **config**\  command can be used to get or set settings int the notmuch
+configuration file.
+
+
+Environment
+===========
+
+
+The following environment variables can be used to control the behavior
+of notmuch.
+
+
+\ **NOTMUCH_CONFIG**\
+
+ Specifies the location of the notmuch configuration file.
+ Notmuch will use ${HOME}/.notmuch-config if this variable is not
+ set.
+
+
+
+\ **NOTMUCH_TALLOC_REPORT**\
+
+ Location to write a talloc memory usage report. See
+ \ **talloc_enable_leak_report_full**\  in talloc(3) for more
+ information.
+
+
+
+\ **NOTMUCH_DEBUG_QUERY**\
+
+ If set to a non-empty value, the notmuch library will print (to
+ stderr) Xapian queries it constructs.
+
+
+See Also
+========
+
+
+notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
+notmuch-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1),
+notmuch-search(1), notmuch-search-terms(7), notmuch-show(1),
+notmuch-tag(1)
+
+The notmuch website: \ **http://notmuchmail.org**\
+
+
+Contact
+========
+
+
+Feel free to send questions, comments, or kudos to the notmuch mailing
+list <notmuch@notmuchmail.org> . Subscription is not required before
+posting, but is available from the notmuchmail.org website.
+
+Real-time interaction with the Notmuch community is available via IRC
+(server: irc.freenode.net, channel: #notmuch).
-- 
1.8.5.2

Re: [RFC Patch] start of sphinx based docs

[Tomi Ollila]

On Sat, Jan 18 2014, David Bremner <david@tethera.net> wrote:

> ---
>
> here is quick and dirty start a sphinx based docs.
> This has the advantage that everything is in rst, no mixed formats.
>
> things you might try, after installing sphinx (only tested with 1.2)
>
> % make -C doc man
>
> % make -C doc info
>
> % man -l doc/_build/man/notmuch-search.1
>
> % info -f doc/_build/texinfo/notmuch-emacs.info

This looks like a good plan, only Makefile & conf.py is a bit noisy
(like Jani's original Doxyfile)

Also;
centos 6$ sudo yum install python-sphinx
...
Downloading Packages:
(1/5): python-babel-0.9.4-5.1.el6.noarch.rpm             | 1.4 MB     00:07    
(2/5): python-jinja2-2.2.1-1.el6.x86_64.rpm              | 464 kB     00:02    
(3/5): python-pygments-1.1.1-1.el6.noarch.rpm            | 561 kB     00:02    
(4/5): python-setuptools-0.6.10-3.el6.noarch.rpm         | 335 kB     00:01    
(5/5): python-sphinx-0.6.6-2.el6.noarch.rpm              | 486 kB     00:02  
---------------------------------------------------------------------------
Total                                           200 kB/s | 3.2 MB     00:16

(python-docutils were already installed)
I wonder how hard it is to install these on some systems...

>
>  doc/Makefile                 | 177 ++++++++++++++++++++++++++++
>  doc/conf.py                  | 272 +++++++++++++++++++++++++++++++++++++++++++
>  doc/index.rst                |  24 ++++
>  doc/notmuch-emacs.rst        | 188 ++++++++++++++++++++++++++++++
>  doc/notmuch-search-terms.rst | 255 ++++++++++++++++++++++++++++++++++++++++
>  doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++
>  doc/notmuch.rst              | 173 +++++++++++++++++++++++++++
>  7 files changed, 1292 insertions(+)
>  create mode 100644 doc/Makefile
>  create mode 100644 doc/conf.py
>  create mode 100644 doc/index.rst
>  create mode 100644 doc/notmuch-emacs.rst
>  create mode 100644 doc/notmuch-search-terms.rst
>  create mode 100644 doc/notmuch-search.rst
>  create mode 100644 doc/notmuch.rst
>

Re: [RFC Patch] start of sphinx based docs

[David Bremner]

Tomi Ollila <tomi.ollila@iki.fi> writes:

>
> This looks like a good plan, only Makefile & conf.py is a bit noisy
> (like Jani's original Doxyfile)

That should be easy to fix. Whoevery posted that patch was incredibly
lazy ;).

> Also;
> centos 6$ sudo yum install python-sphinx
> ...
> Downloading Packages:
> (1/5): python-babel-0.9.4-5.1.el6.noarch.rpm             | 1.4 MB     00:07    
> (2/5): python-jinja2-2.2.1-1.el6.x86_64.rpm              | 464 kB     00:02    
> (3/5): python-pygments-1.1.1-1.el6.noarch.rpm            | 561 kB     00:02    
> (4/5): python-setuptools-0.6.10-3.el6.noarch.rpm         | 335 kB     00:01    
> (5/5): python-sphinx-0.6.6-2.el6.noarch.rpm              | 486 kB     00:02  
> ---------------------------------------------------------------------------
> Total                                           200 kB/s | 3.2 MB     00:16
>
> (python-docutils were already installed)
> I wonder how hard it is to install these on some systems...

It's definitely a concern. We could fall back to python-docutils to
generate the manpages, since there is a standalone rst2man script there.
There are some incompatibilities about how the TH line is generated, but
I think those could be hacked around, if people thought it was worth it.

d

(no subject)

[David Bremner]

Here's a second try.
       
       - less build system cruft

       - integrate into notmuch's build system

       - optionally build the man pages (but not info) using just
         python-docutils.

No doubt this could use polishing; I'm still looking for feedback on
the general approach.

[RFC Patch v2 1/2] doc: start of sphinx based docs

[David Bremner]

This is the output from sphinx-quickstart, massaged a bit, along with
a few sample docs converted to rst.
---
 Makefile                     |   2 +-
 doc/Makefile                 |   5 +
 doc/Makefile.local           |  28 +++++
 doc/conf.py                  |  91 +++++++++++++++
 doc/index.rst                |  24 ++++
 doc/notmuch-emacs.rst        | 188 +++++++++++++++++++++++++++++++
 doc/notmuch-search-terms.rst | 255 +++++++++++++++++++++++++++++++++++++++++++
 doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++++
 doc/notmuch.rst              | 173 +++++++++++++++++++++++++++++
 9 files changed, 968 insertions(+), 1 deletion(-)
 create mode 100644 doc/Makefile
 create mode 100644 doc/Makefile.local
 create mode 100644 doc/conf.py
 create mode 100644 doc/index.rst
 create mode 100644 doc/notmuch-emacs.rst
 create mode 100644 doc/notmuch-search-terms.rst
 create mode 100644 doc/notmuch-search.rst
 create mode 100644 doc/notmuch.rst

diff --git a/Makefile b/Makefile
index 0428160..39f0e62 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,7 @@ all:
 # List all subdirectories here. Each contains its own Makefile.local.
 # Use of '=', without '+=', seems to be required for out-of-tree
 # builds to work.
-subdirs = compat completion emacs lib man parse-time-string performance-test util test
+subdirs = compat completion doc emacs lib man parse-time-string performance-test util test
 
 # We make all targets depend on the Makefiles themselves.
 global_deps = Makefile Makefile.config Makefile.local \
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..fa25832
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,5 @@
+all:
+	$(MAKE) -C .. all
+
+.DEFAULT:
+	$(MAKE) -C .. $@
diff --git a/doc/Makefile.local b/doc/Makefile.local
new file mode 100644
index 0000000..d2a339b
--- /dev/null
+++ b/doc/Makefile.local
@@ -0,0 +1,28 @@
+# Makefile for Sphinx documentation
+#
+
+dir := doc
+
+# You can set these variables from the command line.
+SPHINXOPTS    := -q -c $(dir)
+SPHINXBUILD   = sphinx-build
+BUILDDIR      := $(dir)/_build
+
+# Internal variables.
+ALLSPHINXOPTS   := -d $(BUILDDIR)/doctrees $(SPHINXOPTS) $(dir)
+
+.PHONY: help clean html man texinfo info
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+
+info: texinfo
+	make -C $(BUILDDIR)/texinfo info
+
+CLEAN := $(CLEAN) $(dir)/_build
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..9170920
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+
+# -- General configuration ------------------------------------------------
+#
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'notmuch'
+copyright = u'2014, Carl Worth and many others'
+
+# The short X.Y version.
+version = '0.17'
+# The full version, including alpha/beta/rc tags.
+release = '0.17'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'notmuchdoc'
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('notmuch', 'notmuch', u'thread-based email index, search, and tagging',
+     [u'Carl Worth and many others'], 1),
+    ('notmuch-search', 'notmuch-search', u'search the notmuch mail index',
+     [u'Carl Worth and many others'], 1),
+    ('notmuch-search-terms', 'notmuch-search-terms', u'query format for notmuch',
+     [u'Carl Worth and many others'], 7),
+
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('notmuch', 'notmuch', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch', 'thread-based email index, search and tagging',
+   'Miscellaneous'),
+  ('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-emacs', 'emacs based front-end for notmuch',
+   'Miscellaneous'),
+  ('notmuch-search', 'notmuch-search', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-search', 'search the notmuch mail index.',
+   'Miscellaneous'),
+  ('notmuch-search-terms', 'notmuch-search-terms', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-search-terms', 'query syntax for notmuch.',
+   'Miscellaneous'),
+]
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+texinfo_no_detailmenu = True
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..c05c855
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,24 @@
+.. notmuch documentation master file, created by
+   sphinx-quickstart on Fri Jan 17 22:34:14 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to notmuch's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   notmuch
+   notmuch-emacs
+   notmuch-search
+   notmuch-search-terms
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
new file mode 100644
index 0000000..283bf69
--- /dev/null
+++ b/doc/notmuch-emacs.rst
@@ -0,0 +1,188 @@
+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 inteface 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 varables docstring.
+
+notmuch-hello
+=============
+
+.. index::
+   single: notmuch-hello
+   single: notmuch
+
+``notmuch-hello`` is the main entry point for notmuch. You can start it
+with ``M-x notmuch`` or ``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 **bold** text indicates buttons you can click with
+a mouse or by positioning the cursor and pressing ``<return>``
+
+|   Welcome to **notmuch** You have 52 messages.
+|
+| Saved searches: **[edit]**
+|
+|	  52 **inbox**           52 **unread**
+|
+| Search: ____________________________________
+|
+| All tags: **[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.
+|		    **Customize** this page.
+
+You can change the overall appearence of the notmuch-hello screen by
+customizing the variable :index:`notmuch-hello-sections`.
+
+
+
+notmuch-hello key bindings
+--------------------------
+
+``<tab>``
+    Move to the next widget (button or text entry field)
+
+``<backtab>``
+    Move to the previous widget.
+
+``<return>``
+    Activate the current widget.
+
+``=``
+    Refresh the buffer; mainly update the counts of messages for various
+    saved searches.
+
+``G``
+    Import mail, See :ref:`importing`
+
+``m``
+    Compose a message
+
+``s``
+    Search the notmuch database using :ref:`notmuch-search`
+
+``v``
+    Print notmuch version
+
+``q``
+    Quit
+
+.. _saved-searches:
+
+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 searchs. The initial defaults are ``tag:inbox`` and
+``tag:unread``, but you can customize the following variables
+
+: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.
+
+:index:`notmuch-saved-searches-sort-function`
+    This variable controls how saved searches should be sorted. A value
+    of ``nil`` displays the saved searches in the order they are stored
+    in ‘notmuch-saved-searches’.
+
+:index:`notmuch-column-control`
+    Controls the number of columns for displaying saved-searches/tags
+
+Search Box
+----------
+
+The search box lets the user enter an notmuch query. See section
+“Description” in 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 :index:`notmuch-hello-recent-searches-max`.
+
+Known Tags
+----------
+
+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.
+
+:index:`notmuch-hello-tag-list-make-query`
+    Control how to construct a search (“virtual folder”) from a given
+    tag.
+
+:index:`notmuch-hello-hide-tags`
+    Which tags not to display at all.
+
+:index:`notmuch-column-control`
+    Controls the number of columns for displaying saved-searches/tags
+
+.. _notmuch-search:
+
+notmuch-search
+==============
+
+``notmuch-search-mode`` is used to display the results from executing
+a query via ``notmuch-search``. The syntax for these queries is the
+the same as :ref:`saved-searches`. For details of this syntax see
+info:notmuch-search-terms
+
+By default the output approximates that of the command line See section
+“Description” in notmuch search command.
+
+The main purpose of the ``notmuch-search-mode`` buffer is to act as a
+menu of results that the user can explore further by pressing
+``<return>`` on the appropriate line.
+
+``n,C-n,<down>``
+    Move to next line
+
+``p,C-p,<up>``
+    Move to previous line
+
+``<return>``
+    Open thread on current line in :ref:`notmuch-show` mode
+
+``?``
+    Display full set of key bindings
+
+The presentation of results can be controlled by the following
+variables.
+
+:index:`notmuch-search-result-format`
+    Control how each thread of messages is presented in the
+    ``notmuch-show-mode`` buffer
+
+:index:`notmuch-search-oldest-first`
+    Display the oldest threads at the top of the buffer
+
+.. _notmuch-show:
+
+notmuch-show
+============
+
+notmuch-tree
+============
+
+Configuration
+=============
+
+.. _importing:
+
+Importing Mail
+--------------
+
+:index:`notmuch-poll`
+
+:index:`notmuch-poll-script`
diff --git a/doc/notmuch-search-terms.rst b/doc/notmuch-search-terms.rst
new file mode 100644
index 0000000..7885c6a
--- /dev/null
+++ b/doc/notmuch-search-terms.rst
@@ -0,0 +1,255 @@
+====================
+notmuch-search-terms
+====================
+
+********
+Synopsis
+********
+
+
+\ **notmuch**\  \ **count**\  [\ *options...*\ ] <\ *search-term*\ >...
+
+\ **notmuch**\  \ **dump**\  [ <\ *filename*\ > ] [--] [ <\ *search-term*\ >...]
+
+\ **notmuch**\  \ **search**\  [\ *options*\ ...] <\ *search-term*\ >...
+
+\ **notmuch**\  \ **show**\  [\ *options*\ ...] <\ *search-term*\ >...
+
+\ **notmuch**\  \ **tag**\  +<\ *tag*\ >|-<\ *tag*\ > [...] [--] <\ *search-term*\ >...
+
+
+***********
+Description
+***********
+
+
+Several notmuch commands accept a common syntax for search terms.
+
+The search terms can consist of free-form text (and quoted phrases)
+which will match all messages that contain all of the given
+terms/phrases in the body, the subject, or any of the sender or
+recipient headers.
+
+As a special case, a search string consisting of exactly a single
+asterisk ("\*") will match all messages.
+
+In addition to free text, the following prefixes can be used to force
+terms to match against specific portions of an email, (where <brackets>
+indicate user-supplied values):
+
+from:<name-or-address>
+
+to:<name-or-address>
+
+subject:<word-or-quoted-phrase>
+
+attachment:<word>
+
+tag:<tag> (or is:<tag>)
+
+id:<message-id>
+
+thread:<thread-id>
+
+folder:<directory-path>
+
+date:<since>..<until>
+
+The \ **from:**\  prefix is used to match the name or address of the sender of
+an email message.
+
+The \ **to:**\  prefix is used to match the names or addresses of any recipient
+of an email message, (whether To, Cc, or Bcc).
+
+Any term prefixed with \ **subject:**\  will match only text from the subject
+of an email. Searching for a phrase in the subject is supported by
+including quotation marks around the phrase, immediately following
+\ **subject:**\ .
+
+The \ **attachment:**\  prefix can be used to search for specific filenames (or
+extensions) of attachments to email messages.
+
+For \ **tag:**\  and \ **is:**\  valid tag values include \ **inbox**\  and \ **unread**\  by default
+for new messages added by \ **notmuch**\  \ **new**\  as well as any other tag values
+added manually with \ **notmuch**\  \ **tag**\ .
+
+For \ **id:**\ , message ID values are the literal contents of the Message-ID:
+header of email messages, but without the \`<', \`>' delimiters.
+
+The \ **thread:**\  prefix can be used with the thread ID values that are
+generated internally by notmuch (and do not appear in email messages).
+These thread ID values can be seen in the first column of output from
+\ **notmuch**\  \ **search**\
+
+The \ **folder:**\  prefix can be used to search for email message files that
+are contained within particular directories within the mail store. If
+the same email message has multiple message files associated with it,
+it's sufficient for a match that at least one of the files is contained
+within a matching directory. Only the directory components below the
+top-level mail database path are available to be searched.
+
+The \ **date:**\  prefix can be used to restrict the results to only messages
+within a particular time range (based on the Date: header) with a range
+syntax of:
+
+date:<since>..<until>
+
+See \ **DATE**\  \ **AND**\  \ **TIME**\  \ **SEARCH**\  below for details on the range expression, and
+supported syntax for <since> and <until> date and time expressions.
+
+The time range can also be specified using timestamps with a syntax of:
+
+<initial-timestamp>..<final-timestamp>
+
+Each timestamp is a number representing the number of seconds since
+1970-01-01 00:00:00 UTC.
+
+In addition to individual terms, multiple terms can be combined with
+Boolean operators ( \ **and**\ , \ **or**\ , \ **not**\  , etc.). Each term in the query will
+be implicitly connected by a logical AND if no explicit operator is
+provided, (except that terms with a common prefix will be implicitly
+combined with OR until we get Xapian defect #402 fixed).
+
+Parentheses can also be used to control the combination of the Boolean
+operators, but will have to be protected from interpretation by the
+shell, (such as by putting quotation marks around any parenthesized
+expression).
+
+
+********************
+Date and Time Search
+********************
+
+
+notmuch understands a variety of standard and natural ways of
+expressing dates and times, both in absolute terms ("2012-10-24") and
+in relative terms ("yesterday"). Any number of relative terms can be
+combined ("1 hour 25 minutes") and an absolute date/time can be
+combined with relative terms to further adjust it. A non-exhaustive
+description of the syntax supported for absolute and relative terms is
+given below.
+
+\ **The**\  \ **range**\  \ **expression**\
+
+date:<since>..<until>
+
+The above expression restricts the results to only messages
+from <since> to <until>, based on the Date: header.
+
+<since> and <until> can describe imprecise times, such as
+"yesterday". In this case, <since> is taken as the earliest
+time it could describe (the beginning of yesterday) and <until>
+is taken as the latest time it could describe (the end of
+yesterday). Similarly, date:january..february matches from the
+beginning of January to the end of February.
+
+Currently, we do not support spaces in range expressions. You
+can replace the spaces with \`_', or (in most cases) \`-', or (in
+some cases) leave the spaces out altogether. Examples in this
+man page use spaces for clarity.
+
+Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's
+possible to specify date:..<until> or date:<since>.. to not
+limit the start or end time, respectively. Pre-1.2.1 Xapian
+does not report an error on open ended ranges, but it does not
+work as expected either.
+
+Entering date:expr without ".." (for example date:yesterday)
+won't work, as it's not interpreted as a range expression at
+all. You can achieve the expected result by duplicating the
+expr both sides of ".." (for example
+date:yesterday..yesterday).
+
+\ **Relative**\  \ **date**\  \ **and**\  \ **time**\
+[N|number]
+(years|months|weeks|days|hours|hrs|minutes|mins|seconds|secs)
+[...]
+
+All refer to past, can be repeated and will be accumulated.
+
+Units can be abbreviated to any length, with the otherwise
+ambiguous single m being m for minutes and M for months.
+
+Number can also be written out one, two, ..., ten, dozen,
+hundred. Additionally, the unit may be preceded by "last" or
+"this" (e.g., "last week" or "this month").
+
+When combined with absolute date and time, the relative date
+and time specification will be relative from the specified
+absolute date and time.
+
+Examples: 5M2d, two weeks
+
+\ **Supported**\  \ **absolute**\  \ **time**\  \ **formats**\
+H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
+
+H[H] (am|a.m.|pm|p.m.)
+
+
+HHMMSS
+
+
+
+now
+
+noon
+
+midnight
+
+Examples: 17:05, 5pm
+
+\ **Supported**\  \ **absolute**\  \ **date**\  \ **formats**\
+YYYY-MM[-DD]
+
+
+DD-MM[-[YY]YY]
+
+
+
+MM-YYYY
+
+
+
+M[M]/D[D][/[YY]YY]
+
+
+
+M[M]/YYYY
+
+
+
+D[D].M[M][.[YY]YY]
+
+
+
+D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
+
+Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
+
+Wee[kday]
+
+Month names can be abbreviated at three or more characters.
+
+Weekday names can be abbreviated at three or more characters.
+
+Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
+
+\ **Time**\  \ **zones**\
+(+|-)HH:MM
+
+
+(+|-)HH[MM]
+
+
+
+Some time zone codes, e.g. UTC, EET.
+
+
+********
+See Also
+********
+
+
+notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),
+notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1),
+notmuch-restore(1), notmuch-search(1), notmuch-show(1), notmuch-tag(1)
diff --git a/doc/notmuch-search.rst b/doc/notmuch-search.rst
new file mode 100644
index 0000000..deb7e8b
--- /dev/null
+++ b/doc/notmuch-search.rst
@@ -0,0 +1,203 @@
+==============
+notmuch-search
+==============
+
+
+********
+Synopsis
+********
+
+
+\ **notmuch**\  \ **search**\  [\ *options*\ ...] <\ *search-term*\ >...
+
+
+***********
+Description
+***********
+
+
+Search for messages matching the given search terms, and display as
+results the threads containing the matched messages.
+
+The output consists of one line per thread, giving a thread ID, the
+date of the newest (or oldest, depending on the sort option) matched
+message in the thread, the number of matched messages and total
+messages in the thread, the names of all participants in the thread,
+and the subject of the newest (or oldest) message.
+
+See notmuch-search-terms(7) for details of the supported syntax for
+<search-terms>.
+
+Supported options for \ **search**\  include
+
+
+  **--format=** ( **json** | **sexp** | **text** |  **text0** )
+
+
+
+Presents the results in either JSON, S-Expressions, newline
+character separated plain-text (default), or null character
+separated plain-text (compatible with xargs(1) -0 option where
+available).
+
+
+\ **--format-version=N**\
+
+
+
+Use the specified structured output format version. This is
+intended for programs that invoke notmuch(1) internally. If
+omitted, the latest supported version will be used.
+
+
+\ **--output=(summary|threads|messages|files|tags)**\
+
+
+
+\ **summary**\
+
+Output a summary of each thread with any message matching
+the search terms. The summary includes the thread ID, date,
+the number of messages in the thread (both the number
+matched and the total number), the authors of the thread
+and the subject.
+
+\ **threads**\
+
+Output the thread IDs of all threads with any message
+matching the search terms, either one per line
+(--format=text), separated by null characters
+(--format=text0), as a JSON array (--format=json), or an S-
+Expression list (--format=sexp).
+
+\ **messages**\
+
+Output the message IDs of all messages matching the search
+terms, either one per line (--format=text), separated by
+null characters (--format=text0), as a JSON array
+(--format=json), or as an S-Expression list
+(--format=sexp).
+
+\ **files**\
+
+Output the filenames of all messages matching the search
+terms, either one per line (--format=text), separated by
+null characters (--format=text0), as a JSON array
+(--format=json), or as an S-Expression list
+(--format=sexp).
+
+Note that each message may have multiple filenames
+associated with it. All of them are included in the
+output, unless limited with the --duplicate=N option.
+
+\ **tags**\
+
+Output all tags that appear on any message matching the
+search terms, either one per line (--format=text),
+separated by null characters (--format=text0), as a JSON
+array (--format=json), or as an S-Expression list
+(--format=sexp).
+
+
+\ **--sort=** (\ **newest-first** | **oldest-first** )
+
+
+
+This option can be used to present results in either
+chronological order (\ **oldest-first**\ ) or reverse chronological
+order (\ **newest-first**\ ).
+
+Note: The thread order will be distinct between these two
+options (beyond being simply reversed). When sorting by
+\ **oldest-first**\  the threads will be sorted by the oldest message
+in each thread, but when sorting by \ **newest-first**\  the threads
+will be sorted by the newest message in each thread.
+
+By default, results will be displayed in reverse chronological
+order, (that is, the newest results will be displayed first).
+
+
+\ **--offset=[-]N**\
+
+
+
+Skip displaying the first N results. With the leading \`-',
+start at the Nth result from the end.
+
+
+\ **--limit=N**\
+
+
+
+Limit the number of displayed results to N.
+
+
+\ **--exclude=(true|false|all|flag)**\
+
+
+
+A message is called "excluded" if it matches at least one tag
+in search.tag_exclude that does not appear explicitly in the
+search terms. This option specifies whether to omit excluded
+messages in the search process.
+
+The default value, \ **true**\ , prevents excluded messages from
+matching the search terms.
+
+\ **all**\  additionally prevents excluded messages from appearing in
+displayed results, in effect behaving as though the excluded
+messages do not exist.
+
+\ **false**\  allows excluded messages to match search terms and appear
+in displayed results. Excluded messages are still marked in the
+relevant outputs.
+
+\ **flag**\  only has an effect when \ **--output=summary**\ . The output is
+almost identical to \ **false**\ , but the "match count" is the number
+of matching non-excluded messages in the thread, rather than
+the number of matching messages.
+
+
+\ **--duplicate=N**\
+
+
+
+Effective with \ **--output=files**\ , output the Nth filename
+associated with each message matching the query (N is 1-based).
+If N is greater than the number of files associated with the
+message, don't print anything.
+
+Note that this option is orthogonal with the \ **folder:**\  search
+prefix. The prefix matches messages based on filenames. This
+option filters filenames of the matching messages.
+
+
+***********
+Exit Status
+***********
+
+
+This command supports the following special exit status codes
+
+
+\ **20**\
+
+   The requested format version is too old.
+
+
+\ **21**\
+
+   The requested format version is too new.
+
+
+
+
+
+********
+See Also
+********
+
+
+notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),
+notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1),
+notmuch-restore(1), notmuch-search-terms(7), notmuch-show(1), notmuchtag(1)
diff --git a/doc/notmuch.rst b/doc/notmuch.rst
new file mode 100644
index 0000000..9d9a35c
--- /dev/null
+++ b/doc/notmuch.rst
@@ -0,0 +1,173 @@
+========
+notmuch
+========
+
+Synopsis
+========
+
+
+\ **notmuch**\  [\ *option*\  ...] \ *command*\  [\ *arg*\  ...]
+
+
+Description
+===========
+
+
+Notmuch is a command-line based program for indexing, searching,
+reading, and tagging large collections of email messages.
+
+This page describes how to get started using notmuch from the command
+line, and gives a brief overview of the commands available. For more
+information on e.g. \ **notmuch**\  \ **show**\  consult the notmuch-show(1) man page,
+also accessible via \ **notmuch**\  \ **help**\  \ **show**\
+
+The quickest way to get started with Notmuch is to simply invoke the
+\ **notmuch**\  command with no arguments, which will interactively guide you
+through the process of indexing your mail.
+
+Note
+====
+
+
+While the command-line program \ **notmuch**\  provides powerful functionality,
+it does not provide the most convenient interface for that
+functionality. More sophisticated interfaces are expected to be built
+on top of either the command-line interface, or more likely, on top of
+the notmuch library interface. See http://notmuchmail.org for more
+about alternate interfaces to notmuch. The emacs-based interface to
+notmuch (available under \ **emacs/**\  in the Notmuch source distribution) is
+probably the most widely used at this time.
+
+Options
+========
+
+
+Supported global options for \ **notmuch**\  include
+
+
+\ **--help**\
+
+
+
+Print a synopsis of available commands and exit.
+
+
+\ **--version**\
+
+
+
+Print the installed version of notmuch, and exit.
+
+
+\ **--config=FILE**\
+
+
+
+Specify the configuration file to use. This overrides any
+configuration file specified by ${NOTMUCH_CONFIG}.
+
+Commands
+========
+
+
+\ **SETUP**\
+The \ **notmuch**\  \ **setup**\  command is used to configure Notmuch for first use,
+(or to reconfigure it later).
+
+The setup command will prompt for your full name, your primary email
+address, any alternate email addresses you use, and the directory
+containing your email archives. Your answers will be written to a
+configuration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-
+config . This configuration file will be created with descriptive
+comments, making it easy to edit by hand later to change the
+configuration. Or you can run \ **notmuch**\  \ **setup**\  again to change the
+configuration.
+
+The mail directory you specify can contain any number of sub-
+directories and should primarily contain only files with individual
+email messages (eg. maildir or mh archives are perfect). If there are
+other, non-email files (such as indexes maintained by other email
+programs) then notmuch will do its best to detect those and ignore
+them.
+
+Mail storage that uses mbox format, (where one mbox file contains many
+messages), will not work with notmuch. If that's how your mail is
+currently stored, it is recommended you first convert it to maildir
+format with a utility such as mb2md before running \ **notmuch**\  \ **setup**\  \ **.**\
+
+Invoking \ **notmuch**\  with no command argument will run \ **setup**\  if the setup
+command has not previously been completed.
+
+\ **OTHER**\  \ **COMMANDS**\
+Several of the notmuch commands accept search terms with a common
+syntax. See notmuch-search-terms(7) for more details on the supported
+syntax.
+
+The \ **search**\ , \ **show**\  and \ **count**\  commands are used to query the email
+database.
+
+The \ **reply**\  command is useful for preparing a template for an email
+reply.
+
+The \ **tag**\  command is the only command available for manipulating database
+contents.
+
+The \ **dump**\  and \ **restore**\  commands can be used to create a textual dump of
+email tags for backup purposes, and to restore from that dump.
+
+The \ **config**\  command can be used to get or set settings int the notmuch
+configuration file.
+
+
+Environment
+===========
+
+
+The following environment variables can be used to control the behavior
+of notmuch.
+
+
+\ **NOTMUCH_CONFIG**\
+
+ Specifies the location of the notmuch configuration file.
+ Notmuch will use ${HOME}/.notmuch-config if this variable is not
+ set.
+
+
+
+\ **NOTMUCH_TALLOC_REPORT**\
+
+ Location to write a talloc memory usage report. See
+ \ **talloc_enable_leak_report_full**\  in talloc(3) for more
+ information.
+
+
+
+\ **NOTMUCH_DEBUG_QUERY**\
+
+ If set to a non-empty value, the notmuch library will print (to
+ stderr) Xapian queries it constructs.
+
+
+See Also
+========
+
+
+notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
+notmuch-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1),
+notmuch-search(1), notmuch-search-terms(7), notmuch-show(1),
+notmuch-tag(1)
+
+The notmuch website: \ **http://notmuchmail.org**\
+
+
+Contact
+========
+
+
+Feel free to send questions, comments, or kudos to the notmuch mailing
+list <notmuch@notmuchmail.org> . Subscription is not required before
+posting, but is available from the notmuchmail.org website.
+
+Real-time interaction with the Notmuch community is available via IRC
+(server: irc.freenode.net, channel: #notmuch).
-- 
1.8.5.2

[RFC Patch v2 2/2] doc: add target rst2man to build man pages using rst2man

[David Bremner]

Many people have docutils installed, but not sphinx. Allow these
people to build the man pages.
---
 Makefile                   |  2 +-
 doc/rst2man/Makefile       |  5 +++++
 doc/rst2man/Makefile.local | 28 ++++++++++++++++++++++++++++
 doc/rst2man/prerst2man.py  | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 80 insertions(+), 1 deletion(-)
 create mode 100644 doc/rst2man/Makefile
 create mode 100644 doc/rst2man/Makefile.local
 create mode 100644 doc/rst2man/prerst2man.py

diff --git a/Makefile b/Makefile
index 39f0e62..3c7f0be 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,7 @@ all:
 # List all subdirectories here. Each contains its own Makefile.local.
 # Use of '=', without '+=', seems to be required for out-of-tree
 # builds to work.
-subdirs = compat completion doc emacs lib man parse-time-string performance-test util test
+subdirs = compat completion doc doc/rst2man emacs lib man parse-time-string performance-test util test
 
 # We make all targets depend on the Makefiles themselves.
 global_deps = Makefile Makefile.config Makefile.local \
diff --git a/doc/rst2man/Makefile b/doc/rst2man/Makefile
new file mode 100644
index 0000000..0a0815d
--- /dev/null
+++ b/doc/rst2man/Makefile
@@ -0,0 +1,5 @@
+all:
+	$(MAKE) -C ../.. all
+
+.DEFAULT:
+	$(MAKE) -C ../.. $@
diff --git a/doc/rst2man/Makefile.local b/doc/rst2man/Makefile.local
new file mode 100644
index 0000000..5bb3e43
--- /dev/null
+++ b/doc/rst2man/Makefile.local
@@ -0,0 +1,28 @@
+# -*- Makefile -*-
+dir := doc/rst2man
+
+prerst2man := python $(dir)/prerst2man.py $(dir)/.. $(dir)
+
+MANSRC := $(dir)/notmuch.1 $(dir)/notmuch-search.1 $(dir)/notmuch-search-terms.7
+
+%.1 : %.rst
+	rst2man $< > $@
+
+%.7: %.rst
+	rst2man $< > $@
+
+# preprocessed source files suitable for rst2man
+RST2MANSRC := $(dir)/notmuch.rst $(dir)/notmuch-search.rst $(dir)/notmuch-search-terms.rst
+
+# actual source files
+
+RSTSRC := $(patsubst ${dir}/%,$(dir)/../%,${RST2MANSRC})
+
+RSTMANSRC := $(patsubst %.rst,%.1,${RST2MANSRC})
+
+rst2man: ${MANSRC}
+
+${RST2MANSRC}: ${RSTSRC}
+	$(prerst2man)
+
+CLEAN := ${CLEAN} ${RST2MANSRC} ${MANSRC}
diff --git a/doc/rst2man/prerst2man.py b/doc/rst2man/prerst2man.py
new file mode 100644
index 0000000..4222f11
--- /dev/null
+++ b/doc/rst2man/prerst2man.py
@@ -0,0 +1,46 @@
+from sys import argv
+from datetime import date
+import re
+
+sourcedir=argv[1]
+outdir=argv[2]
+
+execfile(sourcedir+"/conf.py");
+
+def header(file,startdocname, command, description, authors, section):
+    file.write("""
+---------------------------------------------
+{:s}
+---------------------------------------------
+
+:Date:   {:s}
+:Version: {:s}
+:Manual section: {:d}
+:Manual group: {:s}
+
+""".format(description,date.today().isoformat(),release,section,project))
+
+blankre = re.compile("^\s*$")
+for page in man_pages:
+    outfile = open(outdir+"/"+page[0]+'.rst','w')
+    infile = open(sourcedir+"/"+page[0]+".rst",'r')
+
+
+    # this is a crude hack. We look for the first blank line, and
+    # insert the rst2man header there.
+    #
+    # XXX consider really parsing input
+
+    count=0
+    lines = infile.readlines()
+    for line in lines:
+        outfile.write(line);
+        if (blankre.match(line)):
+            break
+        count = count + 1
+
+    del lines[0:count+1]
+
+    header(outfile,*page)
+
+    outfile.write("".join(lines))
-- 
1.8.5.2

Re:

[Mark Walters]

Hi

I have been playing with this. One thing that is worrying me a little at
the moment is that the man page looks different from before (imo less
nice). More importantly, I can't tweak the rst to get the generated
pages to look like the current ones (this could just be my lack of skill
with rst)

I do like the general approach but would like to make sure we can get
manpages (amongst other things) that we like from it. See below for one
example which I thought looked less nice

Best wishes

Mark



The particular  thing is the indentation for options (eg options in the
notmuch.1 page) In the original pages it looks like

OPTIONS
       Supported global options for notmuch include

           --help

               Print a synopsis of available commands and exit.

and in the new ones

OPTIONS
       Supported global options for notmuch include

       --help

       Print a synopsis of available commands and exit.

I find this makes it more difficult to scan the man page quickly.







On Tue, 28 Jan 2014, David Bremner <david@tethera.net> wrote:
> Here's a second try.
>        
>        - less build system cruft
>
>        - integrate into notmuch's build system
>
>        - optionally build the man pages (but not info) using just
>          python-docutils.
>
> No doubt this could use polishing; I'm still looking for feedback on
> the general approach.
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re:

[David Bremner]

Mark Walters <markwalters1009@gmail.com> writes:

>
> The particular  thing is the indentation for options (eg options in the
> notmuch.1 page) In the original pages it looks like
>
> OPTIONS
>        Supported global options for notmuch include
>
>            --help
>
>                Print a synopsis of available commands and exit.
>
> and in the new ones
>
> OPTIONS
>        Supported global options for notmuch include
>
>        --help
>
>        Print a synopsis of available commands and exit.
>
> I find this makes it more difficult to scan the man page quickly.

This rst is mainly autogenerated, and hence a bit ugly.

This particular example doesn't seem too hard to fix; try replacing the
relevant bit of notmuch.rst with


Supported global options for \ **notmuch**\  include

  \ --help
    Print a synopsis of available commands and exit.

  \ --version
    Print the installed version of notmuch, and exit.

  \ --config=FILE
    Specify the configuration file to use. This overrides any
    configuration file specified by ${NOTMUCH_CONFIG}.

or

Supported global options for \ **notmuch**\  include

--help         Print a synopsis of available commands and exit.

--version      Print the installed version of notmuch, and exit.

--config=FILE  Specify the configuration file to use. This overrides any
               configuration file specified by ${NOTMUCH_CONFIG}.

--help    Print a synopsis of available commands and exit.


The latter is an "option list" [1], so I guess is the most official way
to do it.

The former is a more generic "definition list" 


[1]
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists

v3 of sphinx docs

[David Bremner]

This version includes a complete conversion of the existing manpages.
The conversion uses doclifter + custom python code + pandoc. It is
pretty much fully automated, so I can rebase against changes to the
nroff source if needed.  

On the other hand, it is fully automated, so there are bound to be a
few rough spots. If there are systematic things, I can fix the
conversion scripts; one offs can just be added to the series.

It does do a much better job of option indentation than the previous
version.

I think this is reaching the point where if anybody has any strong
objections to sphinx (with a fallback to rst2man) for the docs, I'd
like to hear them.

[RFC Patch v3 1/3] doc: start of sphinx based docs

[David Bremner]

This is the output from sphinx-quickstart, massaged a bit, along with
a man and texinfo pages all converted to rst.
---
 Makefile                          |   2 +-
 doc/Makefile                      |   5 +
 doc/Makefile.local                |  28 +++++
 doc/conf.py                       | 166 ++++++++++++++++++++++++++++
 doc/index.rst                     |  31 ++++++
 doc/man1/notmuch-compact.rst      |  52 +++++++++
 doc/man1/notmuch-config.rst       | 111 +++++++++++++++++++
 doc/man1/notmuch-count.rst        |  60 ++++++++++
 doc/man1/notmuch-dump.rst         |  72 ++++++++++++
 doc/man1/notmuch-insert.rst       |  57 ++++++++++
 doc/man1/notmuch-new.rst          |  51 +++++++++
 doc/man1/notmuch-reply.rst        | 112 +++++++++++++++++++
 doc/man1/notmuch-restore.rst      |  58 ++++++++++
 doc/man1/notmuch-search.rst       | 146 +++++++++++++++++++++++++
 doc/man1/notmuch-show.rst         | 180 ++++++++++++++++++++++++++++++
 doc/man1/notmuch-tag.rst          | 105 ++++++++++++++++++
 doc/man1/notmuch.rst              | 143 ++++++++++++++++++++++++
 doc/man5/notmuch-hooks.rst        |  42 +++++++
 doc/man7/notmuch-search-terms.rst | 225 ++++++++++++++++++++++++++++++++++++++
 doc/notmuch-emacs.rst             | 192 ++++++++++++++++++++++++++++++++
 20 files changed, 1837 insertions(+), 1 deletion(-)
 create mode 100644 doc/Makefile
 create mode 100644 doc/Makefile.local
 create mode 100644 doc/conf.py
 create mode 100644 doc/index.rst
 create mode 100644 doc/man1/notmuch-compact.rst
 create mode 100644 doc/man1/notmuch-config.rst
 create mode 100644 doc/man1/notmuch-count.rst
 create mode 100644 doc/man1/notmuch-dump.rst
 create mode 100644 doc/man1/notmuch-insert.rst
 create mode 100644 doc/man1/notmuch-new.rst
 create mode 100644 doc/man1/notmuch-reply.rst
 create mode 100644 doc/man1/notmuch-restore.rst
 create mode 100644 doc/man1/notmuch-search.rst
 create mode 100644 doc/man1/notmuch-show.rst
 create mode 100644 doc/man1/notmuch-tag.rst
 create mode 100644 doc/man1/notmuch.rst
 create mode 100644 doc/man5/notmuch-hooks.rst
 create mode 100644 doc/man7/notmuch-search-terms.rst
 create mode 100644 doc/notmuch-emacs.rst

diff --git a/Makefile b/Makefile
index 0428160..39f0e62 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,7 @@ all:
 # List all subdirectories here. Each contains its own Makefile.local.
 # Use of '=', without '+=', seems to be required for out-of-tree
 # builds to work.
-subdirs = compat completion emacs lib man parse-time-string performance-test util test
+subdirs = compat completion doc emacs lib man parse-time-string performance-test util test
 
 # We make all targets depend on the Makefiles themselves.
 global_deps = Makefile Makefile.config Makefile.local \
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..fa25832
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,5 @@
+all:
+	$(MAKE) -C .. all
+
+.DEFAULT:
+	$(MAKE) -C .. $@
diff --git a/doc/Makefile.local b/doc/Makefile.local
new file mode 100644
index 0000000..d2a339b
--- /dev/null
+++ b/doc/Makefile.local
@@ -0,0 +1,28 @@
+# Makefile for Sphinx documentation
+#
+
+dir := doc
+
+# You can set these variables from the command line.
+SPHINXOPTS    := -q -c $(dir)
+SPHINXBUILD   = sphinx-build
+BUILDDIR      := $(dir)/_build
+
+# Internal variables.
+ALLSPHINXOPTS   := -d $(BUILDDIR)/doctrees $(SPHINXOPTS) $(dir)
+
+.PHONY: help clean html man texinfo info
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+
+info: texinfo
+	make -C $(BUILDDIR)/texinfo info
+
+CLEAN := $(CLEAN) $(dir)/_build
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..d80b2af
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,166 @@
+
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'notmuch'
+copyright = u'2014, Carl Worth and many others'
+
+# The short X.Y version.
+version = '0.17'
+# The full version, including alpha/beta/rc tags.
+release = '0.17'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'notmuchdoc'
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+
+man_pages = [
+
+('man1/notmuch','notmuch',
+        u'thread-based email index, search, and tagging',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-compact','notmuch-compact',
+        u'compact the notmuch database',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-config','notmuch-config',
+        u'access notmuch configuration file',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-count','notmuch-count',
+        u'count messages matching the given search terms',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-dump','notmuch-dump',
+        u'creates a plain-text dump of the tags of each message',
+        [u'Carl Worth and many others'], 1),
+
+('man5/notmuch-hooks','notmuch-hooks',
+        u'hooks for notmuch',
+        [u'Carl Worth and many others'], 5),
+
+('man1/notmuch-insert','notmuch-insert',
+        u'add a message to the maildir and notmuch database',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-new','notmuch-new',
+        u'incorporate new mail into the notmuch database',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-reply','notmuch-reply',
+        u'constructs a reply template for a set of messages',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-restore','notmuch-restore',
+        u'restores the tags from the given file (see notmuch dump)',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-search','notmuch-search',
+        u'search for messages matching the given search terms',
+        [u'Carl Worth and many others'], 1),
+
+('man7/notmuch-search-terms','notmuch-search-terms',
+        u'syntax for notmuch queries',
+        [u'Carl Worth and many others'], 7),
+
+('man1/notmuch-show','notmuch-show',
+        u'show messages matching the given search terms',
+        [u'Carl Worth and many others'], 1),
+
+('man1/notmuch-tag','notmuch-tag',
+        u'add/remove tags for all messages matching the search terms',
+        [u'Carl Worth and many others'], 1),
+
+
+]
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+texinfo_no_detailmenu = True
+
+texinfo_documents = [
+ ('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
+   u'Carl Worth and many others', 'notmuch-emacs',
+   'emacs based front-end for notmuch', 'Miscellaneous'),
+('man1/notmuch','notmuch',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch',
+      'thread-based email index, search, and tagging','Miscellaneous'),
+('man1/notmuch-compact','notmuch-compact',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-compact',
+      'compact the notmuch database','Miscellaneous'),
+('man1/notmuch-config','notmuch-config',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-config',
+      'access notmuch configuration file','Miscellaneous'),
+('man1/notmuch-count','notmuch-count',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-count',
+      'count messages matching the given search terms','Miscellaneous'),
+('man1/notmuch-dump','notmuch-dump',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-dump',
+      'creates a plain-text dump of the tags of each message','Miscellaneous'),
+('man5/notmuch-hooks','notmuch-hooks',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-hooks',
+      'hooks for notmuch','Miscellaneous'),
+('man1/notmuch-insert','notmuch-insert',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-insert',
+      'add a message to the maildir and notmuch database','Miscellaneous'),
+('man1/notmuch-new','notmuch-new',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-new',
+      'incorporate new mail into the notmuch database','Miscellaneous'),
+('man1/notmuch-reply','notmuch-reply',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-reply',
+      'constructs a reply template for a set of messages','Miscellaneous'),
+('man1/notmuch-restore','notmuch-restore',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-restore',
+      'restores the tags from the given file (see notmuch dump)','Miscellaneous'),
+('man1/notmuch-search','notmuch-search',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-search',
+      'search for messages matching the given search terms','Miscellaneous'),
+('man7/notmuch-search-terms','notmuch-search-terms',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-search-terms',
+      'syntax for notmuch queries','Miscellaneous'),
+('man1/notmuch-show','notmuch-show',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-show',
+      'show messages matching the given search terms','Miscellaneous'),
+('man1/notmuch-tag','notmuch-tag',u'notmuch Documentation',
+      u'Carl Worth and many others', 'notmuch-tag',
+      'add/remove tags for all messages matching the search terms','Miscellaneous'),
+]
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..deac9f4
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,31 @@
+
+Welcome to notmuch's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+   :titlesonly:
+
+   man1/notmuch
+   man1/notmuch-compact
+   man1/notmuch-config
+   man1/notmuch-count
+   man1/notmuch-dump
+   man5/notmuch-hooks
+   man1/notmuch-insert
+   man1/notmuch-new
+   man1/notmuch-reply
+   man1/notmuch-restore
+   man1/notmuch-search
+   man7/notmuch-search-terms
+   man1/notmuch-show
+   man1/notmuch-tag
+   notmuch-emacs
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/man1/notmuch-compact.rst b/doc/man1/notmuch-compact.rst
new file mode 100644
index 0000000..aeabd16
--- /dev/null
+++ b/doc/man1/notmuch-compact.rst
@@ -0,0 +1,52 @@
+===============
+notmuch-compact
+===============
+
+SYNOPSIS
+========
+
+**notmuch** **compact** [--quiet] [--backup=]
+
+DESCRIPTION
+===========
+
+The *compact* command can be used to compact the notmuch database. This
+can both reduce the space required by the database and improve lookup
+performance.
+
+The compacted database is built in a temporary directory and is later
+moved into the place of the origin database. The original uncompacted
+database is discarded, unless the ``--backup=``\ <directory> option is
+used.
+
+Note that the database write lock will be held during the compaction
+process (which may be quite long) to protect data integrity.
+
+Supported options for *compact* include
+
+    ``--backup=``\ <directory>
+        Save the current database to the given directory before
+        replacing it with the compacted database. The backup directory
+        must not exist and it must reside on the same mounted filesystem
+        as the current database.
+
+    ``--quiet``
+        Do not report database compaction progress to stdout.
+
+ENVIRONMENT
+===========
+
+The following environment variables can be used to control the behavior
+of notmuch.
+
+*NOTMUCH\_CONFIG*
+    Specifies the location of the notmuch configuration file. Notmuch
+    will use ${HOME}/.notmuch-config if this variable is not set.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-count(1)*, *notmuch-dump(1)*, *notmuch-hooks(5)*,
+*notmuch-insert(1)*, *notmuch-new(1)*, *notmuch-reply(1)*,
+*notmuch-restore(1)*, *notmuch-search(1)*, *notmuch-search-terms(7)*,
+*notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
new file mode 100644
index 0000000..50c9e7e
--- /dev/null
+++ b/doc/man1/notmuch-config.rst
@@ -0,0 +1,111 @@
+==============
+notmuch-config
+==============
+
+SYNOPSIS
+========
+
+**notmuch** **config** **get** **<section>.<item>**
+
+**notmuch** **config** **set** **<section>.<item>** [value ...]
+
+**notmuch** **config** **list**
+
+DESCRIPTION
+===========
+
+The *config* command can be used to get or set settings in the notmuch
+configuration file.
+
+    *get*
+        The value of the specified configuration item is printed to
+        stdout. If the item has multiple values (it is a list), each
+        value is separated by a newline character.
+
+    *set*
+        The specified configuration item is set to the given value. To
+        specify a multiple-value item (a list), provide each value as a
+        separate command-line argument.
+
+        If no values are provided, the specified configuration item will
+        be removed from the configuration file.
+
+    *list*
+        Every configuration item is printed to stdout, each on a
+        separate line of the form:
+
+        *section*.\ *item*\ =\ *value*
+
+        No additional whitespace surrounds the dot or equals sign
+        characters. In a multiple-value item (a list), the values are
+        separated by semicolon characters.
+
+The available configuration items are described below.
+
+    *database.path*
+        The top-level directory where your mail currently exists and to
+        where mail will be delivered in the future. Files should be
+        individual email messages. Notmuch will store its database
+        within a sub-directory of the path configured here named
+        ``.notmuch``.
+
+    *user.name*
+        Your full name.
+
+    *user.primary\_email*
+        Your primary email address.
+
+    *user.other\_email*
+        A list of other email addresses at which you receive email.
+
+    *new.tags*
+        A list of tags that will be added to all messages incorporated
+        by *notmuch new*.
+
+    *new.ignore*
+        A list of file and directory names, without path, that will not
+        be searched for messages by *notmuch new*. All the files and
+        directories matching any of the names specified here will be
+        ignored, regardless of the location in the mail store directory
+        hierarchy.
+
+    *search.exclude\_tags*
+        A list of tags that will be excluded from search results by
+        default. Using an excluded tag in a query will override that
+        exclusion.
+
+    *maildir.synchronize\_flags*
+        If true, then the following maildir flags (in message filenames)
+        will be synchronized with the corresponding notmuch tags:
+
+        Flag Tag ---- ------- D draft F flagged P passed R replied S
+        unread (added when 'S' flag is not present)
+
+        The *notmuch new* command will notice flag changes in filenames
+        and update tags, while the *notmuch tag* and *notmuch restore*
+        commands will notice tag changes and update flags in filenames.
+
+        If there have been any changes in the maildir (new messages
+        added, old ones removed or renamed, maildir flags changed,
+        etc.), it is advisable to run *notmuch new* before *notmuch tag*
+        or *notmuch restore* commands to ensure the tag changes are
+        properly synchronized to the maildir flags, as the commands
+        expect the database and maildir to be in sync.
+
+ENVIRONMENT
+===========
+
+The following environment variables can be used to control the behavior
+of notmuch.
+
+*NOTMUCH\_CONFIG*
+    Specifies the location of the notmuch configuration file. Notmuch
+    will use ${HOME}/.notmuch-config if this variable is not set.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-count(1)*, *notmuch-dump(1)*, *notmuch-hooks(5)*,
+*notmuch-insert(1)*, *notmuch-new(1)*, *notmuch-reply(1)*,
+*notmuch-restore(1)*, *notmuch-search(1)*, *notmuch-search-terms(7)*,
+*notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-count.rst b/doc/man1/notmuch-count.rst
new file mode 100644
index 0000000..9165207
--- /dev/null
+++ b/doc/man1/notmuch-count.rst
@@ -0,0 +1,60 @@
+=============
+notmuch-count
+=============
+
+SYNOPSIS
+========
+
+**notmuch** **count** [options ...] **<search-term> ...**
+
+DESCRIPTION
+===========
+
+Count messages matching the search terms.
+
+The number of matching messages (or threads) is output to stdout.
+
+With no search terms, a count of all messages (or threads) in the
+database will be displayed.
+
+See *notmuch-search-terms(7)* for details of the supported syntax for
+<search-terms>.
+
+Supported options for *count* include
+
+    ``--output=(messages|threads|files)``
+
+        *messages*
+            Output the number of matching messages. This is the default.
+
+        *threads*
+            Output the number of matching threads.
+
+        *files*
+            Output the number of files associated with matching
+            messages. This may be bigger than the number of matching
+            messages due to duplicates (i.e. multiple files having the
+            same message-id).
+
+    ``--exclude=(true|false)``
+        Specify whether to omit messages matching search.tag\_exclude
+        from the count (the default) or not.
+
+    ``--batch``
+        Read queries from a file (stdin by default), one per line, and
+        output the number of matching messages (or threads) to stdout,
+        one per line. On an empty input line the count of all messages
+        (or threads) in the database will be output. This option is not
+        compatible with specifying search terms on the command line.
+
+    ``--input=``\ <filename>
+        Read input from given file, instead of from stdin. Implies
+        ``--batch``.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-dump(1)*,
+*notmuch-hooks(5)*, *notmuch-insert(1)*, *notmuch-new(1)*,
+*notmuch-reply(1)*, *notmuch-restore(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
new file mode 100644
index 0000000..018faf1
--- /dev/null
+++ b/doc/man1/notmuch-dump.rst
@@ -0,0 +1,72 @@
+============
+notmuch-dump
+============
+
+SYNOPSIS
+========
+
+**notmuch** **dump** **--format=** **batch-tag)** [--] [--output=] [--] [<search-term> ...]
+
+DESCRIPTION
+===========
+
+Dump tags for messages matching the given search terms.
+
+Output is to the given filename, if any, or to stdout.
+
+These tags are the only data in the notmuch database that can't be
+recreated from the messages themselves. The output of notmuch dump is
+therefore the only critical thing to backup (and much more friendly to
+incremental backup than the native database files.)
+
+``--format=(sup|batch-tag)``
+    Notmuch restore supports two plain text dump formats, both with one
+    message-id per line, followed by a list of tags.
+
+    *batch-tag*
+        The default *batch-tag* dump format is intended to more robust
+        against malformed message-ids and tags containing whitespace or
+        non-\ *ascii(7)* characters. Each line has the form
+
+            +<*encoded-tag*\ > +<*encoded-tag*\ > ... --
+            id:<*quoted-message-id*\ >
+
+            Tags are hex-encoded by replacing every byte not matching
+            the regex *[A-Za-z0-9@=.,\_+-]* with *%nn* where nn is the
+            two digit hex encoding. The message ID is a valid Xapian
+            query, quoted using Xapian boolean term quoting rules: if
+            the ID contains whitespace or a close paren or starts with a
+            double quote, it must be enclosed in double quotes and
+            double quotes inside the ID must be doubled. The astute
+            reader will notice this is a special case of the batch input
+            format for *notmuch-tag(1)*; note that the single message-id
+            query is mandatory for *notmuch-restore(1)*.
+
+    *sup*
+        The *sup* dump file format is specifically chosen to be
+        compatible with the format of files produced by sup-dump. So if
+        you've previously been using sup for mail, then the *notmuch
+        restore* command provides you a way to import all of your tags
+        (or labels as sup calls them). Each line has the following form
+
+            <*message-id*\ > *(* <*tag*\ > ... *)*
+
+            with zero or more tags are separated by spaces. Note that
+            (malformed) message-ids may contain arbitrary non-null
+            characters. Note also that tags with spaces will not be
+            correctly restored with this format.
+
+    With no search terms, a dump of all messages in the database will be
+    generated. A "--" argument instructs notmuch that the remaining
+    arguments are search terms.
+
+    See *notmuch-search-terms(7)* for details of the supported syntax
+    for <search-terms>.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-hooks(5)*, *notmuch-insert(1)*, *notmuch-new(1)*,
+*notmuch-reply(1)*, *notmuch-restore(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
new file mode 100644
index 0000000..18591b3
--- /dev/null
+++ b/doc/man1/notmuch-insert.rst
@@ -0,0 +1,57 @@
+==============
+notmuch-insert
+==============
+
+SYNOPSIS
+========
+
+**notmuch** **insert** [options] **+<tag>** **-<tag>**
+
+DESCRIPTION
+===========
+
+*notmuch insert* reads a message from standard input and delivers it
+into the maildir directory given by configuration option
+*database.path*, then incorporates the message into the notmuch
+database. It is an alternative to using a separate tool to deliver the
+message then running *notmuch new* afterwards.
+
+The new message will be tagged with the tags specified by the *new.tags*
+configuration option, then by operations specified on the command-line:
+tags prefixed by '+' are added while those prefixed by '-' are removed.
+
+If the new message is a duplicate of an existing message in the database
+(it has same Message-ID), it will be added to the maildir folder and
+notmuch database, but the tags will not be changed.
+
+Option arguments must appear before any tag operation arguments.
+Supported options for *insert* include
+
+    ``--folder=<``\ folder\ *>*
+        Deliver the message to the specified folder, relative to the
+        top-level directory given by the value of *database.path*. The
+        default is to deliver to the top-level directory.
+
+    ``--create-folder``
+        Try to create the folder named by the ``--folder`` option, if it
+        does not exist. Otherwise the folder must already exist for mail
+        delivery to succeed.
+
+EXIT STATUS
+===========
+
+This command returns exit status 0 if the message was successfully added
+to the mail directory, even if the message could not be indexed and
+added to the notmuch database. In the latter case, a warning will be
+printed to standard error but the message file will be left on disk.
+
+If the message could not be written to disk then a non-zero exit status
+is returned.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-reply(1)*,
+*notmuch-restore(1)*, *notmuch-search(1)*, *notmuch-search-terms(7)*,
+*notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst
new file mode 100644
index 0000000..949af4d
--- /dev/null
+++ b/doc/man1/notmuch-new.rst
@@ -0,0 +1,51 @@
+===========
+notmuch-new
+===========
+
+SYNOPSIS
+========
+
+**notmuch** **new** [--no-hooks]
+
+DESCRIPTION
+===========
+
+Find and import any new messages to the database.
+
+The *new* command scans all sub-directories of the database, performing
+full-text indexing on new messages that are found. Each new message will
+automatically be tagged with both the *inbox* and *unread* tags.
+
+You should run *notmuch new* once after first running *notmuch setup* to
+create the initial database. The first run may take a long time if you
+have a significant amount of mail (several hundred thousand messages or
+more). Subsequently, you should run *notmuch new* whenever new mail is
+delivered and you wish to incorporate it into the database. These
+subsequent runs will be much quicker than the initial run.
+
+Invoking ``notmuch`` with no command argument will run *new* if *notmuch
+setup* has previously been completed, but *notmuch new* has not
+previously been run.
+
+*notmuch new* updates tags according to maildir flag changes if the
+*maildir.synchronize\_flags* configuration option is enabled. See
+*notmuch-config(1)* for details.
+
+The *new* command supports hooks. See *notmuch-hooks(5)* for more
+details on hooks.
+
+Supported options for *new* include
+
+    ``--no-hooks``
+        Prevents hooks from being run.
+
+    ``--quiet``
+        Do not print progress or results.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-reply(1)*, *notmuch-restore(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-reply.rst b/doc/man1/notmuch-reply.rst
new file mode 100644
index 0000000..7575071
--- /dev/null
+++ b/doc/man1/notmuch-reply.rst
@@ -0,0 +1,112 @@
+=============
+notmuch-reply
+=============
+
+SYNOPSIS
+========
+
+**notmuch** **reply** [options ...] **<search-term> ...**
+
+DESCRIPTION
+===========
+
+Constructs a reply template for a set of messages.
+
+To make replying to email easier, *notmuch reply* takes an existing set
+of messages and constructs a suitable mail template. The Reply-to:
+header (if any, otherwise From:) is used for the To: address. Unless
+``--reply-to=sender`` is specified, values from the To: and Cc: headers
+are copied, but not including any of the current user's email addresses
+(as configured in primary\_mail or other\_email in the .notmuch-config
+file) in the recipient list.
+
+It also builds a suitable new subject, including Re: at the front (if
+not already present), and adding the message IDs of the messages being
+replied to to the References list and setting the In-Reply-To: field
+correctly.
+
+Finally, the original contents of the emails are quoted by prefixing
+each line with '> ' and included in the body.
+
+The resulting message template is output to stdout.
+
+Supported options for *reply* include
+
+    ``--format=``\ (*default*\ \|\ *json*\ \|\ *sexp*\ \|\ *headers-only*)
+
+        *default*
+            Includes subject and quoted message body as an RFC 2822
+            message.
+
+        *json*
+            Produces JSON output containing headers for a reply message
+            and the contents of the original message. This output can be
+            used by a client to create a reply message intelligently.
+
+        *sexp*
+            Produces S-Expression output containing headers for a reply
+            message and the contents of the original message. This
+            output can be used by a client to create a reply message
+            intelligently.
+
+        *headers-only*
+            Only produces In-Reply-To, References, To, Cc, and Bcc
+            headers.
+
+    ``--format-version=N``
+        Use the specified structured output format version. This is
+        intended for programs that invoke *notmuch(1)* internally. If
+        omitted, the latest supported version will be used.
+
+    ``--reply-to=``\ (*all*\ \|\ *sender*)
+
+        *all* (default)
+            Replies to all addresses.
+
+        *sender*
+            Replies only to the sender. If replying to user's own
+            message (Reply-to: or From: header is one of the user's
+            configured email addresses), try To:, Cc:, and Bcc: headers
+            in this order, and copy values from the first that contains
+            something other than only the user's addresses.
+
+    ``--decrypt``
+        Decrypt any MIME encrypted parts found in the selected content
+        (ie. "multipart/encrypted" parts). Status of the decryption will
+        be reported (currently only supported with --format=json and
+        --format=sexp) and on successful decryption the
+        multipart/encrypted part will be replaced by the decrypted
+        content.
+
+        Decryption expects a functioning *gpg-agent(1)* to provide any
+        needed credentials. Without one, the decryption will fail.
+
+See *notmuch-search-terms(7)* for details of the supported syntax for
+<search-terms>.
+
+Note: It is most common to use *notmuch reply* with a search string
+matching a single message, (such as id:<message-id>), but it can be
+useful to reply to several messages at once. For example, when a series
+of patches are sent in a single thread, replying to the entire thread
+allows for the reply to comment on issues found in multiple patches. The
+default format supports replying to multiple messages at once, but the
+JSON and S-Expression formats do not.
+
+EXIT STATUS
+===========
+
+This command supports the following special exit status codes
+
+``20``
+    The requested format version is too old.
+
+``21``
+    The requested format version is too new.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-new(1)*, *notmuch-restore(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-restore.rst b/doc/man1/notmuch-restore.rst
new file mode 100644
index 0000000..ec1cb6c
--- /dev/null
+++ b/doc/man1/notmuch-restore.rst
@@ -0,0 +1,58 @@
+===============
+notmuch-restore
+===============
+
+SYNOPSIS
+========
+
+**notmuch** **restore** [--accumulate] **--format=** **batch-tag** **sup)** [--input=]
+
+DESCRIPTION
+===========
+
+Restores the tags from the given file (see *notmuch dump*).
+
+The input is read from the given filename, if any, or from stdin.
+
+Supported options for *restore* include
+
+    ``--accumulate``
+        The union of the existing and new tags is applied, instead of
+        replacing each message's tags as they are read in from the dump
+        file.
+
+    ``--format=(sup|batch-tag|auto)``
+        Notmuch restore supports two plain text dump formats, with each
+        line specifying a message-id and a set of tags. For details of
+        the actual formats, see *notmuch-dump(1)*.
+
+        *sup*
+            The *sup* dump file format is specifically chosen to be
+            compatible with the format of files produced by sup-dump. So
+            if you've previously been using sup for mail, then the
+            *notmuch restore* command provides you a way to import all
+            of your tags (or labels as sup calls them).
+
+        *batch-tag*
+            The *batch-tag* dump format is intended to more robust
+            against malformed message-ids and tags containing whitespace
+            or non-\ *ascii(7)* characters. See *notmuch-dump(1)* for
+            details on this format.
+
+            *notmuch restore* updates the maildir flags according to tag
+            changes if the *maildir.synchronize\_flags* configuration
+            option is enabled. See *notmuch-config(1)* for details.
+
+        *auto*
+            This option (the default) tries to guess the format from the
+            input. For correctly formed input in either supported
+            format, this heuristic, based the fact that batch-tag format
+            contains no parentheses, should be accurate.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-new(1)*, *notmuch-reply(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
new file mode 100644
index 0000000..8ac580e
--- /dev/null
+++ b/doc/man1/notmuch-search.rst
@@ -0,0 +1,146 @@
+==============
+notmuch-search
+==============
+
+SYNOPSIS
+========
+
+**notmuch** **search** [options ...] **<search-term> ...**
+
+DESCRIPTION
+===========
+
+Search for messages matching the given search terms, and display as
+results the threads containing the matched messages.
+
+The output consists of one line per thread, giving a thread ID, the date
+of the newest (or oldest, depending on the sort option) matched message
+in the thread, the number of matched messages and total messages in the
+thread, the names of all participants in the thread, and the subject of
+the newest (or oldest) message.
+
+See *notmuch-search-terms(7)* for details of the supported syntax for
+<search-terms>.
+
+Supported options for *search* include
+
+    ``--format=``\ (*json*\ \|\ *sexp*\ \|\ *text*\ \|\ *text0*)
+        Presents the results in either JSON, S-Expressions, newline
+        character separated plain-text (default), or null character
+        separated plain-text (compatible with *xargs(1)* -0 option where
+        available).
+
+    ``--format-version=N``
+        Use the specified structured output format version. This is
+        intended for programs that invoke *notmuch(1)* internally. If
+        omitted, the latest supported version will be used.
+
+    ``--output=(summary|threads|messages|files|tags)``
+
+        *summary*
+            Output a summary of each thread with any message matching
+            the search terms. The summary includes the thread ID, date,
+            the number of messages in the thread (both the number
+            matched and the total number), the authors of the thread and
+            the subject.
+
+        *threads*
+            Output the thread IDs of all threads with any message
+            matching the search terms, either one per line
+            (--format=text), separated by null characters
+            (--format=text0), as a JSON array (--format=json), or an
+            S-Expression list (--format=sexp).
+
+        *messages*
+            Output the message IDs of all messages matching the search
+            terms, either one per line (--format=text), separated by
+            null characters (--format=text0), as a JSON array
+            (--format=json), or as an S-Expression list (--format=sexp).
+
+        *files*
+            Output the filenames of all messages matching the search
+            terms, either one per line (--format=text), separated by
+            null characters (--format=text0), as a JSON array
+            (--format=json), or as an S-Expression list (--format=sexp).
+
+            Note that each message may have multiple filenames
+            associated with it. All of them are included in the output,
+            unless limited with the --duplicate=N option.
+
+        *tags*
+            Output all tags that appear on any message matching the
+            search terms, either one per line (--format=text), separated
+            by null characters (--format=text0), as a JSON array
+            (--format=json), or as an S-Expression list (--format=sexp).
+
+    ``--sort=``\ (*newest-first*\ \|\ *oldest-first*)
+        This option can be used to present results in either
+        chronological order (*oldest-first*) or reverse chronological
+        order (*newest-first*).
+
+        Note: The thread order will be distinct between these two
+        options (beyond being simply reversed). When sorting by
+        *oldest-first* the threads will be sorted by the oldest message
+        in each thread, but when sorting by *newest-first* the threads
+        will be sorted by the newest message in each thread.
+
+        By default, results will be displayed in reverse chronological
+        order, (that is, the newest results will be displayed first).
+
+    ``--offset=[-]N``
+        Skip displaying the first N results. With the leading '-', start
+        at the Nth result from the end.
+
+    ``--limit=N``
+        Limit the number of displayed results to N.
+
+    ``--exclude=(true|false|all|flag)``
+        A message is called "excluded" if it matches at least one tag in
+        search.tag\_exclude that does not appear explicitly in the
+        search terms. This option specifies whether to omit excluded
+        messages in the search process.
+
+        The default value, *true*, prevents excluded messages from
+        matching the search terms.
+
+        *all* additionally prevents excluded messages from appearing in
+        displayed results, in effect behaving as though the excluded
+        messages do not exist.
+
+        *false* allows excluded messages to match search terms and
+        appear in displayed results. Excluded messages are still marked
+        in the relevant outputs.
+
+        *flag* only has an effect when ``--output=summary``. The output
+        is almost identical to *false*, but the "match count" is the
+        number of matching non-excluded messages in the thread, rather
+        than the number of matching messages.
+
+    ``--duplicate=N``
+        Effective with ``--output=files``, output the Nth filename
+        associated with each message matching the query (N is 1-based).
+        If N is greater than the number of files associated with the
+        message, don't print anything.
+
+        Note that this option is orthogonal with the *folder:* search
+        prefix. The prefix matches messages based on filenames. This
+        option filters filenames of the matching messages.
+
+EXIT STATUS
+===========
+
+This command supports the following special exit status codes
+
+``20``
+    The requested format version is too old.
+
+``21``
+    The requested format version is too new.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-new(1)*, *notmuch-reply(1)*, *notmuch-restore(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst
new file mode 100644
index 0000000..5d9837c
--- /dev/null
+++ b/doc/man1/notmuch-show.rst
@@ -0,0 +1,180 @@
+============
+notmuch-show
+============
+
+SYNOPSIS
+========
+
+**notmuch** **show** [options ...] **<search-term> ...**
+
+DESCRIPTION
+===========
+
+Shows all messages matching the search terms.
+
+See *notmuch-search-terms(7)* for details of the supported syntax for
+<search-terms>.
+
+The messages will be grouped and sorted based on the threading (all
+replies to a particular message will appear immediately after that
+message in date order). The output is not indented by default, but depth
+tags are printed so that proper indentation can be performed by a
+post-processor (such as the emacs interface to notmuch).
+
+Supported options for *show* include
+
+    ``--entire-thread=(true|false)``
+        If true, *notmuch show* outputs all messages in the thread of
+        any message matching the search terms; if false, it outputs only
+        the matching messages. For ``--format=json`` and
+        ``--format=sexp`` this defaults to true. For other formats, this
+        defaults to false.
+
+    ``--format=(text|json|sexp|mbox|raw)``
+
+        *text* (default for messages)
+            The default plain-text format has all text-content MIME
+            parts decoded. Various components in the output, (*message*,
+            *header*, *body*, *attachment*, and MIME *part*), will be
+            delimited by easily-parsed markers. Each marker consists of
+            a Control-L character (ASCII decimal 12), the name of the
+            marker, and then either an opening or closing brace, ('{' or
+            '}'), to either open or close the component. For a multipart
+            MIME message, these parts will be nested.
+
+        *json*
+            The output is formatted with Javascript Object Notation
+            (JSON). This format is more robust than the text format for
+            automated processing. The nested structure of multipart MIME
+            messages is reflected in nested JSON output. By default JSON
+            output includes all messages in a matching thread; that is,
+            by default,
+
+            ``--format=json`` sets ``--entire-thread`` The caller can
+            disable this behaviour by setting ``--entire-thread=false``
+
+        *sexp*
+            The output is formatted as an S-Expression (sexp). This
+            format is more robust than the text format for automated
+            processing. The nested structure of multipart MIME messages
+            is reflected in nested S-Expression output. By default,
+            S-Expression output includes all messages in a matching
+            thread; that is, by default,
+
+            ``--format=sexp`` sets ``--entire-thread`` The caller can
+            disable this behaviour by setting ``--entire-thread=false``
+
+        *mbox*
+            All matching messages are output in the traditional, Unix
+            mbox format with each message being prefixed by a line
+            beginning with "From " and a blank line separating each
+            message. Lines in the message content beginning with "From "
+            (preceded by zero or more '>' characters) have an additional
+            '>' character added. This reversible escaping is termed
+            "mboxrd" format and described in detail here:
+
+            ::
+
+
+
+        *raw* (default for a single part, see --part)
+            For a message or an attached message part, the original, raw
+            content of the email message is output. Consumers of this
+            format should expect to implement MIME decoding and similar
+            functions.
+
+            For a single part (--part) the raw part content is output
+            after performing any necessary MIME decoding. Note that
+            messages with a simple body still have two parts: part 0 is
+            the whole message and part 1 is the body.
+
+            For a multipart part, the part headers and body (including
+            all child parts) is output.
+
+            The raw format must only be used with search terms matching
+            single message.
+
+    ``--format-version=N``
+        Use the specified structured output format version. This is
+        intended for programs that invoke *notmuch(1)* internally. If
+        omitted, the latest supported version will be used.
+
+    ``--part=N``
+        Output the single decoded MIME part N of a single message. The
+        search terms must match only a single message. Message parts are
+        numbered in a depth-first walk of the message MIME structure,
+        and are identified in the 'json', 'sexp' or 'text' output
+        formats.
+
+    ``--verify``
+        Compute and report the validity of any MIME cryptographic
+        signatures found in the selected content (ie. "multipart/signed"
+        parts). Status of the signature will be reported (currently only
+        supported with --format=json and --format=sexp), and the
+        multipart/signed part will be replaced by the signed data.
+
+    ``--decrypt``
+        Decrypt any MIME encrypted parts found in the selected content
+        (ie. "multipart/encrypted" parts). Status of the decryption will
+        be reported (currently only supported with --format=json and
+        --format=sexp) and on successful decryption the
+        multipart/encrypted part will be replaced by the decrypted
+        content.
+
+        Decryption expects a functioning *gpg-agent(1)* to provide any
+        needed credentials. Without one, the decryption will fail.
+
+        Implies --verify.
+
+    ``--exclude=(true|false)``
+        Specify whether to omit threads only matching
+        search.tag\_exclude from the search results (the default) or
+        not. In either case the excluded message will be marked with the
+        exclude flag (except when output=mbox when there is nowhere to
+        put the flag).
+
+        If --entire-thread is specified then complete threads are
+        returned regardless (with the excluded flag being set when
+        appropriate) but threads that only match in an excluded message
+        are not returned when ``--exclude=true.``
+
+        The default is ``--exclude=true.``
+
+    ``--body=(true|false)``
+        If true (the default) *notmuch show* includes the bodies of the
+        messages in the output; if false, bodies are omitted.
+        ``--body=false`` is only implemented for the json and sexp
+        formats and it is incompatible with ``--part > 0.``
+
+        This is useful if the caller only needs the headers as body-less
+        output is much faster and substantially smaller.
+
+    ``--include-html``
+        Include "text/html" parts as part of the output (currently only
+        supported with --format=json and --format=sexp). By default,
+        unless ``--part=N`` is used to select a specific part or
+        ``--include-html`` is used to include all "text/html" parts, no
+        part with content type "text/html" is included in the output.
+
+A common use of *notmuch show* is to display a single thread of email
+messages. For this, use a search term of "thread:<thread-id>" as can be
+seen in the first column of output from the *notmuch search* command.
+
+EXIT STATUS
+===========
+
+This command supports the following special exit status codes
+
+``20``
+    The requested format version is too old.
+
+``21``
+    The requested format version is too new.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-new(1)*, *notmuch-reply(1)*, *notmuch-restore(1)*,
+*notmuch-search(1)*, *notmuch-search-terms(7)*, *notmuch-tag(1)*
diff --git a/doc/man1/notmuch-tag.rst b/doc/man1/notmuch-tag.rst
new file mode 100644
index 0000000..548c7aa
--- /dev/null
+++ b/doc/man1/notmuch-tag.rst
@@ -0,0 +1,105 @@
+===========
+notmuch-tag
+===========
+
+SYNOPSIS
+========
+
+**notmuch** **tag** [options ...] **+<tag>** **-<tag>** [--] **<search-term>** **.[..]** **notmuch** **tag** **--batch** [--input=]
+
+DESCRIPTION
+===========
+
+Add/remove tags for all messages matching the search terms.
+
+See *notmuch-search-terms(7)* for details of the supported syntax for
+<*search-term*\ >.
+
+Tags prefixed by '+' are added while those prefixed by '-' are removed.
+For each message, tag changes are applied in the order they appear on
+the command line.
+
+The beginning of the search terms is recognized by the first argument
+that begins with neither '+' nor '-'. Support for an initial search term
+beginning with '+' or '-' is provided by allowing the user to specify a
+"--" argument to separate the tags from the search terms.
+
+*notmuch tag* updates the maildir flags according to tag changes if the
+*maildir.synchronize\_flags* configuration option is enabled. See
+*notmuch-config(1)* for details.
+
+Supported options for *tag* include
+
+    ``--remove-all``
+        Remove all tags from each message matching the search terms
+        before applying the tag changes appearing on the command line.
+        This means setting the tags of each message to the tags to be
+        added. If there are no tags to be added, the messages will have
+        no tags.
+
+    ``--batch``
+        Read batch tagging operations from a file (stdin by default).
+        This is more efficient than repeated *notmuch tag* invocations.
+        See `TAG FILE FORMAT <#tag_file_format>`__ below for the input
+        format. This option is not compatible with specifying tagging on
+        the command line.
+
+    ``--input=``\ <filename>
+        Read input from given file, instead of from stdin. Implies
+        ``--batch``.
+
+TAG FILE FORMAT
+===============
+
+The input must consist of lines of the format:
+
++<*tag*\ >\|-<*tag*\ > [...] [--] <*query*\ >
+
+Each line is interpreted similarly to *notmuch tag* command line
+arguments. The delimiter is one or more spaces ' '. Any characters in
+<*tag*\ > *may* be hex-encoded with %NN where NN is the hexadecimal
+value of the character. To hex-encode a character with a multi-byte
+UTF-8 encoding, hex-encode each byte. Any spaces in <tag> *must* be
+hex-encoded as %20. Any characters that are not part of <*tag*\ > *must
+not* be hex-encoded.
+
+In the future tag:"tag with spaces" style quoting may be supported for
+<*tag*\ > as well; for this reason all double quote characters in
+<*tag*\ > *should* be hex-encoded.
+
+The <*query*\ > should be quoted using Xapian boolean term quoting
+rules: if a term contains whitespace or a close paren or starts with a
+double quote, it must be enclosed in double quotes (not including any
+prefix) and double quotes inside the term must be doubled (see below for
+examples).
+
+Leading and trailing space ' ' is ignored. Empty lines and lines
+beginning with '#' are ignored.
+
+EXAMPLE
+-------
+
+The following shows a valid input to batch tagging. Note that only the
+isolated '\*' acts as a wildcard. Also note the two different quotings
+of the tag *space in tags*
+
+::
+
+    +winner *
+    +foo::bar%25 -- (One and Two) or (One and tag:winner)
+    +found::it -- tag:foo::bar%
+    # ignore this line and the next
+
+    +space%20in%20tags -- Two
+    # add tag '(tags)', among other stunts.
+    +crazy{ +(tags) +&are +#possible\ -- tag:"space in tags"
+    +match*crazy -- tag:crazy{
+    +some_tag -- id:"this is ""nauty)"""
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-new(1)*, *notmuch-reply(1)*, *notmuch-restore(1)*,
+*notmuch-search(1)*, *notmuch-search-terms(7)*, *notmuch-show(1)*,
diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
new file mode 100644
index 0000000..ac728af
--- /dev/null
+++ b/doc/man1/notmuch.rst
@@ -0,0 +1,143 @@
+=======
+notmuch
+=======
+
+SYNOPSIS
+========
+
+**notmuch** [option ...] **command** [arg ...]
+
+DESCRIPTION
+===========
+
+Notmuch is a command-line based program for indexing, searching,
+reading, and tagging large collections of email messages.
+
+This page describes how to get started using notmuch from the command
+line, and gives a brief overview of the commands available. For more
+information on e.g. *notmuch show* consult the *notmuch-show(1)* man
+page, also accessible via *notmuch help show*
+
+The quickest way to get started with Notmuch is to simply invoke the
+``notmuch`` command with no arguments, which will interactively guide
+you through the process of indexing your mail.
+
+NOTE
+====
+
+While the command-line program ``notmuch`` provides powerful
+functionality, it does not provide the most convenient interface for
+that functionality. More sophisticated interfaces are expected to be
+built on top of either the command-line interface, or more likely, on
+top of the notmuch library interface. See http://notmuchmail.org for
+more about alternate interfaces to notmuch. The emacs-based interface to
+notmuch (available under *emacs/* in the Notmuch source distribution) is
+probably the most widely used at this time.
+
+OPTIONS
+=======
+
+Supported global options for ``notmuch`` include
+
+    ``--help``
+        Print a synopsis of available commands and exit.
+
+    ``--version``
+        Print the installed version of notmuch, and exit.
+
+    ``--config=FILE``
+        Specify the configuration file to use. This overrides any
+        configuration file specified by ${NOTMUCH\_CONFIG}.
+
+COMMANDS
+========
+
+SETUP
+-----
+
+The *notmuch setup* command is used to configure Notmuch for first use,
+(or to reconfigure it later).
+
+The setup command will prompt for your full name, your primary email
+address, any alternate email addresses you use, and the directory
+containing your email archives. Your answers will be written to a
+configuration file in ${NOTMUCH\_CONFIG} (if set) or
+${HOME}/.notmuch-config . This configuration file will be created with
+descriptive comments, making it easy to edit by hand later to change the
+configuration. Or you can run *notmuch setup* again to change the
+configuration.
+
+The mail directory you specify can contain any number of sub-directories
+and should primarily contain only files with individual email messages
+(eg. maildir or mh archives are perfect). If there are other, non-email
+files (such as indexes maintained by other email programs) then notmuch
+will do its best to detect those and ignore them.
+
+Mail storage that uses mbox format, (where one mbox file contains many
+messages), will not work with notmuch. If that's how your mail is
+currently stored, it is recommended you first convert it to maildir
+format with a utility such as mb2md before running *notmuch setup .*
+
+Invoking ``notmuch`` with no command argument will run *setup* if the
+setup command has not previously been completed.
+
+OTHER COMMANDS
+--------------
+
+Several of the notmuch commands accept search terms with a common
+syntax. See *notmuch-search-terms*\ (7) for more details on the
+supported syntax.
+
+The *search*, *show* and *count* commands are used to query the email
+database.
+
+The *reply* command is useful for preparing a template for an email
+reply.
+
+The *tag* command is the only command available for manipulating
+database contents.
+
+The *dump* and *restore* commands can be used to create a textual dump
+of email tags for backup purposes, and to restore from that dump.
+
+The *config* command can be used to get or set settings in the notmuch
+configuration file.
+
+ENVIRONMENT
+===========
+
+The following environment variables can be used to control the behavior
+of notmuch.
+
+*NOTMUCH\_CONFIG*
+    Specifies the location of the notmuch configuration file. Notmuch
+    will use ${HOME}/.notmuch-config if this variable is not set.
+
+*NOTMUCH\_TALLOC\_REPORT*
+    Location to write a talloc memory usage report. See
+    *talloc\_enable\_leak\_report\_full* in *talloc(3)* for more
+    information.
+
+*NOTMUCH\_DEBUG\_QUERY*
+    If set to a non-empty value, the notmuch library will print (to
+    stderr) Xapian queries it constructs.
+
+SEE ALSO
+========
+
+*notmuch-config(1)*, *notmuch-count(1)*, *notmuch-dump(1)*,
+*notmuch-hooks(5)*, *notmuch-insert(1)*, *notmuch-new(1)*,
+*notmuch-reply(1)*, *notmuch-restore(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
+
+The notmuch website: *http://notmuchmail.org*
+
+CONTACT
+=======
+
+Feel free to send questions, comments, or kudos to the notmuch mailing
+list <notmuch@notmuchmail.org> . Subscription is not required before
+posting, but is available from the notmuchmail.org website.
+
+Real-time interaction with the Notmuch community is available via IRC
+(server: irc.freenode.net, channel: #notmuch).
diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst
new file mode 100644
index 0000000..5a055eb
--- /dev/null
+++ b/doc/man5/notmuch-hooks.rst
@@ -0,0 +1,42 @@
+=============
+notmuch-hooks
+=============
+
+SYNOPSIS
+========
+
+DESCRIPTION
+===========
+
+Hooks are scripts (or arbitrary executables or symlinks to such) that
+notmuch invokes before and after certain actions. These scripts reside
+in the .notmuch/hooks directory within the database directory and must
+have executable permissions.
+
+The currently available hooks are described below.
+
+    *pre-new*
+        This hook is invoked by the *new* command before scanning or
+        importing new messages into the database. If this hook exits
+        with a non-zero status, notmuch will abort further processing of
+        the *new* command.
+
+        Typically this hook is used for fetching or delivering new mail
+        to be imported into the database.
+
+    *post-new*
+        This hook is invoked by the *new* command after new messages
+        have been imported into the database and initial tags have been
+        applied. The hook will not be run if there have been any errors
+        during the scan or import.
+
+        Typically this hook is used to perform additional query-based
+        tagging on the imported messages.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-insert(1)*, *notmuch-new(1)*,
+*notmuch-reply(1)*, *notmuch-restore(1)*, *notmuch-search(1)*,
+*notmuch-search-terms(7)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
new file mode 100644
index 0000000..37095d7
--- /dev/null
+++ b/doc/man7/notmuch-search-terms.rst
@@ -0,0 +1,225 @@
+====================
+notmuch-search-terms
+====================
+
+SYNOPSIS
+========
+
+**notmuch** **count** [options ...] **<search-term> ...**
+
+**notmuch** **dump** [<filename>] [--] [<search-term> ...]
+
+**notmuch** **search** [options ...] **<search-term> ...**
+
+**notmuch** **show** [options ...] **<search-term> ...**
+
+**notmuch** **tag** **+<tag>** **-<tag>** [--] **<search-term>** **...**
+
+DESCRIPTION
+===========
+
+Several notmuch commands accept a common syntax for search terms.
+
+The search terms can consist of free-form text (and quoted phrases)
+which will match all messages that contain all of the given
+terms/phrases in the body, the subject, or any of the sender or
+recipient headers.
+
+As a special case, a search string consisting of exactly a single
+asterisk ("\*") will match all messages.
+
+In addition to free text, the following prefixes can be used to force
+terms to match against specific portions of an email, (where <brackets>
+indicate user-supplied values):
+
+from:<name-or-address>
+
+to:<name-or-address>
+
+subject:<word-or-quoted-phrase>
+
+attachment:<word>
+
+tag:<tag> (or is:<tag>)
+
+id:<message-id>
+
+thread:<thread-id>
+
+folder:<directory-path>
+
+date:<since>..<until>
+
+The *from:* prefix is used to match the name or address of the sender of
+an email message.
+
+The *to:* prefix is used to match the names or addresses of any
+recipient of an email message, (whether To, Cc, or Bcc).
+
+Any term prefixed with *subject:* will match only text from the subject
+of an email. Searching for a phrase in the subject is supported by
+including quotation marks around the phrase, immediately following
+*subject:*.
+
+The *attachment:* prefix can be used to search for specific filenames
+(or extensions) of attachments to email messages.
+
+For *tag:* and *is:* valid tag values include *inbox* and *unread* by
+default for new messages added by *notmuch new* as well as any other tag
+values added manually with *notmuch tag*.
+
+For *id:*, message ID values are the literal contents of the Message-ID:
+header of email messages, but without the '<', '>' delimiters.
+
+The *thread:* prefix can be used with the thread ID values that are
+generated internally by notmuch (and do not appear in email messages).
+These thread ID values can be seen in the first column of output from
+*notmuch search*
+
+The *folder:* prefix can be used to search for email message files that
+are contained within particular directories within the mail store. If
+the same email message has multiple message files associated with it,
+it's sufficient for a match that at least one of the files is contained
+within a matching directory. Only the directory components below the
+top-level mail database path are available to be searched.
+
+The *date:* prefix can be used to restrict the results to only messages
+within a particular time range (based on the Date: header) with a range
+syntax of:
+
+date:<since>..<until>
+
+See *DATE AND TIME SEARCH* below for details on the range expression,
+and supported syntax for <since> and <until> date and time expressions.
+
+The time range can also be specified using timestamps with a syntax of:
+
+<initial-timestamp>..<final-timestamp>
+
+Each timestamp is a number representing the number of seconds since
+1970-01-01 00:00:00 UTC.
+
+In addition to individual terms, multiple terms can be combined with
+Boolean operators ( *and*, *or*, *not* , etc.). Each term in the query
+will be implicitly connected by a logical AND if no explicit operator is
+provided, (except that terms with a common prefix will be implicitly
+combined with OR until we get Xapian defect #402 fixed).
+
+Parentheses can also be used to control the combination of the Boolean
+operators, but will have to be protected from interpretation by the
+shell, (such as by putting quotation marks around any parenthesized
+expression).
+
+DATE AND TIME SEARCH
+====================
+
+notmuch understands a variety of standard and natural ways of expressing
+dates and times, both in absolute terms ("2012-10-24") and in relative
+terms ("yesterday"). Any number of relative terms can be combined ("1
+hour 25 minutes") and an absolute date/time can be combined with
+relative terms to further adjust it. A non-exhaustive description of the
+syntax supported for absolute and relative terms is given below.
+
+    *The range expression*
+        date:<since>..<until>
+
+        The above expression restricts the results to only messages from
+        <since> to <until>, based on the Date: header.
+
+        <since> and <until> can describe imprecise times, such as
+        "yesterday". In this case, <since> is taken as the earliest time
+        it could describe (the beginning of yesterday) and <until> is
+        taken as the latest time it could describe (the end of
+        yesterday). Similarly, date:january..february matches from the
+        beginning of January to the end of February.
+
+        Currently, we do not support spaces in range expressions. You
+        can replace the spaces with '\_', or (in most cases) '-', or (in
+        some cases) leave the spaces out altogether. Examples in this
+        man page use spaces for clarity.
+
+        Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's
+        possible to specify date:..<until> or date:<since>.. to not
+        limit the start or end time, respectively. Pre-1.2.1 Xapian does
+        not report an error on open ended ranges, but it does not work
+        as expected either.
+
+        Entering date:expr without ".." (for example date:yesterday)
+        won't work, as it's not interpreted as a range expression at
+        all. You can achieve the expected result by duplicating the expr
+        both sides of ".." (for example date:yesterday..yesterday).
+
+    *Relative date and time*
+        [N\|number]
+        (years\|months\|weeks\|days\|hours\|hrs\|minutes\|mins\|seconds\|secs)
+        [...]
+
+        All refer to past, can be repeated and will be accumulated.
+
+        Units can be abbreviated to any length, with the otherwise
+        ambiguous single m being m for minutes and M for months.
+
+        Number can also be written out one, two, ..., ten, dozen,
+        hundred. Additionally, the unit may be preceded by "last" or
+        "this" (e.g., "last week" or "this month").
+
+        When combined with absolute date and time, the relative date and
+        time specification will be relative from the specified absolute
+        date and time.
+
+        Examples: 5M2d, two weeks
+
+    *Supported absolute time formats*
+        H[H]:MM[:SS] [(am\|a.m.\|pm\|p.m.)]
+
+        H[H] (am\|a.m.\|pm\|p.m.)
+
+        HHMMSS
+
+        now
+
+        noon
+
+        midnight
+
+        Examples: 17:05, 5pm
+
+    *Supported absolute date formats*
+        YYYY-MM[-DD]
+
+        DD-MM[-[YY]YY]
+
+        MM-YYYY
+
+        M[M]/D[D][/[YY]YY]
+
+        M[M]/YYYY
+
+        D[D].M[M][.[YY]YY]
+
+        D[D][(st\|nd\|rd\|th)] Mon[thname] [YYYY]
+
+        Mon[thname] D[D][(st\|nd\|rd\|th)] [YYYY]
+
+        Wee[kday]
+
+        Month names can be abbreviated at three or more characters.
+
+        Weekday names can be abbreviated at three or more characters.
+
+        Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
+
+    *Time zones*
+        (+\|-)HH:MM
+
+        (+\|-)HH[MM]
+
+        Some time zone codes, e.g. UTC, EET.
+
+SEE ALSO
+========
+
+*notmuch(1)*, *notmuch-config(1)*, *notmuch-count(1)*,
+*notmuch-dump(1)*, *notmuch-hooks(5)*, *notmuch-insert(1)*,
+*notmuch-new(1)*, *notmuch-reply(1)*, *notmuch-restore(1)*,
+*notmuch-search(1)*, *notmuch-show(1)*, *notmuch-tag(1)*
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
new file mode 100644
index 0000000..28301b3
--- /dev/null
+++ b/doc/notmuch-emacs.rst
@@ -0,0 +1,192 @@
+=============
+notmuch-emacs
+=============
+
+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 inteface 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 varables docstring.
+
+notmuch-hello
+=============
+
+.. index::
+   single: notmuch-hello
+   single: notmuch
+
+``notmuch-hello`` is the main entry point for notmuch. You can start it
+with ``M-x notmuch`` or ``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 **bold** text indicates buttons you can click with
+a mouse or by positioning the cursor and pressing ``<return>``
+
+|   Welcome to **notmuch** You have 52 messages.
+|
+| Saved searches: **[edit]**
+|
+|	  52 **inbox**           52 **unread**
+|
+| Search: ____________________________________
+|
+| All tags: **[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.
+|		    **Customize** this page.
+
+You can change the overall appearence of the notmuch-hello screen by
+customizing the variable :index:`notmuch-hello-sections`.
+
+
+
+notmuch-hello key bindings
+--------------------------
+
+``<tab>``
+    Move to the next widget (button or text entry field)
+
+``<backtab>``
+    Move to the previous widget.
+
+``<return>``
+    Activate the current widget.
+
+``=``
+    Refresh the buffer; mainly update the counts of messages for various
+    saved searches.
+
+``G``
+    Import mail, See :ref:`importing`
+
+``m``
+    Compose a message
+
+``s``
+    Search the notmuch database using :ref:`notmuch-search`
+
+``v``
+    Print notmuch version
+
+``q``
+    Quit
+
+.. _saved-searches:
+
+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 searchs. The initial defaults are ``tag:inbox`` and
+``tag:unread``, but you can customize the following variables
+
+: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.
+
+:index:`notmuch-saved-searches-sort-function`
+    This variable controls how saved searches should be sorted. A value
+    of ``nil`` displays the saved searches in the order they are stored
+    in ‘notmuch-saved-searches’.
+
+:index:`notmuch-column-control`
+    Controls the number of columns for displaying saved-searches/tags
+
+Search Box
+----------
+
+The search box lets the user enter an notmuch query. See section
+“Description” in 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 :index:`notmuch-hello-recent-searches-max`.
+
+Known Tags
+----------
+
+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.
+
+:index:`notmuch-hello-tag-list-make-query`
+    Control how to construct a search (“virtual folder”) from a given
+    tag.
+
+:index:`notmuch-hello-hide-tags`
+    Which tags not to display at all.
+
+:index:`notmuch-column-control`
+    Controls the number of columns for displaying saved-searches/tags
+
+.. _notmuch-search:
+
+notmuch-search
+==============
+
+``notmuch-search-mode`` is used to display the results from executing
+a query via ``notmuch-search``. The syntax for these queries is the
+the same as :ref:`saved-searches`. For details of this syntax see
+info:notmuch-search-terms
+
+By default the output approximates that of the command line See section
+“Description” in notmuch search command.
+
+The main purpose of the ``notmuch-search-mode`` buffer is to act as a
+menu of results that the user can explore further by pressing
+``<return>`` on the appropriate line.
+
+``n,C-n,<down>``
+    Move to next line
+
+``p,C-p,<up>``
+    Move to previous line
+
+``<return>``
+    Open thread on current line in :ref:`notmuch-show` mode
+
+``?``
+    Display full set of key bindings
+
+The presentation of results can be controlled by the following
+variables.
+
+:index:`notmuch-search-result-format`
+    Control how each thread of messages is presented in the
+    ``notmuch-show-mode`` buffer
+
+:index:`notmuch-search-oldest-first`
+    Display the oldest threads at the top of the buffer
+
+.. _notmuch-show:
+
+notmuch-show
+============
+
+notmuch-tree
+============
+
+Configuration
+=============
+
+.. _importing:
+
+Importing Mail
+--------------
+
+:index:`notmuch-poll`
+
+:index:`notmuch-poll-script`
-- 
1.8.5.3

[RFC Patch v3 2/3] doc: add target rst2man to build man pages using rst2man

[David Bremner]

Many people have docutils installed, but not sphinx. Allow these
people to build the man pages.
---
 Makefile                   |  2 +-
 doc/conf.py                |  2 +-
 doc/rst2man/Makefile       |  5 +++++
 doc/rst2man/Makefile.local | 37 ++++++++++++++++++++++++++++++++
 doc/rst2man/prerst2man.py  | 53 ++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 97 insertions(+), 2 deletions(-)
 create mode 100644 doc/rst2man/Makefile
 create mode 100644 doc/rst2man/Makefile.local
 create mode 100644 doc/rst2man/prerst2man.py

diff --git a/Makefile b/Makefile
index 39f0e62..3c7f0be 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,7 @@ all:
 # List all subdirectories here. Each contains its own Makefile.local.
 # Use of '=', without '+=', seems to be required for out-of-tree
 # builds to work.
-subdirs = compat completion doc emacs lib man parse-time-string performance-test util test
+subdirs = compat completion doc doc/rst2man emacs lib man parse-time-string performance-test util test
 
 # We make all targets depend on the Makefiles themselves.
 global_deps = Makefile Makefile.config Makefile.local \
diff --git a/doc/conf.py b/doc/conf.py
index d80b2af..9180d86 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -21,7 +21,7 @@ release = '0.17'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build','rst2man']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
diff --git a/doc/rst2man/Makefile b/doc/rst2man/Makefile
new file mode 100644
index 0000000..0a0815d
--- /dev/null
+++ b/doc/rst2man/Makefile
@@ -0,0 +1,5 @@
+all:
+	$(MAKE) -C ../.. all
+
+.DEFAULT:
+	$(MAKE) -C ../.. $@
diff --git a/doc/rst2man/Makefile.local b/doc/rst2man/Makefile.local
new file mode 100644
index 0000000..bc821fe
--- /dev/null
+++ b/doc/rst2man/Makefile.local
@@ -0,0 +1,37 @@
+# -*- Makefile -*-
+dir := doc/rst2man
+
+prerst2man := python $(dir)/prerst2man.py $(dir)/.. $(dir)
+
+%.1 :%.rst
+	rst2man $< > $@
+
+%.5 :%.rst
+	rst2man $< > $@
+
+%.7: %.rst
+	rst2man $< > $@
+
+# actual source files
+RST1SRC := $(wildcard doc/man1/*.rst)
+RST5SRC	:= $(wildcard doc/man5/*.rst)
+RST7SRC := $(wildcard doc/man7/*.rst)
+
+RST2MAN1SRC := $(patsubst doc/man1/%,doc/rst2man/man1/%,$(RST1SRC))
+RST2MAN5SRC := $(patsubst doc/man5/%,doc/rst2man/man5/%,$(RST5SRC))
+RST2MAN7SRC := $(patsubst doc/man7/%,doc/rst2man/man7/%,$(RST7SRC))
+
+RST2MANSRC := ${RST2MAN1SRC} ${RST2MAN5SRC} ${RST2MAN7SRC}
+
+MAN1SRC := $(patsubst $(dir)/man1/%.rst,$(dir)/man1/%.1,${RST2MAN1SRC})
+MAN5SRC := $(patsubst $(dir)/man5/%.rst,$(dir)/man5/%.5,${RST2MAN5SRC})
+MAN7SRC := $(patsubst $(dir)/man7/%.rst,$(dir)/man7/%.7,${RST2MAN7SRC})
+MANSRC := ${MAN1SRC} ${MAN5SRC} ${MAN7SRC}
+
+rst2man: ${MANSRC}
+
+${RST2MANSRC}: ${RSTSRC}
+	mkdir -p doc/rst2man/man1 doc/rst2man/man5 doc/rst2man/man7
+	$(prerst2man)
+
+CLEAN := ${CLEAN} ${RST2MANSRC} ${MANSRC}
diff --git a/doc/rst2man/prerst2man.py b/doc/rst2man/prerst2man.py
new file mode 100644
index 0000000..797dd20
--- /dev/null
+++ b/doc/rst2man/prerst2man.py
@@ -0,0 +1,53 @@
+from sys import argv
+from datetime import date
+import re
+
+sourcedir=argv[1]
+outdir=argv[2]
+
+execfile(sourcedir+"/conf.py");
+
+
+
+
+def header(file,startdocname, command, description, authors, section):
+    file.write("""
+{:s}
+{:s}
+{:s}
+
+:Date:   {:s}
+:Version: {:s}
+:Manual section: {:d}
+:Manual group: {:s}
+
+""".format(
+'-' * len(description),
+description,
+'-' * len(description),
+date.today().isoformat(),release,section,project))
+
+blankre = re.compile("^\s*$")
+for page in man_pages:
+    outfile = open(outdir+"/"+page[0]+'.rst','w')
+    infile = open(sourcedir+"/"+page[0]+".rst",'r')
+
+
+    # this is a crude hack. We look for the first blank line, and
+    # insert the rst2man header there.
+    #
+    # XXX consider really parsing input
+
+    count=0
+    lines = infile.readlines()
+    for line in lines:
+        outfile.write(line);
+        if (blankre.match(line)):
+            break
+        count = count + 1
+
+    del lines[0:count+1]
+
+    header(outfile,*page)
+
+    outfile.write("".join(lines))
-- 
1.8.5.3

[RFC Patch v3 3/3] doc: fix for conversion errors

[David Bremner]

notmuch-show: For some reason a url got dropped.

notmuch-compact: Probably my synopsis converter misses a case
---
 doc/man1/notmuch-compact.rst | 2 +-
 doc/man1/notmuch-show.rst    | 4 +---
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/doc/man1/notmuch-compact.rst b/doc/man1/notmuch-compact.rst
index aeabd16..c149566 100644
--- a/doc/man1/notmuch-compact.rst
+++ b/doc/man1/notmuch-compact.rst
@@ -5,7 +5,7 @@ notmuch-compact
 SYNOPSIS
 ========
 
-**notmuch** **compact** [--quiet] [--backup=]
+**notmuch** **compact** [--quiet] [--backup=<directory>]
 
 DESCRIPTION
 ===========
diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst
index 5d9837c..46e4c9b 100644
--- a/doc/man1/notmuch-show.rst
+++ b/doc/man1/notmuch-show.rst
@@ -73,9 +73,7 @@ Supported options for *show* include
             '>' character added. This reversible escaping is termed
             "mboxrd" format and described in detail here:
 
-            ::
-
-
+	    http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
 
         *raw* (default for a single part, see --part)
             For a message or an attached message part, the original, raw
-- 
1.8.5.3

Re: [RFC Patch v3 2/3] doc: add target rst2man to build man pages using rst2man

[Tomi Ollila]

On Sun, Feb 23 2014, David Bremner <david@tethera.net> wrote:

> Many people have docutils installed, but not sphinx. Allow these
> people to build the man pages.

+1 from me to start having manuals in reStructuredText format and
then converting these to the target formats. Some comments on
the patch series below:

Building any docs using this is not yet activated ?

Anyway, I tried to build manual pages using 'make man' and got this:

  $ make man
  sphinx-build -b man -d doc/_build/doctrees -q -c doc doc doc/_build/man
  Making output directory...

  Sphinx error:
  Builder name man not registered

No fallback to use rst2man...


Comments regarding prerst2man.py inline below:

Tomi

> ---

// stuff deleted //

> diff --git a/doc/rst2man/prerst2man.py b/doc/rst2man/prerst2man.py
> new file mode 100644
> index 0000000..797dd20
> --- /dev/null
> +++ b/doc/rst2man/prerst2man.py
> @@ -0,0 +1,53 @@
> +from sys import argv
> +from datetime import date
> +import re
> +
> +sourcedir=argv[1]
> +outdir=argv[2]

Style! run pep8 prerst2html.py and fix the issues it prints
to the screen, like ' = ' above and remove trailing semicolon
below... (and also pep8(1) doc/conf.py.
 
> +
> +execfile(sourcedir+"/conf.py");
> +
> +
> +
> +
> +def header(file,startdocname, command, description, authors, section):
> +    file.write("""
> +{:s}
> +{:s}
> +{:s}
> +
> +:Date:   {:s}
> +:Version: {:s}
> +:Manual section: {:d}
> +:Manual group: {:s}

For python < 2.7 these needs to be {0:s}, {1:s}, {2:s}.. {5:d}...

> +
> +""".format(
> +'-' * len(description),
> +description,
> +'-' * len(description),
> +date.today().isoformat(),release,section,project))

Replace date.today.isoformat() with date determined from other
sources (NEWS file?)

> +
> +blankre = re.compile("^\s*$")
> +for page in man_pages:
> +    outfile = open(outdir+"/"+page[0]+'.rst','w')
> +    infile = open(sourcedir+"/"+page[0]+".rst",'r')

In addition to formatting above, use either ".rst" or '.rst'
(and perhaps other quotations in these 2 lines) for consistency.

> +
> +
> +    # this is a crude hack. We look for the first blank line, and
> +    # insert the rst2man header there.
> +    #
> +    # XXX consider really parsing input
> +
> +    count=0
> +    lines = infile.readlines()
> +    for line in lines:
> +        outfile.write(line);
> +        if (blankre.match(line)):
> +            break
> +        count = count + 1
> +
> +    del lines[0:count+1]

pep8 will in the lime above (as it is not lines[0:count + 1])
I might not have complained but... :D

> +
> +    header(outfile,*page)
> +
> +    outfile.write("".join(lines))
> -- 
> 1.8.5.3

Re: [RFC Patch v3 2/3] doc: add target rst2man to build man pages using rst2man

[David Bremner]

Tomi Ollila <tomi.ollila@iki.fi> writes:

> Anyway, I tried to build manual pages using 'make man' and got this:
>
>   $ make man
>   sphinx-build -b man -d doc/_build/doctrees -q -c doc doc doc/_build/man
>   Sphinx error:
>   Builder name man not registered

It seems you need sphinx version 1.0, from July 2010 for the man
builder.

> No fallback to use rst2man...

I don't really plan on an automatic fallback. There is currently a
separate target rst2man.  I'm open to better names for the targets.

> Comments regarding prerst2man.py inline below:

Yeah, I'm sure there's lots that could be improved with that script. But
I'll wait until I see if the general approach is acceptable.

d

Re: v3 of sphinx docs

[Mark Walters]

This looks good to me. It will obviously need a little tweaking but I
like it.

There is some error in the conversion for SYNOPSIS for dump, restore
and tag (which may also have caused the problem for compact?)

Otherwise there were a small number of oddities in indentation, and a
general reduction in boldness (using underlining instead). (This is on a
standard xterm). One case we might care a little about is the SEE ALSO
section at the end where the underlining rather than bold seems
inconsistent with the rest of my debian manpages.

Best wishes

Mark




On Sun, 23 Feb 2014, David Bremner <david@tethera.net> wrote:
> This version includes a complete conversion of the existing manpages.
> The conversion uses doclifter + custom python code + pandoc. It is
> pretty much fully automated, so I can rebase against changes to the
> nroff source if needed.  
>
> On the other hand, it is fully automated, so there are bound to be a
> few rough spots. If there are systematic things, I can fix the
> conversion scripts; one offs can just be added to the series.
>
> It does do a much better job of option indentation than the previous
> version.
>
> I think this is reaching the point where if anybody has any strong
> objections to sphinx (with a fallback to rst2man) for the docs, I'd
> like to hear them.
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re:

[Tomi Ollila]

On Thu, Mar 13 2014, David Bremner <david@tethera.net> wrote:

> Several people observed a problem with the test T010-help not finding
> the man pages anymore. To fix that, I had change the previous fix:
> instead of flattening the rst2man output into one directory, I had to
> move the sphinx output into a hierarchy.

These patches fix my build and tests pass. +1

Database upgraded (real men don't use backups or how did it go ?).

Tomi


>
> Patches 1 and 3 should be the same as 
>
> 	id:1394539555-28334-1-git-send-email-david@tethera.net
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re:

[David Bremner]

David Bremner <david@tethera.net> writes:

> Several people observed a problem with the test T010-help not finding
> the man pages anymore. To fix that, I had change the previous fix:
> instead of flattening the rst2man output into one directory, I had to
> move the sphinx output into a hierarchy.
>
> Patches 1 and 3 should be the same as 
>
> 	id:1394539555-28334-1-git-send-email-david@tethera.net
>

pushed this series

d

Re:

[Jameson Graef Rollins]

[-- Attachment #1: Type: text/plain, Size: 498 bytes --]

On Tue, May 06 2014, David Bremner <david@tethera.net> wrote:
> The first of these fixes a build failure on Debian Linux/armhf (and
> OS/X). If the patch seems ok, I'd like to roll it into a bug fix
> release.  The second is more of a suggestion to make that atomicity
> test easier to debug, since it seems to find the dark corners of gdb.

Hey, David.  It looks like Charles's series fixes some of these same
issues and more:

id:1399395748-44920-1-git-send-email-cceleri@cs.stanford.edu

jamie.

[-- Attachment #2: Type: application/pgp-signature, Size: 818 bytes --]

Re:

[Tomi Ollila]

On Tue, May 06 2014, David Bremner <david@tethera.net> wrote:

> The first of these fixes a build failure on Debian Linux/armhf (and
> OS/X). If the patch seems ok, I'd like to roll it into a bug fix
> release.  The second is more of a suggestion to make that atomicity
> test easier to debug, since it seems to find the dark corners of gdb.

Series LGTM.

Tomi

Re:

[David Bremner]

David Bremner <david@tethera.net> writes:

> This is in some sense a successor to 
>
>      id:cover.1411914914.git.jani@nikula.org
>
> It includes the first two patches of that series verbatim, and adds
> some tests.

I should have said _almost_ verbatim; it marks some tests non-broken.

Re:

[Jani Nikula]

On Sat, 04 Oct 2014, David Bremner <david@tethera.net> wrote:
> This is in some sense a successor to 
>
>      id:cover.1411914914.git.jani@nikula.org
>
> It includes the first two patches of that series verbatim, and adds
> some tests.

I like it, very nice. Start pushing and add the post-insert hook patch
from my series on top?  ;)

BR,
Jani.

Re:

[David Bremner]

David Bremner <david@tethera.net> writes:

> This has Jani's suggestions fixed, along with a couple of other trivial patches.
>
> I'll mark them ready at this point.

I pushed these, with Trevor's suggested changes.

d

Re:

[Mark Walters]

On Tue, 11 Oct 2016, matt@bubblegen.co.uk wrote:
> From: Matthew Lear <matt@bubblegen.co.uk>
> To: notmuch@notmuchmail.org
> Cc: Matthew Lear <matt@bubblegen.co.uk>
> Subject: [PATCH] Fix reply to encrypted mail when discouraging plain text.
> Date: Tue, 11 Oct 2016 22:24:18 +0100
> Message-Id: <1476221058-10431-1-git-send-email-matt@bubblegen.co.uk>
> X-Mailer: git-send-email 2.4.10
>
> If an encrypted multipart message is received which contains html and
> notmuch-multipart/alternative-discouraged is set to discourage "text/plain",
> any encrypted parts are not decrypted during generation of the reply
> text. This fixes that problem by making sure notmuch-mua-reply does
> that.

Hi

I haven't tested this but it looks correct: more broadly I think this is
needed whenever notmuch-show has to get a part directly rather than just
from the sexp reply.

Best wishes

Mark


> ---
>  emacs/notmuch-mua.el | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el
> index c567173..f333655 100644
> --- a/emacs/notmuch-mua.el
> +++ b/emacs/notmuch-mua.el
> @@ -251,6 +251,10 @@ mutiple parts get a header."
>  		       (notmuch-show-max-text-part-size 0)
>  		       ;; Insert headers for parts as appropriate for replying.
>  		       (notmuch-show-insert-header-p-function notmuch-mua-reply-insert-header-p-function)
> +		       ;; Ensure that any encrypted parts are
> +		       ;; decrypted during the generation of the reply
> +		       ;; text.
> +		       (notmuch-show-process-crypto process-crypto)
>  		       ;; Don't indent multipart sub-parts.
>  		       (notmuch-show-indent-multipart nil))
>  		    ;; We don't want sigstatus buttons (an information leak and usually wrong anyway).
> -- 
> 2.4.10
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> https://notmuchmail.org/mailman/listinfo/notmuch

Re:

[Matt Armstrong]

Matt Armstrong <marmstrong@google.com> writes:

> This supercedes
> id:1476207707-21827-1-git-send-email-marmstrong@google.com with
> changes steming from Mark's helpful feedback.

Apologies for the lack of a subject here.  I'm still learning the ins
and outs of 'git send-email'.  I can't say I'd call it a friendly
facility.  :)

Re:

[Mark Walters]

On Wed, 12 Oct 2016, Mark Walters <markwalters1009@gmail.com> wrote:
> On Tue, 11 Oct 2016, matt@bubblegen.co.uk wrote:
>> From: Matthew Lear <matt@bubblegen.co.uk>
>> To: notmuch@notmuchmail.org
>> Cc: Matthew Lear <matt@bubblegen.co.uk>
>> Subject: [PATCH] Fix reply to encrypted mail when discouraging plain text.
>> Date: Tue, 11 Oct 2016 22:24:18 +0100
>> Message-Id: <1476221058-10431-1-git-send-email-matt@bubblegen.co.uk>
>> X-Mailer: git-send-email 2.4.10
>>
>> If an encrypted multipart message is received which contains html and
>> notmuch-multipart/alternative-discouraged is set to discourage "text/plain",
>> any encrypted parts are not decrypted during generation of the reply
>> text. This fixes that problem by making sure notmuch-mua-reply does
>> that.
>
> Hi
>
> I haven't tested this but it looks correct: more broadly I think this is
> needed whenever notmuch-show has to get a part directly rather than just
> from the sexp reply.

Hi

Just to confirm I have now tested this -- it compiles and test suite
passes. (Note I don't have suitable encrypted messages to test).

Anyway LGTM +1

Best wishes

Mark



>
> Best wishes
>
> Mark
>
>
>> ---
>>  emacs/notmuch-mua.el | 4 ++++
>>  1 file changed, 4 insertions(+)
>>
>> diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el
>> index c567173..f333655 100644
>> --- a/emacs/notmuch-mua.el
>> +++ b/emacs/notmuch-mua.el
>> @@ -251,6 +251,10 @@ mutiple parts get a header."
>>  		       (notmuch-show-max-text-part-size 0)
>>  		       ;; Insert headers for parts as appropriate for replying.
>>  		       (notmuch-show-insert-header-p-function notmuch-mua-reply-insert-header-p-function)
>> +		       ;; Ensure that any encrypted parts are
>> +		       ;; decrypted during the generation of the reply
>> +		       ;; text.
>> +		       (notmuch-show-process-crypto process-crypto)
>>  		       ;; Don't indent multipart sub-parts.
>>  		       (notmuch-show-indent-multipart nil))
>>  		    ;; We don't want sigstatus buttons (an information leak and usually wrong anyway).
>> -- 
>> 2.4.10
>>
>> _______________________________________________
>> notmuch mailing list
>> notmuch@notmuchmail.org
>> https://notmuchmail.org/mailman/listinfo/notmuch

Re:

[Matthew Lear]

[-- Attachment #1: Type: text/plain, Size: 2594 bytes --]

Hi Mark. Excellent :-) I'll look out for it in the repository at some point soon. Cheers,   Matt 
-------- Original message --------From: Mark Walters <markwalters1009@gmail.com> Date: 15/10/2016  08:09  (GMT+00:00) To: matt@bubblegen.co.uk, notmuch@notmuchmail.org, matt@bubblegen.co.uk Subject: Re: 

On Wed, 12 Oct 2016, Mark Walters <markwalters1009@gmail.com> wrote:
> On Tue, 11 Oct 2016, matt@bubblegen.co.uk wrote:
>> From: Matthew Lear <matt@bubblegen.co.uk>
>> To: notmuch@notmuchmail.org
>> Cc: Matthew Lear <matt@bubblegen.co.uk>
>> Subject: [PATCH] Fix reply to encrypted mail when discouraging plain text.
>> Date: Tue, 11 Oct 2016 22:24:18 +0100
>> Message-Id: <1476221058-10431-1-git-send-email-matt@bubblegen.co.uk>
>> X-Mailer: git-send-email 2.4.10
>>
>> If an encrypted multipart message is received which contains html and
>> notmuch-multipart/alternative-discouraged is set to discourage "text/plain",
>> any encrypted parts are not decrypted during generation of the reply
>> text. This fixes that problem by making sure notmuch-mua-reply does
>> that.
>
> Hi
>
> I haven't tested this but it looks correct: more broadly I think this is
> needed whenever notmuch-show has to get a part directly rather than just
> from the sexp reply.

Hi

Just to confirm I have now tested this -- it compiles and test suite
passes. (Note I don't have suitable encrypted messages to test).

Anyway LGTM +1

Best wishes

Mark



>
> Best wishes
>
> Mark
>
>
>> ---
>>  emacs/notmuch-mua.el | 4 ++++
>>  1 file changed, 4 insertions(+)
>>
>> diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el
>> index c567173..f333655 100644
>> --- a/emacs/notmuch-mua.el
>> +++ b/emacs/notmuch-mua.el
>> @@ -251,6 +251,10 @@ mutiple parts get a header."
>>  		       (notmuch-show-max-text-part-size 0)
>>  		       ;; Insert headers for parts as appropriate for replying.
>>  		       (notmuch-show-insert-header-p-function notmuch-mua-reply-insert-header-p-function)
>> +		       ;; Ensure that any encrypted parts are
>> +		       ;; decrypted during the generation of the reply
>> +		       ;; text.
>> +		       (notmuch-show-process-crypto process-crypto)
>>  		       ;; Don't indent multipart sub-parts.
>>  		       (notmuch-show-indent-multipart nil))
>>  		    ;; We don't want sigstatus buttons (an information leak and usually wrong anyway).
>> -- 
>> 2.4.10
>>
>> _______________________________________________
>> notmuch mailing list
>> notmuch@notmuchmail.org
>> https://notmuchmail.org/mailman/listinfo/notmuch

[-- Attachment #2: Type: text/html, Size: 3660 bytes --]

Re:

[David Bremner]

matt@bubblegen.co.uk writes:

> From: Matthew Lear <matt@bubblegen.co.uk>
> To: notmuch@notmuchmail.org
> Cc: Matthew Lear <matt@bubblegen.co.uk>
> Subject: [PATCH] Fix reply to encrypted mail when discouraging plain text.
> Date: Tue, 11 Oct 2016 22:24:18 +0100
> Message-Id: <1476221058-10431-1-git-send-email-matt@bubblegen.co.uk>
> X-Mailer: git-send-email 2.4.10

Pushed to master. For future reference it would be nice if the actual
git send-email output made to the list, so I don't have to fix up the
commit message by hand.

Re:

[David Bremner]

Tomi Ollila <tomi.ollila@iki.fi> writes:

> This implementation adds add_exit_function (and rm_exit_function)
> which can also be used for other things in the future.
>

Pushed to master.

d

Re:

[David Bremner]

Damien Cassou <damien@cassou.me> writes:

>> OK, I see with counsel-imenu the current indexing by header lines is
>> reasonable. It might be improvable by adding the subject, but I'm
>> not sure about line lengths.
>> - maybe the docstrings should recomment counsel-imenu?
>
> I'm not sure as the function
> `notmuch-show-imenu-extract-index-name-function` is private and there
> are other imenu frontends available. What about a NEWS entry instead
> along those lines:
>
>     * Add Emacs' imenu support in notmuch-show and notmuch-search
>
>     Emacs' major modes can facilitate navigation in their buffers by
>     supporting Imenu. In such major modes, launching Imenu (M-x imenu)
>     makes Emacs display a list of items (e.g., function definitions in
>     a code buffer). Selecting an item from this list moves point to
>     this item.
>
>     This release adds Imenu support to both notmuch-show and
>     notmuch-search buffers:
>
>        * in notmuch-show, Imenu will present a list of all messages in
>          the currently visible thread;
>
>        * in notmuch-search, Imenu will present a list of all messages in the
>          search buffer.
>
>     We recommand an external imenu frontend, such as counsel-imenu,
>     which will make the experience much better that the default `M-x
>     imenu`.

That sounds fine.

>> I think the indentation should probably go to make it more usable
>> with the builtin imenu
>
> I did that in the patch even though I liked it with indentation better.

I haven't had a chance to test the new version yet, but I think I know
what you mean from testing counsel-imenu. Is it worth adding a
customization variable so that the user can choose indentation if they
have a more sophisticated imenu front end?

d

Re:

[David Bremner]

David Bremner <david@tethera.net> writes:

>> I did that in the patch even though I liked it with indentation better.
>
> I haven't had a chance to test the new version yet, but I think I know
> what you mean from testing counsel-imenu. Is it worth adding a
> customization variable so that the user can choose indentation if they
> have a more sophisticated imenu front end?

So this version is ok with both builtin and counsel imenu front
ends. It's up to you. Do you want to leave the question of controllable
indentation for a later commit or add it now?

d

Re:

[Damien Cassou]

David Bremner <david@tethera.net> writes:

> David Bremner <david@tethera.net> writes: 
> 
>>> I did that in the patch even though I liked it with 
>>> indentation better. 
>> 
>> I haven't had a chance to test the new version yet, but I think 
>> I know what you mean from testing counsel-imenu. Is it worth 
>> adding a customization variable so that the user can choose 
>> indentation if they have a more sophisticated imenu front end? 
> 
> So this version is ok with both builtin and counsel imenu front 
> ends. It's up to you. Do you want to leave the question of 
> controllable indentation for a later commit or add it now? 

if you are ok to merge that right now, that would be perfect for 
me. Thanks. 

-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Re:

[Jani Nikula]

On Thu, 01 Feb 2018, Matthew Lear <matt@bubblegen.co.uk> wrote:
> From: Matthew Lear <matt@bubblegen.co.uk>
> To: notmuch@notmuchmail.org
> Cc: Matthew Lear <matt@bubblegen.co.uk>
> Subject: [PATCH] Update date search syntax.
> Date: Thu,  1 Feb 2018 20:52:18 +0000
> Message-Id: <20180201205218.4368-1-matt@bubblegen.co.uk>
> X-Mailer: git-send-email 2.14.1
>
> If searching using the date prefix and timestamps, each timestamp
> is required to be prefixed with an @
> Legacy syntax of <initial-timestamp>..<final-timestamp> without the
> date prefix is still honoured, only without the @ specifiers.
> ---
>  doc/man7/notmuch-search-terms.rst | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
> index 6d2bf62a..b6e7079a 100644
> --- a/doc/man7/notmuch-search-terms.rst
> +++ b/doc/man7/notmuch-search-terms.rst
> @@ -124,10 +124,13 @@ date:<since>..<until> or date:<date>
>      The time range can also be specified using timestamps with a
>      syntax of:
>  
> -    <initial-timestamp>..<final-timestamp>
> +    @<initial-timestamp>..@<final-timestamp>

So I think I'd add the @ syntax in the DATE AND TIME SEARCH section,
maybe under a separate new heading, and just emphasize this here is
about the non-date prefixed thing.

BR,
Jani.
  
>      Each timestamp is a number representing the number of seconds
> -    since 1970-01-01 00:00:00 UTC.
> +    since 1970-01-01 00:00:00 UTC. A date range search using
> +    timestamps is also permitted without using the date prefix and
> +    @ specifiers, although this is considered legacy and pre-dates
> +    the date prefix.
>  
>  lastmod:<initial-revision>..<final-revision>
>      The **lastmod:** prefix can be used to restrict the result by the
> -- 
> 2.14.1
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> https://notmuchmail.org/mailman/listinfo/notmuch