X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch.rst;h=3acfbdb436db953f3889e98e75f913135ae06858;hp=ae0461a2725e09d8c367dfcd5eefbaca2c1a51c4;hb=36b75cd4419c298bba7d12394b2e198a9b7f6a41;hpb=8cca886b10c5ec44f3214701c0c1e3c896d53d5c diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index ae0461a2..3acfbdb4 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -39,19 +39,28 @@ OPTIONS Supported global options for ``notmuch`` include - ``--help`` - Print a synopsis of available commands and exit. + ``--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. + 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}. + 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 -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 ========