unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 4/4] doc: use hyperlinks for config options in notmuch-insert(1)
Date: Sun,  6 Feb 2022 10:23:34 -0400	[thread overview]
Message-ID: <20220206142334.303341-5-david@tethera.net> (raw)
In-Reply-To: <20220206142334.303341-1-david@tethera.net>

The tradeoff is no bold/italic in the man pages to get actual
hyperlinks in the html output.
---
 doc/man1/notmuch-config.rst | 2 ++
 doc/man1/notmuch-insert.rst | 6 +++---
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 84a9e023..acc5ecec 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -85,6 +85,8 @@ database.hook_dir
 
     Default: See HOOKS, below.
 
+.. _database.mail_root:
+
 database.mail_root
     The top-level directory where your mail currently exists and to
     where mail will be delivered in the future. Files should be
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index 8d91d62a..fe2bf26b 100644
--- a/doc/man1/notmuch-insert.rst
+++ b/doc/man1/notmuch-insert.rst
@@ -14,12 +14,12 @@ DESCRIPTION
 
 **notmuch insert** reads a message from standard input and delivers it
 into the maildir directory given by configuration option
-**database.mail_root**, then incorporates the message into the notmuch
+:ref:`database.mail_root <database.mail_root>`, then incorporates the message into the notmuch
 database. It is an alternative to using a separate tool to deliver the
 message then running :any:`notmuch-new(1)` afterwards.
 
 The new message will be tagged with the tags specified by the
-**new.tags** configuration option, then by operations specified on the
+:ref:`new.tags <new.tags>` configuration option, then by operations specified on the
 command-line: tags prefixed by '+' are added while those prefixed by '-'
 are removed.
 
@@ -86,7 +86,7 @@ Supported options for **insert** include
    ``--decrypt=nostash`` without considering the security of your
    index.
 
-   See also ``index.decrypt`` in :any:`notmuch-config(1)`.
+   See also :ref:`index.decrypt <index.decrypt>` in :any:`notmuch-config(1)`.
 
 CONFIGURATION
 =============
-- 
2.34.1

      parent reply	other threads:[~2022-02-06 14:24 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-06 14:23 improve documentation of configuration options David Bremner
2022-02-06 14:23 ` [PATCH 1/4] doc: alphabetize options in notmuch-config(1) David Bremner
2022-02-06 14:23 ` [PATCH 2/4] doc: add configuration section to notmuch-new(1) David Bremner
2022-02-06 14:23 ` [PATCH 3/4] doc: add configuration section to notmuch-insert(1) David Bremner
2022-02-06 14:23 ` David Bremner [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220206142334.303341-5-david@tethera.net \
    --to=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).