X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=man%2Fman5%2Fnotmuch-hooks.5;fp=man%2Fman5%2Fnotmuch-hooks.5;h=8b66425ef13a7987d96a45976c8cdc8439f0f03e;hb=c48797b498ba8dc46fb323a8a7f2cde4d41d3123;hp=0000000000000000000000000000000000000000;hpb=347f39d73e2ab541b61d6e95b7feeebc6a1a453a;p=obsolete%2Fnotmuch-old

diff --git a/man/man5/notmuch-hooks.5 b/man/man5/notmuch-hooks.5
new file mode 100644
index 00000000..8b66425e
--- /dev/null
+++ b/man/man5/notmuch-hooks.5
@@ -0,0 +1,40 @@
+.TH NOTMUCH-HOOKS 5 2011-12-04 "Notmuch 0.10.2"
+
+.SH NAME
+notmuch-hooks \- hooks for notmuch
+
+.SH SYNOPSIS
+ $DATABASEDIR/.notmuch/hooks/*
+
+.SH 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.
+.RS 4
+.TP 4
+.B pre\-new
+This hook is invoked by the
+.B 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
+.B new
+command.
+
+Typically this hook is used for fetching or delivering new mail to be imported
+into the database.
+.RE
+.RS 4
+.TP 4
+.B post\-new
+This hook is invoked by the
+.B 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.
+.RE