cli/insert: add --try-decrypt=(true|false)

[notmuch] / doc / man1 / notmuch.rst

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index ae0461a2725e09d8c367dfcd5eefbaca2c1a51c4..358f42e8d5bef9335a9649839b0e73289ddadc61 100644 (file)
--- 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
 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.
 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,19 +39,28 @@ OPTIONS
 
 Supported global options for ``notmuch`` include
 
 
 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``
 
     ``--version``

-        Print the installed version of notmuch, and exit.
+       Print the installed version of notmuch, and exit.

 
     ``--config=FILE``
 
     ``--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
 
 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
 ========
 
 COMMANDS
 ========


@@ -107,6 +116,29 @@ dump of email tags for backup purposes, and to restore from that dump.
 The **config** command can be used to get or set settings in the notmuch
 configuration file.
 
 The **config** command can be used to get or set settings in the notmuch
 configuration file.
 

+CUSTOM COMMANDS
+---------------
+
+If the given command is not known to notmuch, notmuch tries to execute
+the external **notmuch-<subcommand>** in ${PATH} instead. This allows
+users to have their own notmuch related tools to be run via the
+notmuch command. By design, this does not allow notmuch's own commands
+to be overridden using external commands.
+
+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:
+
+::
+
+   notmuch --config=alt-config config get user.name
+   notmuch --config:alt-config config get user.name
+   notmuch --config alt-config config get user.name
+

 ENVIRONMENT
 ===========
 
 ENVIRONMENT
 ===========
 


@@ -129,13 +161,24 @@ of notmuch.
 SEE ALSO
 ========
 
 SEE ALSO
 ========
 

-**notmuch-config(1)**, **notmuch-count(1)**, **notmuch-dump(1)**,
-**notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**,
-**notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
-**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**,
-**notmuch-address(1)**
-
-The notmuch website: **http://notmuchmail.org**
+**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**

 
 CONTACT
 =======
 
 CONTACT
 =======