]> git.cworth.org Git - notmuch/commitdiff
doc: example command-line option reference
authorJani Nikula <jani@nikula.org>
Fri, 21 May 2021 20:44:13 +0000 (23:44 +0300)
committerDavid Bremner <david@tethera.net>
Sat, 22 May 2021 19:47:32 +0000 (16:47 -0300)
Example reference to a command-line option using the option role
reference. This creates a hyperlink in html, and the usual boldface
style in man page. This could be used throughout the man pages.

doc/man1/notmuch-config.rst

index af126289a97f1b9aaffed9a0861c19d064b0b2a0..56f4a1600153517edce62d9094ff37ef1ffb13c1 100644 (file)
@@ -248,7 +248,7 @@ CONFIGURATION
 
 Notmuch configuration file search order:
 
-1. File specified by ``--config=FILE`` global option; see
+1. File specified by :option:`notmuch --config` global option; see
    :any:`notmuch(1)`.
 
 2. File specified by :envvar:`NOTMUCH_CONFIG` environment variable.