X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch.rst;h=48351588a3eafc7a20ed69161fa2ae44485c7486;hb=dd9112e7d8e89e8566b90379f5f3b1461a2d2845;hp=40fd335bd8240c1eeb3b7c96a267fa19e6f624b8;hpb=84ae74aada7d4a4574c09a81c9bddcc947d834b1;p=notmuch diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index 40fd335b..48351588 100644 --- 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 ======== @@ -129,9 +130,9 @@ OPTION SYNTAX ------------- All options accepting an argument can be used with '=' or ':' as a -separator. For the cases where it's not ambiguous (in particular -excluding boolean options), a space can also be used. The following -are all equivalent: +separator. Except for boolean options (which would be ambiguous), a +space can also be used as a separator. The following are all +equivalent: :: @@ -161,11 +162,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-reindex(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**