cli: add global option "--uuid"

[notmuch] / doc / man1 / notmuch.rst

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index 0401c91bea89d3a0381eee37c2d59064ac69ec8c..3acfbdb436db953f3889e98e75f913135ae06858 100644 (file)
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -51,9 +51,16 @@ Supported global options for ``notmuch`` include
        Specify the configuration file to use. This overrides any
        configuration file specified by ${NOTMUCH\_CONFIG}.
 
        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``
+

 All global options except ``--config`` can also be specified after the
 All global options except ``--config`` can also be specified after the

-command. For example, ``notmuch subcommand --version`` is equivalent to
-``notmuch --version subcommand``.
+command. For example, ``notmuch subcommand --uuid=HEX`` is
+equivalent to ``notmuch --uuid=HEX subcommand``.

 
 COMMANDS
 ========
 
 COMMANDS
 ========