aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2016-12-07 07:27:12 -0400
committerDavid Bremner <david@tethera.net>2016-12-15 20:21:02 +0900
commit3d312e2577820f7c14df24be305da715d4ea74ee (patch)
tree94782b2752d4f32d72194cc3bc386bb8885ad62a
parentd74c5345704136611f993ca38e0d035b1da798b6 (diff)
cli/insert: document the use of EX_TEMPFAIL
-rw-r--r--doc/man1/notmuch-insert.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index 9e7afc36..9847e674 100644
--- 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.
+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.