cli/insert: document the use of EX_TEMPFAIL

This commit is contained in:
David Bremner 2016-12-07 07:27:12 -04:00
parent d74c534570
commit 3d312e2577

View file

@ -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 maildir flags. The ``--keep`` option may be used to settle for
successful message file delivery. 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 The exit status of the **post-insert** hook does not affect the exit
status of the **insert** command. status of the **insert** command.