diff options
| author | David Bremner <david@tethera.net> | 2015-04-06 07:39:55 +0900 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2015-08-14 18:23:49 +0200 |
| commit | f76d8f82dd004cf14426a91e8a80dcd2a4b97317 (patch) | |
| tree | b2a08fb89242d809d095665a84ff75c6d7d142e3 /doc | |
| parent | 5a3b42fb8c556397841b86c5fda1c4554dab253a (diff) | |
cli: add global option "--uuid"
The function notmuch_exit_if_unmatched_db_uuid is split from
notmuch_process_shared_options because it needs an open notmuch
database.
There are two exceptional cases in uuid handling.
1) notmuch config and notmuch setup don't currently open the database,
so it doesn't make sense to check the UUID.
2) notmuch compact opens the database inside the library, so we either
need to open the database just to check uuid, or change the API.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man1/notmuch.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index 0401c91b..3acfbdb4 100644 --- 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}. + ``--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 ======== |