mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-22 19:08:09 +01:00
ff4e81ac57
Add internal hyperlink targets for man pages and cross-reference them using the any role reference. There are a number of alternatives to accomplish this, but this seems like the combination that retains the man page section number and the same boldface style in the man pages. As a bonus, we get sanity checking on the links; for example notmuch-search-terms.rst had a reference to notmuch-properties(1) i.e. the wrong section. The obvious semantic follow-up change would be to only have meaningful "see also" references instead of having them all everywhere.
64 lines
1.9 KiB
ReStructuredText
64 lines
1.9 KiB
ReStructuredText
.. _notmuch-hooks(5):
|
|
|
|
=============
|
|
notmuch-hooks
|
|
=============
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
<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 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 :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.
|
|
|
|
Typically this hook is used for fetching or delivering new mail to
|
|
be imported into the database.
|
|
|
|
**post-new**
|
|
This hook is invoked by the :any:`notmuch-new(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.
|
|
|
|
**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.
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
: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)`
|