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 fbd7f381675748cfca83d5818a50669323485117..7fdcc9dd57fbeb99cfd7b391730e9df20b0543c4 100644 (file)
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -39,28 +39,29 @@ OPTIONS
 
 Supported global options for ``notmuch`` include
 
-    ``--help`` [command-name]
-       Print a synopsis of available commands and exit.
-       With an optional command name, show the man page
-       for that subcommand.
-
-    ``--version``
-       Print the installed version of notmuch, and exit.
-
-    ``--config=FILE``
-       Specify the configuration file to use. This overrides any
-       configuration file specified by ${NOTMUCH\_CONFIG}.
-
-    ``--uuid=HEX``
-       Enforce that the database UUID (a unique identifier which
-       persists until e.g. the database is compacted)
-       is HEX; exit with an error if it is not. This is useful to
-       detect rollover in modification counts on messages. You can
-       find this UUID using e.g. ``notmuch count --lastmod``
+``--help`` [command-name]
+    Print a synopsis of available commands and exit. With an optional
+    command name, show the man page for that subcommand.
+
+``--version``
+    Print the installed version of notmuch, and exit.
+
+``--config=FILE``
+    Specify the configuration file to use. This overrides any
+    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
+    until e.g. the database is compacted) is HEX; exit with an error
+    if it is not. This is useful to detect rollover in modification
+    counts on messages. You can find this UUID using e.g. ``notmuch
+    count --lastmod``
 
 All global options except ``--config`` can also be specified after the
-command. For example, ``notmuch subcommand --uuid=HEX`` is
-equivalent to ``notmuch --uuid=HEX subcommand``.
+command. For example, ``notmuch subcommand --uuid=HEX`` is equivalent
+to ``notmuch --uuid=HEX subcommand``.
 
 COMMANDS
 ========
@@ -89,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.
@@ -123,7 +125,21 @@ If the given command is not known to notmuch, notmuch tries to execute
 the external **notmuch-<subcommand>** in ${PATH} instead. This allows
 users to have their own notmuch related tools to be run via the
 notmuch command. By design, this does not allow notmuch's own commands
-to be overriden using external commands.
+to be overridden using external commands.
+
+OPTION SYNTAX
+-------------
+
+All options accepting an argument can be used with '=' or ':' as a
+separator. Except for boolean options (which would be ambiguous), a
+space can also be used as a separator. The following are all
+equivalent:
+
+::
+
+   notmuch --config=alt-config config get user.name
+   notmuch --config:alt-config config get user.name
+   notmuch --config alt-config config get user.name
 
 ENVIRONMENT
 ===========
@@ -137,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**
@@ -147,11 +163,22 @@ of notmuch.
 SEE ALSO
 ========
 
-**notmuch-address(1)**, **notmuch-compact(1)**, **notmuch-config(1)**,
-**notmuch-count(1)**, **notmuch-dump(1)**, **notmuch-hooks(5)**,
-**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)**
+**notmuch-address(1)**,
+**notmuch-compact(1)**,
+**notmuch-config(1)**,
+**notmuch-count(1)**,
+**notmuch-dump(1)**,
+**notmuch-hooks(5)**,
+**notmuch-insert(1)**,
+**notmuch-new(1)**,
+**notmuch-properties(7)**,
+**notmuch-reindex(1)**,
+**notmuch-reply(1)**,
+**notmuch-restore(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**
 
 The notmuch website: **https://notmuchmail.org**