]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-hooks-5.mdwn
manpages updates for release 0.32
[notmuch-wiki] / manpages / notmuch-hooks-5.mdwn
index 08f07ceb987bffa449391ab7e71de426c2123e6d..931ea8a18c1d7aa1817ea3a7a3ea9385ac8bb6ee 100644 (file)
@@ -7,41 +7,41 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
 
 <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
 </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.
 
        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.
+       <b>pre-new</b>
+              This hook is invoked by the <b>new</b> command before scanning  or  im‐
+              porting  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.
 
 
-                 Typically  this  hook  is used for fetching or delivering new
-                 mail to be imported into the database.
+              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.
+       <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 ap‐
+              plied. 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.
+              Typically  this  hook  is used to perform additional query-based
+              tagging on the imported messages.
 
 
-          <b>post-insert</b>
+       <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
               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 succes‐
+              errors during the message delivery; what is regarded as success‐
               ful delivery depends on the <b>--keep</b> option.
 
               Typically this hook is used to  perform  additional  query-based
               ful delivery depends on the <b>--keep</b> option.
 
               Typically this hook is used to  perform  additional  query-based
@@ -63,7 +63,7 @@
 
 <h2>COPYRIGHT</h2>
 <pre>
 
 <h2>COPYRIGHT</h2>
 <pre>
-       2015, Carl Worth and many others
+       2009-2021, Carl Worth and many others
 </pre>
 
 </pre>
 
-<h2>0.20.2</h2>
+<h2>0.32</h2>