X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch.rst;h=edd04efb035a10374d8c5c88d7077b1935157e1f;hb=6a833a6e83865f6999707cc30768d07e1351c2cb;hp=b33738ed33166699fb3872610634aa2f984e7c74;hpb=9710f0886ab48b12d2401b3d68504b586b6a7309;p=notmuch diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index b33738ed..edd04efb 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -29,7 +29,7 @@ While the command-line program ``notmuch`` provides powerful functionality, it does not provide the most convenient interface for that functionality. More sophisticated interfaces are expected to be built on top of either the command-line interface, or more likely, on -top of the notmuch library interface. See http://notmuchmail.org for +top of the notmuch library interface. See https://notmuchmail.org for more about alternate interfaces to notmuch. The emacs-based interface to notmuch (available under **emacs/** in the Notmuch source distribution) is probably the most widely used at this time. @@ -39,15 +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 --uuid=HEX`` is +equivalent to ``notmuch --uuid=HEX subcommand``. COMMANDS ======== @@ -131,7 +144,7 @@ SEE ALSO **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**, **notmuch-address(1)** -The notmuch website: **http://notmuchmail.org** +The notmuch website: **https://notmuchmail.org** CONTACT =======