doc: use manpage role references to external man pages

[notmuch] / doc / man1 / notmuch.rst

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index d2cd8da55cb99e0d20792fdbe326e415bd0109f7..7fdcc9dd57fbeb99cfd7b391730e9df20b0543c4 100644 (file)
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -48,7 +48,9 @@ Supported global options for ``notmuch`` include
 
 ``--config=FILE``
     Specify the configuration file to use. This overrides any
-    configuration file specified by ${NOTMUCH\_CONFIG}.
+    configuration file specified by ${NOTMUCH\_CONFIG}. The empty
+    string is a permitted and sometimes useful value of *FILE*, which
+    tells ``notmuch`` to use only configuration metadata from the database.
 
 ``--uuid=HEX``
     Enforce that the database UUID (a unique identifier which persists
@@ -88,7 +90,8 @@ will do its best to detect those and ignore them.
 Mail storage that uses mbox format, (where one mbox file contains many
 messages), will not work with notmuch. If that's how your mail is
 currently stored, it is recommended you first convert it to maildir
-format with a utility such as mb2md before running **notmuch setup .**
+format with a utility such as :manpage:`mb2md(1)` before running
+**notmuch setup**.
 
 Invoking ``notmuch`` with no command argument will run **setup** if the
 setup command has not previously been completed.
@@ -128,9 +131,9 @@ OPTION SYNTAX
 -------------
 
 All options accepting an argument can be used with '=' or ':' as a
-separator. For the cases where it's not ambiguous (in particular
-excluding boolean options), a space can also be used. The following
-are all equivalent:
+separator. Except for boolean options (which would be ambiguous), a
+space can also be used as a separator. The following are all
+equivalent:
 
 ::
 
@@ -150,7 +153,7 @@ of notmuch.
 
 **NOTMUCH\_TALLOC\_REPORT**
     Location to write a talloc memory usage report. See
-    **talloc\_enable\_leak\_report\_full** in **talloc(3)** for more
+    **talloc\_enable\_leak\_report\_full** in :manpage:`talloc(3)` for more
     information.
 
 **NOTMUCH\_DEBUG\_QUERY**