cli/insert: document the use of EX_TEMPFAIL

diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index 9e7afc36d75f24df41b7154b78a7f6a5e889f1a9..9847e674688ed1cb23b95ef87ccc2efb89599268 100644 (file)
--- a/doc/man1/notmuch-insert.rst
+++ b/doc/man1/notmuch-insert.rst
@@ -60,6 +60,13 @@ indexing to Notmuch database, changing tags, and synchronizing tags to
 maildir flags. The ``--keep`` option may be used to settle for
 successful message file delivery.
 
 maildir flags. The ``--keep`` option may be used to settle for
 successful message file delivery.
 

+This command supports the following special exit status code for
+errors most likely to be temporary in nature, e.g. failure to get a
+database write lock.
+
+``75 (EX_TEMPFAIL)``
+    A temporary failure occured; the user is invited to retry.
+

 The exit status of the **post-insert** hook does not affect the exit
 status of the **insert** command.
 
 The exit status of the **post-insert** hook does not affect the exit
 status of the **insert** command.