aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/man5
diff options
context:
space:
mode:
authorGravatar David Bremner <david@tethera.net>2014-01-28 12:12:37 -0400
committerGravatar David Bremner <david@tethera.net>2014-03-09 10:41:08 -0300
commitd736260385a689b5c77d8121f48e29440e3adfa4 (patch)
tree4d5c4279405a012f6f312fbb8c003226c618bb78 /doc/man5
parent029790d3ff6e9fccfed2214efac777b8c438e318 (diff)
doc: convert sphinx based docs
This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
Diffstat (limited to 'doc/man5')
-rw-r--r--doc/man5/notmuch-hooks.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst
new file mode 100644
index 00000000..493abf20
--- /dev/null
+++ b/doc/man5/notmuch-hooks.rst
@@ -0,0 +1,44 @@
+=============
+notmuch-hooks
+=============
+
+SYNOPSIS
+========
+
+ $DATABASEDIR/.notmuch/hooks/*
+
+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)**