X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch.rst;fp=doc%2Fman1%2Fnotmuch.rst;h=e7adcfcd7ff573bbe7b5603642543b1b0a1bdad3;hp=93135bdd6abb6ce3cff8f5b917c55cf14e8d1a8a;hb=f2e2f2aa96cb0d40c6fb85cde2ab82380c367485;hpb=574b2436eeabf60c930ba227931ee87b0b151a65 diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index 93135bdd..e7adcfcd 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -43,25 +43,31 @@ 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 :envvar:`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`` +.. program:: notmuch + +.. option:: --help [command-name] + + Print a synopsis of available commands and exit. With an optional + command name, show the man page for that subcommand. + +.. option:: --version + + Print the installed version of notmuch, and exit. + +.. option:: --config=FILE + + Specify the configuration file to use. This overrides any + configuration file specified by :envvar:`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. + +.. option:: --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