diff options
-rw-r--r-- | INSTALL | 18 | ||||
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | debian/control | 1 | ||||
-rw-r--r-- | doc/.gitignore | 2 | ||||
-rw-r--r-- | doc/INSTALL | 24 | ||||
-rw-r--r-- | doc/Makefile | 5 | ||||
-rw-r--r-- | doc/Makefile.local | 27 | ||||
-rw-r--r-- | doc/conf.py | 166 | ||||
-rw-r--r-- | doc/index.rst | 30 | ||||
-rw-r--r-- | doc/man1/notmuch-compact.rst | 52 | ||||
-rw-r--r-- | doc/man1/notmuch-config.rst | 123 | ||||
-rw-r--r-- | doc/man1/notmuch-count.rst | 60 | ||||
-rw-r--r-- | doc/man1/notmuch-dump.rst | 72 | ||||
-rw-r--r-- | doc/man1/notmuch-insert.rst | 58 | ||||
-rw-r--r-- | doc/man1/notmuch-new.rst | 52 | ||||
-rw-r--r-- | doc/man1/notmuch-reply.rst | 112 | ||||
-rw-r--r-- | doc/man1/notmuch-restore.rst | 59 | ||||
-rw-r--r-- | doc/man1/notmuch-search.rst | 146 | ||||
-rw-r--r-- | doc/man1/notmuch-show.rst | 179 | ||||
-rw-r--r-- | doc/man1/notmuch-tag.rst | 107 | ||||
-rw-r--r-- | doc/man1/notmuch.rst | 143 | ||||
-rw-r--r-- | doc/man5/notmuch-hooks.rst | 44 | ||||
-rw-r--r-- | doc/man7/notmuch-search-terms.rst | 234 | ||||
-rw-r--r-- | doc/notmuch-emacs.rst | 192 |
24 files changed, 1905 insertions, 3 deletions
@@ -60,16 +60,30 @@ Talloc which are each described below: Talloc is available from http://talloc.samba.org/ +Building Documentation +---------------------- + +By default the documentation for notmuch is built using sphinx. + +Sphinx is available from www.sphinx-doc.org. + +If you prefer, you can build the man pages using rst2man, from the +python docutils package. See doc/INSTALL for details. + + +Installing Dependencies from Packages +------------------------------------- + On a modern, package-based operating system you can install all of the dependencies with a simple simple command line. For example: For Debian and similar: - sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev + sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev python-sphinx For Fedora and similar: - sudo yum install xapian-core-devel gmime-devel libtalloc-devel + sudo yum install xapian-core-devel gmime-devel libtalloc-devel python-sphinx On other systems, a similar command can be used, but the details of the package names may be different. @@ -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/debian/control b/debian/control index c5475c41..8d8e938e 100644 --- a/debian/control +++ b/debian/control @@ -15,6 +15,7 @@ Build-Depends: libz-dev, python-all (>= 2.6.6-3~), python3-all (>= 3.1.2-7~), + python-sphinx (>= 1.0), ruby, ruby-dev (>>1:1.9.3~), emacs23-nox | emacs23 (>=23~) | emacs23-lucid (>=23~) | emacs24-nox | emacs24 (>=24~) | emacs24-lucid (>=24~), diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000..a60fb31e --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,2 @@ +docdeps.mk +_build diff --git a/doc/INSTALL b/doc/INSTALL new file mode 100644 index 00000000..e37c2b9b --- /dev/null +++ b/doc/INSTALL @@ -0,0 +1,24 @@ +This file contains some more detailed information about building and +installing the documentation. + +Building with sphinx. +--------------------- + +- You need sphinx at least version 1.0. + +- You can build build and install man pages with 'make install-man' + +- You can build man, info, html, and pdf versions of the docs + (currently only the man pages) with + + 'make install-{man|info|html|pdf}' + +Building the man pages +---------------------- + +- You can build the man pages with rst2man (from python-docutils) with + 'make rst2man'. + +- Currently there is no support to automagically install the resulting + nroff files, but it should work to modify the target install-man + in doc/Makefile.local. diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..fa25832e --- /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 00000000..ec230125 --- /dev/null +++ b/doc/Makefile.local @@ -0,0 +1,27 @@ +# -*- makefile -*- + +dir := doc + +# You can set these variables from the command line. +SPHINXOPTS := -q -c $(dir) +SPHINXBUILD = sphinx-build +DOCBUILDDIR := $(dir)/_build + +# Internal variables. +ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir) + +.PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info + +sphinx-html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html + +sphinx-man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man + +sphinx-texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo + +sphinx-info: sphinx-texinfo + make -C $(DOCBUILDDIR)/texinfo info + +CLEAN := $(CLEAN) $(DOCBUILDDIR) diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 00000000..6c2806d7 --- /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', 'notmuch-emacs.rst'] + +# 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 00000000..b33aa9fb --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,30 @@ + +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 + +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 00000000..e0109dce --- /dev/null +++ b/doc/man1/notmuch-compact.rst @@ -0,0 +1,52 @@ +=============== +notmuch-compact +=============== + +SYNOPSIS +======== + +**notmuch** **compact** [--quiet] [--backup=<*directory*>] + +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 00000000..3c9a5684 --- /dev/null +++ b/doc/man1/notmuch-config.rst @@ -0,0 +1,123 @@ +============== +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 00000000..ca78c18b --- /dev/null +++ b/doc/man1/notmuch-count.rst @@ -0,0 +1,60 @@ +============= +notmuch-count +============= + +SYNOPSIS +======== + +**notmuch** **count** [*option* ...] <*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 00000000..17d1da5c --- /dev/null +++ b/doc/man1/notmuch-dump.rst @@ -0,0 +1,72 @@ +============ +notmuch-dump +============ + +SYNOPSIS +======== + +**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*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 00000000..2be1a7b8 --- /dev/null +++ b/doc/man1/notmuch-insert.rst @@ -0,0 +1,58 @@ +============== +notmuch-insert +============== + +SYNOPSIS +======== + +**notmuch** **insert** [option ...] [+<*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 00000000..d11fceed --- /dev/null +++ b/doc/man1/notmuch-new.rst @@ -0,0 +1,52 @@ +=========== +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 00000000..cfbd4ea8 --- /dev/null +++ b/doc/man1/notmuch-reply.rst @@ -0,0 +1,112 @@ +============= +notmuch-reply +============= + +SYNOPSIS +======== + +**notmuch** **reply** [option ...] <*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`` |