aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man5
diff options
context:
space:
mode:
authorGravatar David Bremner <bremner@debian.org>2011-12-18 22:38:24 -0400
committerGravatar David Bremner <bremner@debian.org>2011-12-31 15:16:31 -0400
commitc48797b498ba8dc46fb323a8a7f2cde4d41d3123 (patch)
tree6632d64290029a9d75ecb5e19f249c729d027c34 /man/man5
parent347f39d73e2ab541b61d6e95b7feeebc6a1a453a (diff)
initial splitting of notmuch.1
We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
Diffstat (limited to 'man/man5')
-rw-r--r--man/man5/notmuch-hooks.540
1 files changed, 40 insertions, 0 deletions
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