emacs: Add new option notmuch-search-hide-excluded

[notmuch] / doc / man5 / notmuch-hooks.rst

diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst
index f96a923b23f2a8f57ac9882ee72d4e6b9099513e..d778bdb8133692e8b542677fd513c7460265a522 100644 (file)
--- a/doc/man5/notmuch-hooks.rst
+++ b/doc/man5/notmuch-hooks.rst
@@ -1,3 +1,5 @@
+.. _notmuch-hooks(5):
+
 =============
 notmuch-hooks
 =============
@@ -5,51 +7,58 @@ notmuch-hooks
 SYNOPSIS
 ========
 
-$DATABASEDIR/.notmuch/hooks/*
+<hook_dir>/{pre-new, post-new, post-insert}
 
 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.
+in a directory defined as described in :any:`notmuch-config(1)`. They
+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.
+pre-new
+    This hook is invoked by the :any:`notmuch-new(1)` 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 :any:`notmuch-new(1)` command.
 
-    **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 for fetching or delivering new mail to
+    be imported into the database.
 
-        Typically this hook is used to perform additional query-based
-        tagging on the imported messages.
+post-new
+    This hook is invoked by the :any:`notmuch-new(1)` command after
+    any 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.
 
-    **post-insert**
+    Typically this hook is used to perform additional query-based
+    tagging on the imported messages.
 
-        This hook is invoked by the **insert** 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 succesful delivery depends on the ``--keep`` option.
+post-insert
+    This hook is invoked by the :any:`notmuch-insert(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 ``--keep`` option.
 
-        Typically this hook is used to perform additional query-based
-        tagging on the delivered messages.
+    Typically this hook is used to perform additional query-based
+    tagging on the delivered 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)**
+:any:`notmuch(1)`,
+:any:`notmuch-config(1)`,
+:any:`notmuch-count(1)`,
+:any:`notmuch-dump(1)`,
+:any:`notmuch-insert(1)`,
+:any:`notmuch-new(1)`,
+:any:`notmuch-reply(1)`,
+:any:`notmuch-restore(1)`,
+:any:`notmuch-search(1)`,
+:any:`notmuch-search-terms(7)`,
+:any:`notmuch-show(1)`,
+:any:`notmuch-tag(1)`