]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-hooks-5.mdwn
complete sentence
[notmuch-wiki] / manpages / notmuch-hooks-5.mdwn
index f616177ad73ff7cb121e2aa5f2bdaad7c71d994a..6a7ae271fee902eff9158e89f0c201407a5a007e 100644 (file)
@@ -7,42 +7,42 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       $DATABASEDIR/.notmuch/hooks/*
+       &lt;hook_dir&gt;/{pre-new, post-new, post-insert}
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>
        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
+       in  a  directory  defined  as described in <a href='../notmuch-config-1/'>notmuch-config</a>(1). They must
        have executable permissions.
 
        The currently available hooks are described below.
 
        <b>pre-new</b>
-              This hook is invoked by  the  <b>new</b>  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</b> command.
+              This hook is invoked by the <a href='../notmuch-new-1/'>notmuch-new</a>(1) command before  scan‐
+              ning  or  importing new messages into the database. If this hook
+              exits with a non-zero status, notmuch will  abort  further  pro‐
+              cessing of the <a href='../notmuch-new-1/'>notmuch-new</a>(1) command.
 
               Typically  this hook is used for fetching or delivering new mail
               to be imported into the database.
 
        <b>post-new</b>
-              This hook is invoked by the <b>new</b> 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.
+              This hook is invoked by the  <a href='../notmuch-new-1/'>notmuch-new</a>(1)  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.
 
        <b>post-insert</b>
-              This hook is invoked by the <b>insert</b> command after the message has
-              been  delivered,  added  to  the database, and initial tags have
-              been applied. The hook will not be run if there  have  been  any
-              errors during the message delivery; what is regarded as success‐
-              ful delivery depends on the <b>--keep</b> option.
+              This hook is invoked by the <a href='../notmuch-insert-1/'>notmuch-insert</a>(1) command after  the
+              message  has  been delivered, added to the database, and initial
+              tags have been applied. The hook will not be run if  there  have
+              been any errors during the message delivery; what is regarded as
+              successful delivery depends on the <b>--keep</b> option.
 
               Typically this hook is used to  perform  additional  query-based
               tagging on the delivered messages.
@@ -63,7 +63,7 @@
 
 <h2>COPYRIGHT</h2>
 <pre>
-       2009-2018, Carl Worth and many others
+       2009-2022, Carl Worth and many others
 </pre>
 
-<h2>0.26</h2>
+<h2>0.35</h2>