diff options
| author | Jani Nikula <jani@nikula.org> | 2021-05-21 23:44:10 +0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-05-22 16:38:56 -0300 |
| commit | ff4e81ac57dee5a62f35093c2966f931a7b7580c (patch) | |
| tree | 7b63cb0cfc64f9256ea7c1edbd3d58cdfc8fc85d /doc/man5 | |
| parent | 8675be1d307bc2df882107744641f6a7858e65ad (diff) | |
doc: cross-reference notmuch man pages with actual links
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.
Diffstat (limited to 'doc/man5')
| -rw-r--r-- | doc/man5/notmuch-hooks.rst | 54 |
1 files changed, 28 insertions, 26 deletions
diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst index c509afb3..268917cd 100644 --- a/doc/man5/notmuch-hooks.rst +++ b/doc/man5/notmuch-hooks.rst @@ -1,3 +1,5 @@ +.. _notmuch-hooks(5): + ============= notmuch-hooks ============= @@ -12,35 +14,35 @@ 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 **notmuch-config(1)**. They +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. + 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 **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. + 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 **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 successful - delivery depends on the ``--keep`` option. + 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. @@ -48,15 +50,15 @@ The currently available hooks are described below. 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)` |
